public abstract class AbstractLDAPMessageHandler extends Object implements LDAPMessageHandler
LDAPMessageHandler
interface, in order to minimize the effort
required to implement this interface. By default each method throws a fatal
DecodeException
.Modifier | Constructor and Description |
---|---|
protected |
AbstractLDAPMessageHandler()
Default constructor.
|
Modifier and Type | Method and Description |
---|---|
void |
abandonRequest(int messageID,
AbandonRequest request)
Handles an LDAP abandon request message.
|
void |
addRequest(int messageID,
AddRequest request)
Handles an LDAP add request message.
|
void |
addResult(int messageID,
Result result)
Handles an LDAP add result message.
|
void |
bindRequest(int messageID,
int version,
GenericBindRequest request)
Handles an LDAP bind request message.
|
void |
bindResult(int messageID,
BindResult result)
Handles an LDAP bind result message.
|
void |
compareRequest(int messageID,
CompareRequest request)
Handles an LDAP compare request message.
|
void |
compareResult(int messageID,
CompareResult result)
Handles an LDAP compare result message.
|
void |
deleteRequest(int messageID,
DeleteRequest request)
Handles an LDAP delete request message.
|
void |
deleteResult(int messageID,
Result result)
Handles an LDAP delete result message.
|
<R extends ExtendedResult> |
extendedRequest(int messageID,
ExtendedRequest<R> request)
Handles an LDAP extended request message.
|
void |
extendedResult(int messageID,
ExtendedResult result)
Handles an LDAP extended result message.
|
void |
intermediateResponse(int messageID,
IntermediateResponse response)
Handles an LDAP intermediate response message.
|
void |
modifyDNRequest(int messageID,
ModifyDNRequest request)
Handles an LDAP modify DN request message.
|
void |
modifyDNResult(int messageID,
Result result)
Handles an LDAP modify DN result message.
|
void |
modifyRequest(int messageID,
ModifyRequest request)
Handles an LDAP modify request message.
|
void |
modifyResult(int messageID,
Result result)
Handles an LDAP modify result message.
|
protected DecodeException |
newUnexpectedRequestException(int messageID,
Request request)
Returns a decoding exception suitable for use when an unexpected LDAP
request is received.
|
protected DecodeException |
newUnexpectedResponseException(int messageID,
Response response)
Returns a decoding exception suitable for use when an unexpected LDAP
response is received.
|
protected DecodeException |
newUnsupportedMessageException(int messageID,
byte messageTag,
ByteString messageBytes)
Returns a decoding exception suitable for use when an unsupported LDAP
message is received.
|
void |
searchRequest(int messageID,
SearchRequest request)
Handles an LDAP search request message.
|
void |
searchResult(int messageID,
Result result)
Handles an LDAP search result message.
|
void |
searchResultEntry(int messageID,
SearchResultEntry entry)
Handles an LDAP search result entry message.
|
void |
searchResultReference(int messageID,
SearchResultReference reference)
Handles an LDAP search result reference message.
|
void |
unbindRequest(int messageID,
UnbindRequest request)
Handles an LDAP unbind request message.
|
void |
unrecognizedMessage(int messageID,
byte messageTag,
ByteString messageBytes)
Handles an unrecognized LDAP message.
|
protected AbstractLDAPMessageHandler()
public void abandonRequest(int messageID, AbandonRequest request) throws DecodeException, IOException
LDAPMessageHandler
abandonRequest
in interface LDAPMessageHandler
messageID
- The LDAP message ID.request
- The decoded abandon request.DecodeException
- If this handler does not support abandon requests.IOException
- If an unexpected IO error occurred while processing the
request.public void addRequest(int messageID, AddRequest request) throws DecodeException, IOException
LDAPMessageHandler
addRequest
in interface LDAPMessageHandler
messageID
- The LDAP message ID.request
- The decoded add request.DecodeException
- If this handler does not support add requests.IOException
- If an unexpected IO error occurred while processing the
request.public void addResult(int messageID, Result result) throws DecodeException, IOException
LDAPMessageHandler
addResult
in interface LDAPMessageHandler
messageID
- The LDAP message ID.result
- The decoded add result.DecodeException
- If this handler does not support add results.IOException
- If an unexpected IO error occurred while processing the
response.public void bindRequest(int messageID, int version, GenericBindRequest request) throws DecodeException, IOException
LDAPMessageHandler
bindRequest
in interface LDAPMessageHandler
messageID
- The LDAP message ID.version
- The requested LDAP protocol version.request
- The decoded bind request.DecodeException
- If this handler does not support bind requests.IOException
- If an unexpected IO error occurred while processing the
request.public void bindResult(int messageID, BindResult result) throws DecodeException, IOException
LDAPMessageHandler
bindResult
in interface LDAPMessageHandler
messageID
- The LDAP message ID.result
- The decoded bind result.DecodeException
- If this handler does not support bind results.IOException
- If an unexpected IO error occurred while processing the
response.public void compareRequest(int messageID, CompareRequest request) throws DecodeException, IOException
LDAPMessageHandler
compareRequest
in interface LDAPMessageHandler
messageID
- The LDAP message ID.request
- The decoded compare request.DecodeException
- If this handler does not support compare requests.IOException
- If an unexpected IO error occurred while processing the
request.public void compareResult(int messageID, CompareResult result) throws DecodeException, IOException
LDAPMessageHandler
compareResult
in interface LDAPMessageHandler
messageID
- The LDAP message ID.result
- The decoded compare result.DecodeException
- If this handler does not support compare results.IOException
- If an unexpected IO error occurred while processing the
response.public void deleteRequest(int messageID, DeleteRequest request) throws DecodeException, IOException
LDAPMessageHandler
deleteRequest
in interface LDAPMessageHandler
messageID
- The LDAP message ID.request
- The decoded delete request.DecodeException
- If this handler does not support delete requests.IOException
- If an unexpected IO error occurred while processing the
request.public void deleteResult(int messageID, Result result) throws DecodeException, IOException
LDAPMessageHandler
deleteResult
in interface LDAPMessageHandler
messageID
- The LDAP message ID.result
- The decoded delete result.DecodeException
- If this handler does not support delete results.IOException
- If an unexpected IO error occurred while processing the
response.public <R extends ExtendedResult> void extendedRequest(int messageID, ExtendedRequest<R> request) throws DecodeException, IOException
LDAPMessageHandler
extendedRequest
in interface LDAPMessageHandler
R
- type of extended resultmessageID
- The LDAP message ID.request
- The decoded extended request.DecodeException
- If this handler does not support extended requests.IOException
- If an unexpected IO error occurred while processing the
request.public void extendedResult(int messageID, ExtendedResult result) throws DecodeException, IOException
LDAPMessageHandler
extendedResult
in interface LDAPMessageHandler
messageID
- The LDAP message ID.result
- The decoded extended result.DecodeException
- If this handler does not support extended results.IOException
- If an unexpected IO error occurred while processing the
response.public void intermediateResponse(int messageID, IntermediateResponse response) throws DecodeException, IOException
LDAPMessageHandler
intermediateResponse
in interface LDAPMessageHandler
messageID
- The LDAP message ID.response
- The decoded intermediate response.DecodeException
- If this handler does not support intermediate responses.IOException
- If an unexpected IO error occurred while processing the
response.public void modifyDNRequest(int messageID, ModifyDNRequest request) throws DecodeException, IOException
LDAPMessageHandler
modifyDNRequest
in interface LDAPMessageHandler
messageID
- The LDAP message ID.request
- The decoded modify DN request.DecodeException
- If this handler does not support modify DN requests.IOException
- If an unexpected IO error occurred while processing the
request.public void modifyDNResult(int messageID, Result result) throws DecodeException, IOException
LDAPMessageHandler
modifyDNResult
in interface LDAPMessageHandler
messageID
- The LDAP message ID.result
- The decoded modify DN result.DecodeException
- If this handler does not support modify DN results.IOException
- If an unexpected IO error occurred while processing the
response.public void modifyRequest(int messageID, ModifyRequest request) throws DecodeException, IOException
LDAPMessageHandler
modifyRequest
in interface LDAPMessageHandler
messageID
- The LDAP message ID.request
- The decoded modify request.DecodeException
- If this handler does not support modify requests.IOException
- If an unexpected IO error occurred while processing the
request.public void modifyResult(int messageID, Result result) throws DecodeException, IOException
LDAPMessageHandler
modifyResult
in interface LDAPMessageHandler
messageID
- The LDAP message ID.result
- The decoded modify result.DecodeException
- If this handler does not support modify results.IOException
- If an unexpected IO error occurred while processing the
response.public void searchRequest(int messageID, SearchRequest request) throws DecodeException, IOException
LDAPMessageHandler
searchRequest
in interface LDAPMessageHandler
messageID
- The LDAP message ID.request
- The decoded search request.DecodeException
- If this handler does not support search requests.IOException
- If an unexpected IO error occurred while processing the
request.public void searchResult(int messageID, Result result) throws DecodeException, IOException
LDAPMessageHandler
searchResult
in interface LDAPMessageHandler
messageID
- The LDAP message ID.result
- The decoded search result.DecodeException
- If this handler does not support search results.IOException
- If an unexpected IO error occurred while processing the
response.public void searchResultEntry(int messageID, SearchResultEntry entry) throws DecodeException, IOException
LDAPMessageHandler
searchResultEntry
in interface LDAPMessageHandler
messageID
- The LDAP message ID.entry
- The decoded search result entry.DecodeException
- If this handler does not support search result entries.IOException
- If an unexpected IO error occurred while processing the
response.public void searchResultReference(int messageID, SearchResultReference reference) throws DecodeException, IOException
LDAPMessageHandler
searchResultReference
in interface LDAPMessageHandler
messageID
- The LDAP message ID.reference
- The decoded search result reference.DecodeException
- If this handler does not support search result references.IOException
- If an unexpected IO error occurred while processing the
response.public void unbindRequest(int messageID, UnbindRequest request) throws DecodeException, IOException
LDAPMessageHandler
unbindRequest
in interface LDAPMessageHandler
messageID
- The LDAP message ID.request
- The decoded unbind request.DecodeException
- If this handler does not support unbind requests.IOException
- If an unexpected IO error occurred while processing the
request.public void unrecognizedMessage(int messageID, byte messageTag, ByteString messageBytes) throws DecodeException, IOException
LDAPMessageHandler
unrecognizedMessage
in interface LDAPMessageHandler
messageID
- The LDAP message ID.messageTag
- The LDAP message type.messageBytes
- The contents of the LDAP message.DecodeException
- If this handler does not support the message type.IOException
- If an unexpected IO error occurred while processing the
message.protected DecodeException newUnsupportedMessageException(int messageID, byte messageTag, ByteString messageBytes)
messageID
- The LDAP message ID.messageTag
- The LDAP message type.messageBytes
- The LDAP message content.protected DecodeException newUnexpectedRequestException(int messageID, Request request)
messageID
- The LDAP message ID.request
- The LDAP request.protected DecodeException newUnexpectedResponseException(int messageID, Response response)
messageID
- The LDAP message ID.response
- The LDAP response.Copyright 2010-2017 ForgeRock AS.