Package netscape.ldap

Interface LDAPv2

All Known Subinterfaces:
LDAPv3
All Known Implementing Classes:
LDAPConnection

public interface LDAPv2
This interface summarizes the basic functionality available in the Lightweight Directory Access Protocol (LDAP) version 2. (See RFC 1777 for the definition of the protocol.)

In the general model for this protocol, objects exist under a directory in a particular server. Objects are identified by unique, hierarchical names called Distinguished Names, commonly abreviated "DN". An example of a DN:

  cn=Barbara Jensen,ou=Product Development,o=Ace Industry,c=us
 
Objects have attributes, of the form
  attributeName = attributeValue(s)
 
Attribute names must be Strings, and attribute values can be any 8-bit sequence (Strings or binary values).
Version:
1.0
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    Option specifying the number of results to return at a time.
    static final int
    Option specifying the object containing the method for authenticating to the server.
    static final int
    The default port number for LDAP servers.
    static final int
    Option specifying how aliases are dereferenced.
    static final int
    Specifies that aliases are always dereferenced.
    static final int
    Specifies that aliases are dereferenced when finding the starting point for the search (but not when searching under that starting entry).
    static final int
    Specifies that aliases are never dereferenced.
    static final int
    Specifies that aliases are dereferenced when searching the entries beneath the starting point of the search (but not when finding the starting entry).
    static final int
    Option specifying the version of the LDAP protocol used by your client when interacting with the LDAP server.
    static final int
    Option specifying whether or not referrals to other LDAP servers are followed automatically.
    static final int
    Option specifying the maximum number of referrals to follow in a sequence when requesting an LDAP operation.
    static final int
    Option specifying the object containing the method for getting authentication information (the distinguished name and password) used during a referral.
    static final int
    Specifies that the scope of a search includes only the base DN (distinguished name).
    static final int
    Specifies that the scope of a search includes only the entries one level below the base DN (distinguished name).
    static final int
    Specifies that the scope of a search includes the base DN (distinguished name) and all entries at all levels beneath that base.
    static final int
    Option specifying the maximum number of milliseconds the server should spend returning search results before aborting the search.
    static final int
    Option specifying the maximum number of search results to return.
    static final int
    Option specifying the maximum number of milliseconds to wait for an operation to complete.
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    Notifies the server to not send additional results associated with this LDAPSearchResults object, and discards any results already received.
    void
    add(LDAPEntry entry)
    Adds an entry to the directory.
    void
    Adds an entry to the directory.
    void
    authenticate(String DN, String passwd)
    Authenticates user with the LDAP server.
    void
    bind(String DN, String passwd)
    Authenticates user with the LDAP server.
    boolean
    Compares the given entry's attribute value to the specified attribute value.
    boolean
    Compares the given entry's attribute value to the specified attribute value.
    void
    connect(String host, int port)
    Connects to the LDAP server.
    void
    connect(String host, int port, String dn, String passwd)
    Connects and authenticates to the LDAP server.
    void
    Removes an entry from the directory.
    void
    Removes an entry from the directory.
    void
    Disconnects from the LDAP server.
    getOption(int option)
    Retrieves an option that applies to the connection.
    void
    Modifies an attribute of a directory entry.
    void
    Modifies an attribute of a directory entry.
    void
    Modifies the attributes of a directory entry.
    void
    Modifies the attributes of a directory entry.
    Read the entry corresponding to the specified distinguished name (DN).
    read(String DN, String[] attrs)
    Read the entry corresponding to the specified distinguished name (DN), and retrieve only the specified attributes.
    read(String DN, String[] attrs, LDAPSearchConstraints cons)
    Read the entry corresponding to the specified distinguished name (DN), and retrieve only the specified attributes.
    void
    rename(String DN, String newRDN, boolean deleteOldRDN)
    Changes the name of an entry in the directory.
    void
    rename(String DN, String newRDN, boolean deleteOldRDN, LDAPConstraints cons)
    Changes the name of an entry in the directory.
    search(String base, int scope, String filter, String[] attrs, boolean attrsOnly)
    Searches for entries in the directory.
    search(String base, int scope, String filter, String[] attrs, boolean attrsOnly, LDAPSearchConstraints cons)
    Searches for entries in the directory.
    void
    setOption(int option, Object value)
    Sets an option that applies to the connection.