Package org.ldaptive

Interface Connection

    • Method Detail

      • operation

        OperationHandle<BindRequest,​BindResponse> operation​(BindRequest request)
        Creates a handle for a bind operation. Since clients must not send requests while a bind is in progress, some methods may not be supported on the operation handle.
        Parameters:
        request - bind request
        Returns:
        operation handle
      • operation

        CompareOperationHandle operation​(CompareRequest request)
        Creates a handle for a compare operation.
        Parameters:
        request - compare request
        Returns:
        compare operation handle
      • operation

        ExtendedOperationHandle operation​(ExtendedRequest request)
        Creates a handle for an extended operation.
        Parameters:
        request - extended request
        Returns:
        extended operation handle
      • operation

        SearchOperationHandle operation​(SearchRequest request)
        Creates a handle for a search operation.
        Parameters:
        request - search request
        Returns:
        search operation handle
      • operation

        BindResponse operation​(SaslClientRequest request)
                        throws LdapException
        Returns the result of a SASL request that requires use of a generic SASL client.
        Parameters:
        request - SASL client request
        Returns:
        operation result
        Throws:
        LdapException - if the operation fails or another bind is in progress
      • operation

        BindResponse operation​(DefaultSaslClientRequest request)
                        throws LdapException
        Returns the result of a SASL request that requires use of the default SASL client. This includes CRAM-MD5, DIGEST-MD5, and GSS-API.
        Parameters:
        request - default SASL client request
        Returns:
        operation result
        Throws:
        LdapException - if the operation fails or another bind is in progress
      • getLdapURL

        LdapURL getLdapURL()
        Returns the URL that was selected for this connection. The existence of this value does not indicate a current established connection.
        Returns:
        LDAP URL
      • isOpen

        boolean isOpen()
        Returns whether this connection is open.
        Returns:
        whether this connection is open
      • close

        void close​(RequestControl... controls)
        Closes the connection.
        Parameters:
        controls - to send when closing the connection