com.unboundid.ldap.listener
Interface IntermediateResponseTransformer
- All Known Implementing Classes:
- InMemoryOperationInterceptorRequestHandler, LDAPDebuggerRequestHandler
@Extensible
@ThreadSafety(level=INTERFACE_THREADSAFE)
public interface IntermediateResponseTransformer
This interface may be implemented by a class which wishes to intercept and
alter intermediate responses in some way before they are returned to the
client, and/or to prevent them from being returned altogether.
transformIntermediateResponse
ObjectPair<IntermediateResponseProtocolOp,Control[]> transformIntermediateResponse(int messageID,
IntermediateResponseProtocolOp response,
Control[] controls)
- Transforms the provided intermediate response and/or set of controls to
alter what will be returned to the client.
- Parameters:
messageID
- The message ID for the associated search operation.response
- The intermediate response to be processed. It will not
be null
.controls
- The set of controls to be processed. It will not be
null
but may be empty if there are no controls.
- Returns:
- An
ObjectPair
containing a possibly updated intermediate
response and set of controls, or null
to indicate that the
response should not be returned to the client.