Package com.unboundid.ldap.listener

Class CannedResponseRequestHandler

java.lang.Object
com.unboundid.ldap.listener.LDAPListenerRequestHandler
com.unboundid.ldap.listener.CannedResponseRequestHandler
All Implemented Interfaces:
Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class CannedResponseRequestHandler extends LDAPListenerRequestHandler implements Serializable
This class provides a very simple LDAP listener request handler implementation that simply returns a canned response to the client for each type of operation.
See Also:

  • Constructor Details

    • CannedResponseRequestHandler

      public CannedResponseRequestHandler()
      Creates a new instance of this canned response request handler that will immediately return a "SUCCESS" response to any request that is received.

    • CannedResponseRequestHandler

      public CannedResponseRequestHandler(@NotNull ResultCode resultCode, @Nullable String matchedDN, @Nullable String diagnosticMessage, @Nullable List<String> referralURLs)
      Creates a new instance of this canned response request handler that will immediately return a response with the provided information to any request that is received.
      Parameters:
      resultCode - The result code to use for the responses. It must not be null.
      matchedDN - The matched DN to use for the responses. It may be null if no matched DN should be included.
      diagnosticMessage - The diagnostic message to use for the responses. It may be null if no diagnostic message should be included.
      referralURLs - The referral URLs to use for the responses. It may be empty or null if no referral URLs should be included.

    • CannedResponseRequestHandler

      public CannedResponseRequestHandler(@NotNull ResultCode resultCode, @Nullable String matchedDN, @Nullable String diagnosticMessage, @Nullable List<String> referralURLs, @Nullable Collection<? extends Entry> searchEntries, @Nullable Collection<SearchResultReference> searchReferences)
      Creates a new instance of this canned response request handler that will immediately return a response with the provided information to any request that is received.
      Parameters:
      resultCode - The result code to use for the responses. It must not be null.
      matchedDN - The matched DN to use for the responses. It may be null if no matched DN should be included.
      diagnosticMessage - The diagnostic message to use for the responses. It may be null if no diagnostic message should be included.
      referralURLs - The referral URLs to use for the responses. It may be empty or null if no referral URLs should be included.
      searchEntries - The set of search result entries that should be returned for every search. It may be null or empty if no entries are required.
      searchReferences - The set of search result references that should be returned for every search. It may be null or empty if no references are required.

  • Method Details

    • newInstance

      @NotNull public CannedResponseRequestHandler 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.

    • 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.