C
- The type of request context.public interface RequestHandler<C>
Implementations must always return results using the provided
LdapResultHandler
unless explicitly permitted.
For example, an LDAPListener
does not require RequestHandler
implementations to return results, which may be useful when implementing
abandon operation functionality. Conversely, an access logger implemented as
a RequestHandler
wrapper will require wrapped RequestHandler
s
to always return results, even abandoned results, in order for it to log the
result status.
ServerConnectionFactory
Modifier and Type | Method and Description |
---|---|
void |
handleAdd(C requestContext,
AddRequest request,
IntermediateResponseHandler intermediateResponseHandler,
LdapResultHandler<Result> resultHandler)
Invoked when an add request is received from a client.
|
void |
handleBind(C requestContext,
int version,
BindRequest request,
IntermediateResponseHandler intermediateResponseHandler,
LdapResultHandler<BindResult> resultHandler)
Invoked when a bind request is received from a client.
|
void |
handleCompare(C requestContext,
CompareRequest request,
IntermediateResponseHandler intermediateResponseHandler,
LdapResultHandler<CompareResult> resultHandler)
Invoked when a compare request is received from a client.
|
void |
handleDelete(C requestContext,
DeleteRequest request,
IntermediateResponseHandler intermediateResponseHandler,
LdapResultHandler<Result> resultHandler)
Invoked when a delete request is received from a client.
|
<R extends ExtendedResult> |
handleExtendedRequest(C requestContext,
ExtendedRequest<R> request,
IntermediateResponseHandler intermediateResponseHandler,
LdapResultHandler<R> resultHandler)
Invoked when an extended request is received from a client.
|
void |
handleModify(C requestContext,
ModifyRequest request,
IntermediateResponseHandler intermediateResponseHandler,
LdapResultHandler<Result> resultHandler)
Invoked when a modify request is received from a client.
|
void |
handleModifyDN(C requestContext,
ModifyDNRequest request,
IntermediateResponseHandler intermediateResponseHandler,
LdapResultHandler<Result> resultHandler)
Invoked when a modify DN request is received from a client.
|
void |
handleSearch(C requestContext,
SearchRequest request,
IntermediateResponseHandler intermediateResponseHandler,
SearchResultHandler entryHandler,
LdapResultHandler<Result> resultHandler)
Invoked when a search request is received from a client.
|
void handleAdd(C requestContext, AddRequest request, IntermediateResponseHandler intermediateResponseHandler, LdapResultHandler<Result> resultHandler)
requestContext
- The request context.request
- The add request.intermediateResponseHandler
- The handler which should be used to send back any intermediate
responses to the client.resultHandler
- The handler which should be used to send back the result to
the client.UnsupportedOperationException
- If this request handler does not handle add requests.void handleBind(C requestContext, int version, BindRequest request, IntermediateResponseHandler intermediateResponseHandler, LdapResultHandler<BindResult> resultHandler)
requestContext
- The request context.version
- The protocol version included with the bind request.request
- The bind request.intermediateResponseHandler
- The handler which should be used to send back any intermediate
responses to the client.resultHandler
- The handler which should be used to send back the result to
the client.UnsupportedOperationException
- If this request handler does not handle bind requests.void handleCompare(C requestContext, CompareRequest request, IntermediateResponseHandler intermediateResponseHandler, LdapResultHandler<CompareResult> resultHandler)
requestContext
- The request context.request
- The compare request.intermediateResponseHandler
- The handler which should be used to send back any intermediate
responses to the client.resultHandler
- The handler which should be used to send back the result to
the client.UnsupportedOperationException
- If this request handler does not handle compare requests.void handleDelete(C requestContext, DeleteRequest request, IntermediateResponseHandler intermediateResponseHandler, LdapResultHandler<Result> resultHandler)
requestContext
- The request context.request
- The delete request.intermediateResponseHandler
- The handler which should be used to send back any intermediate
responses to the client.resultHandler
- The handler which should be used to send back the result to
the client.UnsupportedOperationException
- If this request handler does not handle delete requests.<R extends ExtendedResult> void handleExtendedRequest(C requestContext, ExtendedRequest<R> request, IntermediateResponseHandler intermediateResponseHandler, LdapResultHandler<R> resultHandler)
R
- The type of result returned by the extended request.requestContext
- The request context.request
- The extended request.intermediateResponseHandler
- The handler which should be used to send back any intermediate
responses to the client.resultHandler
- The handler which should be used to send back the result to
the client.UnsupportedOperationException
- If this request handler does not handle extended requests.void handleModify(C requestContext, ModifyRequest request, IntermediateResponseHandler intermediateResponseHandler, LdapResultHandler<Result> resultHandler)
requestContext
- The request context.request
- The modify request.intermediateResponseHandler
- The handler which should be used to send back any intermediate
responses to the client.resultHandler
- The handler which should be used to send back the result to
the client.UnsupportedOperationException
- If this request handler does not handle modify requests.void handleModifyDN(C requestContext, ModifyDNRequest request, IntermediateResponseHandler intermediateResponseHandler, LdapResultHandler<Result> resultHandler)
requestContext
- The request context.request
- The modify DN request.intermediateResponseHandler
- The handler which should be used to send back any intermediate
responses to the client.resultHandler
- The handler which should be used to send back the result to
the client.UnsupportedOperationException
- If this request handler does not handle modify DN requests.void handleSearch(C requestContext, SearchRequest request, IntermediateResponseHandler intermediateResponseHandler, SearchResultHandler entryHandler, LdapResultHandler<Result> resultHandler)
requestContext
- The request context.request
- The search request.intermediateResponseHandler
- The handler which should be used to send back any intermediate
responses to the client.entryHandler
- The entry handler which should be used to send back the search
entries results to the client.resultHandler
- The handler which should be used to send back the result to
the client.UnsupportedOperationException
- If this request handler does not handle search requests.Copyright 2010-2017 ForgeRock AS.