Interface LdapAsyncConnection
-
- All Superinterfaces:
AutoCloseable
,Closeable
,LdapConnection
- All Known Implementing Classes:
LdapNetworkConnection
public interface LdapAsyncConnection extends LdapConnection
Root interface for all asynchronous LDAP connections.- Author:
- Apache Directory Project
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description AddFuture
addAsync(Entry entry)
Add an entry to the server asynchronously.AddFuture
addAsync(AddRequest addRequest)
Add an entry present in the AddRequest to the server.BindFuture
anonymousBindAsync()
Anonymous asynchronous Bind on a server.BindFuture
bindAsync()
Asynchronous Bind on a server, using the LdapConnectionConfig informations.BindFuture
bindAsync(String name, String credentials)
Simple asynchronous Bind on a server.BindFuture
bindAsync(BindRequest bindRequest)
Do an asynchronous bind, based on a BindRequest.BindFuture
bindAsync(Dn name, String credentials)
Simple asynchronous Bind on a server.CompareFuture
compareAsync(CompareRequest compareRequest)
Asynchronously compares an entry's attribute's value with that of the given valueDeleteFuture
deleteAsync(DeleteRequest delRequest)
Performs an asynchronous delete operation based on the delete request object.ExtendedFuture
extendedAsync(ExtendedRequest extendedRequest)
Asynchronously requests the server to perform an extended operation based on the given request.LdapConnectionConfig
getConfig()
Configuration of LdapNetworkConnectionModifyFuture
modifyAsync(ModifyRequest modRequest)
Performs an asynchronous modify operation based on the modifications present in the ModifyRequest.ModifyDnFuture
modifyDnAsync(ModifyDnRequest modDnRequest)
Performs the modifyDn operation based on the given ModifyDnRequest.SearchFuture
searchAsync(String baseDn, String filter, SearchScope scope, String... attributes)
Do an asynchronous search, on the base object, using the given filter.SearchFuture
searchAsync(SearchRequest searchRequest)
Do a search, on the base object, using the given filter.SearchFuture
searchAsync(Dn baseDn, String filter, SearchScope scope, String... attributes)
Do an asynchronous search, on the base object, using the given filter.-
Methods inherited from interface org.apache.directory.ldap.client.api.LdapConnection
abandon, abandon, add, add, anonymousBind, bind, bind, bind, bind, bind, bind, bind, close, compare, compare, compare, compare, compare, compare, compare, connect, delete, delete, delete, doesFutureExistFor, exists, exists, extended, extended, extended, extended, extended, getBinaryAttributeDetector, getCodecService, getRootDse, getRootDse, getSchemaManager, getSupportedControls, isAuthenticated, isConnected, isControlSupported, isRequestCompleted, loadSchema, loadSchemaRelaxed, lookup, lookup, lookup, lookup, lookup, lookup, modify, modify, modify, modify, modifyDn, move, move, moveAndRename, moveAndRename, moveAndRename, moveAndRename, rename, rename, rename, rename, search, search, search, setBinaryAttributeDetector, setSchemaManager, setTimeOut, unBind
-
-
-
-
Method Detail
-
addAsync
AddFuture addAsync(Entry entry) throws LdapException
Add an entry to the server asynchronously. This is a non blocking add : the user has to get for the response from the returned Future.- Parameters:
entry
- The entry to add- Returns:
- the add operation's future
- Throws:
LdapException
- if some error occurred
-
addAsync
AddFuture addAsync(AddRequest addRequest) throws LdapException
Add an entry present in the AddRequest to the server.- Parameters:
addRequest
- the request object containing an entry and controls(if any)- Returns:
- the add operation's future
- Throws:
LdapException
- if some error occurred
-
bindAsync
BindFuture bindAsync() throws LdapException, IOException
Asynchronous Bind on a server, using the LdapConnectionConfig informations.- Returns:
- the bind operation's future
- Throws:
LdapException
- if some error occurredIOException
- if some IO error occurred
-
anonymousBindAsync
BindFuture anonymousBindAsync() throws LdapException, IOException
Anonymous asynchronous Bind on a server.- Returns:
- the bind operation's future
- Throws:
LdapException
- if some error occurredIOException
- if some IO error occurred
-
bindAsync
BindFuture bindAsync(String name, String credentials) throws LdapException, IOException
Simple asynchronous Bind on a server.- Parameters:
name
- The name we use to authenticate the user, it must be a valid Dncredentials
- The password, it can't be null- Returns:
- the bind operation's future
- Throws:
LdapException
- if some error occurredIOException
- if some IO error occurred
-
bindAsync
BindFuture bindAsync(Dn name, String credentials) throws LdapException, IOException
Simple asynchronous Bind on a server.- Parameters:
name
- The name we use to authenticate the user, it must be a valid Dncredentials
- The password, it can't be null- Returns:
- the bind operation's future
- Throws:
LdapException
- if some error occurredIOException
- if some IO error occurred
-
bindAsync
BindFuture bindAsync(BindRequest bindRequest) throws LdapException, IOException
Do an asynchronous bind, based on a BindRequest.- Parameters:
bindRequest
- The BindRequest to send- Returns:
- the bind operation's future
- Throws:
LdapException
- if some error occurredIOException
- if some IO error occurred
-
searchAsync
SearchFuture searchAsync(String baseDn, String filter, SearchScope scope, String... attributes) throws LdapException
Do an asynchronous search, on the base object, using the given filter. The SearchRequest parameters default to :Scope : ONE DerefAlias : ALWAYS SizeLimit : none TimeLimit : none TypesOnly : false Attributes : all the user's attributes. This method is blocking.
- Parameters:
baseDn
- The base for the search, it must be a valid Dn, and can't be emtpyfilter
- The filter to use for this search, it can't be emptyscope
- The search scope : OBJECT, ONELEVEL or SUBTREEattributes
- The attributes for this search- Returns:
- the search operation's future
- Throws:
LdapException
- if some error occurred
-
searchAsync
SearchFuture searchAsync(Dn baseDn, String filter, SearchScope scope, String... attributes) throws LdapException
Do an asynchronous search, on the base object, using the given filter. The SearchRequest parameters default to :Scope : ONE DerefAlias : ALWAYS SizeLimit : none TimeLimit : none TypesOnly : false Attributes : all the user's attributes. This method is blocking.
- Parameters:
baseDn
- The base for the search, it must be a valid Dn, and can't be emptyfilter
- The filter to use for this search, it can't be emptyscope
- The search scope : OBJECT, ONELEVEL or SUBTREEattributes
- The attributes for this search- Returns:
- the search operation's future
- Throws:
LdapException
- if some error occurred
-
searchAsync
SearchFuture searchAsync(SearchRequest searchRequest) throws LdapException
Do a search, on the base object, using the given filter. The SearchRequest parameters default to :Scope : ONE DerefAlias : ALWAYS SizeLimit : none TimeLimit : none TypesOnly : false Attributes : all the user's attributes. This method is blocking.
- Parameters:
searchRequest
- The search request to send to the server- Returns:
- the search operation's future
- Throws:
LdapException
- if some error occurred
-
modifyAsync
ModifyFuture modifyAsync(ModifyRequest modRequest) throws LdapException
Performs an asynchronous modify operation based on the modifications present in the ModifyRequest.- Parameters:
modRequest
- the request for modify operation- Returns:
- the modify operation's future
- Throws:
LdapException
- in case of modify operation failure or timeout happens
-
modifyDnAsync
ModifyDnFuture modifyDnAsync(ModifyDnRequest modDnRequest) throws LdapException
Performs the modifyDn operation based on the given ModifyDnRequest.- Parameters:
modDnRequest
- the request- Returns:
- modifyDn operation's future
- Throws:
LdapException
- if some error occurred
-
deleteAsync
DeleteFuture deleteAsync(DeleteRequest delRequest) throws LdapException
Performs an asynchronous delete operation based on the delete request object.- Parameters:
delRequest
- the delete operation's request- Returns:
- delete operation's future
- Throws:
LdapException
- If the Dn is not valid or if the deletion failed
-
compareAsync
CompareFuture compareAsync(CompareRequest compareRequest) throws LdapException
Asynchronously compares an entry's attribute's value with that of the given value- Parameters:
compareRequest
- the CompareRequest which contains the target Dn, attribute name and value- Returns:
- compare operation's future
- Throws:
LdapException
- if some error occurred
-
extendedAsync
ExtendedFuture extendedAsync(ExtendedRequest extendedRequest) throws LdapException
Asynchronously requests the server to perform an extended operation based on the given request.- Parameters:
extendedRequest
- the object containing the details of the extended operation to be performed- Returns:
- extended operation's Future
- Throws:
LdapException
- if some error occurred
-
getConfig
LdapConnectionConfig getConfig()
Configuration of LdapNetworkConnection- Returns:
- the configuration of the LDAP connection
-
-