Class SASLBindRequest

    • Field Detail

      • CRED_TYPE_SASL

        protected static final byte CRED_TYPE_SASL
        The BER type to use for the credentials element in a simple bind request protocol op.
        See Also:
        Constant Field Values
    • Constructor Detail

      • SASLBindRequest

        protected SASLBindRequest​(Control[] controls)
        Creates a new SASL bind request with the provided controls.
        Parameters:
        controls - The set of controls to include in this SASL bind request.
    • Method Detail

      • getBindType

        public java.lang.String getBindType()
        Retrieves a human-readable string that describes the type of bind request.
        Specified by:
        getBindType in class BindRequest
        Returns:
        A human-readable string that describes the type of bind request.
      • getSASLMechanismName

        public abstract java.lang.String getSASLMechanismName()
        Retrieves the name of the SASL mechanism used in this SASL bind request.
        Returns:
        The name of the SASL mechanism used in this SASL bind request.
      • getLastMessageID

        public int getLastMessageID()
        Retrieves the message ID for the last LDAP message sent using this request.
        Specified by:
        getLastMessageID in class LDAPRequest
        Returns:
        The message ID for the last LDAP message sent using this request, or -1 if it no LDAP messages have yet been sent using this request.
      • sendBindRequest

        protected final BindResult sendBindRequest​(LDAPConnection connection,
                                                   java.lang.String bindDN,
                                                   ASN1OctetString saslCredentials,
                                                   Control[] controls,
                                                   long timeoutMillis)
                                            throws LDAPException
        Sends an LDAP message to the directory server and waits for the response.
        Parameters:
        connection - The connection to the directory server.
        bindDN - The bind DN to use for the request. It should be null for most types of SASL bind requests.
        saslCredentials - The SASL credentials to use for the bind request. It may be null if no credentials are required.
        controls - The set of controls to include in the request. It may be null if no controls are required.
        timeoutMillis - The maximum length of time in milliseconds to wait for a response, or zero if it should wait forever.
        Returns:
        The bind response message returned by the directory server.
        Throws:
        LDAPException - If a problem occurs while sending the request or reading the response, or if a timeout occurred while waiting for the response.
      • sendMessage

        protected final BindResult sendMessage​(LDAPConnection connection,
                                               LDAPMessage requestMessage,
                                               long timeoutMillis)
                                        throws LDAPException
        Sends an LDAP message to the directory server and waits for the response.
        Parameters:
        connection - The connection to the directory server.
        requestMessage - The LDAP message to send to the directory server.
        timeoutMillis - The maximum length of time in milliseconds to wait for a response, or zero if it should wait forever.
        Returns:
        The response message received from the server.
        Throws:
        LDAPException - If a problem occurs while sending the request or reading the response, or if a timeout occurred while waiting for the response.
      • toCode

        public void toCode​(java.util.List<java.lang.String> lineList,
                           java.lang.String requestID,
                           int indentSpaces,
                           boolean includeProcessing)
        Appends a number of lines comprising the Java source code that can be used to recreate this request to the given list.
        Specified by:
        toCode in interface ReadOnlyLDAPRequest
        Parameters:
        lineList - The list to which the source code lines should be added.
        requestID - The name that should be used as an identifier for the request. If this is null or empty, then a generic ID will be used.
        indentSpaces - The number of spaces that should be used to indent the generated code. It must not be negative.
        includeProcessing - Indicates whether the generated code should include code required to actually process the request and handle the result (if true), or just to generate the request (if false).