Package com.unboundid.ldap.listener

Class LDAPDebuggerRequestHandler

java.lang.Object

com.unboundid.ldap.listener.LDAPListenerRequestHandler

com.unboundid.ldap.listener.LDAPDebuggerRequestHandler

All Implemented Interfaces:

IntermediateResponseTransformer, SearchEntryTransformer, SearchReferenceTransformer

@NotMutable
@ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class LDAPDebuggerRequestHandler
extends LDAPListenerRequestHandler
implements IntermediateResponseTransformer, SearchEntryTransformer, SearchReferenceTransformer

This class provides a request handler that may be used to write detailed information about the contents of all requests and responses that pass through it. It will be also be associated with another request handler that will actually be used to handle the request.

Constructor Summary

Constructors

Constructor	Description
LDAPDebuggerRequestHandler(Handler logHandler, LDAPListenerRequestHandler requestHandler)	Creates a new LDAP debugger request handler that will write detailed information about the contents of all requests and responses that pass through it using the provided log handler, and will process client requests using the provided request handler.

Method Summary

Modifier and Type	Method	Description
void	closeInstance()	Indicates that the client connection with which this request handler instance is associated is being closed and any resources associated with it should be released.
LDAPDebuggerRequestHandler	newInstance(LDAPListenerClientConnection connection)	Creates a new instance of this request handler that will be used to process requests read by the provided connection.
void	processAbandonRequest(int messageID, AbandonRequestProtocolOp request, List<Control> controls)	Performs any processing necessary for the provided abandon request.
LDAPMessage	processAddRequest(int messageID, AddRequestProtocolOp request, List<Control> controls)	Performs any processing necessary for the provided add request.
LDAPMessage	processBindRequest(int messageID, BindRequestProtocolOp request, List<Control> controls)	Performs any processing necessary for the provided bind request.
LDAPMessage	processCompareRequest(int messageID, CompareRequestProtocolOp request, List<Control> controls)	Performs any processing necessary for the provided compare request.
LDAPMessage	processDeleteRequest(int messageID, DeleteRequestProtocolOp request, List<Control> controls)	Performs any processing necessary for the provided delete request.
LDAPMessage	processExtendedRequest(int messageID, ExtendedRequestProtocolOp request, List<Control> controls)	Performs any processing necessary for the provided extended request.
LDAPMessage	processModifyDNRequest(int messageID, ModifyDNRequestProtocolOp request, List<Control> controls)	Performs any processing necessary for the provided modify DN request.
LDAPMessage	processModifyRequest(int messageID, ModifyRequestProtocolOp request, List<Control> controls)	Performs any processing necessary for the provided modify request.
LDAPMessage	processSearchRequest(int messageID, SearchRequestProtocolOp request, List<Control> controls)	Performs any processing necessary for the provided search request.
void	processUnbindRequest(int messageID, UnbindRequestProtocolOp request, List<Control> controls)	Performs any processing necessary for the provided unbind request.
ObjectPair<SearchResultEntryProtocolOp,Control[]>	transformEntry(int messageID, SearchResultEntryProtocolOp entry, Control[] controls)	Transforms the provided search result entry and/or set of controls to alter what will be returned to the client.
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.
ObjectPair<SearchResultReferenceProtocolOp,Control[]>	transformReference(int messageID, SearchResultReferenceProtocolOp reference, Control[] controls)	Transforms the provided search result reference and/or set of controls to alter what will be returned to the client.

Methods inherited from class java.lang.Object

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

Constructor Details

LDAPDebuggerRequestHandler

public LDAPDebuggerRequestHandler(@NotNull
 Handler logHandler,
 @NotNull
 LDAPListenerRequestHandler requestHandler)

Creates a new LDAP debugger request handler that will write detailed information about the contents of all requests and responses that pass through it using the provided log handler, and will process client requests using the provided request handler.

Parameters:

logHandler - The log handler that will be used to write detailed information about requests and responses. Note that all messages will be logged at the INFO level. It must not be null. Note that the log handler will not be automatically closed when the associated listener is shut down.

requestHandler - The request handler that will actually be used to process any requests received. It must not be null.

Method Details

newInstance

@NotNull
public LDAPDebuggerRequestHandler newInstance(@NotNull
 LDAPListenerClientConnection connection)
                                       throws LDAPException

Creates a new instance of this request handler that will be used to process requests read by the provided connection.

Specified by:

newInstance in class LDAPListenerRequestHandler

Parameters:

connection - The connection with which this request handler instance will be associated.

Returns:

The request handler instance that will be used for the provided connection.

Throws:

LDAPException - If the connection should not be accepted.

closeInstance

public void closeInstance()

Indicates that the client connection with which this request handler instance is associated is being closed and any resources associated with it should be released.

Overrides:

closeInstance in class LDAPListenerRequestHandler

processAbandonRequest

public void processAbandonRequest(int messageID,
 @NotNull
 AbandonRequestProtocolOp request,
 @NotNull
 List<Control> controls)

Performs any processing necessary for the provided abandon request.

Overrides:

processAbandonRequest in class LDAPListenerRequestHandler

Parameters:

messageID - The message ID of the LDAP message containing the abandon request.

request - The abandon request that was included in the LDAP message that was received.

controls - The set of controls included in the LDAP message. It may be empty if there were no controls, but will not be null.

processAddRequest

@NotNull
public LDAPMessage processAddRequest(int messageID,
 @NotNull
 AddRequestProtocolOp request,
 @NotNull
 List<Control> controls)

Performs any processing necessary for the provided add request.

Specified by:

processAddRequest in class LDAPListenerRequestHandler

Parameters:

messageID - The message ID of the LDAP message containing the add request.

request - The add request that was included in the LDAP message that was received.

controls - The set of controls included in the LDAP message. It may be empty if there were no controls, but will not be null.

Returns:

The LDAPMessage containing the response to send to the client. The protocol op in the LDAPMessage must be an AddResponseProtocolOp.

processBindRequest

@NotNull
public LDAPMessage processBindRequest(int messageID,
 @NotNull
 BindRequestProtocolOp request,
 @NotNull
 List<Control> controls)

Performs any processing necessary for the provided bind request.

Specified by:

processBindRequest in class LDAPListenerRequestHandler

Parameters:

messageID - The message ID of the LDAP message containing the bind request.

request - The bind request that was included in the LDAP message that was received.

controls - The set of controls included in the LDAP message. It may be empty if there were no controls, but will not be null.

Returns:

The LDAPMessage containing the response to send to the client. The protocol op in the LDAPMessage must be a BindResponseProtocolOp.

processCompareRequest

@NotNull
public LDAPMessage processCompareRequest(int messageID,
 @NotNull
 CompareRequestProtocolOp request,
 @NotNull
 List<Control> controls)

Performs any processing necessary for the provided compare request.

Specified by:

processCompareRequest in class LDAPListenerRequestHandler

Parameters:

messageID - The message ID of the LDAP message containing the compare request.

request - The compare request that was included in the LDAP message that was received.

controls - The set of controls included in the LDAP message. It may be empty if there were no controls, but will not be null.

Returns:

The LDAPMessage containing the response to send to the client. The protocol op in the LDAPMessage must be a CompareResponseProtocolOp.

processDeleteRequest

@NotNull
public LDAPMessage processDeleteRequest(int messageID,
 @NotNull
 DeleteRequestProtocolOp request,
 @NotNull
 List<Control> controls)

Performs any processing necessary for the provided delete request.

Specified by:

processDeleteRequest in class LDAPListenerRequestHandler

Parameters:

messageID - The message ID of the LDAP message containing the delete request.

request - The delete request that was included in the LDAP message that was received.

controls - The set of controls included in the LDAP message. It may be empty if there were no controls, but will not be null.

Returns:

The LDAPMessage containing the response to send to the client. The protocol op in the LDAPMessage must be a DeleteResponseProtocolOp.

processExtendedRequest

@NotNull
public LDAPMessage processExtendedRequest(int messageID,
 @NotNull
 ExtendedRequestProtocolOp request,
 @NotNull
 List<Control> controls)

Performs any processing necessary for the provided extended request.

Specified by:

processExtendedRequest in class LDAPListenerRequestHandler

Parameters:

messageID - The message ID of the LDAP message containing the extended request.

request - The extended request that was included in the LDAP message that was received.

controls - The set of controls included in the LDAP message. It may be empty if there were no controls, but will not be null.

Returns:

The LDAPMessage containing the response to send to the client. The protocol op in the LDAPMessage must be an ExtendedResponseProtocolOp.

processModifyRequest

@NotNull
public LDAPMessage processModifyRequest(int messageID,
 @NotNull
 ModifyRequestProtocolOp request,
 @NotNull
 List<Control> controls)

Performs any processing necessary for the provided modify request.

Specified by:

processModifyRequest in class LDAPListenerRequestHandler

Parameters:

messageID - The message ID of the LDAP message containing the modify request.

request - The modify request that was included in the LDAP message that was received.

controls - The set of controls included in the LDAP message. It may be empty if there were no controls, but will not be null.

Returns:

The LDAPMessage containing the response to send to the client. The protocol op in the LDAPMessage must be an ModifyResponseProtocolOp.

processModifyDNRequest

@NotNull
public LDAPMessage processModifyDNRequest(int messageID,
 @NotNull
 ModifyDNRequestProtocolOp request,
 @NotNull
 List<Control> controls)

Performs any processing necessary for the provided modify DN request.

Specified by:

processModifyDNRequest in class LDAPListenerRequestHandler

Parameters:

messageID - The message ID of the LDAP message containing the modify DN request.

request - The modify DN request that was included in the LDAP message that was received.

controls - The set of controls included in the LDAP message. It may be empty if there were no controls, but will not be null.

Returns:

The LDAPMessage containing the response to send to the client. The protocol op in the LDAPMessage must be an ModifyDNResponseProtocolOp.

processSearchRequest

@NotNull
public LDAPMessage processSearchRequest(int messageID,
 @NotNull
 SearchRequestProtocolOp request,
 @NotNull
 List<Control> controls)

Performs any processing necessary for the provided search request.

Specified by:

processSearchRequest in class LDAPListenerRequestHandler

Parameters:

messageID - The message ID of the LDAP message containing the search request.

request - The search request that was included in the LDAP message that was received.

controls - The set of controls included in the LDAP message. It may be empty if there were no controls, but will not be null.

Returns:

The LDAPMessage containing the response to send to the client. The protocol op in the LDAPMessage must be an SearchResultDoneProtocolOp.

processUnbindRequest

public void processUnbindRequest(int messageID,
 @NotNull
 UnbindRequestProtocolOp request,
 @NotNull
 List<Control> controls)

Performs any processing necessary for the provided unbind request.

Overrides:

processUnbindRequest in class LDAPListenerRequestHandler

Parameters:

messageID - The message ID of the LDAP message containing the search request.

request - The search request that was included in the LDAP message that was received.

controls - The set of controls included in the LDAP message. It may be empty if there were no controls, but will not be null.

transformIntermediateResponse

@NotNull
public ObjectPair<IntermediateResponseProtocolOp,Control[]> transformIntermediateResponse(int messageID,
 @NotNull
 IntermediateResponseProtocolOp response,
 @NotNull
 Control[] controls)

Transforms the provided intermediate response and/or set of controls to alter what will be returned to the client.

Specified by:

transformIntermediateResponse in interface IntermediateResponseTransformer

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.

transformEntry

@NotNull
public ObjectPair<SearchResultEntryProtocolOp,Control[]> transformEntry(int messageID,
 @NotNull
 SearchResultEntryProtocolOp entry,
 @NotNull
 Control[] controls)

Transforms the provided search result entry and/or set of controls to alter what will be returned to the client.

Specified by:

transformEntry in interface SearchEntryTransformer

Parameters:

messageID - The message ID for the associated search operation.

entry - The search result entry 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 entry and set of controls, or null to indicate that the entry should not be returned to the client.

transformReference

@NotNull
public ObjectPair<SearchResultReferenceProtocolOp,Control[]> transformReference(int messageID,
 @NotNull
 SearchResultReferenceProtocolOp reference,
 @NotNull
 Control[] controls)

Transforms the provided search result reference and/or set of controls to alter what will be returned to the client.

Specified by:

transformReference in interface SearchReferenceTransformer

Parameters:

messageID - The message ID for the associated search operation.

reference - The search result reference 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 reference and set of controls, or null to indicate that the reference should not be returned to the client.