Interface LDAPBindRequest

  • All Superinterfaces:
    Cloneable, LDAPRequest

    public interface LDAPBindRequest
    extends LDAPRequest
    Represents an LDAP bind request, which can be used to perform an LDAPv3 simple bind operation to authenticate using a bind DN and password.

    Note that LDAPBindRequest objects should not be considered thread-safe, thus should not be used concurrently by multiple threads. Each thread wishing to process a request should have its own instance of that request.

    See Also:
    LDAPProvider
    • Method Detail

      • clone

        LDAPBindRequest clone()
        Creates and returns a copy of this bind request that may be modified without impacting this request.
        Specified by:
        clone in interface LDAPRequest
        Returns:
        A copy of this bind request that may be modified without impacting this request.
      • getBindDN

        String getBindDN()
        Returns the distinguished name for this bind request.
        Returns:
        the distinguished name for this bind request.
      • getPassword

        String getPassword()
        Returns the password for this bind request.
        Returns:
        the password for this bind request.
      • setQueryTimeout

        LDAPBindRequest setQueryTimeout​(long timeout)
        Sets the maximum time, in milliseconds, to wait for a response from the server when processing this bind request.

        A value of zero indicates that no timeout should be enforced.

        A value that is less than zero indicates that the default query timeout for the underlying connection should be used.

        Specified by:
        setQueryTimeout in interface LDAPRequest
        Parameters:
        timeout - the maximum time, in milliseconds, to wait for a response from the server when processing this bind request.
        Returns:
        this bind request.