LdapNetworkConnection (Apache Directory LDAP API Client API 1.0.0 API)

java.lang.Object
- org.apache.mina.core.service.IoHandlerAdapter
- - org.apache.directory.ldap.client.api.AbstractLdapConnection
  - - org.apache.directory.ldap.client.api.LdapNetworkConnection

All Implemented Interfaces:

Closeable, AutoCloseable, LdapAsyncConnection, LdapConnection, org.apache.mina.core.service.IoHandler
```
public class LdapNetworkConnection
extends AbstractLdapConnection
implements LdapAsyncConnection
```
This class is the base for every operations sent or received to and from a LDAP server. A connection instance is necessary to send requests to the server. The connection is valid until either the client closes it, the server closes it or the client does an unbind.

Author:

Apache Directory Project

Field Summary

Fields
Modifier and Type	Field and Description
`private AtomicBoolean`	`authenticated` A flag indicating that the BindRequest has been issued and successfully authenticated the user
`private List<ConnectionClosedEventListener>`	`conCloseListeners` a list of listeners interested in getting notified when the connection's session gets closed cause of network issues
`private LdapConnectionConfig`	`config` configuration object for the connection
`private AtomicBoolean`	`connected` A flag indicating that the connection is connected or not
`private org.apache.mina.transport.socket.SocketSessionConfig`	`connectionConfig` The Sockect configuratio
`private org.apache.mina.core.service.IoConnector`	`connector` The connector open with the remote server
`private ReentrantLock`	`connectorMutex` A mutex used to avoid a double close of the connector
`private static String`	`EXCEPTION_KEY` The exception stored in the session if we've got one
`private Map<Integer,ResponseFuture<? extends org.apache.directory.api.ldap.model.message.Response>>`	`futureMap` a map to hold the ResponseFutures for all operations
`private org.apache.mina.core.filterchain.IoFilter`	`ldapProtocolFilter` The Ldap codec protocol filter
`private org.apache.mina.core.session.IoSession`	`ldapSession` The created session, created when we open a connection with the Ldap server.
`private static org.slf4j.Logger`	`LOG` logger for reporting errors that might not be handled properly upstream
`(package private) static String`	`NO_RESPONSE_ERROR`
`private org.apache.directory.api.ldap.model.entry.Entry`	`rootDse` The ROOT DSE entry
`private static String`	`SSL_FILTER_KEY` the SslFilter key
`private List<String>`	`supportedControls` list of controls supported by the server
`(package private) static String`	`TIME_OUT_ERROR`
`private long`	`timeout` The timeout used for response we are waiting for

Fields inherited from class org.apache.directory.ldap.client.api.AbstractLdapConnection
codec, messageId, schemaManager

Constructor Summary

Constructors
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, org.apache.directory.api.ldap.codec.api.LdapApiService ldapApiService)` Creates a new LdapNetworkConnection instance
`LdapNetworkConnection(LdapConnectionConfig config)` Creates a new instance of LdapConnection with the given connection configuration.
`LdapNetworkConnection(LdapConnectionConfig config, org.apache.directory.api.ldap.codec.api.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, org.apache.directory.api.ldap.codec.api.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, org.apache.directory.api.ldap.codec.api.LdapApiService ldapApiService)` Create a new instance of a LdapConnection on a given server and a given port.
`LdapNetworkConnection(String server, int port, org.apache.directory.api.ldap.codec.api.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, org.apache.directory.api.ldap.codec.api.LdapApiService ldapApiService)` Creates a new LdapNetworkConnection instance

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`abandon(org.apache.directory.api.ldap.model.message.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.
`private void`	`abandonInternal(org.apache.directory.api.ldap.model.message.AbandonRequest abandonRequest)` Internal AbandonRequest handling
`org.apache.directory.api.ldap.model.message.AddResponse`	`add(org.apache.directory.api.ldap.model.message.AddRequest addRequest)` Add an entry present in the `AddRequest` to the server.
`void`	`add(org.apache.directory.api.ldap.model.entry.Entry entry)` Add an entry to the server.
`AddFuture`	`addAsync(org.apache.directory.api.ldap.model.message.AddRequest addRequest)` Add an entry present in the AddRequest to the server.
`AddFuture`	`addAsync(org.apache.directory.api.ldap.model.entry.Entry entry)` Add an entry to the server asynchronously.
`void`	`addConnectionClosedEventListener(ConnectionClosedEventListener ccListener)` Adds the connection closed event listener.
`private void`	`addControls(org.apache.directory.api.ldap.model.message.Message codec, org.apache.directory.api.ldap.model.message.Message message)`
`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)`
`private void`	`addSslFilter()` adds `SslFilter` to the IOConnector or IOSession's filter chain
`private void`	`addToFutureMap(int messageId, ResponseFuture<? extends org.apache.directory.api.ldap.model.message.Response> future)`
`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.
`org.apache.directory.api.ldap.model.message.BindResponse`	`bind(org.apache.directory.api.ldap.model.message.BindRequest bindRequest)` Bind to the server using a bind request object.
`org.apache.directory.api.ldap.model.message.BindResponse`	`bind(SaslCramMd5Request request)` Bind to the server using a CramMd5Request object.
`org.apache.directory.api.ldap.model.message.BindResponse`	`bind(SaslDigestMd5Request request)` Bind to the server using a DigestMd5Request object.
`org.apache.directory.api.ldap.model.message.BindResponse`	`bind(SaslGssApiRequest request)` Bind to the server using a GssApiRequest object.
`BindFuture`	`bindAsync()` Asynchronous Bind on a server, using the LdapConnectionConfig informations.
`BindFuture`	`bindAsync(org.apache.directory.api.ldap.model.message.BindRequest bindRequest)` Do an asynchronous bind, based on a BindRequest.
`BindFuture`	`bindAsync(org.apache.directory.api.ldap.model.name.Dn name)` Asynchronous unauthenticated authentication Bind on a server.
`BindFuture`	`bindAsync(org.apache.directory.api.ldap.model.name.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.
`private BindFuture`	`bindSasl(SaslRequest saslRequest)` Process the SASL Bind.
`org.apache.directory.api.ldap.model.message.BindResponse`	`bindSaslPlain(String authcid, String credentials)` SASL PLAIN Bind on a server.
`org.apache.directory.api.ldap.model.message.BindResponse`	`bindSaslPlain(String authzid, String authcid, String credentials)` SASL PLAIN Bind on a server.
`private static LdapConnectionConfig`	`buildConfig(String server, int port, boolean useSsl)`
`private void`	`checkSession()` Check that a session is valid, ie we can send requests to the server
`private void`	`clearMaps()` clears the async listener, responseQueue and future mapppings to the corresponding request IDs
`void`	`close()` Disconnect from the remote LDAP server.
`org.apache.directory.api.ldap.model.message.CompareResponse`	`compare(org.apache.directory.api.ldap.model.message.CompareRequest compareRequest)` Compares an entry's attribute's value with that of the given value.
`boolean`	`compare(org.apache.directory.api.ldap.model.name.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(org.apache.directory.api.ldap.model.name.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(org.apache.directory.api.ldap.model.name.Dn dn, String attributeName, org.apache.directory.api.ldap.model.entry.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, org.apache.directory.api.ldap.model.entry.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(org.apache.directory.api.ldap.model.message.CompareRequest compareRequest)` Asynchronously compares an entry's attribute's value with that of the given value
`boolean`	`connect()` Connect to the remote LDAP server.
`private org.apache.directory.api.ldap.model.message.BindRequest`	`createBindRequest(org.apache.directory.api.ldap.model.name.Dn name, byte[] credentials)` Create a Simple BindRequest ready to be sent.
`private org.apache.directory.api.ldap.model.message.BindRequest`	`createBindRequest(String name, byte[] credentials)` Create a Simple BindRequest ready to be sent.
`private void`	`createConnector()` Create the connector
`private String`	`createKrb5ConfFile(String realmName, String kdcHost, int kdcPort)` method to write the kerberos config in the standard MIT kerberos format This is required cause the JGSS api is not able to recognize the port value set in the system property java.security.krb5.kdc this issue makes it impossible to set a kdc running non standard ports (other than 88) e.g localhost:6088
`org.apache.directory.api.ldap.model.message.DeleteResponse`	`delete(org.apache.directory.api.ldap.model.message.DeleteRequest deleteRequest)` Performs a delete operation based on the delete request object.
`void`	`delete(org.apache.directory.api.ldap.model.name.Dn dn)` Deletes the entry with the given distinguished name.
`void`	`delete(String dn)` Deletes the entry with the given distinguished name.
`DeleteFuture`	`deleteAsync(org.apache.directory.api.ldap.model.message.DeleteRequest deleteRequest)` Performs an asynchronous delete operation based on the delete request object.
`void`	`deleteTree(org.apache.directory.api.ldap.model.name.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`	`exceptionCaught(org.apache.mina.core.session.IoSession session, Throwable cause)` Handle the exception we got.
`boolean`	`exists(org.apache.directory.api.ldap.model.name.Dn dn)` Tells if an Entry exists in the server.
`boolean`	`exists(String dn)` Tells if an entry exists in the server.
`org.apache.directory.api.ldap.model.message.ExtendedResponse`	`extended(org.apache.directory.api.ldap.model.message.ExtendedRequest extendedRequest)` Performs an extended operation based on the extended request object.
`org.apache.directory.api.ldap.model.message.ExtendedResponse`	`extended(org.apache.directory.api.asn1.util.Oid oid)` Sends a extended operation request to the server with the given OID and no value.
`org.apache.directory.api.ldap.model.message.ExtendedResponse`	`extended(org.apache.directory.api.asn1.util.Oid oid, byte[] value)` Sends a extended operation request to the server with the given OID and value.
`org.apache.directory.api.ldap.model.message.ExtendedResponse`	`extended(String oid)` Sends a extended operation request to the server with the given OID and no value.
`org.apache.directory.api.ldap.model.message.ExtendedResponse`	`extended(String oid, byte[] value)` Sends a extended operation request to the server with the given OID and value.
`ExtendedFuture`	`extendedAsync(org.apache.directory.api.ldap.model.message.ExtendedRequest extendedRequest)` Asynchronously requests the server to perform an extended operation based on the given request.
`private void`	`fetchRootDSE(String... explicitAttributes)` fetches the rootDSE from the server
`org.apache.directory.api.ldap.codec.api.BinaryAttributeDetector`	`getBinaryAttributeDetector()`
`org.apache.directory.api.ldap.codec.api.LdapApiService`	`getCodecService()` Gets the LDAP CODEC service responsible for encoding and decoding messages.
`LdapConnectionConfig`	`getConfig()` gives the configuration information of the connection
`org.apache.mina.transport.socket.SocketSessionConfig`	`getConnectionConfig()`
`private ResponseFuture<? extends org.apache.directory.api.ldap.model.message.Response>`	`getFromFutureMap(int messageId)`
`org.apache.directory.api.ldap.model.entry.Entry`	`getRootDse()` Get back the RooDSE from the connected server.
`org.apache.directory.api.ldap.model.entry.Entry`	`getRootDse(String... attributes)` Get back the RooDSE from the connected server.
`org.apache.directory.api.ldap.model.schema.SchemaManager`	`getSchemaManager()`
`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.
`private boolean`	`isNoticeOfDisconnect(org.apache.directory.api.ldap.model.message.Message message)` Check if the message is a NoticeOfDisconnect message
`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(org.apache.directory.api.ldap.model.schema.registries.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.
`org.apache.directory.api.ldap.model.entry.Entry`	`lookup(org.apache.directory.api.ldap.model.name.Dn dn)` Searches for an entry having the given distinguished name.
`org.apache.directory.api.ldap.model.entry.Entry`	`lookup(org.apache.directory.api.ldap.model.name.Dn dn, org.apache.directory.api.ldap.model.message.Control[] controls, String... attributes)` Searches for an entry having the given distinguished name.
`org.apache.directory.api.ldap.model.entry.Entry`	`lookup(org.apache.directory.api.ldap.model.name.Dn dn, String... attributes)` Searches for an entry having the given distinguished name.
`org.apache.directory.api.ldap.model.entry.Entry`	`lookup(String dn)` Searches for an entry having the given distinguished name.
`org.apache.directory.api.ldap.model.entry.Entry`	`lookup(String dn, org.apache.directory.api.ldap.model.message.Control[] controls, String... attributes)` Searches for an entry having the given distinguished name.
`org.apache.directory.api.ldap.model.entry.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(org.apache.directory.api.ldap.model.name.Dn dn, org.apache.directory.api.ldap.model.entry.Modification... modifications)` Applies all the modifications to the entry specified by its distinguished name.
`void`	`modify(org.apache.directory.api.ldap.model.entry.Entry entry, org.apache.directory.api.ldap.model.entry.ModificationOperation modOp)` Modifies all the attributes present in the entry by applying the same operation.
`org.apache.directory.api.ldap.model.message.ModifyResponse`	`modify(org.apache.directory.api.ldap.model.message.ModifyRequest modRequest)` Performs an modify operation based on the modifications present in the modify request.
`void`	`modify(String dn, org.apache.directory.api.ldap.model.entry.Modification... modifications)` Applies all the modifications to the entry specified by its distinguished name.
`ModifyFuture`	`modifyAsync(org.apache.directory.api.ldap.model.message.ModifyRequest modRequest)` Performs an asynchronous modify operation based on the modifications present in the ModifyRequest.
`org.apache.directory.api.ldap.model.message.ModifyDnResponse`	`modifyDn(org.apache.directory.api.ldap.model.message.ModifyDnRequest modDnRequest)` Performs the modifyDn operation based on the given request object.
`ModifyDnFuture`	`modifyDnAsync(org.apache.directory.api.ldap.model.message.ModifyDnRequest modDnRequest)` Performs the modifyDn operation based on the given ModifyDnRequest.
`void`	`move(org.apache.directory.api.ldap.model.name.Dn entryDn, org.apache.directory.api.ldap.model.name.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(org.apache.directory.api.ldap.model.name.Dn entryDn, org.apache.directory.api.ldap.model.name.Dn newDn)` Moves and renames the given entryDn.
`void`	`moveAndRename(org.apache.directory.api.ldap.model.name.Dn entryDn, org.apache.directory.api.ldap.model.name.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.
`private ResponseFuture<? extends org.apache.directory.api.ldap.model.message.Response>`	`peekFromFutureMap(int messageId)`
`private void`	`removeFromFutureMaps(int msgId)` removes the Objects associated with the given message ID from future and response queue maps
`void`	`rename(org.apache.directory.api.ldap.model.name.Dn entryDn, org.apache.directory.api.ldap.model.name.Rdn newRdn)` Renames the given entryDn with new relative distinguished name and deletes the old relative distinguished name.
`void`	`rename(org.apache.directory.api.ldap.model.name.Dn entryDn, org.apache.directory.api.ldap.model.name.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.
`org.apache.directory.api.ldap.model.cursor.EntryCursor`	`search(org.apache.directory.api.ldap.model.name.Dn baseDn, String filter, org.apache.directory.api.ldap.model.message.SearchScope scope, String... attributes)` Do a search, on the base object, using the given filter and scope.
`org.apache.directory.api.ldap.model.cursor.SearchCursor`	`search(org.apache.directory.api.ldap.model.message.SearchRequest searchRequest)` Performs search using a search request object.
`org.apache.directory.api.ldap.model.cursor.EntryCursor`	`search(String baseDn, String filter, org.apache.directory.api.ldap.model.message.SearchScope scope, String... attributes)` Do a search, on the base object, using the given filter and scope.
`SearchFuture`	`searchAsync(org.apache.directory.api.ldap.model.name.Dn baseDn, String filter, org.apache.directory.api.ldap.model.message.SearchScope scope, String... attributes)` Do an asynchronous search, on the base object, using the given filter.
`SearchFuture`	`searchAsync(org.apache.directory.api.ldap.model.message.SearchRequest searchRequest)` Do a search, on the base object, using the given filter.
`SearchFuture`	`searchAsync(String baseDn, String filter, org.apache.directory.api.ldap.model.message.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(org.apache.directory.api.ldap.codec.api.BinaryAttributeDetector binaryAttributeDetector)` Sets the object responsible for the detection of binary attributes.
`void`	`setConnectionConfig(org.apache.mina.transport.socket.SocketSessionConfig connectionConfig)`
`void`	`setConnector(org.apache.mina.core.service.IoConnector connector)` Set the connector to use.
`void`	`setSchemaManager(org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager)` sets a SchemaManager to be used by this connection
`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.
`void`	`unBind()` UnBind from a server.
`private void`	`writeRequest(org.apache.directory.api.ldap.model.message.Request request)` a reusable code block to be used in various bind methods

Methods inherited from class org.apache.directory.ldap.client.api.AbstractLdapConnection
bind, bind, bind, bind, createBindRequest

Methods inherited from class org.apache.mina.core.service.IoHandlerAdapter
messageSent, sessionIdle, sessionOpened

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.directory.ldap.client.api.LdapConnection
bind, bind, bind, bind

- Field Detail
  - LOG
```
private static final org.slf4j.Logger LOG
```
    logger for reporting errors that might not be handled properly upstream
  - timeout
```
private long timeout
```
    The timeout used for response we are waiting for
  - config
```
private LdapConnectionConfig config
```
    configuration object for the connection
  - connectionConfig
```
private org.apache.mina.transport.socket.SocketSessionConfig connectionConfig
```
    The Sockect configuratio
  - connector
```
private org.apache.mina.core.service.IoConnector connector
```
    The connector open with the remote server
  - connectorMutex
```
private ReentrantLock connectorMutex
```
    A mutex used to avoid a double close of the connector
  - ldapSession
```
private org.apache.mina.core.session.IoSession ldapSession
```
    The created session, created when we open a connection with the Ldap server.
  - futureMap
```
private Map<Integer,ResponseFuture<? extends org.apache.directory.api.ldap.model.message.Response>> futureMap
```
    a map to hold the ResponseFutures for all operations
  - supportedControls
```
private List<String> supportedControls
```
    list of controls supported by the server
  - rootDse
```
private org.apache.directory.api.ldap.model.entry.Entry rootDse
```
    The ROOT DSE entry
  - authenticated
```
private AtomicBoolean authenticated
```
    A flag indicating that the BindRequest has been issued and successfully authenticated the user
  - connected
```
private AtomicBoolean connected
```
    A flag indicating that the connection is connected or not
  - conCloseListeners
```
private List<ConnectionClosedEventListener> conCloseListeners
```
    a list of listeners interested in getting notified when the connection's session gets closed cause of network issues
  - ldapProtocolFilter
```
private org.apache.mina.core.filterchain.IoFilter ldapProtocolFilter
```
    The Ldap codec protocol filter
  - SSL_FILTER_KEY
```
private static final String SSL_FILTER_KEY
```
    the SslFilter key
    
    See Also:
    
    Constant Field Values
  - EXCEPTION_KEY
```
private static final String EXCEPTION_KEY
```
    The exception stored in the session if we've got one
    
    See Also:
    
    Constant Field Values
  - TIME_OUT_ERROR
```
static final String TIME_OUT_ERROR
```
    See Also:
    
    Constant Field Values
  - NO_RESPONSE_ERROR
```
static final String NO_RESPONSE_ERROR
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - LdapNetworkConnection
```
public LdapNetworkConnection()
```
    Create a new instance of a LdapConnection on localhost, port 389.
  - LdapNetworkConnection
```
public LdapNetworkConnection(LdapConnectionConfig config)
```
    Creates a new instance of LdapConnection with the given connection configuration.
    
    Parameters:
    
    config - the configuration of the LdapConnection
  - LdapNetworkConnection
```
public LdapNetworkConnection(LdapConnectionConfig config,
                             org.apache.directory.api.ldap.codec.api.LdapApiService ldapApiService)
```
    Creates a new LdapNetworkConnection instance
    
    Parameters:
    
    config - The configuration to use
    
    ldapApiService - The LDAP API Service to use
  - LdapNetworkConnection
```
public LdapNetworkConnection(boolean useSsl)
```
    Create a new instance of a LdapConnection on localhost, port 389 if the SSL flag is off, or 636 otherwise.
    
    Parameters:
    
    useSsl - A flag to tell if it's a SSL connection or not.
  - LdapNetworkConnection
```
public LdapNetworkConnection(boolean useSsl,
                             org.apache.directory.api.ldap.codec.api.LdapApiService ldapApiService)
```
    Creates a new LdapNetworkConnection instance
    
    Parameters:
    
    useSsl - If we are going to create a secure connection or not
    
    ldapApiService - The LDAP API Service to use
  - LdapNetworkConnection
```
public LdapNetworkConnection(String server)
```
    Create a new instance of a LdapConnection on a given server, using the default port (389).
    
    Parameters:
    
    server - The server we want to be connected to. If null or empty, we will default to LocalHost.
  - LdapNetworkConnection
```
public LdapNetworkConnection(String server,
                             org.apache.directory.api.ldap.codec.api.LdapApiService ldapApiService)
```
    Creates a new LdapNetworkConnection instance
    
    Parameters:
    
    server - The server we want to be connected to. If null or empty, we will default to LocalHost.
    
    ldapApiService - The LDAP API Service to use
  - LdapNetworkConnection
```
public 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.
    
    Parameters:
    
    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.
  - LdapNetworkConnection
```
public LdapNetworkConnection(String server,
                             boolean useSsl,
                             org.apache.directory.api.ldap.codec.api.LdapApiService ldapApiService)
```
    Creates a new LdapNetworkConnection instance
    
    Parameters:
    
    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 use
  - LdapNetworkConnection
```
public LdapNetworkConnection(String server,
                             int port)
```
    Create a new instance of a LdapConnection on a given server and a given port. We don't use ssl.
    
    Parameters:
    
    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 on
  - LdapNetworkConnection
```
public LdapNetworkConnection(String server,
                             int port,
                             org.apache.directory.api.ldap.codec.api.LdapApiService ldapApiService)
```
    Create a new instance of a LdapConnection on a given server and a given port. We don't use ssl.
    
    Parameters:
    
    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 on
    
    ldapApiService - The LDAP API Service to use
  - LdapNetworkConnection
```
public LdapNetworkConnection(String server,
                             int port,
                             boolean useSsl)
```
    Create a new instance of a LdapConnection on a given server, and a give port. We set the SSL flag accordingly to the last parameter.
    
    Parameters:
    
    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 to
    
    useSsl - A flag to tell if it's a SSL connection or not.
  - LdapNetworkConnection
```
public LdapNetworkConnection(String server,
                             int port,
                             TrustManager... trustManagers)
```
    Create a new instance of a LdapConnection on a given server, and a give port. This SSL connection will use the provided TrustManagers
    
    Parameters:
    
    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 to
    
    trustManagers - The TrustManager to use
  - LdapNetworkConnection
```
public LdapNetworkConnection(String server,
                             int port,
                             boolean useSsl,
                             org.apache.directory.api.ldap.codec.api.LdapApiService ldapApiService)
```
    Create a new instance of a LdapConnection on a given server and a given port. We don't use ssl.
    
    Parameters:
    
    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 on
    
    useSsl - A flag to tell if it's a SSL connection or not.
    
    ldapApiService - The LDAP API Service to use
- Method Detail
  - isConnected
```
public boolean isConnected()
```
    Check if the connection is established
    
    Specified by:
    
    isConnected in interface LdapConnection
    
    Returns:
    
    true if the connection is established
  - isAuthenticated
```
public boolean isAuthenticated()
```
    Check if the connection is authenticated.
    
    Specified by:
    
    isAuthenticated in interface LdapConnection
    
    Returns:
    
    true if the connection is authenticated
  - isSecured
```
public boolean isSecured()
```
    Tells if the connection is using a secured channel
    
    Returns:
    
    true if the session is using a secured channel
  - checkSession
```
private void checkSession()
                   throws InvalidConnectionException
```
    Check that a session is valid, ie we can send requests to the server
    
    Throws:
    
    Exception - If the session is not valid
    
    InvalidConnectionException
  - addToFutureMap
```
private void addToFutureMap(int messageId,
                            ResponseFuture<? extends org.apache.directory.api.ldap.model.message.Response> future)
```
  - getFromFutureMap
```
private ResponseFuture<? extends org.apache.directory.api.ldap.model.message.Response> getFromFutureMap(int messageId)
```
  - peekFromFutureMap
```
private ResponseFuture<? extends org.apache.directory.api.ldap.model.message.Response> peekFromFutureMap(int messageId)
```
  - getTimeout
```
public long getTimeout(long connectionTimoutInMS,
                       int searchTimeLimitInSeconds)
```
    Get the largest timeout from the search time limit and the connection timeout.
    
    Parameters:
    
    connectionTimoutInMS - Connection timeout
    
    searchTimeLimitInSeconds - Search timeout
    
    Returns:
    
    The largest timeout
  - buildConfig
```
private static LdapConnectionConfig buildConfig(String server,
                                                int port,
                                                boolean useSsl)
```
  - createConnector
```
private void createConnector()
                      throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Create the connector
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException
  - connect
```
public boolean connect()
                throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Connect to the remote LDAP server.
    
    Specified by:
    
    connect in interface LdapConnection
    
    Returns:
    
    true if the connection is established, false otherwise
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - if some error occurred
  - close
```
public void close()
           throws IOException
```
    Disconnect from the remote LDAP server.
    
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
    
    Specified by:
    
    close in interface LdapConnection
    
    Throws:
    
    IOException - if some I/O error occurs
  - add
```
public void add(org.apache.directory.api.ldap.model.entry.Entry entry)
         throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Add an entry to the server.
    
    Specified by:
    
    add in interface LdapConnection
    
    Parameters:
    
    entry - The entry to add
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - if some error occurred
  - addAsync
```
public AddFuture addAsync(org.apache.directory.api.ldap.model.entry.Entry entry)
                   throws org.apache.directory.api.ldap.model.exception.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.
    
    Specified by:
    
    addAsync in interface LdapAsyncConnection
    
    Parameters:
    
    entry - The entry to add
    
    Returns:
    
    the add operation's future
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - if some error occurred
  - add
```
public org.apache.directory.api.ldap.model.message.AddResponse add(org.apache.directory.api.ldap.model.message.AddRequest addRequest)
                                                            throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Add an entry present in the AddRequest to the server.
    
    Specified by:
    
    add in interface LdapConnection
    
    Parameters:
    
    addRequest - the request object containing an entry and controls (if any)
    
    Returns:
    
    the add operation's response
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - if some error occurred
  - addAsync
```
public AddFuture addAsync(org.apache.directory.api.ldap.model.message.AddRequest addRequest)
                   throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Add an entry present in the AddRequest to the server.
    
    Specified by:
    
    addAsync in interface LdapAsyncConnection
    
    Parameters:
    
    addRequest - the request object containing an entry and controls(if any)
    
    Returns:
    
    the add operation's future
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - if some error occurred
  - abandon
```
public void abandon(int messageId)
```
    Abandons a request submitted to the server for performing a particular operation. The abandonRequest is always non-blocking, because no response is expected
    
    Specified by:
    
    abandon in interface LdapConnection
    
    Parameters:
    
    messageId - the ID of the request message sent to the server
  - abandon
```
public void abandon(org.apache.directory.api.ldap.model.message.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). The abandonRequest is always non-blocking, because no response is expected.
    
    Specified by:
    
    abandon in interface LdapConnection
    
    Parameters:
    
    abandonRequest - the abandon operation's request
  - abandonInternal
```
private void abandonInternal(org.apache.directory.api.ldap.model.message.AbandonRequest abandonRequest)
```
    Internal AbandonRequest handling
  - bind
```
public void bind()
          throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Bind on a server, using the LdapConnectionConfig information of this connection.
    
    Specified by:
    
    bind in interface LdapConnection
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - if some error occurred
  - anonymousBind
```
public void anonymousBind()
                   throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Anonymous bind on a server.
    
    Specified by:
    
    anonymousBind in interface LdapConnection
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - if some error occurred
  - bindAsync
```
public BindFuture bindAsync()
                     throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Asynchronous Bind on a server, using the LdapConnectionConfig informations.
    
    Specified by:
    
    bindAsync in interface LdapAsyncConnection
    
    Returns:
    
    the bind operation's future
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - if some error occurred
  - anonymousBindAsync
```
public BindFuture anonymousBindAsync()
                              throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Anonymous asynchronous Bind on a server.
    
    Specified by:
    
    anonymousBindAsync in interface LdapAsyncConnection
    
    Returns:
    
    the bind operation's future
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - if some error occurred
  - bindAsync
```
public BindFuture bindAsync(String name)
                     throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Asynchronous unauthenticated authentication bind
    
    Parameters:
    
    name - The name we use to authenticate the user. It must be a valid Dn
    
    Returns:
    
    The BindResponse LdapResponse
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - if some error occurred
  - bindAsync
```
public BindFuture bindAsync(String name,
                            String credentials)
                     throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Simple asynchronous Bind on a server.
    
    Specified by:
    
    bindAsync in interface LdapAsyncConnection
    
    Parameters:
    
    name - The name we use to authenticate the user, it must be a valid Dn
    
    credentials - The password, it can't be null
    
    Returns:
    
    the bind operation's future
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - if some error occurred
  - bindAsync
```
public BindFuture bindAsync(org.apache.directory.api.ldap.model.name.Dn name)
                     throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Asynchronous unauthenticated authentication Bind on a server.
    
    Parameters:
    
    name - The name we use to authenticate the user. It must be a valid Dn
    
    Returns:
    
    The BindResponse LdapResponse
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - if some error occurred
  - bindAsync
```
public BindFuture bindAsync(org.apache.directory.api.ldap.model.name.Dn name,
                            String credentials)
                     throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Simple asynchronous Bind on a server.
    
    Specified by:
    
    bindAsync in interface LdapAsyncConnection
    
    Parameters:
    
    name - The name we use to authenticate the user, it must be a valid Dn
    
    credentials - The password, it can't be null
    
    Returns:
    
    the bind operation's future
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - if some error occurred
  - bind
```
public org.apache.directory.api.ldap.model.message.BindResponse bind(org.apache.directory.api.ldap.model.message.BindRequest bindRequest)
                                                              throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Bind to the server using a bind request object.
    
    Specified by:
    
    bind in interface LdapConnection
    
    Parameters:
    
    bindRequest - The bind request object containing all the needed parameters
    
    Returns:
    
    A BindResponse containing the result
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - if some error occurred
  - createBindRequest
```
private org.apache.directory.api.ldap.model.message.BindRequest createBindRequest(String name,
                                                                                  byte[] credentials)
                                                                           throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Create a Simple BindRequest ready to be sent.
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException
  - createBindRequest
```
private org.apache.directory.api.ldap.model.message.BindRequest createBindRequest(org.apache.directory.api.ldap.model.name.Dn name,
                                                                                  byte[] credentials)
                                                                           throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Create a Simple BindRequest ready to be sent.
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException
  - bindAsync
```
public BindFuture bindAsync(org.apache.directory.api.ldap.model.message.BindRequest bindRequest)
                     throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Do an asynchronous bind, based on a BindRequest.
    
    Specified by:
    
    bindAsync in interface LdapAsyncConnection
    
    Parameters:
    
    bindRequest - The BindRequest to send
    
    Returns:
    
    the bind operation's future
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - if some error occurred
  - bindSaslPlain
```
public org.apache.directory.api.ldap.model.message.BindResponse bindSaslPlain(String authcid,
                                                                              String credentials)
                                                                       throws org.apache.directory.api.ldap.model.exception.LdapException
```
    SASL PLAIN Bind on a server.
    
    Parameters:
    
    authcid - The Authentication identity
    
    credentials - The password. It can't be null
    
    Returns:
    
    The BindResponse LdapResponse
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - if some error occurred
  - bindSaslPlain
```
public org.apache.directory.api.ldap.model.message.BindResponse bindSaslPlain(String authzid,
                                                                              String authcid,
                                                                              String credentials)
                                                                       throws org.apache.directory.api.ldap.model.exception.LdapException
```
    SASL PLAIN Bind on a server.
    
    Parameters:
    
    authzid - The Authorization identity
    
    authcid - The Authentication identity
    
    credentials - The password. It can't be null
    
    Returns:
    
    The BindResponse LdapResponse
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - if some error occurred
  - bind
```
public org.apache.directory.api.ldap.model.message.BindResponse bind(SaslCramMd5Request request)
                                                              throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Bind to the server using a CramMd5Request object.
    
    Parameters:
    
    request - The CramMd5Request POJO containing all the needed parameters
    
    Returns:
    
    A LdapResponse containing the result
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - if some error occurred
  - bindAsync
```
public BindFuture bindAsync(SaslRequest request)
                     throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Do an asynchronous bind, based on a SaslPlainRequest.
    
    Parameters:
    
    request - The SaslPlainRequest POJO containing all the needed parameters
    
    Returns:
    
    The bind operation's future
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - if some error occurred
  - bind
```
public org.apache.directory.api.ldap.model.message.BindResponse bind(SaslDigestMd5Request request)
                                                              throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Bind to the server using a DigestMd5Request object.
    
    Parameters:
    
    request - The DigestMd5Request POJO containing all the needed parameters
    
    Returns:
    
    A LdapResponse containing the result
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - if some error occurred
  - bind
```
public org.apache.directory.api.ldap.model.message.BindResponse bind(SaslGssApiRequest request)
                                                              throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Bind to the server using a GssApiRequest object.
    
    Parameters:
    
    request - The GssApiRequest POJO containing all the needed parameters
    
    Returns:
    
    A LdapResponse containing the result
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - if some error occurred
  - bindAsync
```
public BindFuture bindAsync(SaslGssApiRequest request)
                     throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Do an asynchronous bind, based on a GssApiRequest.
    
    Parameters:
    
    request - The GssApiRequest POJO containing all the needed parameters
    
    Returns:
    
    The bind operation's future
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - if some error occurred
  - search
```
public org.apache.directory.api.ldap.model.cursor.EntryCursor search(org.apache.directory.api.ldap.model.name.Dn baseDn,
                                                                     String filter,
                                                                     org.apache.directory.api.ldap.model.message.SearchScope scope,
                                                                     String... attributes)
                                                              throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Do a search, on the base object, using the given filter and scope. The SearchRequest parameters default to
    - DerefAlias : ALWAYS
    - SizeLimit : none
    - TimeLimit : none
    - TypesOnly : false
    Specified by:
    
    search in interface LdapConnection
    
    Parameters:
    
    baseDn - The base for the search. It must be a valid distinguished name and can't be emtpy
    
    filter - The filter to use for this search. It can't be empty
    
    scope - The search scope : OBJECT, ONELEVEL or SUBTREE
    
    attributes - The attributes to use for this search
    
    Returns:
    
    An EntryCursor on the result.
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - if some error occurred
  - search
```
public org.apache.directory.api.ldap.model.cursor.EntryCursor search(String baseDn,
                                                                     String filter,
                                                                     org.apache.directory.api.ldap.model.message.SearchScope scope,
                                                                     String... attributes)
                                                              throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Do a search, on the base object, using the given filter and scope. The SearchRequest parameters default to
    - DerefAlias : ALWAYS
    - SizeLimit : none
    - TimeLimit : none
    - TypesOnly : false
    Specified by:
    
    search in interface LdapConnection
    
    Parameters:
    
    baseDn - The base for the search. It must be a valid distinguished name, and can't be emtpy
    
    filter - The filter to use for this search. It can't be empty
    
    scope - The search scope : OBJECT, ONELEVEL or SUBTREE
    
    attributes - The attributes to use for this search
    
    Returns:
    
    An EntryCursor on the result.
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - if some error occurred
  - searchAsync
```
public SearchFuture searchAsync(org.apache.directory.api.ldap.model.name.Dn baseDn,
                                String filter,
                                org.apache.directory.api.ldap.model.message.SearchScope scope,
                                String... attributes)
                         throws org.apache.directory.api.ldap.model.exception.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.
 
```
    Specified by:
    
    searchAsync in interface LdapAsyncConnection
    
    Parameters:
    
    baseDn - The base for the search, it must be a valid Dn, and can't be empty
    
    filter - The filter to use for this search, it can't be empty
    
    scope - The search scope : OBJECT, ONELEVEL or SUBTREE
    
    attributes - The attributes for this search
    
    Returns:
    
    the search operation's future
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - if some error occurred
  - searchAsync
```
public SearchFuture searchAsync(String baseDn,
                                String filter,
                                org.apache.directory.api.ldap.model.message.SearchScope scope,
                                String... attributes)
                         throws org.apache.directory.api.ldap.model.exception.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.
 
```
    Specified by:
    
    searchAsync in interface LdapAsyncConnection
    
    Parameters:
    
    baseDn - The base for the search, it must be a valid Dn, and can't be emtpy
    
    filter - The filter to use for this search, it can't be empty
    
    scope - The search scope : OBJECT, ONELEVEL or SUBTREE
    
    attributes - The attributes for this search
    
    Returns:
    
    the search operation's future
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - if some error occurred
  - searchAsync
```
public SearchFuture searchAsync(org.apache.directory.api.ldap.model.message.SearchRequest searchRequest)
                         throws org.apache.directory.api.ldap.model.exception.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.
 
```
    Specified by:
    
    searchAsync in interface LdapAsyncConnection
    
    Parameters:
    
    searchRequest - The search request to send to the server
    
    Returns:
    
    the search operation's future
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - if some error occurred
  - search
```
public org.apache.directory.api.ldap.model.cursor.SearchCursor search(org.apache.directory.api.ldap.model.message.SearchRequest searchRequest)
                                                               throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Performs search using a search request object.
    
    Specified by:
    
    search in interface LdapConnection
    
    Parameters:
    
    searchRequest - The search request object containing all the needed information
    
    Returns:
    
    a search cursor on the result.
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - if some error occurred
  - unBind
```
public void unBind()
            throws org.apache.directory.api.ldap.model.exception.LdapException
```
    UnBind from a server. This is a request which expects no response.
    
    Specified by:
    
    unBind in interface LdapConnection
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - if some error occurred
  - setConnector
```
public void setConnector(org.apache.mina.core.service.IoConnector connector)
```
    Set the connector to use.
    
    Parameters:
    
    connector - The connector to use
  - setTimeOut
```
public void setTimeOut(long timeout)
```
    Set the timeout for the responses. We won't wait longer than this value.
    
    Specified by:
    
    setTimeOut in interface LdapConnection
    
    Parameters:
    
    timeout - The timeout, in milliseconds
  - exceptionCaught
```
public void exceptionCaught(org.apache.mina.core.session.IoSession session,
                            Throwable cause)
                     throws Exception
```
    Handle the exception we got.
    
    Specified by:
    
    exceptionCaught in interface org.apache.mina.core.service.IoHandler
    
    Overrides:
    
    exceptionCaught in class org.apache.mina.core.service.IoHandlerAdapter
    
    Parameters:
    
    session - The session we got the exception on
    
    cause - The exception cause
    
    Throws:
    
    Exception - The t
  - isNoticeOfDisconnect
```
private boolean isNoticeOfDisconnect(org.apache.directory.api.ldap.model.message.Message message)
```
    Check if the message is a NoticeOfDisconnect message
  - messageReceived
```
public void messageReceived(org.apache.mina.core.session.IoSession session,
                            Object message)
                     throws Exception
```
    Handle the incoming LDAP messages. This is where we feed the cursor for search requests, or call the listener.
    
    Specified by:
    
    messageReceived in interface org.apache.mina.core.service.IoHandler
    
    Overrides:
    
    messageReceived in class org.apache.mina.core.service.IoHandlerAdapter
    
    Parameters:
    
    session - The session that received a message
    
    message - The received message
    
    Throws:
    
    Exception - If there is some error while processing the message
  - modify
```
public void modify(org.apache.directory.api.ldap.model.entry.Entry entry,
                   org.apache.directory.api.ldap.model.entry.ModificationOperation modOp)
            throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Modifies all the attributes present in the entry by applying the same operation.
    
    Specified by:
    
    modify in interface LdapConnection
    
    Parameters:
    
    entry - the entry with the attributes to be modified
    
    modOp - the operation to be applied on all the attributes of the above entry
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - in case of modify operation failure or timeout happens
  - modify
```
public void modify(org.apache.directory.api.ldap.model.name.Dn dn,
                   org.apache.directory.api.ldap.model.entry.Modification... modifications)
            throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Applies all the modifications to the entry specified by its distinguished name.
    
    Specified by:
    
    modify in interface LdapConnection
    
    Parameters:
    
    dn - The entry's distinguished name
    
    modifications - The list of modifications to be applied
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - in case of modify operation failure or timeout happens
  - modify
```
public void modify(String dn,
                   org.apache.directory.api.ldap.model.entry.Modification... modifications)
            throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Applies all the modifications to the entry specified by its distinguished name.
    
    Specified by:
    
    modify in interface LdapConnection
    
    Parameters:
    
    dn - The entry's distinguished name, it must be a valid distinguished name.
    
    modifications - The list of modifications to be applied
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - in case of modify operation failure or timeout happens
  - modify
```
public org.apache.directory.api.ldap.model.message.ModifyResponse modify(org.apache.directory.api.ldap.model.message.ModifyRequest modRequest)
                                                                  throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Performs an modify operation based on the modifications present in the modify request.
    
    Specified by:
    
    modify in interface LdapConnection
    
    Parameters:
    
    modRequest - the modify request object
    
    Returns:
    
    the modify operation's response
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - in case of modify operation failure or timeout happens
  - modifyAsync
```
public ModifyFuture modifyAsync(org.apache.directory.api.ldap.model.message.ModifyRequest modRequest)
                         throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Performs an asynchronous modify operation based on the modifications present in the ModifyRequest.
    
    Specified by:
    
    modifyAsync in interface LdapAsyncConnection
    
    Parameters:
    
    modRequest - the request for modify operation
    
    Returns:
    
    the modify operation's future
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - in case of modify operation failure or timeout happens
  - rename
```
public void rename(String entryDn,
                   String newRdn)
            throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Renames the given entryDn with new relative distinguished name and deletes the old relative distinguished name.
    
    Specified by:
    
    rename in interface LdapConnection
    
    Parameters:
    
    entryDn - the target distinguished name.
    
    newRdn - new relative distinguished name for the target distinguished name.
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - if some error occurred
    
    See Also:
    
    LdapConnection.rename(String, String, boolean)
  - rename
```
public void rename(org.apache.directory.api.ldap.model.name.Dn entryDn,
                   org.apache.directory.api.ldap.model.name.Rdn newRdn)
            throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Renames the given entryDn with new relative distinguished name and deletes the old relative distinguished name.
    
    Specified by:
    
    rename in interface LdapConnection
    
    Parameters:
    
    entryDn - the target distinguished name.
    
    newRdn - new relative distinguished name for the target distinguished name.
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - if some error occurred
    
    See Also:
    
    LdapConnection.rename(Dn, Rdn, boolean)
  - rename
```
public void rename(String entryDn,
                   String newRdn,
                   boolean deleteOldRdn)
            throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Renames the given entryDn with new relative distinguished name and deletes the old relative distinguished name if deleteOldRdn is set to true.
    
    Specified by:
    
    rename in interface LdapConnection
    
    Parameters:
    
    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 name
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - if some error occurred
    
    See Also:
    
    LdapConnection.rename(Dn, Rdn, boolean)
  - rename
```
public void rename(org.apache.directory.api.ldap.model.name.Dn entryDn,
                   org.apache.directory.api.ldap.model.name.Rdn newRdn,
                   boolean deleteOldRdn)
            throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Renames the given entryDn with new relative distinguished name and deletes the old relative distinguished name if deleteOldRdn is set to true.
    
    Specified by:
    
    rename in interface LdapConnection
    
    Parameters:
    
    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 name
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - if some error occurred
  - move
```
public void move(String entryDn,
                 String newSuperiorDn)
          throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Moves the given entry distinguished name under the new superior distinguished name.
    
    Specified by:
    
    move in interface LdapConnection
    
    Parameters:
    
    entryDn - the distinguished name of the target entry
    
    newSuperiorDn - distinguished name of the new parent/superior
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - if some error occurred
    
    See Also:
    
    LdapConnection.move(Dn, Dn)
  - move
```
public void move(org.apache.directory.api.ldap.model.name.Dn entryDn,
                 org.apache.directory.api.ldap.model.name.Dn newSuperiorDn)
          throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Moves the given entry distinguished name under the new superior distinguished name.
    
    Specified by:
    
    move in interface LdapConnection
    
    Parameters:
    
    entryDn - the distinguished name of the target entry
    
    newSuperiorDn - distinguished name of the new parent/superior
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - if some error occurred
  - moveAndRename
```
public void moveAndRename(org.apache.directory.api.ldap.model.name.Dn entryDn,
                          org.apache.directory.api.ldap.model.name.Dn newDn)
                   throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Moves and renames the given entryDn. The old relative distinguished name will be deleted.
    
    Specified by:
    
    moveAndRename in interface LdapConnection
    
    Parameters:
    
    entryDn - The original entry distinguished name.
    
    newDn - The new entry distinguished name.
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - if some error occurred
    
    See Also:
    
    LdapConnection.moveAndRename(Dn, Dn, boolean)
  - moveAndRename
```
public void moveAndRename(String entryDn,
                          String newDn)
                   throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Moves and renames the given entry distinguished name. The old relative distinguished name will be deleted
    
    Specified by:
    
    moveAndRename in interface LdapConnection
    
    Parameters:
    
    entryDn - The original entry distinguished name.
    
    newDn - The new entry distinguished name.
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - if some error occurred
    
    See Also:
    
    LdapConnection.moveAndRename(Dn, Dn, boolean)
  - moveAndRename
```
public void moveAndRename(org.apache.directory.api.ldap.model.name.Dn entryDn,
                          org.apache.directory.api.ldap.model.name.Dn newDn,
                          boolean deleteOldRdn)
                   throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Moves and renames the given entryDn. The old relative distinguished name will be deleted if requested.
    
    Specified by:
    
    moveAndRename in interface LdapConnection
    
    Parameters:
    
    entryDn - The original entry distinguished name.
    
    newDn - The new entry distinguished name.
    
    deleteOldRdn - Tells if the old relative distinguished name must be removed
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - if some error occurred
  - moveAndRename
```
public void moveAndRename(String entryDn,
                          String newDn,
                          boolean deleteOldRdn)
                   throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Moves and renames the given entryDn. The old relative distinguished name will be deleted if requested.
    
    Specified by:
    
    moveAndRename in interface LdapConnection
    
    Parameters:
    
    entryDn - The original entry distinguished name.
    
    newDn - The new entry distinguished name.
    
    deleteOldRdn - Tells if the old relative distinguished name must be removed
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - if some error occurred
  - modifyDn
```
public org.apache.directory.api.ldap.model.message.ModifyDnResponse modifyDn(org.apache.directory.api.ldap.model.message.ModifyDnRequest modDnRequest)
                                                                      throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Performs the modifyDn operation based on the given request object.
    
    Specified by:
    
    modifyDn in interface LdapConnection
    
    Parameters:
    
    modDnRequest - the request object
    
    Returns:
    
    modifyDn operation's response
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - if some error occurred
  - modifyDnAsync
```
public ModifyDnFuture modifyDnAsync(org.apache.directory.api.ldap.model.message.ModifyDnRequest modDnRequest)
                             throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Performs the modifyDn operation based on the given ModifyDnRequest.
    
    Specified by:
    
    modifyDnAsync in interface LdapAsyncConnection
    
    Parameters:
    
    modDnRequest - the request
    
    Returns:
    
    modifyDn operation's future
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - if some error occurred
  - delete
```
public void delete(String dn)
            throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Deletes the entry with the given distinguished name.
    
    Specified by:
    
    delete in interface LdapConnection
    
    Parameters:
    
    dn - the target entry's distinguished name, it must be a valid distinguished name.
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - If the distinguished name is not valid or if the deletion failed
  - delete
```
public void delete(org.apache.directory.api.ldap.model.name.Dn dn)
            throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Deletes the entry with the given distinguished name.
    
    Specified by:
    
    delete in interface LdapConnection
    
    Parameters:
    
    dn - the target entry's distinguished name
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - If the distinguished name is not valid or if the deletion failed
  - deleteTree
```
public void deleteTree(org.apache.directory.api.ldap.model.name.Dn dn)
                throws org.apache.directory.api.ldap.model.exception.LdapException
```
    deletes the entry with the given Dn, and all its children
    
    Parameters:
    
    dn - the target entry's Dn
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - If the Dn is not valid or if the deletion failed
  - deleteTree
```
public void deleteTree(String dn)
                throws org.apache.directory.api.ldap.model.exception.LdapException
```
    deletes the entry with the given Dn, and all its children
    
    Parameters:
    
    dn - the target entry's Dn as a String
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - If the Dn is not valid or if the deletion failed
  - delete
```
public org.apache.directory.api.ldap.model.message.DeleteResponse delete(org.apache.directory.api.ldap.model.message.DeleteRequest deleteRequest)
                                                                  throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Performs a delete operation based on the delete request object.
    
    Specified by:
    
    delete in interface LdapConnection
    
    Parameters:
    
    deleteRequest - the delete operation's request
    
    Returns:
    
    delete operation's response
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - If the distinguished name is not valid or if the deletion failed
  - deleteAsync
```
public DeleteFuture deleteAsync(org.apache.directory.api.ldap.model.message.DeleteRequest deleteRequest)
                         throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Performs an asynchronous delete operation based on the delete request object.
    
    Specified by:
    
    deleteAsync in interface LdapAsyncConnection
    
    Parameters:
    
    deleteRequest - the delete operation's request
    
    Returns:
    
    delete operation's future
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - If the Dn is not valid or if the deletion failed
  - compare
```
public boolean compare(String dn,
                       String attributeName,
                       String value)
                throws org.apache.directory.api.ldap.model.exception.LdapException
```
    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.
    
    Specified by:
    
    compare in interface LdapConnection
    
    Parameters:
    
    dn - the target entry's distinguished name, it must be a valid distinguished name.
    
    attributeName - the attribute's name
    
    value - a String value with which the target entry's attribute value to be compared with
    
    Returns:
    
    true if the value matches, false otherwise
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - if some error occurred
  - compare
```
public boolean compare(String dn,
                       String attributeName,
                       byte[] value)
                throws org.apache.directory.api.ldap.model.exception.LdapException
```
    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.
    
    Specified by:
    
    compare in interface LdapConnection
    
    Parameters:
    
    dn - the target entry's distinguished name, it must be a valid distinguished name.
    
    attributeName - the attribute's name
    
    value - a byte[] value with which the target entry's attribute value to be compared with
    
    Returns:
    
    true if the value matches, false otherwise
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - if some error occurred
  - compare
```
public boolean compare(String dn,
                       String attributeName,
                       org.apache.directory.api.ldap.model.entry.Value<?> value)
                throws org.apache.directory.api.ldap.model.exception.LdapException
```
    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.
    
    Specified by:
    
    compare in interface LdapConnection
    
    Parameters:
    
    dn - the target entry's distinguished name, it must be a valid distinguished name.
    
    attributeName - the attribute's name
    
    value - a Value<?> value with which the target entry's attribute value to be compared with
    
    Returns:
    
    true if the value matches, false otherwise
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - if some error occurred
  - compare
```
public boolean compare(org.apache.directory.api.ldap.model.name.Dn dn,
                       String attributeName,
                       String value)
                throws org.apache.directory.api.ldap.model.exception.LdapException
```
    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.
    
    Specified by:
    
    compare in interface LdapConnection
    
    Parameters:
    
    dn - the target entry's distinguished name
    
    attributeName - the attribute's name
    
    value - a String value with which the target entry's attribute value to be compared with
    
    Returns:
    
    true if the value matches, false otherwise
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - if some error occurred
  - compare
```
public boolean compare(org.apache.directory.api.ldap.model.name.Dn dn,
                       String attributeName,
                       byte[] value)
                throws org.apache.directory.api.ldap.model.exception.LdapException
```
    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.
    
    Specified by:
    
    compare in interface LdapConnection
    
    Parameters:
    
    dn - the target entry's distinguished name
    
    attributeName - the attribute's name
    
    value - a byte[] value with which the target entry's attribute value to be compared with
    
    Returns:
    
    true if the value matches, false otherwise
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - if some error occurred
  - compare
```
public boolean compare(org.apache.directory.api.ldap.model.name.Dn dn,
                       String attributeName,
                       org.apache.directory.api.ldap.model.entry.Value<?> value)
                throws org.apache.directory.api.ldap.model.exception.LdapException
```
    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.
    
    Specified by:
    
    compare in interface LdapConnection
    
    Parameters:
    
    dn - the target entry's distinguished name
    
    attributeName - the attribute's name
    
    value - a Value<?> value with which the target entry's attribute value to be compared with
    
    Returns:
    
    true if the value matches, false otherwise
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - if some error occurred
  - compare
```
public org.apache.directory.api.ldap.model.message.CompareResponse compare(org.apache.directory.api.ldap.model.message.CompareRequest compareRequest)
                                                                    throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Compares an entry's attribute's value with that of the given value.
    
    Specified by:
    
    compare in interface LdapConnection
    
    Parameters:
    
    compareRequest - the compare request which contains the target distinguished name, attribute name and value
    
    Returns:
    
    compare operation's response
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - if some error occurred
  - compareAsync
```
public CompareFuture compareAsync(org.apache.directory.api.ldap.model.message.CompareRequest compareRequest)
                           throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Asynchronously compares an entry's attribute's value with that of the given value
    
    Specified by:
    
    compareAsync in interface LdapAsyncConnection
    
    Parameters:
    
    compareRequest - the CompareRequest which contains the target Dn, attribute name and value
    
    Returns:
    
    compare operation's future
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - if some error occurred
  - extended
```
public org.apache.directory.api.ldap.model.message.ExtendedResponse extended(String oid)
                                                                      throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Sends a extended operation request to the server with the given OID and no value.
    
    Specified by:
    
    extended in interface LdapConnection
    
    Parameters:
    
    oid - the object identifier of the extended operation
    
    Returns:
    
    extended operation's response
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - if some error occurred
    
    See Also:
    
    LdapConnection.extended(org.apache.directory.api.asn1.util.Oid, byte[])
  - extended
```
public org.apache.directory.api.ldap.model.message.ExtendedResponse extended(String oid,
                                                                             byte[] value)
                                                                      throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Sends a extended operation request to the server with the given OID and value.
    
    Specified by:
    
    extended in interface LdapConnection
    
    Parameters:
    
    oid - the object identifier of the extended operation
    
    value - value to be used by the extended operation, can be a null value
    
    Returns:
    
    extended operation's response
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - if some error occurred
    
    See Also:
    
    LdapConnection.extended(org.apache.directory.api.asn1.util.Oid, byte[])
  - extended
```
public org.apache.directory.api.ldap.model.message.ExtendedResponse extended(org.apache.directory.api.asn1.util.Oid oid)
                                                                      throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Sends a extended operation request to the server with the given OID and no value.
    
    Specified by:
    
    extended in interface LdapConnection
    
    Parameters:
    
    oid - the object identifier of the extended operation
    
    Returns:
    
    extended operation's response
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - if some error occurred
    
    See Also:
    
    LdapConnection.extended(org.apache.directory.api.asn1.util.Oid, byte[])
  - extended
```
public org.apache.directory.api.ldap.model.message.ExtendedResponse extended(org.apache.directory.api.asn1.util.Oid oid,
                                                                             byte[] value)
                                                                      throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Sends a extended operation request to the server with the given OID and value.
    
    Specified by:
    
    extended in interface LdapConnection
    
    Parameters:
    
    oid - the object identifier of the extended operation
    
    value - value to be used by the extended operation, can be a null value
    
    Returns:
    
    extended operation's response
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - if some error occurred
  - extended
```
public org.apache.directory.api.ldap.model.message.ExtendedResponse extended(org.apache.directory.api.ldap.model.message.ExtendedRequest extendedRequest)
                                                                      throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Performs an extended operation based on the extended request object.
    
    Specified by:
    
    extended in interface LdapConnection
    
    Parameters:
    
    extendedRequest - the extended operation's request
    
    Returns:
    
    Extended operation's response
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - if the extended operation failed
  - extendedAsync
```
public ExtendedFuture extendedAsync(org.apache.directory.api.ldap.model.message.ExtendedRequest extendedRequest)
                             throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Asynchronously requests the server to perform an extended operation based on the given request.
    
    Specified by:
    
    extendedAsync in interface LdapAsyncConnection
    
    Parameters:
    
    extendedRequest - the object containing the details of the extended operation to be performed
    
    Returns:
    
    extended operation's Future
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - if some error occurred
  - exists
```
public boolean exists(String dn)
               throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Tells if an entry exists in the server.
    
    Specified by:
    
    exists in interface LdapConnection
    
    Parameters:
    
    dn - The distinguished name of the entry to check for existence, must be a valid distinguished name.
    
    Returns:
    
    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 returned
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - if some error occurred
  - exists
```
public boolean exists(org.apache.directory.api.ldap.model.name.Dn dn)
               throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Tells if an Entry exists in the server.
    
    Specified by:
    
    exists in interface LdapConnection
    
    Parameters:
    
    dn - The distinguished name of the entry to check for existence
    
    Returns:
    
    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 returned
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - if some error occurred
  - getRootDse
```
public org.apache.directory.api.ldap.model.entry.Entry getRootDse()
                                                           throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Get back the RooDSE from the connected server. Only the user attributes are returned.
    
    Specified by:
    
    getRootDse in interface LdapConnection
    
    Returns:
    
    The Entry containing all the information about the rootDSE
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - If the rootDSE can't be read
  - getRootDse
```
public org.apache.directory.api.ldap.model.entry.Entry getRootDse(String... attributes)
                                                           throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Get back the RooDSE from the connected server. The user can provide the list of attributes he wants to get back. Sending "*" will return all the user attributes, sending "+" will return all the operational attributes.
    
    Specified by:
    
    getRootDse in interface LdapConnection
    
    Parameters:
    
    attributes - The list of attributes to return
    
    Returns:
    
    The Entry containing all the information about the rootDSE
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - If the rootDSE can't be read
  - lookup
```
public org.apache.directory.api.ldap.model.entry.Entry lookup(org.apache.directory.api.ldap.model.name.Dn dn)
                                                       throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Searches for an entry having the given distinguished name.
    
    Specified by:
    
    lookup in interface LdapConnection
    
    Parameters:
    
    dn - the distinguished name of the entry to be fetched
    
    Returns:
    
    the Entry with the given distinguished name or null if no entry exists with that distinguished name.
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - in case of any problems while searching for the distinguished name or if the returned response contains a referral
    
    See Also:
    
    LdapConnection.lookup(Dn, String...)
  - lookup
```
public org.apache.directory.api.ldap.model.entry.Entry lookup(String dn)
                                                       throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Searches for an entry having the given distinguished name.
    
    Specified by:
    
    lookup in interface LdapConnection
    
    Parameters:
    
    dn - the distinguished name of the entry to be fetched
    
    Returns:
    
    the Entry with the given distinguished name or null if no entry exists with that distinguished name.
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - in case of any problems while searching for the distinguished name or if the returned response contains a referral
    
    See Also:
    
    LdapConnection.lookup(String, String...)
  - lookup
```
public org.apache.directory.api.ldap.model.entry.Entry lookup(org.apache.directory.api.ldap.model.name.Dn dn,
                                                              String... attributes)
                                                       throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Searches for an entry having the given distinguished name.
    
    Specified by:
    
    lookup in interface LdapConnection
    
    Parameters:
    
    dn - the distinguished name of the entry to be fetched
    
    attributes - the attributes to be returned along with entry
    
    Returns:
    
    the Entry with the given distinguished name or null if no entry exists with that distinguished name.
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - in case of any problems while searching for the distinguished name or if the returned response contains a referral
  - lookup
```
public org.apache.directory.api.ldap.model.entry.Entry lookup(org.apache.directory.api.ldap.model.name.Dn dn,
                                                              org.apache.directory.api.ldap.model.message.Control[] controls,
                                                              String... attributes)
                                                       throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Searches for an entry having the given distinguished name.
    
    Specified by:
    
    lookup in interface LdapConnection
    
    Parameters:
    
    dn - the distinguished name of the entry to be fetched
    
    controls - the controls to use
    
    attributes - the attributes to be returned along with entry
    
    Returns:
    
    the Entry with the given distinguished name or null if no entry exists with that distinguished name.
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - in case of any problems while searching for the distinguished name or if the returned response contains a referral
  - lookup
```
public org.apache.directory.api.ldap.model.entry.Entry lookup(String dn,
                                                              String... attributes)
                                                       throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Searches for an entry having the given distinguished name.
    
    Specified by:
    
    lookup in interface LdapConnection
    
    Parameters:
    
    dn - the distinguished name of the entry to be fetched
    
    attributes - the attributes to be returned along with entry
    
    Returns:
    
    the Entry with the given distinguished name or null if no entry exists with that distinguished name.
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - in case of any problems while searching for the distinguished name or if the returned response contains a referral
    
    See Also:
    
    LdapConnection.lookup(Dn, String...)
  - lookup
```
public org.apache.directory.api.ldap.model.entry.Entry lookup(String dn,
                                                              org.apache.directory.api.ldap.model.message.Control[] controls,
                                                              String... attributes)
                                                       throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Searches for an entry having the given distinguished name.
    
    Specified by:
    
    lookup in interface LdapConnection
    
    Parameters:
    
    dn - the distinguished name of the entry to be fetched
    
    controls - the controls to use
    
    attributes - the attributes to be returned along with entry
    
    Returns:
    
    the Entry with the given distinguished name or null if no entry exists with that distinguished name.
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - in case of any problems while searching for the distinguished name or if the returned response contains a referral
    
    See Also:
    
    LdapConnection.lookup(Dn, String...)
  - isControlSupported
```
public boolean isControlSupported(String controlOID)
                           throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Checks if a control with the given OID is supported.
    
    Specified by:
    
    isControlSupported in interface LdapConnection
    
    Parameters:
    
    controlOID - the OID of the control
    
    Returns:
    
    true if the control is supported, false otherwise
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - if some error occurred
  - getSupportedControls
```
public List<String> getSupportedControls()
                                  throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Get the Controls supported by server.
    
    Specified by:
    
    getSupportedControls in interface LdapConnection
    
    Returns:
    
    a list of control OIDs supported by server
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - if some error occurred
  - loadSchema
```
public void loadSchema()
                throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Loads all the default schemas that are bundled with the API.
    
    Note: This method enables all schemas prior to loading.
    
    Specified by:
    
    loadSchema in interface LdapConnection
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - in case of problems while loading the schema
  - loadSchemaRelaxed
```
public void loadSchemaRelaxed()
                       throws org.apache.directory.api.ldap.model.exception.LdapException
```
    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.
    
    Specified by:
    
    loadSchemaRelaxed in interface LdapConnection
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - in case of problems while loading the schema
  - loadSchema
```
public void loadSchema(org.apache.directory.api.ldap.model.schema.registries.SchemaLoader loader)
                throws org.apache.directory.api.ldap.model.exception.LdapException
```
    loads schema using the specified schema loader
    
    Parameters:
    
    loader - the SchemaLoader to be used to load schema
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - If the schema loading failed
  - addSchema
```
public void addSchema(File schemaFile)
               throws org.apache.directory.api.ldap.model.exception.LdapException
```
    parses the given schema file present in OpenLDAP schema format and adds all the SchemaObjects present in it to the SchemaManager
    
    Parameters:
    
    schemaFile - the schema file in OpenLDAP schema format
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - in case of any errors while parsing
  - addSchema
```
public void addSchema(String schemaFileName)
               throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Parameters:
    
    schemaFileName - The schema file name to add
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - If the schema addition failed
    
    See Also:
    
    addSchema(File)
  - getCodecService
```
public org.apache.directory.api.ldap.codec.api.LdapApiService getCodecService()
```
    Gets the LDAP CODEC service responsible for encoding and decoding messages.
    
    Specified by:
    
    getCodecService in interface LdapConnection
    
    Returns:
    
    The LDAP CODEC service.
  - getSchemaManager
```
public org.apache.directory.api.ldap.model.schema.SchemaManager getSchemaManager()
```
    Specified by:
    
    getSchemaManager in interface LdapConnection
    
    Returns:
    
    The SchemaManager associated with this LdapConection if any
  - fetchRootDSE
```
private void fetchRootDSE(String... explicitAttributes)
                   throws org.apache.directory.api.ldap.model.exception.LdapException
```
    fetches the rootDSE from the server
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException
  - getConfig
```
public LdapConnectionConfig getConfig()
```
    gives the configuration information of the connection
    
    Specified by:
    
    getConfig in interface LdapAsyncConnection
    
    Returns:
    
    the configuration of the connection
  - addControls
```
private void addControls(org.apache.directory.api.ldap.model.message.Message codec,
                         org.apache.directory.api.ldap.model.message.Message message)
```
  - removeFromFutureMaps
```
private void removeFromFutureMaps(int msgId)
```
    removes the Objects associated with the given message ID from future and response queue maps
    
    Parameters:
    
    msgId - id of the message
  - clearMaps
```
private void clearMaps()
```
    clears the async listener, responseQueue and future mapppings to the corresponding request IDs
  - doesFutureExistFor
```
public boolean doesFutureExistFor(int messageId)
```
    Checks if there is a ResponseFuture associated with the given message ID.
    
    Specified by:
    
    doesFutureExistFor in interface LdapConnection
    
    Parameters:
    
    messageId - ID of the request
    
    Returns:
    
    true if there is a non-null future exists, false otherwise
  - isRequestCompleted
```
public boolean isRequestCompleted(int messageId)
```
    Checks if a request has been completed, or not.
    
    Specified by:
    
    isRequestCompleted in interface LdapConnection
    
    Parameters:
    
    messageId - ID of the request
    
    Returns:
    
    true if the request has been completed, false is still being processed
  - addConnectionClosedEventListener
```
public void addConnectionClosedEventListener(ConnectionClosedEventListener ccListener)
```
    Adds the connection closed event listener.
    
    Parameters:
    
    ccListener - the connection closed listener
  - inputClosed
```
public void inputClosed(org.apache.mina.core.session.IoSession session)
                 throws Exception
```
    Specified by:
    
    inputClosed in interface org.apache.mina.core.service.IoHandler
    
    Overrides:
    
    inputClosed in class org.apache.mina.core.service.IoHandlerAdapter
    
    Throws:
    
    Exception
  - sessionCreated
```
public void sessionCreated(org.apache.mina.core.session.IoSession session)
                    throws Exception
```
    This method is called when a new session is created. We will store some informations that the session will need to process incoming requests.
    
    Specified by:
    
    sessionCreated in interface org.apache.mina.core.service.IoHandler
    
    Overrides:
    
    sessionCreated in class org.apache.mina.core.service.IoHandlerAdapter
    
    Parameters:
    
    session - the newly created session
    
    Throws:
    
    Exception
  - sessionClosed
```
public void sessionClosed(org.apache.mina.core.session.IoSession session)
                   throws Exception
```
    Specified by:
    
    sessionClosed in interface org.apache.mina.core.service.IoHandler
    
    Overrides:
    
    sessionClosed in class org.apache.mina.core.service.IoHandlerAdapter
    
    Throws:
    
    Exception
  - startTls
```
public void startTls()
              throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Sends the StartTLS extended request to server and adds a security layer upon receiving a response with successful result. Note that we will use the default LDAP connection.
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException - If the StartTLS operation failed
  - addSslFilter
```
private void addSslFilter()
                   throws org.apache.directory.api.ldap.model.exception.LdapException
```
    adds SslFilter to the IOConnector or IOSession's filter chain
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException
  - bindSasl
```
private BindFuture bindSasl(SaslRequest saslRequest)
                     throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Process the SASL Bind. It's a dialog with the server, we will send a first BindRequest, receive a response and the, if this response is a challenge, continue by sending a new BindRequest with the requested informations.
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException
  - writeRequest
```
private void writeRequest(org.apache.directory.api.ldap.model.message.Request request)
                   throws org.apache.directory.api.ldap.model.exception.LdapException
```
    a reusable code block to be used in various bind methods
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException
  - createKrb5ConfFile
```
private String createKrb5ConfFile(String realmName,
                                  String kdcHost,
                                  int kdcPort)
                           throws IOException
```
    method to write the kerberos config in the standard MIT kerberos format This is required cause the JGSS api is not able to recognize the port value set in the system property java.security.krb5.kdc this issue makes it impossible to set a kdc running non standard ports (other than 88) e.g localhost:6088
```
 [libdefaults]
     default_realm = EXAMPLE.COM

 [realms]
     EXAMPLE.COM = {
         kdc = localhost:6088
     }
 
```
    Returns:
    
    the full path of the config file
    
    Throws:
    
    IOException
  - getBinaryAttributeDetector
```
public org.apache.directory.api.ldap.codec.api.BinaryAttributeDetector getBinaryAttributeDetector()
```
    Specified by:
    
    getBinaryAttributeDetector in interface LdapConnection
    
    Returns:
    
    the object responsible for the detection of binary attributes
  - setBinaryAttributeDetector
```
public void setBinaryAttributeDetector(org.apache.directory.api.ldap.codec.api.BinaryAttributeDetector binaryAttributeDetector)
```
    Sets the object responsible for the detection of binary attributes.
    
    Specified by:
    
    setBinaryAttributeDetector in interface LdapConnection
    
    Parameters:
    
    binaryAttributeDetector - The Binary Attribute Detector to use
  - setSchemaManager
```
public void setSchemaManager(org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager)
```
    sets a SchemaManager to be used by this connection
    
    Specified by:
    
    setSchemaManager in interface LdapConnection
    
    Parameters:
    
    schemaManager - The SchemaManager to set
  - getConnectionConfig
```
public org.apache.mina.transport.socket.SocketSessionConfig getConnectionConfig()
```
    Returns:
    
    the connectionConfig
  - setConnectionConfig
```
public void setConnectionConfig(org.apache.mina.transport.socket.SocketSessionConfig connectionConfig)
```
    Parameters:
    
    connectionConfig - the connectionConfig to set

Class LdapNetworkConnection

Field Summary

Fields inherited from class org.apache.directory.ldap.client.api.AbstractLdapConnection

Constructor Summary

Method Summary

Methods inherited from class org.apache.directory.ldap.client.api.AbstractLdapConnection

Methods inherited from class org.apache.mina.core.service.IoHandlerAdapter

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.directory.ldap.client.api.LdapConnection

Field Detail

LOG

timeout

config

connectionConfig

connector

connectorMutex

ldapSession

futureMap

supportedControls

rootDse

authenticated

connected

conCloseListeners

ldapProtocolFilter

SSL_FILTER_KEY

EXCEPTION_KEY

TIME_OUT_ERROR

NO_RESPONSE_ERROR

Constructor Detail

LdapNetworkConnection

LdapNetworkConnection

LdapNetworkConnection

LdapNetworkConnection

LdapNetworkConnection

LdapNetworkConnection

LdapNetworkConnection

LdapNetworkConnection

LdapNetworkConnection

LdapNetworkConnection

LdapNetworkConnection

LdapNetworkConnection

LdapNetworkConnection

LdapNetworkConnection

Method Detail

isConnected

isAuthenticated

isSecured

checkSession

addToFutureMap

getFromFutureMap

peekFromFutureMap

getTimeout

buildConfig

createConnector

connect

close

add

addAsync

add

addAsync

abandon

abandon

abandonInternal

bind

anonymousBind

bindAsync

anonymousBindAsync

bindAsync

bindAsync

bindAsync

bindAsync

bind

createBindRequest

createBindRequest

bindAsync

bindSaslPlain

bindSaslPlain

bind

bindAsync

bind