public class LdapNetworkConnection extends AbstractLdapConnection implements LdapAsyncConnection
Constructor and Description |
---|
LdapNetworkConnection()
Create a new instance of a LdapConnection on localhost,
port 389.
|
LdapNetworkConnection(boolean useSsl)
Create a new instance of a LdapConnection on localhost,
port 389 if the SSL flag is off, or 636 otherwise.
|
LdapNetworkConnection(boolean useSsl,
LdapApiService ldapApiService)
Creates a new LdapNetworkConnection instance
|
LdapNetworkConnection(LdapConnectionConfig config)
Creates a new instance of LdapConnection with the given connection configuration.
|
LdapNetworkConnection(LdapConnectionConfig config,
LdapApiService ldapApiService)
Creates a new LdapNetworkConnection instance
|
LdapNetworkConnection(String server)
Create a new instance of a LdapConnection on a given
server, using the default port (389).
|
LdapNetworkConnection(String server,
boolean useSsl)
Create a new instance of a LdapConnection on a given
server, using the default port (389) if the SSL flag
is off, or 636 otherwise.
|
LdapNetworkConnection(String server,
boolean useSsl,
LdapApiService ldapApiService)
Creates a new LdapNetworkConnection instance
|
LdapNetworkConnection(String server,
int port)
Create a new instance of a LdapConnection on a
given server and a given port.
|
LdapNetworkConnection(String server,
int port,
boolean useSsl)
Create a new instance of a LdapConnection on a given
server, and a give port.
|
LdapNetworkConnection(String server,
int port,
boolean useSsl,
LdapApiService ldapApiService)
Create a new instance of a LdapConnection on a
given server and a given port.
|
LdapNetworkConnection(String server,
int port,
LdapApiService ldapApiService)
Create a new instance of a LdapConnection on a
given server and a given port.
|
LdapNetworkConnection(String server,
int port,
TrustManager... trustManagers)
Create a new instance of a LdapConnection on a given
server, and a give port.
|
LdapNetworkConnection(String server,
LdapApiService ldapApiService)
Creates a new LdapNetworkConnection instance
|
Modifier and Type | Method and Description |
---|---|
void |
abandon(AbandonRequest abandonRequest)
An abandon request essentially with the request message ID of the operation to be canceled
and/or potentially some controls and timeout (the controls and timeout are not mandatory).
|
void |
abandon(int messageId)
Abandons a request submitted to the server for performing a particular operation.
|
AddResponse |
add(AddRequest addRequest)
Add an entry present in the
AddRequest to the server. |
void |
add(Entry entry)
Add an entry to the server.
|
AddFuture |
addAsync(AddRequest addRequest)
Add an entry present in the AddRequest to the server.
|
AddFuture |
addAsync(Entry entry)
Add an entry to the server asynchronously.
|
void |
addConnectionClosedEventListener(ConnectionClosedEventListener ccListener)
Adds the connection closed event listener.
|
void |
addSchema(File schemaFile)
parses the given schema file present in OpenLDAP schema format
and adds all the SchemaObjects present in it to the SchemaManager
|
void |
addSchema(String schemaFileName) |
void |
anonymousBind()
Anonymous bind on a server.
|
BindFuture |
anonymousBindAsync()
Anonymous asynchronous Bind on a server.
|
void |
bind()
Bind on a server, using the
LdapConnectionConfig information of this connection. |
BindResponse |
bind(BindRequest bindRequest)
Bind to the server using a bind request object.
|
BindResponse |
bind(SaslCramMd5Request request)
Bind to the server using a CramMd5Request object.
|
BindResponse |
bind(SaslDigestMd5Request request)
Bind to the server using a DigestMd5Request object.
|
BindResponse |
bind(SaslExternalRequest request)
Bind to the server using a SaslExternalRequest object.
|
BindResponse |
bind(SaslGssApiRequest request)
Bind to the server using a GssApiRequest object.
|
BindResponse |
bind(SaslRequest request)
Bind to the server using a SaslRequest object.
|
BindFuture |
bindAsync()
Asynchronous Bind on a server, using the LdapConnectionConfig informations.
|
BindFuture |
bindAsync(BindRequest bindRequest)
Do an asynchronous bind, based on a BindRequest.
|
BindFuture |
bindAsync(Dn name)
Asynchronous unauthenticated authentication Bind on a server.
|
BindFuture |
bindAsync(Dn name,
String credentials)
Simple asynchronous Bind on a server.
|
BindFuture |
bindAsync(SaslGssApiRequest request)
Do an asynchronous bind, based on a GssApiRequest.
|
BindFuture |
bindAsync(SaslRequest request)
Do an asynchronous bind, based on a SaslPlainRequest.
|
BindFuture |
bindAsync(String name)
Asynchronous unauthenticated authentication bind
|
BindFuture |
bindAsync(String name,
String credentials)
Simple asynchronous Bind on a server.
|
BindFuture |
bindSasl(SaslRequest saslRequest)
Process the SASL Bind.
|
BindResponse |
bindSaslCramMd5(String userName,
String credentials)
Bind to the server using the SASL CRAM-MD5 mechanism.
|
BindResponse |
bindSaslDigestMd5(String userName,
String credentials)
Bind to the server using the SASL DIGEST-MD5 mechanism.
|
BindResponse |
bindSaslPlain(String authcid,
String credentials)
SASL PLAIN Bind on a server.
|
BindResponse |
bindSaslPlain(String authzid,
String authcid,
String credentials)
SASL PLAIN Bind on a server.
|
void |
close()
Disconnect from the remote LDAP server.
|
CompareResponse |
compare(CompareRequest compareRequest)
Compares an entry's attribute's value with that of the given value.
|
boolean |
compare(Dn dn,
String attributeName,
byte[] value)
Compares whether a given attribute's value matches that of the
existing value of the attribute present in the entry with the given distinguished name.
|
boolean |
compare(Dn dn,
String attributeName,
String value)
Compares whether a given attribute's value matches that of the
existing value of the attribute present in the entry with the given distinguished name.
|
boolean |
compare(Dn dn,
String attributeName,
Value value)
Compares whether a given attribute's value matches that of the
existing value of the attribute present in the entry with the given distinguished name.
|
boolean |
compare(String dn,
String attributeName,
byte[] value)
Compares whether a given attribute's value matches that of the
existing value of the attribute present in the entry with the given distinguished name.
|
boolean |
compare(String dn,
String attributeName,
String value)
Compares whether a given attribute's value matches that of the
existing value of the attribute present in the entry with the given distinguished name.
|
boolean |
compare(String dn,
String attributeName,
Value value)
Compares whether a given attribute's value matches that of the
existing value of the attribute present in the entry with the given distinguished name.
|
CompareFuture |
compareAsync(CompareRequest compareRequest)
Asynchronously compares an entry's attribute's value with that of the given value
|
boolean |
connect()
Connect to the remote LDAP server.
|
DeleteResponse |
delete(DeleteRequest deleteRequest)
Performs a delete operation based on the delete request object.
|
void |
delete(Dn dn)
Deletes the entry with the given distinguished name.
|
void |
delete(String dn)
Deletes the entry with the given distinguished name.
|
DeleteFuture |
deleteAsync(DeleteRequest deleteRequest)
Performs an asynchronous delete operation based on the delete request object.
|
void |
deleteTree(Dn dn)
deletes the entry with the given Dn, and all its children
|
void |
deleteTree(String dn)
deletes the entry with the given Dn, and all its children
|
boolean |
doesFutureExistFor(int messageId)
Checks if there is a ResponseFuture associated with the given message ID.
|
void |
event(org.apache.mina.core.session.IoSession session,
org.apache.mina.filter.FilterEvent event) |
Throwable |
exceptionCaught()
tell if an exception was caught while processing the request or a response.
|
void |
exceptionCaught(org.apache.mina.core.session.IoSession session,
Throwable cause)
Handle the exception we got.
|
boolean |
exists(Dn dn)
Tells if an Entry exists in the server.
|
boolean |
exists(String dn)
Tells if an entry exists in the server.
|
ExtendedResponse |
extended(ExtendedRequest extendedRequest)
Performs an extended operation based on the extended request object.
|
ExtendedResponse |
extended(Oid oid)
Sends a extended operation request to the server with the given OID and no value.
|
ExtendedResponse |
extended(Oid oid,
byte[] value)
Sends a extended operation request to the server with the given OID and value.
|
ExtendedResponse |
extended(String oid)
Sends a extended operation request to the server with the given OID and no value.
|
ExtendedResponse |
extended(String oid,
byte[] value)
Sends a extended operation request to the server with the given OID and value.
|
ExtendedFuture |
extendedAsync(ExtendedRequest extendedRequest)
Asynchronously requests the server to perform an extended operation based on the given request.
|
BinaryAttributeDetector |
getBinaryAttributeDetector() |
LdapApiService |
getCodecService()
Gets the LDAP CODEC service responsible for encoding and decoding
messages.
|
LdapConnectionConfig |
getConfig()
gives the configuration information of the connection
|
Entry |
getRootDse()
Get back the RooDSE from the connected server.
|
Entry |
getRootDse(String... attributes)
Get back the RooDSE from the connected server.
|
SchemaManager |
getSchemaManager() |
org.apache.mina.transport.socket.SocketSessionConfig |
getSocketSessionConfig() |
SSLSession |
getSslSession()
Gets the
SSLSession associated with the connection. |
List<String> |
getSupportedControls()
Get the Controls supported by server.
|
long |
getTimeout(long connectionTimoutInMS,
int searchTimeLimitInSeconds)
Get the largest timeout from the search time limit and the connection
timeout.
|
void |
inputClosed(org.apache.mina.core.session.IoSession session) |
boolean |
isAuthenticated()
Check if the connection is authenticated.
|
boolean |
isConnected()
Check if the connection is established
|
boolean |
isControlSupported(String controlOID)
Checks if a control with the given OID is supported.
|
boolean |
isRequestCompleted(int messageId)
Checks if a request has been completed, or not.
|
boolean |
isSecured()
Tells if the connection is using a secured channel
|
void |
loadSchema()
Loads all the default schemas that are bundled with the API.
Note: This method enables all schemas prior to loading. |
void |
loadSchema(SchemaLoader loader)
loads schema using the specified schema loader
|
void |
loadSchemaRelaxed()
Loads all the default schemas that are bundled with the API, in a relaxed mode.
Note: This method enables all schemas prior to loading. The relaxed mode will allow inconsistencies in the schema. |
Entry |
lookup(Dn dn)
Searches for an entry having the given distinguished name..
|
Entry |
lookup(Dn dn,
Control[] controls,
String... attributes)
Searches for an entry having the given distinguished name.
|
Entry |
lookup(Dn dn,
String... attributes)
Searches for an entry having the given distinguished name.
|
Entry |
lookup(String dn)
Searches for an entry having the given distinguished name.
|
Entry |
lookup(String dn,
Control[] controls,
String... attributes)
Searches for an entry having the given distinguished name.
|
Entry |
lookup(String dn,
String... attributes)
Searches for an entry having the given distinguished name.
|
void |
messageReceived(org.apache.mina.core.session.IoSession session,
Object message)
Handle the incoming LDAP messages.
|
void |
modify(Dn dn,
Modification... modifications)
Applies all the modifications to the entry specified by its distinguished name.
|
void |
modify(Entry entry,
ModificationOperation modOp)
Modifies all the attributes present in the entry by applying the same operation.
|
ModifyResponse |
modify(ModifyRequest modRequest)
Performs an modify operation based on the modifications present in
the modify request.
|
void |
modify(String dn,
Modification... modifications)
Applies all the modifications to the entry specified by its distinguished name.
|
ModifyFuture |
modifyAsync(ModifyRequest modRequest)
Performs an asynchronous modify operation based on the modifications present in
the ModifyRequest.
|
ModifyDnResponse |
modifyDn(ModifyDnRequest modDnRequest)
Performs the modifyDn operation based on the given request object.
|
ModifyDnFuture |
modifyDnAsync(ModifyDnRequest modDnRequest)
Performs the modifyDn operation based on the given ModifyDnRequest.
|
void |
move(Dn entryDn,
Dn newSuperiorDn)
Moves the given entry distinguished name under the new superior distinguished name.
|
void |
move(String entryDn,
String newSuperiorDn)
Moves the given entry distinguished name under the new superior distinguished name.
|
void |
moveAndRename(Dn entryDn,
Dn newDn)
Moves and renames the given entryDn.
|
void |
moveAndRename(Dn entryDn,
Dn newDn,
boolean deleteOldRdn)
Moves and renames the given entryDn.
|
void |
moveAndRename(String entryDn,
String newDn)
Moves and renames the given entry distinguished name.
|
void |
moveAndRename(String entryDn,
String newDn,
boolean deleteOldRdn)
Moves and renames the given entryDn.
|
void |
rename(Dn entryDn,
Rdn newRdn)
Renames the given entryDn with new relative distinguished name and deletes the
old relative distinguished name.
|
void |
rename(Dn entryDn,
Rdn newRdn,
boolean deleteOldRdn)
Renames the given entryDn with new relative distinguished name and deletes the
old relative distinguished name if deleteOldRdn is set to true.
|
void |
rename(String entryDn,
String newRdn)
Renames the given entryDn with new relative distinguished name and deletes the
old relative distinguished name.
|
void |
rename(String entryDn,
String newRdn,
boolean deleteOldRdn)
Renames the given entryDn with new relative distinguished name and deletes the
old relative distinguished name if deleteOldRdn is set to true.
|
EntryCursor |
search(Dn baseDn,
String filter,
SearchScope scope,
String... attributes)
Do a search, on the base object, using the given filter and scope.
|
SearchCursor |
search(SearchRequest searchRequest)
Performs search using a search request object.
|
EntryCursor |
search(String baseDn,
String filter,
SearchScope scope,
String... attributes)
Do a search, on the base object, using the given filter and scope.
|
SearchFuture |
searchAsync(Dn 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(String baseDn,
String filter,
SearchScope scope,
String... attributes)
Do an asynchronous search, on the base object, using the given filter.
|
void |
sessionClosed(org.apache.mina.core.session.IoSession session) |
void |
sessionCreated(org.apache.mina.core.session.IoSession session)
This method is called when a new session is created.
|
void |
setBinaryAttributeDetector(BinaryAttributeDetector binaryAttributeDetector)
Sets the object responsible for the detection of binary attributes.
|
void |
setConnector(org.apache.mina.core.service.IoConnector connector)
Set the connector to use.
|
void |
setSchemaManager(SchemaManager schemaManager)
sets a SchemaManager to be used by this connection
|
void |
setSocketSessionConfig(org.apache.mina.transport.socket.SocketSessionConfig socketSessionConfig) |
void |
setTimeOut(long timeout)
Set the timeout for the responses.
|
void |
startTls()
Sends the StartTLS extended request to server and adds a security layer
upon receiving a response with successful result.
|
org.apache.mina.core.future.ConnectFuture |
tryConnect()
Process the connect.
|
void |
unBind()
UnBind from a server.
|
bind, bind, bind, bind
messageSent, sessionIdle, sessionOpened
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
bind, bind, bind, bind
public LdapNetworkConnection()
public LdapNetworkConnection(LdapConnectionConfig config)
config
- the configuration of the LdapConnectionpublic LdapNetworkConnection(LdapConnectionConfig config, LdapApiService ldapApiService)
config
- The configuration to useldapApiService
- The LDAP API Service to usepublic LdapNetworkConnection(boolean useSsl)
useSsl
- A flag to tell if it's a SSL connection or not.public LdapNetworkConnection(boolean useSsl, LdapApiService ldapApiService)
useSsl
- If we are going to create a secure connection or notldapApiService
- The LDAP API Service to usepublic LdapNetworkConnection(String server)
server
- The server we want to be connected to. If null or empty,
we will default to LocalHost.public LdapNetworkConnection(String server, LdapApiService ldapApiService)
server
- The server we want to be connected to. If null or empty,
we will default to LocalHost.ldapApiService
- The LDAP API Service to usepublic LdapNetworkConnection(String server, boolean useSsl)
server
- The server we want to be connected to. If null or empty,
we will default to LocalHost.useSsl
- A flag to tell if it's a SSL connection or not.public LdapNetworkConnection(String server, boolean useSsl, LdapApiService ldapApiService)
server
- The server we want to be connected to. If null or empty,
we will default to LocalHost.useSsl
- A flag to tell if it's a SSL connection or not.ldapApiService
- The LDAP API Service to usepublic LdapNetworkConnection(String server, int port)
server
- The server we want to be connected toport
- The port the server is listening topublic LdapNetworkConnection(String server, int port, LdapApiService ldapApiService)
server
- The server we want to be connected to. If null or empty,
we will default to LocalHost.port
- The port the server is listening onldapApiService
- The LDAP API Service to usepublic LdapNetworkConnection(String server, int port, boolean useSsl)
server
- The server we want to be connected to. If null or empty,
we will default to LocalHost.port
- The port the server is listening touseSsl
- A flag to tell if it's a SSL connection or not.public LdapNetworkConnection(String server, int port, TrustManager... trustManagers)
server
- The server we want to be connected to. If null or empty,
we will default to LocalHost.port
- The port the server is listening totrustManagers
- The TrustManager to usepublic LdapNetworkConnection(String server, int port, boolean useSsl, LdapApiService ldapApiService)
server
- The server we want to be connected to. If null or empty,
we will default to LocalHost.port
- The port the server is listening onuseSsl
- A flag to tell if it's a SSL connection or not.ldapApiService
- The LDAP API Service to usepublic boolean isConnected()
isConnected
in interface LdapConnection
true
if the connection is establishedpublic boolean isAuthenticated()
isAuthenticated
in interface LdapConnection
true
if the connection is authenticatedpublic boolean isSecured()
public Throwable exceptionCaught()
exceptionCaught
in interface LdapConnection
public long getTimeout(long connectionTimoutInMS, int searchTimeLimitInSeconds)
connectionTimoutInMS
- Connection timeoutsearchTimeLimitInSeconds
- Search timeoutpublic org.apache.mina.core.future.ConnectFuture tryConnect() throws LdapException
LdapException
- If we weren't able to connectpublic boolean connect() throws LdapException
connect
in interface LdapConnection
true
if the connection is established, false otherwiseLdapException
- if some error occurredpublic void close()
close
in interface Closeable
close
in interface AutoCloseable
close
in interface LdapConnection
public void add(Entry entry) throws LdapException
add
in interface LdapConnection
entry
- The entry to addLdapException
- if some error occurredpublic AddFuture addAsync(Entry entry) throws LdapException
addAsync
in interface LdapAsyncConnection
entry
- The entry to addLdapException
- if some error occurredpublic AddResponse add(AddRequest addRequest) throws LdapException
AddRequest
to the server.add
in interface LdapConnection
addRequest
- the request object containing an entry and controls (if any)LdapException
- if some error occurredpublic AddFuture addAsync(AddRequest addRequest) throws LdapException
addAsync
in interface LdapAsyncConnection
addRequest
- the request object containing an entry and controls(if any)LdapException
- if some error occurredpublic void abandon(int messageId)
abandon
in interface LdapConnection
messageId
- the ID of the request message sent to the serverpublic void abandon(AbandonRequest abandonRequest)
abandon
in interface LdapConnection
abandonRequest
- the abandon operation's requestpublic void bind() throws LdapException
LdapConnectionConfig
information of this connection.bind
in interface LdapConnection
LdapException
- if some error occurredpublic void anonymousBind() throws LdapException
anonymousBind
in interface LdapConnection
LdapException
- if some error occurredpublic BindFuture bindAsync() throws LdapException
bindAsync
in interface LdapAsyncConnection
LdapException
- if some error occurredpublic BindFuture anonymousBindAsync() throws LdapException
anonymousBindAsync
in interface LdapAsyncConnection
LdapException
- if some error occurredpublic BindFuture bindAsync(String name) throws LdapException
name
- The name we use to authenticate the user. It must be a
valid DnLdapException
- if some error occurredpublic BindFuture bindAsync(String name, String credentials) throws LdapException
bindAsync
in interface LdapAsyncConnection
name
- The name we use to authenticate the user, it must be a valid Dncredentials
- The password, it can't be nullLdapException
- if some error occurredpublic BindFuture bindAsync(Dn name) throws LdapException
name
- The name we use to authenticate the user. It must be a
valid DnLdapException
- if some error occurredpublic BindFuture bindAsync(Dn name, String credentials) throws LdapException
bindAsync
in interface LdapAsyncConnection
name
- The name we use to authenticate the user, it must be a valid Dncredentials
- The password, it can't be nullLdapException
- if some error occurredpublic BindResponse bind(BindRequest bindRequest) throws LdapException
bind
in interface LdapConnection
bindRequest
- The bind request object containing all the needed parametersBindResponse
containing the resultLdapException
- if some error occurredpublic BindFuture bindAsync(BindRequest bindRequest) throws LdapException
bindAsync
in interface LdapAsyncConnection
bindRequest
- The BindRequest to sendLdapException
- if some error occurredpublic BindResponse bindSaslPlain(String authcid, String credentials) throws LdapException
authcid
- The Authentication identitycredentials
- The password. It can't be nullLdapException
- if some error occurredpublic BindResponse bindSaslPlain(String authzid, String authcid, String credentials) throws LdapException
authzid
- The Authorization identityauthcid
- The Authentication identitycredentials
- The password. It can't be nullLdapException
- if some error occurredpublic BindResponse bind(SaslRequest request) throws LdapException
bind
in interface LdapConnection
request
- The SaslRequest POJO containing all the needed parametersLdapException
- if some error occurredpublic BindResponse bindSaslCramMd5(String userName, String credentials) throws LdapException
userName
- The user namecredentials
- The user credentialsLdapException
- if some error occurredpublic BindResponse bindSaslDigestMd5(String userName, String credentials) throws LdapException
userName
- The user namecredentials
- The user credentialsLdapException
- if some error occurredpublic BindResponse bind(SaslCramMd5Request request) throws LdapException
request
- The CramMd5Request POJO containing all the needed parametersLdapException
- if some error occurredpublic BindFuture bindAsync(SaslRequest request) throws LdapException
request
- The SaslPlainRequest POJO containing all the needed parametersLdapException
- if some error occurredpublic BindResponse bind(SaslDigestMd5Request request) throws LdapException
request
- The DigestMd5Request POJO containing all the needed parametersLdapException
- if some error occurredpublic BindResponse bind(SaslGssApiRequest request) throws LdapException
request
- The GssApiRequest POJO containing all the needed parametersLdapException
- if some error occurredpublic BindResponse bind(SaslExternalRequest request) throws LdapException
request
- The SaslExternalRequest POJO containing all the needed parametersLdapException
- if some error occurredpublic BindFuture bindAsync(SaslGssApiRequest request) throws LdapException
request
- The GssApiRequest POJO containing all the needed parametersLdapException
- if some error occurredpublic EntryCursor search(Dn baseDn, String filter, SearchScope scope, String... attributes) throws LdapException
search
in interface LdapConnection
baseDn
- The base for the search. It must be a valid distinguished name 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 to use for this searchEntryCursor
on the result.LdapException
- if some error occurredpublic EntryCursor search(String baseDn, String filter, SearchScope scope, String... attributes) throws LdapException
search
in interface LdapConnection
baseDn
- The base for the search. It must be a valid distinguished name, 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 to use for this searchEntryCursor
on the result.LdapException
- if some error occurredpublic SearchFuture searchAsync(Dn baseDn, String filter, SearchScope scope, String... attributes) throws LdapException
Scope : ONE DerefAlias : ALWAYS SizeLimit : none TimeLimit : none TypesOnly : false Attributes : all the user's attributes. This method is blocking.
searchAsync
in interface LdapAsyncConnection
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 searchLdapException
- if some error occurredpublic SearchFuture searchAsync(String baseDn, String filter, SearchScope scope, String... attributes) throws LdapException
Scope : ONE DerefAlias : ALWAYS SizeLimit : none TimeLimit : none TypesOnly : false Attributes : all the user's attributes. This method is blocking.
searchAsync
in interface LdapAsyncConnection
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 searchLdapException
- if some error occurredpublic SearchFuture searchAsync(SearchRequest searchRequest) throws LdapException
Scope : ONE DerefAlias : ALWAYS SizeLimit : none TimeLimit : none TypesOnly : false Attributes : all the user's attributes. This method is blocking.
searchAsync
in interface LdapAsyncConnection
searchRequest
- The search request to send to the serverLdapException
- if some error occurredpublic SearchCursor search(SearchRequest searchRequest) throws LdapException
search
in interface LdapConnection
searchRequest
- The search request object containing all the needed informationLdapException
- if some error occurredpublic void unBind() throws LdapException
unBind
in interface LdapConnection
LdapException
- if some error occurredpublic void setConnector(org.apache.mina.core.service.IoConnector connector)
connector
- The connector to usepublic void setTimeOut(long timeout)
setTimeOut
in interface LdapConnection
timeout
- The timeout, in millisecondspublic void exceptionCaught(org.apache.mina.core.session.IoSession session, Throwable cause) throws Exception
exceptionCaught
in interface org.apache.mina.core.service.IoHandler
exceptionCaught
in class org.apache.mina.core.service.IoHandlerAdapter
session
- The session we got the exception oncause
- The exception causeException
- If we have had another exceptionpublic void messageReceived(org.apache.mina.core.session.IoSession session, Object message) throws Exception
messageReceived
in interface org.apache.mina.core.service.IoHandler
messageReceived
in class org.apache.mina.core.service.IoHandlerAdapter
session
- The session that received a messagemessage
- The received messageException
- If there is some error while processing the messagepublic void modify(Entry entry, ModificationOperation modOp) throws LdapException
modify
in interface LdapConnection
entry
- the entry with the attributes to be modifiedmodOp
- the operation to be applied on all the attributes of the above entryLdapException
- in case of modify operation failure or timeout happenspublic void modify(Dn dn, Modification... modifications) throws LdapException
modify
in interface LdapConnection
dn
- The entry's distinguished namemodifications
- The list of modifications to be appliedLdapException
- in case of modify operation failure or timeout happenspublic void modify(String dn, Modification... modifications) throws LdapException
modify
in interface LdapConnection
dn
- The entry's distinguished name, it must be a valid distinguished name.modifications
- The list of modifications to be appliedLdapException
- in case of modify operation failure or timeout happenspublic ModifyResponse modify(ModifyRequest modRequest) throws LdapException
modify
in interface LdapConnection
modRequest
- the modify request objectLdapException
- in case of modify operation failure or timeout happenspublic ModifyFuture modifyAsync(ModifyRequest modRequest) throws LdapException
modifyAsync
in interface LdapAsyncConnection
modRequest
- the request for modify operationLdapException
- in case of modify operation failure or timeout happenspublic void rename(String entryDn, String newRdn) throws LdapException
rename
in interface LdapConnection
entryDn
- the target distinguished name.newRdn
- new relative distinguished name for the target distinguished name.LdapException
- if some error occurredLdapConnection.rename(String, String, boolean)
public void rename(Dn entryDn, Rdn newRdn) throws LdapException
rename
in interface LdapConnection
entryDn
- the target distinguished name.newRdn
- new relative distinguished name for the target distinguished name.LdapException
- if some error occurredLdapConnection.rename(Dn, Rdn, boolean)
public void rename(String entryDn, String newRdn, boolean deleteOldRdn) throws LdapException
rename
in interface LdapConnection
entryDn
- the target distinguished name.newRdn
- new relative distinguished name for the target distinguished name.deleteOldRdn
- flag to indicate whether to delete the old relative distinguished nameLdapException
- if some error occurredLdapConnection.rename(Dn, Rdn, boolean)
public void rename(Dn entryDn, Rdn newRdn, boolean deleteOldRdn) throws LdapException
rename
in interface LdapConnection
entryDn
- the target distinguished name.newRdn
- new relative distinguished name for the target distinguished name.deleteOldRdn
- flag to indicate whether to delete the old relative distinguished nameLdapException
- if some error occurredpublic void move(String entryDn, String newSuperiorDn) throws LdapException
move
in interface LdapConnection
entryDn
- the distinguished name of the target entrynewSuperiorDn
- distinguished name of the new parent/superiorLdapException
- if some error occurredLdapConnection.move(Dn, Dn)
public void move(Dn entryDn, Dn newSuperiorDn) throws LdapException
move
in interface LdapConnection
entryDn
- the distinguished name of the target entrynewSuperiorDn
- distinguished name of the new parent/superiorLdapException
- if some error occurredpublic void moveAndRename(Dn entryDn, Dn newDn) throws LdapException
moveAndRename
in interface LdapConnection
entryDn
- The original entry distinguished name.newDn
- The new entry distinguished name.LdapException
- if some error occurredLdapConnection.moveAndRename(Dn, Dn, boolean)
public void moveAndRename(String entryDn, String newDn) throws LdapException
moveAndRename
in interface LdapConnection
entryDn
- The original entry distinguished name.newDn
- The new entry distinguished name.LdapException
- if some error occurredLdapConnection.moveAndRename(Dn, Dn, boolean)
public void moveAndRename(Dn entryDn, Dn newDn, boolean deleteOldRdn) throws LdapException
moveAndRename
in interface LdapConnection
entryDn
- The original entry distinguished name.newDn
- The new entry distinguished name.deleteOldRdn
- Tells if the old relative distinguished name must be removedLdapException
- if some error occurredpublic void moveAndRename(String entryDn, String newDn, boolean deleteOldRdn) throws LdapException
moveAndRename
in interface LdapConnection
entryDn
- The original entry distinguished name.newDn
- The new entry distinguished name.deleteOldRdn
- Tells if the old relative distinguished name must be removedLdapException
- if some error occurredpublic ModifyDnResponse modifyDn(ModifyDnRequest modDnRequest) throws LdapException
modifyDn
in interface LdapConnection
modDnRequest
- the request objectLdapException
- if some error occurredpublic ModifyDnFuture modifyDnAsync(ModifyDnRequest modDnRequest) throws LdapException
modifyDnAsync
in interface LdapAsyncConnection
modDnRequest
- the requestLdapException
- if some error occurredpublic void delete(String dn) throws LdapException
delete
in interface LdapConnection
dn
- the target entry's distinguished name, it must be a valid distinguished name.LdapException
- If the distinguished name is not valid or if the deletion failedpublic void delete(Dn dn) throws LdapException
delete
in interface LdapConnection
dn
- the target entry's distinguished nameLdapException
- If the distinguished name is not valid or if the deletion failedpublic void deleteTree(Dn dn) throws LdapException
dn
- the target entry's DnLdapException
- If the Dn is not valid or if the deletion failedpublic void deleteTree(String dn) throws LdapException
dn
- the target entry's Dn as a StringLdapException
- If the Dn is not valid or if the deletion failedpublic DeleteResponse delete(DeleteRequest deleteRequest) throws LdapException
delete
in interface LdapConnection
deleteRequest
- the delete operation's requestLdapException
- If the distinguished name is not valid or if the deletion failedpublic DeleteFuture deleteAsync(DeleteRequest deleteRequest) throws LdapException
deleteAsync
in interface LdapAsyncConnection
deleteRequest
- the delete operation's requestLdapException
- If the Dn is not valid or if the deletion failedpublic boolean compare(String dn, String attributeName, String value) throws LdapException
compare
in interface LdapConnection
dn
- the target entry's distinguished name, it must be a valid distinguished name.attributeName
- the attribute's namevalue
- a String value with which the target entry's attribute value to be compared withtrue
if the value matches, false
otherwiseLdapException
- if some error occurredpublic boolean compare(String dn, String attributeName, byte[] value) throws LdapException
compare
in interface LdapConnection
dn
- the target entry's distinguished name, it must be a valid distinguished name.attributeName
- the attribute's namevalue
- a byte[] value with which the target entry's attribute value to be compared withtrue
if the value matches, false
otherwiseLdapException
- if some error occurredpublic boolean compare(String dn, String attributeName, Value value) throws LdapException
compare
in interface LdapConnection
dn
- the target entry's distinguished name, it must be a valid distinguished name.attributeName
- the attribute's namevalue
- a Value<?> value with which the target entry's attribute value to be compared withtrue
if the value matches, false
otherwiseLdapException
- if some error occurredpublic boolean compare(Dn dn, String attributeName, String value) throws LdapException
compare
in interface LdapConnection
dn
- the target entry's distinguished nameattributeName
- the attribute's namevalue
- a String value with which the target entry's attribute value to be compared withtrue
if the value matches, false
otherwiseLdapException
- if some error occurredpublic boolean compare(Dn dn, String attributeName, byte[] value) throws LdapException
compare
in interface LdapConnection
dn
- the target entry's distinguished nameattributeName
- the attribute's namevalue
- a byte[] value with which the target entry's attribute value to be compared withtrue
if the value matches, false
otherwiseLdapException
- if some error occurredpublic boolean compare(Dn dn, String attributeName, Value value) throws LdapException
compare
in interface LdapConnection
dn
- the target entry's distinguished nameattributeName
- the attribute's namevalue
- a Value<?> value with which the target entry's attribute value to be compared withtrue
if the value matches, false
otherwiseLdapException
- if some error occurredpublic CompareResponse compare(CompareRequest compareRequest) throws LdapException
compare
in interface LdapConnection
compareRequest
- the compare request which contains the target distinguished name,
attribute name and valueLdapException
- if some error occurredpublic CompareFuture compareAsync(CompareRequest compareRequest) throws LdapException
compareAsync
in interface LdapAsyncConnection
compareRequest
- the CompareRequest which contains the target Dn, attribute name and valueLdapException
- if some error occurredpublic ExtendedResponse extended(String oid) throws LdapException
extended
in interface LdapConnection
oid
- the object identifier of the extended operationLdapException
- if some error occurredLdapConnection.extended(org.apache.directory.api.asn1.util.Oid, byte[])
public ExtendedResponse extended(String oid, byte[] value) throws LdapException
extended
in interface LdapConnection
oid
- the object identifier of the extended operationvalue
- value to be used by the extended operation, can be a null valueLdapException
- if some error occurredLdapConnection.extended(org.apache.directory.api.asn1.util.Oid, byte[])
public ExtendedResponse extended(Oid oid) throws LdapException
extended
in interface LdapConnection
oid
- the object identifier of the extended operationLdapException
- if some error occurredLdapConnection.extended(org.apache.directory.api.asn1.util.Oid, byte[])
public ExtendedResponse extended(Oid oid, byte[] value) throws LdapException
extended
in interface LdapConnection
oid
- the object identifier of the extended operationvalue
- value to be used by the extended operation, can be a null valueLdapException
- if some error occurredpublic ExtendedResponse extended(ExtendedRequest extendedRequest) throws LdapException
extended
in interface LdapConnection
extendedRequest
- the extended operation's requestLdapException
- if the extended operation failedpublic ExtendedFuture extendedAsync(ExtendedRequest extendedRequest) throws LdapException
extendedAsync
in interface LdapAsyncConnection
extendedRequest
- the object containing the details of the extended operation to be performedLdapException
- if some error occurredpublic boolean exists(String dn) throws LdapException
exists
in interface LdapConnection
dn
- The distinguished name of the entry to check for existence, must be a valid distinguished name.true
if the entry exists, false
otherwise.
Note that if the entry exists but if the user does not have the permission to
read it, false
will also be returnedLdapException
- if some error occurredpublic boolean exists(Dn dn) throws LdapException
exists
in interface LdapConnection
dn
- The distinguished name of the entry to check for existencetrue
if the entry exists, false
otherwise.
Note that if the entry exists but if the user does not have the permission to
read it, false
will also be returnedLdapException
- if some error occurredpublic Entry getRootDse() throws LdapException
getRootDse
in interface LdapConnection
LdapException
- If the rootDSE can't be readpublic Entry getRootDse(String... attributes) throws LdapException
getRootDse
in interface LdapConnection
attributes
- The list of attributes to returnLdapException
- If the rootDSE can't be readpublic Entry lookup(Dn dn) throws LdapException
lookup
in interface LdapConnection
dn
- the distinguished name of the entry to be fetchedLdapException
- in case of any problems while searching for the distinguished name or if the returned
response contains a referralLdapConnection.lookup(Dn, String...)
public Entry lookup(String dn) throws LdapException
lookup
in interface LdapConnection
dn
- the distinguished name of the entry to be fetchedLdapException
- in case of any problems while searching for the distinguished name or
if the returned response contains a referralLdapConnection.lookup(String, String...)
public Entry lookup(Dn dn, String... attributes) throws LdapException
lookup
in interface LdapConnection
dn
- the distinguished name of the entry to be fetchedattributes
- the attributes to be returned along with entryLdapException
- in case of any problems while searching for the distinguished name
or if the returned response contains a referralpublic Entry lookup(Dn dn, Control[] controls, String... attributes) throws LdapException
lookup
in interface LdapConnection
dn
- the distinguished name of the entry to be fetchedcontrols
- the controls to useattributes
- the attributes to be returned along with entryLdapException
- in case of any problems while searching for the distinguished name
or if the returned response contains a referralpublic Entry lookup(String dn, String... attributes) throws LdapException
lookup
in interface LdapConnection
dn
- the distinguished name of the entry to be fetchedattributes
- the attributes to be returned along with entryLdapException
- in case of any problems while searching for the distinguished name
or if the returned response contains a referralLdapConnection.lookup(Dn, String...)
public Entry lookup(String dn, Control[] controls, String... attributes) throws LdapException
lookup
in interface LdapConnection
dn
- the distinguished name of the entry to be fetchedcontrols
- the controls to useattributes
- the attributes to be returned along with entryLdapException
- in case of any problems while searching for the distinguished name
or if the returned response contains a referralLdapConnection.lookup(Dn, String...)
public boolean isControlSupported(String controlOID) throws LdapException
isControlSupported
in interface LdapConnection
controlOID
- the OID of the controlLdapException
- if some error occurredpublic List<String> getSupportedControls() throws LdapException
getSupportedControls
in interface LdapConnection
LdapException
- if some error occurredpublic void loadSchema() throws LdapException
loadSchema
in interface LdapConnection
LdapException
- in case of problems while loading the schemapublic void loadSchemaRelaxed() throws LdapException
loadSchemaRelaxed
in interface LdapConnection
LdapException
- in case of problems while loading the schemapublic void loadSchema(SchemaLoader loader) throws LdapException
loader
- the SchemaLoader
to be used to load schemaLdapException
- If the schema loading failedpublic void addSchema(File schemaFile) throws LdapException
schemaFile
- the schema file in OpenLDAP schema formatLdapException
- in case of any errors while parsingpublic void addSchema(String schemaFileName) throws LdapException
schemaFileName
- The schema file name to addLdapException
- If the schema addition failedaddSchema(File)
public LdapApiService getCodecService()
getCodecService
in interface LdapConnection
public SchemaManager getSchemaManager()
getSchemaManager
in interface LdapConnection
public LdapConnectionConfig getConfig()
getConfig
in interface LdapAsyncConnection
public boolean isRequestCompleted(int messageId)
isRequestCompleted
in interface LdapConnection
messageId
- ID of the requestpublic boolean doesFutureExistFor(int messageId)
doesFutureExistFor
in interface LdapConnection
messageId
- ID of the requestpublic void addConnectionClosedEventListener(ConnectionClosedEventListener ccListener)
ccListener
- the connection closed listenerpublic void inputClosed(org.apache.mina.core.session.IoSession session) throws Exception
inputClosed
in interface org.apache.mina.core.service.IoHandler
inputClosed
in class org.apache.mina.core.service.IoHandlerAdapter
Exception
public void sessionCreated(org.apache.mina.core.session.IoSession session) throws Exception
sessionCreated
in interface org.apache.mina.core.service.IoHandler
sessionCreated
in class org.apache.mina.core.service.IoHandlerAdapter
session
- the newly created sessionException
public void sessionClosed(org.apache.mina.core.session.IoSession session) throws Exception
sessionClosed
in interface org.apache.mina.core.service.IoHandler
sessionClosed
in class org.apache.mina.core.service.IoHandlerAdapter
Exception
public void startTls() throws LdapException
LdapException
- If the StartTLS operation failedpublic BindFuture bindSasl(SaslRequest saslRequest) throws LdapException
saslRequest
- The SASL request object containing all the needed parametersBindResponse
containing the resultLdapException
- if some error occurredpublic BinaryAttributeDetector getBinaryAttributeDetector()
getBinaryAttributeDetector
in interface LdapConnection
public void setBinaryAttributeDetector(BinaryAttributeDetector binaryAttributeDetector)
setBinaryAttributeDetector
in interface LdapConnection
binaryAttributeDetector
- The Binary Attribute Detector to usepublic void setSchemaManager(SchemaManager schemaManager)
setSchemaManager
in interface LdapConnection
schemaManager
- The SchemaManager to setpublic org.apache.mina.transport.socket.SocketSessionConfig getSocketSessionConfig()
public void setSocketSessionConfig(org.apache.mina.transport.socket.SocketSessionConfig socketSessionConfig)
socketSessionConfig
- the socketSessionConfig to setpublic void event(org.apache.mina.core.session.IoSession session, org.apache.mina.filter.FilterEvent event) throws Exception
event
in interface org.apache.mina.core.service.IoHandler
event
in class org.apache.mina.core.service.IoHandlerAdapter
Exception
public SSLSession getSslSession()
SSLSession
associated with the connection.SSLSession
associated with the connection or null if the connection is not securedCopyright © 2003–2021 The Apache Software Foundation. All rights reserved.