Package com.unboundid.ldap.listener

Class ProxyRequestHandler

java.lang.Object

com.unboundid.ldap.listener.LDAPListenerRequestHandler

com.unboundid.ldap.listener.ProxyRequestHandler

All Implemented Interfaces:

IntermediateResponseListener, Serializable

@NotMutable
@ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class ProxyRequestHandler
extends LDAPListenerRequestHandler
implements IntermediateResponseListener

This class provides an implementation of a simple LDAP listener request handler that may be used to forward the request to another LDAP directory server.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ProxyRequestHandler(ServerSet serverSet)	Creates a new instance of this proxy request handler that will use the provided ServerSet to connect to an LDAP server.

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.
void	intermediateResponseReturned(IntermediateResponse intermediateResponse)	Indicates that the provided intermediate response has been returned by the server and may be processed by this intermediate response listener.
ProxyRequestHandler	newInstance(LDAPListenerClientConnection connection)	Creates a new instance of this request handler that will be used to process requests read by the provided connection.
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.

Methods inherited from class com.unboundid.ldap.listener.LDAPListenerRequestHandler

processAbandonRequest, processUnbindRequest

Methods inherited from class java.lang.Object

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

Constructor Details

ProxyRequestHandler

public ProxyRequestHandler(@NotNull
 ServerSet serverSet)

Creates a new instance of this proxy request handler that will use the provided ServerSet to connect to an LDAP server.

Parameters:

serverSet - The server that will be used to create LDAP connections to forward any requests received. It must not be null.

Method Details

newInstance

@NotNull
public ProxyRequestHandler 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

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.

intermediateResponseReturned

public void intermediateResponseReturned(@NotNull
 IntermediateResponse intermediateResponse)

Indicates that the provided intermediate response has been returned by the server and may be processed by this intermediate response listener.

Specified by:

intermediateResponseReturned in interface IntermediateResponseListener

Parameters:

intermediateResponse - The intermediate response that has been returned by the server.