Package netscape.ldap
Interface LDAPAsynchronousConnection
- All Known Implementing Classes:
LDAPConnection
public interface LDAPAsynchronousConnection
Encapsulates a connection to an LDAP server, providing access to the input queue
for messages received.
- Version:
- 1.0
-
Method Summary
Modifier and TypeMethodDescriptionvoid
abandon
(int id) Cancels the ldap request with the specified id and discards any results already received.void
abandon
(LDAPSearchListener searchlistener) Cancels all outstanding search requests associated with this LDAPSearchListener object and discards any results already received.add
(LDAPEntry entry, LDAPResponseListener listener) Adds an entry to the directory.add
(LDAPEntry entry, LDAPResponseListener listener, LDAPConstraints cons) Adds an entry to the directory and allows you to specify constraints for this LDAP add operation by using anLDAPConstraints
object.bind
(String dn, String passwd, LDAPResponseListener listener) Authenticates to the LDAP server (that the object is currently connected to) using the specified name and password.bind
(String dn, String passwd, LDAPResponseListener listener, LDAPConstraints cons) Authenticates to the LDAP server (that the object is currently connected to) using the specified name and password and allows you to specify constraints for this LDAP add operation by using anLDAPConstraints
object.compare
(String dn, LDAPAttribute attr, LDAPResponseListener listener) Compares an attribute value with one in the directory.compare
(String dn, LDAPAttribute attr, LDAPResponseListener listener, LDAPConstraints cons) Compares an attribute value with one in the directory.delete
(String dn, LDAPResponseListener listener) Deletes the entry for the specified DN from the directory.delete
(String dn, LDAPResponseListener listener, LDAPConstraints cons) Deletes the entry for the specified DN from the directory.modify
(String dn, LDAPModification mod, LDAPResponseListener listener) Makes a single change to an existing entry in the directory.modify
(String dn, LDAPModification mod, LDAPResponseListener listener, LDAPConstraints cons) Makes a single change to an existing entry in the directory.modify
(String dn, LDAPModificationSet mods, LDAPResponseListener listener) Makes a set of changes to an existing entry in the directory.modify
(String dn, LDAPModificationSet mods, LDAPResponseListener listener, LDAPConstraints cons) Makes a set of changes to an existing entry in the directory.rename
(String dn, String newRdn, boolean deleteOldRdn, LDAPResponseListener listener) Renames an existing entry in the directory.rename
(String dn, String newRdn, boolean deleteOldRdn, LDAPResponseListener listener, LDAPConstraints cons) Renames an existing entry in the directory.search
(String base, int scope, String filter, String[] attrs, boolean typesOnly, LDAPSearchListener listener) Performs the search specified by the criteria that you enter.search
(String base, int scope, String filter, String[] attrs, boolean typesOnly, LDAPSearchListener listener, LDAPSearchConstraints cons) Performs the search specified by the criteria that you enter.
-
Method Details
-
add
Adds an entry to the directory.- Parameters:
entry
- LDAPEntry object specifying the distinguished name and attributes of the new entrylistener
- handler for messages returned from a server in response to this request. If it is null, a listener object is created internally.- Returns:
- LDAPSearchListener handler for messages returned from a server in response to this request.
- Throws:
LDAPException
- Failed to send request.- See Also:
-
add
LDAPResponseListener add(LDAPEntry entry, LDAPResponseListener listener, LDAPConstraints cons) throws LDAPException Adds an entry to the directory and allows you to specify constraints for this LDAP add operation by using anLDAPConstraints
object. For example, you can specify whether or not to follow referrals. You can also apply LDAP v3 controls to the operation.- Parameters:
entry
- LDAPEntry object specifying the distinguished name and attributes of the new entrylistener
- handler for messages returned from a server in response to this request. If it is null, a listener object is created internally.cons
- constraints specific to the operation- Returns:
- LDAPResponseListener handler for messages returned from a server in response to this request.
- Throws:
LDAPException
- Failed to send request.- See Also:
-
bind
LDAPResponseListener bind(String dn, String passwd, LDAPResponseListener listener) throws LDAPException Authenticates to the LDAP server (that the object is currently connected to) using the specified name and password. 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:
dn
- if non-null and non-empty, specifies that the connection and all operations through it should be authenticated with dn as the distinguished namepasswd
- if non-null and non-empty, specifies that the connection and all operations through it should be authenticated with dn as the distinguished name and passwd as passwordlistener
- handler for messages returned from a server in response to this request. If it is null, a listener object is created internally.- Returns:
- LDAPResponseListener handler for messages returned from a server in response to this request.
- Throws:
LDAPException
- Failed to send request.- See Also:
-
bind
LDAPResponseListener bind(String dn, String passwd, LDAPResponseListener listener, LDAPConstraints cons) throws LDAPException Authenticates to the LDAP server (that the object is currently connected to) using the specified name and password and allows you to specify constraints for this LDAP add operation by using anLDAPConstraints
object. 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:
dn
- if non-null and non-empty, specifies that the connection and all operations through it should be authenticated with dn as the distinguished namepasswd
- if non-null and non-empty, specifies that the connection and all operations through it should be authenticated with dn as the distinguished name and passwd as passwordlistener
- handler for messages returned from a server in response to this request. If it is null, a listener object is created internally.cons
- constraints specific to the operation- Returns:
- LDAPResponseListener handler for messages returned from a server in response to this request.
- Throws:
LDAPException
- Failed to send request.- See Also:
-
delete
Deletes the entry for the specified DN from the directory.- Parameters:
dn
- distinguished name of the entry to deletelistener
- handler for messages returned from a server in response to this request. If it is null, a listener object is created internally.- Returns:
- LDAPResponseListener handler for messages returned from a server in response to this request.
- Throws:
LDAPException
- Failed to send request.- See Also:
-
delete
LDAPResponseListener delete(String dn, LDAPResponseListener listener, LDAPConstraints cons) throws LDAPException Deletes the entry for the specified DN from the directory.- Parameters:
dn
- distinguished name of the entry to deletelistener
- handler for messages returned from a server in response to this request. If it is null, a listener object is created internally.cons
- constraints specific to the operation- Returns:
- LDAPResponseListener handler for messages returned from a server in response to this request.
- Throws:
LDAPException
- Failed to send request.- See Also:
-
modify
LDAPResponseListener modify(String dn, LDAPModification mod, LDAPResponseListener listener) throws LDAPException Makes a single change to an existing entry in the directory. For example, changes the value of an attribute, adds a new attribute value, or removes an existing attribute value.
The LDAPModification object specifies both the change to be made and the LDAPAttribute value to be changed.- Parameters:
dn
- distinguished name of the entry to modifymod
- a single change to make to an entrylistener
- handler for messages returned from a server in response to this request. If it is null, a listener object is created internally.- Returns:
- LDAPResponseListener handler for messages returned from a server in response to this request.
- Throws:
LDAPException
- Failed to send request.- See Also:
-
modify
LDAPResponseListener modify(String dn, LDAPModification mod, LDAPResponseListener listener, LDAPConstraints cons) throws LDAPException Makes a single change to an existing entry in the directory. For example, changes the value of an attribute, adds a new attribute value, or removes an existing attribute value.
The LDAPModification object specifies both the change to be made and the LDAPAttribute value to be changed.- Parameters:
dn
- distinguished name of the entry to modifymod
- a single change to make to an entrylistener
- handler for messages returned from a server in response to this request. If it is null, a listener object is created internally.cons
- constraints specific to the operation- Returns:
- LDAPResponseListener handler for messages returned from a server in response to this request.
- Throws:
LDAPException
- Failed to send request.- See Also:
-
modify
LDAPResponseListener modify(String dn, LDAPModificationSet mods, LDAPResponseListener listener) throws LDAPException Makes a set of changes to an existing entry in the directory. For example, changes attribute values, adds new attribute values, or removes existing attribute values.- Parameters:
dn
- distinguished name of the entry to modifymods
- a set of modifications to make to the entrylistener
- handler for messages returned from a server in response to this request. If it is null, a listener object is created internally.- Returns:
- LDAPResponseListener handler for messages returned from a server in response to this request.
- Throws:
LDAPException
- Failed to send request.- See Also:
-
modify
LDAPResponseListener modify(String dn, LDAPModificationSet mods, LDAPResponseListener listener, LDAPConstraints cons) throws LDAPException Makes a set of changes to an existing entry in the directory. For example, changes attribute values, adds new attribute values, or removes existing attribute values.- Parameters:
dn
- distinguished name of the entry to modifymods
- a set of modifications to make to the entrylistener
- handler for messages returned from a server in response to this request. If it is null, a listener object is created internally.cons
- constraints specific to the operation- Returns:
- LDAPResponseListener handler for messages returned from a server in response to this request.
- Throws:
LDAPException
- Failed to send request.- See Also:
-
rename
LDAPResponseListener rename(String dn, String newRdn, boolean deleteOldRdn, LDAPResponseListener listener) throws LDAPException Renames an existing entry in the directory.- Parameters:
dn
- current distinguished name of the entrynewRdn
- new relative distinguished name for the entrydeleteOldRdn
- iftrue
, the old name is not retained as an attribute valuelistener
- handler for messages returned from a server in response to this request. If it is null, a listener object is created internally.- Returns:
- LDAPResponseListener handler for messages returned from a server in response to this request.
- Throws:
LDAPException
- Failed to send request.- See Also:
-
rename
LDAPResponseListener rename(String dn, String newRdn, boolean deleteOldRdn, LDAPResponseListener listener, LDAPConstraints cons) throws LDAPException Renames an existing entry in the directory.- Parameters:
dn
- current distinguished name of the entrynewRdn
- new relative distinguished name for the entrydeleteOldRdn
- iftrue
, the old name is not retained as an attribute valuelistener
- handler for messages returned from a server in response to this request. If it is null, a listener object is created internally.cons
- constraints specific to the operation- Returns:
- LDAPResponseListener handler for messages returned from a server in response to this request.
- Throws:
LDAPException
- Failed to send request.- See Also:
-
search
LDAPSearchListener search(String base, int scope, String filter, String[] attrs, boolean typesOnly, LDAPSearchListener listener) throws LDAPException Performs the search specified by the criteria that you enter.To abandon the search, use the
abandon
method.- Parameters:
base
- the base distinguished name from which to searchscope
- the scope of the entries to search. You can specify one of the following:LDAPv2.SCOPE_BASE
(search only the base DN)LDAPv2.SCOPE_ONE
(search only those entries that are one level below the base DN)LDAPv2.SCOPE_SUB
(search the base DN and all entries within its subtree)
filter
- search filter specifying the search criteriaattrs
- list of attributes to return in the search resultstypesOnly
- iftrue
, returns the names but not the values of the attributes found. Iffalse
, returns the names and values of the attributes found.listener
- handler for messages returned from a server in response to this request. If it is null, a listener object is created internally.- Returns:
- LDAPSearchListener handler for messages returned from a server in response to this request.
- Throws:
LDAPException
- Failed to send request.- See Also:
-
search
LDAPSearchListener search(String base, int scope, String filter, String[] attrs, boolean typesOnly, LDAPSearchListener listener, LDAPSearchConstraints cons) throws LDAPException Performs the search specified by the criteria that you enter. This method also allows you to specify constraints for the search (such as the maximum number of entries to find or the maximum time to wait for search results).To abandon the search, use the
abandon
method.- Parameters:
base
- the base distinguished name from which to searchscope
- the scope of the entries to search. You can specify one of the following:LDAPv2.SCOPE_BASE
(search only the base DN)LDAPv2.SCOPE_ONE
(search only those entries that are one level below the base DN)LDAPv2.SCOPE_SUB
(search the base DN and all entries within its subtree)
filter
- search filter specifying the search criteriaattrs
- list of attributes to return in the search resultstypesOnly
- iftrue
, returns the names but not the values of the attributes found. Iffalse
, returns the names and values for attributes found.listener
- handler for messages returned from a server in response to this request. If it is null, a listener object is created internally.cons
- constraints specific to this search (for example, the maximum number of entries to return)- Returns:
- LDAPSearchListener handler for messages returned from a server in response to this request.
- Throws:
LDAPException
- Failed to send request.- See Also:
-
compare
LDAPResponseListener compare(String dn, LDAPAttribute attr, LDAPResponseListener listener) throws LDAPException Compares an attribute value with one in the directory. The result is obtained by callinggetResultCode
on theLDAPResponse
from theLDAPResponseListener
. The code will beLDAPException.COMPARE_TRUE
orLDAPException.COMPARE_FALSE
.- Parameters:
dn
- distinguished name of the entry to compareattr
- attribute with a value to comparelistener
- handler for messages returned from a server in response to the specified request. If it is null, a listener object is created internally.- Returns:
- LDAPResponseListener handler for messages returned from a server in response to the specified request.
- Throws:
LDAPException
- Failed to send request.
-
compare
LDAPResponseListener compare(String dn, LDAPAttribute attr, LDAPResponseListener listener, LDAPConstraints cons) throws LDAPException Compares an attribute value with one in the directory. The result is obtained by callinggetResultCode
on theLDAPResponse
from theLDAPResponseListener
. The code will beLDAPException.COMPARE_TRUE
orLDAPException.COMPARE_FALSE
.- Parameters:
dn
- distinguished name of the entry to compareattr
- attribute with a value to comparelistener
- handler for messages returned from a server in response to the specified request. If it is null, a listener object is created internally.cons
- constraints specific to this operation- Returns:
- LDAPResponseListener handler for messages returned from a server in response to the specified request.
- Throws:
LDAPException
- Failed to send request.
-
abandon
Cancels the ldap request with the specified id and discards any results already received.- Parameters:
id
- an LDAP request ID- Throws:
LDAPException
- Failed to send request.
-
abandon
Cancels all outstanding search requests associated with this LDAPSearchListener object and discards any results already received.- Parameters:
searchlistener
- a search listener returned from a search- Throws:
LDAPException
- Failed to send request.
-