Package netscape.ldap

Interface LDAPv3

  • All Superinterfaces:
    LDAPv2
    All Known Implementing Classes:
    LDAPConnection

    public interface LDAPv3
    extends LDAPv2
    Specifies additional features available in version 3 of the LDAP protocol.
    Version:
    1.0
    • Method Detail

      • connect

        void connect​(int version,
                     java.lang.String host,
                     int port,
                     java.lang.String dn,
                     java.lang.String passwd)
              throws LDAPException
        Connects and authenticates to the LDAP server using the specified version of the LDAP protocol.
        Parameters:
        version - requested version of the LDAP protocol: currently 2 or 3
        host - hostname of the LDAP server
        port - port number of the LDAP server. To specify the default port, use DEFAULT_PORT.
        dn - distinguished name to use for authentication
        passwd - password for authentication
        Throws:
        LDAPException - Failed to connect and authenticate to the server.
      • authenticate

        void authenticate​(int version,
                          java.lang.String dn,
                          java.lang.String passwd)
                   throws LDAPException
        Authenticates to the LDAP server (to which the object is currently connected) using the specified name, password, and version of the LDAP protocol. If the server does not support the requested protocol version, an exception is thrown. If the object has been disconnected from an LDAP server, this method attempts to reconnect to the server. If the object had already authenticated, the old authentication is discarded.
        Parameters:
        version - requested LDAP protocol version: currently 2 or 3.
        dn - if non-null and non-empty, specifies that the connection and all operations through it should authenticate with dn as the distinguished name
        passwd - if non-null and non-empty, specifies that the connection and all operations through it should authenticated with passwd as password
        Throws:
        LDAPException - Failed to authenticate to the LDAP server.
      • bind

        void bind​(int version,
                  java.lang.String dn,
                  java.lang.String passwd)
           throws LDAPException
        Authenticates to the LDAP server (to which the object is currently connected) using the specified name, password, and version of the LDAP protocol. If the server does not support the requested version of the protocol, an exception is thrown. If the object has been disconnected from an LDAP server, this method attempts to reconnect to the server. If the object had already authenticated, the old authentication is discarded.
        Parameters:
        version - requested LDAP protocol version: currently 2 or 3.
        dn - if non-null and non-empty, specifies that the connection and all operations through it should authenticate with dn as the distinguished name
        passwd - if non-null and non-empty, specifies that the connection and all operations through it should authenticate with passwd as password
        Throws:
        LDAPException - Failed to authenticate to the LDAP server.
      • extendedOperation

        LDAPExtendedOperation extendedOperation​(LDAPExtendedOperation op)
                                         throws LDAPException
        Performs an extended operation on the directory. Extended operations are part of version 3 of the LDAP protocol.

        Parameters:
        op - LDAPExtendedOperation object specifying the OID of the extended operation and the data to use in the operation
        Returns:
        LDAPExtendedOperation object representing the extended response returned by the server.
        Throws:
        LDAPException - Failed to execute the operation
        See Also:
        LDAPExtendedOperation
      • rename

        void rename​(java.lang.String DN,
                    java.lang.String newRDN,
                    java.lang.String newParentDN,
                    boolean deleteOldRDN)
             throws LDAPException
        Renames and moves an entry in the directory.
        Parameters:
        DN - original distinguished name (DN) for the entry
        newRDN - new relative distinguished name (RDN) for the entry
        newParentDN - distinguished name of the new parent entry of the specified entry
        deleteOldRDN - specifies whether or not to remove the old RDN when renaming and moving the entry. If true, the old RDN will be deleted.
        Throws:
        LDAPException - Failed to rename the specified entry.
      • rename

        void rename​(java.lang.String DN,
                    java.lang.String newRDN,
                    java.lang.String newParentDN,
                    boolean deleteOldRDN,
                    LDAPConstraints cons)
             throws LDAPException
        Renames and moves an entry in the directory.
        Parameters:
        DN - original distinguished name (DN) for the entry
        newRDN - new relative distinguished name (RDN) for the entry
        newParentDN - distinguished name of the new parent entry of the specified entry
        deleteOldRDN - specifies whether or not to remove the old RDN when renaming and moving the entry. If true, the old RDN will be deleted.
        cons - the constraints set for the rename operation
        Throws:
        LDAPException - Failed to rename the specified entry.
      • getResponseControls

        LDAPControl[] getResponseControls()
        Returns an array of the latest controls (if any) from the server.
        Returns:
        an array of the controls returned by an operation, or null if none.
        See Also:
        LDAPControl