Class StartTLSRequestHandler

    • Constructor Detail

      • StartTLSRequestHandler

        public StartTLSRequestHandler​(javax.net.ssl.SSLSocketFactory sslSocketFactory,
                                      LDAPListenerRequestHandler requestHandler)
        Creates a new StartTLS request handler with the provided information.
        Parameters:
        sslSocketFactory - The SSL socket factory that will be used to convert the existing socket to use SSL encryption.
        requestHandler - The request handler that will be used to process all operations except StartTLS extended operations.
    • Method Detail

      • 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,
                                          AbandonRequestProtocolOp request,
                                          java.util.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

        public LDAPMessage processAddRequest​(int messageID,
                                             AddRequestProtocolOp request,
                                             java.util.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

        public LDAPMessage processBindRequest​(int messageID,
                                              BindRequestProtocolOp request,
                                              java.util.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

        public LDAPMessage processCompareRequest​(int messageID,
                                                 CompareRequestProtocolOp request,
                                                 java.util.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

        public LDAPMessage processDeleteRequest​(int messageID,
                                                DeleteRequestProtocolOp request,
                                                java.util.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

        public LDAPMessage processExtendedRequest​(int messageID,
                                                  ExtendedRequestProtocolOp request,
                                                  java.util.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

        public LDAPMessage processModifyRequest​(int messageID,
                                                ModifyRequestProtocolOp request,
                                                java.util.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

        public LDAPMessage processModifyDNRequest​(int messageID,
                                                  ModifyDNRequestProtocolOp request,
                                                  java.util.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

        public LDAPMessage processSearchRequest​(int messageID,
                                                SearchRequestProtocolOp request,
                                                java.util.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,
                                         UnbindRequestProtocolOp request,
                                         java.util.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.