Package org.forgerock.opendj.io

Class AbstractLDAPMessageHandler

java.lang.Object

org.forgerock.opendj.io.AbstractLDAPMessageHandler

All Implemented Interfaces:

LDAPMessageHandler

public abstract class AbstractLDAPMessageHandler
extends Object
implements LDAPMessageHandler

This class provides a skeletal implementation of the LDAPMessageHandler interface, in order to minimize the effort required to implement this interface. By default each method throws a fatal DecodeException.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractLDAPMessageHandler()	Default constructor.

Method Summary

Modifier and Type	Method	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> void	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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

AbstractLDAPMessageHandler

protected AbstractLDAPMessageHandler()

Default constructor.

Method Details

abandonRequest

public void abandonRequest(int messageID,
 AbandonRequest request)
                    throws DecodeException,
IOException

Description copied from interface: LDAPMessageHandler

Handles an LDAP abandon request message.

Specified by:

abandonRequest in interface LDAPMessageHandler

Parameters:

messageID - The LDAP message ID.

request - The decoded abandon request.

Throws:

DecodeException - If this handler does not support abandon requests.

IOException - If an unexpected IO error occurred while processing the request.

addRequest

public void addRequest(int messageID,
 AddRequest request)
                throws DecodeException,
IOException

Description copied from interface: LDAPMessageHandler

Handles an LDAP add request message.

Specified by:

addRequest in interface LDAPMessageHandler

Parameters:

messageID - The LDAP message ID.

request - The decoded add request.

Throws:

DecodeException - If this handler does not support add requests.

IOException - If an unexpected IO error occurred while processing the request.

addResult

public void addResult(int messageID,
 Result result)
               throws DecodeException,
IOException

Description copied from interface: LDAPMessageHandler

Handles an LDAP add result message.

Specified by:

addResult in interface LDAPMessageHandler

Parameters:

messageID - The LDAP message ID.

result - The decoded add result.

Throws:

DecodeException - If this handler does not support add results.

IOException - If an unexpected IO error occurred while processing the response.

bindRequest

public void bindRequest(int messageID,
 int version,
 GenericBindRequest request)
                 throws DecodeException,
IOException

Description copied from interface: LDAPMessageHandler

Handles an LDAP bind request message.

Specified by:

bindRequest in interface LDAPMessageHandler

Parameters:

messageID - The LDAP message ID.

version - The requested LDAP protocol version.

request - The decoded bind request.

Throws:

DecodeException - If this handler does not support bind requests.

IOException - If an unexpected IO error occurred while processing the request.

bindResult

public void bindResult(int messageID,
 BindResult result)
                throws DecodeException,
IOException

Description copied from interface: LDAPMessageHandler

Handles an LDAP bind result message.

Specified by:

bindResult in interface LDAPMessageHandler

Parameters:

messageID - The LDAP message ID.

result - The decoded bind result.

Throws:

DecodeException - If this handler does not support bind results.

IOException - If an unexpected IO error occurred while processing the response.

compareRequest

public void compareRequest(int messageID,
 CompareRequest request)
                    throws DecodeException,
IOException

Description copied from interface: LDAPMessageHandler

Handles an LDAP compare request message.

Specified by:

compareRequest in interface LDAPMessageHandler

Parameters:

messageID - The LDAP message ID.

request - The decoded compare request.

Throws:

DecodeException - If this handler does not support compare requests.

IOException - If an unexpected IO error occurred while processing the request.

compareResult

public void compareResult(int messageID,
 CompareResult result)
                   throws DecodeException,
IOException

Description copied from interface: LDAPMessageHandler

Handles an LDAP compare result message.

Specified by:

compareResult in interface LDAPMessageHandler

Parameters:

messageID - The LDAP message ID.

result - The decoded compare result.

Throws:

DecodeException - If this handler does not support compare results.

IOException - If an unexpected IO error occurred while processing the response.

deleteRequest

public void deleteRequest(int messageID,
 DeleteRequest request)
                   throws DecodeException,
IOException

Description copied from interface: LDAPMessageHandler

Handles an LDAP delete request message.

Specified by:

deleteRequest in interface LDAPMessageHandler

Parameters:

messageID - The LDAP message ID.

request - The decoded delete request.

Throws:

DecodeException - If this handler does not support delete requests.

IOException - If an unexpected IO error occurred while processing the request.

deleteResult

public void deleteResult(int messageID,
 Result result)
                  throws DecodeException,
IOException

Description copied from interface: LDAPMessageHandler

Handles an LDAP delete result message.

Specified by:

deleteResult in interface LDAPMessageHandler

Parameters:

messageID - The LDAP message ID.

result - The decoded delete result.

Throws:

DecodeException - If this handler does not support delete results.

IOException - If an unexpected IO error occurred while processing the response.

extendedRequest

public <R extends ExtendedResult> void extendedRequest(int messageID,
 ExtendedRequest<R> request)
                                                throws DecodeException,
IOException

Description copied from interface: LDAPMessageHandler

Handles an LDAP extended request message.

Specified by:

extendedRequest in interface LDAPMessageHandler

Type Parameters:

R - type of extended result

Parameters:

messageID - The LDAP message ID.

request - The decoded extended request.

Throws:

DecodeException - If this handler does not support extended requests.

IOException - If an unexpected IO error occurred while processing the request.

extendedResult

public void extendedResult(int messageID,
 ExtendedResult result)
                    throws DecodeException,
IOException

Description copied from interface: LDAPMessageHandler

Handles an LDAP extended result message.

Specified by:

extendedResult in interface LDAPMessageHandler

Parameters:

messageID - The LDAP message ID.

result - The decoded extended result.

Throws:

DecodeException - If this handler does not support extended results.

IOException - If an unexpected IO error occurred while processing the response.

intermediateResponse

public void intermediateResponse(int messageID,
 IntermediateResponse response)
                          throws DecodeException,
IOException

Description copied from interface: LDAPMessageHandler

Handles an LDAP intermediate response message.

Specified by:

intermediateResponse in interface LDAPMessageHandler

Parameters:

messageID - The LDAP message ID.

response - The decoded intermediate response.

Throws:

DecodeException - If this handler does not support intermediate responses.

IOException - If an unexpected IO error occurred while processing the response.

modifyDNRequest

public void modifyDNRequest(int messageID,
 ModifyDNRequest request)
                     throws DecodeException,
IOException

Description copied from interface: LDAPMessageHandler

Handles an LDAP modify DN request message.

Specified by:

modifyDNRequest in interface LDAPMessageHandler

Parameters:

messageID - The LDAP message ID.

request - The decoded modify DN request.

Throws:

DecodeException - If this handler does not support modify DN requests.

IOException - If an unexpected IO error occurred while processing the request.

modifyDNResult

public void modifyDNResult(int messageID,
 Result result)
                    throws DecodeException,
IOException

Description copied from interface: LDAPMessageHandler

Handles an LDAP modify DN result message.

Specified by:

modifyDNResult in interface LDAPMessageHandler

Parameters:

messageID - The LDAP message ID.

result - The decoded modify DN result.

Throws:

DecodeException - If this handler does not support modify DN results.

IOException - If an unexpected IO error occurred while processing the response.

modifyRequest

public void modifyRequest(int messageID,
 ModifyRequest request)
                   throws DecodeException,
IOException

Description copied from interface: LDAPMessageHandler

Handles an LDAP modify request message.

Specified by:

modifyRequest in interface LDAPMessageHandler

Parameters:

messageID - The LDAP message ID.

request - The decoded modify request.

Throws:

DecodeException - If this handler does not support modify requests.

IOException - If an unexpected IO error occurred while processing the request.

modifyResult

public void modifyResult(int messageID,
 Result result)
                  throws DecodeException,
IOException

Description copied from interface: LDAPMessageHandler

Handles an LDAP modify result message.

Specified by:

modifyResult in interface LDAPMessageHandler

Parameters:

messageID - The LDAP message ID.

result - The decoded modify result.

Throws:

DecodeException - If this handler does not support modify results.

IOException - If an unexpected IO error occurred while processing the response.

searchRequest

public void searchRequest(int messageID,
 SearchRequest request)
                   throws DecodeException,
IOException

Description copied from interface: LDAPMessageHandler

Handles an LDAP search request message.

Specified by:

searchRequest in interface LDAPMessageHandler

Parameters:

messageID - The LDAP message ID.

request - The decoded search request.

Throws:

DecodeException - If this handler does not support search requests.

IOException - If an unexpected IO error occurred while processing the request.

searchResult

public void searchResult(int messageID,
 Result result)
                  throws DecodeException,
IOException

Description copied from interface: LDAPMessageHandler

Handles an LDAP search result message.

Specified by:

searchResult in interface LDAPMessageHandler

Parameters:

messageID - The LDAP message ID.

result - The decoded search result.

Throws:

DecodeException - If this handler does not support search results.

IOException - If an unexpected IO error occurred while processing the response.

searchResultEntry

public void searchResultEntry(int messageID,
 SearchResultEntry entry)
                       throws DecodeException,
IOException

Description copied from interface: LDAPMessageHandler

Handles an LDAP search result entry message.

Specified by:

searchResultEntry in interface LDAPMessageHandler

Parameters:

messageID - The LDAP message ID.

entry - The decoded search result entry.

Throws:

DecodeException - If this handler does not support search result entries.

IOException - If an unexpected IO error occurred while processing the response.

searchResultReference

public void searchResultReference(int messageID,
 SearchResultReference reference)
                           throws DecodeException,
IOException

Description copied from interface: LDAPMessageHandler

Handles an LDAP search result reference message.

Specified by:

searchResultReference in interface LDAPMessageHandler

Parameters:

messageID - The LDAP message ID.

reference - The decoded search result reference.

Throws:

DecodeException - If this handler does not support search result references.

IOException - If an unexpected IO error occurred while processing the response.

unbindRequest

public void unbindRequest(int messageID,
 UnbindRequest request)
                   throws DecodeException,
IOException

Description copied from interface: LDAPMessageHandler

Handles an LDAP unbind request message.

Specified by:

unbindRequest in interface LDAPMessageHandler

Parameters:

messageID - The LDAP message ID.

request - The decoded unbind request.

Throws:

DecodeException - If this handler does not support unbind requests.

IOException - If an unexpected IO error occurred while processing the request.

unrecognizedMessage

public void unrecognizedMessage(int messageID,
 byte messageTag,
 ByteString messageBytes)
                         throws DecodeException,
IOException

Description copied from interface: LDAPMessageHandler

Handles an unrecognized LDAP message.

Specified by:

unrecognizedMessage in interface LDAPMessageHandler

Parameters:

messageID - The LDAP message ID.

messageTag - The LDAP message type.

messageBytes - The contents of the LDAP message.

Throws:

DecodeException - If this handler does not support the message type.

IOException - If an unexpected IO error occurred while processing the message.

newUnsupportedMessageException

protected DecodeException newUnsupportedMessageException(int messageID,
 byte messageTag,
 ByteString messageBytes)

Returns a decoding exception suitable for use when an unsupported LDAP message is received.

Parameters:

messageID - The LDAP message ID.

messageTag - The LDAP message type.

messageBytes - The LDAP message content.

Returns:

A decoding exception suitable for use when an unsupported LDAP message is received.

newUnexpectedRequestException

protected DecodeException newUnexpectedRequestException(int messageID,
 Request request)

Returns a decoding exception suitable for use when an unexpected LDAP request is received.

Parameters:

messageID - The LDAP message ID.

request - The LDAP request.

Returns:

A decoding exception suitable for use when an unexpected LDAP request is received.

newUnexpectedResponseException

protected DecodeException newUnexpectedResponseException(int messageID,
 Response response)

Returns a decoding exception suitable for use when an unexpected LDAP response is received.

Parameters:

messageID - The LDAP message ID.

response - The LDAP response.

Returns:

A decoding exception suitable for use when an unexpected LDAP response is received.