org.apache.directory.ldap.client.api

Class LdapNetworkConnection

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:

java.io.Closeable, java.lang.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.

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.concurrent.atomic.AtomicBoolean	authenticated A flag indicating that the BindRequest has been issued and successfully authenticated the user
private java.util.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 java.util.concurrent.atomic.AtomicBoolean	connected A flag indicating that the connection is connected or not
private org.apache.mina.core.service.IoConnector	connector The connector open with the remote server
private java.util.concurrent.locks.ReentrantLock	connectorMutex A mutex used to avoid a double close of the connector
private static java.lang.String	EXCEPTION_KEY The exception stored in the session if we've got one
private java.util.Map<java.lang.Integer,ResponseFuture<? extends 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 java.lang.String	NO_RESPONSE_ERROR
private Entry	rootDse The ROOT DSE entry
private static java.lang.String	SSL_FILTER_KEY the SslFilter key
private java.util.List<java.lang.String>	supportedControls list of controls supported by the server
(package private) static java.lang.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, LdapApiService ldapApiService)
LdapNetworkConnection(LdapConnectionConfig config) Creates a new instance of LdapConnection with the given connection configuration.
LdapNetworkConnection(LdapConnectionConfig config, LdapApiService ldapApiService)
LdapNetworkConnection(java.lang.String server) Create a new instance of a LdapConnection on a given server, using the default port (389).
LdapNetworkConnection(java.lang.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(java.lang.String server, boolean useSsl, LdapApiService ldapApiService)
LdapNetworkConnection(java.lang.String server, int port) Create a new instance of a LdapConnection on a given server and a given port.
LdapNetworkConnection(java.lang.String server, int port, boolean useSsl) Create a new instance of a LdapConnection on a given server, and a give port.
LdapNetworkConnection(java.lang.String server, int port, boolean useSsl, LdapApiService ldapApiService)
LdapNetworkConnection(java.lang.String server, int port, LdapApiService ldapApiService)
LdapNetworkConnection(java.lang.String server, LdapApiService ldapApiService)

Method Summary

Modifier and Type	Method and Description
void	abandon(AbandonRequest abandonRequest) An abandon request essentially with the request message ID of the operation to be canceled and/or potentially some controls and timeout (the controls and timeout are not mandatory).
void	abandon(int messageId) Abandons a request submitted to the server for performing a particular operation.
private void	abandonInternal(AbandonRequest abandonRequest) Internal AbandonRequest handling
AddResponse	add(AddRequest addRequest) Add an entry present in the AddRequest to the server.
void	add(Entry entry) Add an entry to the server.
AddFuture	addAsync(AddRequest addRequest) Add an entry present in the AddRequest to the server.
AddFuture	addAsync(Entry entry) Add an entry to the server asynchronously.
void	addConnectionClosedEventListener(ConnectionClosedEventListener ccListener) Adds the connection closed event listener.
private void	addControls(Message codec, Message message)
void	addSchema(java.io.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(java.lang.String schemaFileName)
private void	addSslFilter() adds SslFilter to the IOConnector or IOSession's filter chain
private void	addToFutureMap(int messageId, ResponseFuture<? extends 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.
BindResponse	bind(BindRequest bindRequest) Bind to the server using a bind request object.
BindResponse	bind(SaslCramMd5Request request) Bind to the server using a CramMd5Request object.
BindResponse	bind(SaslDigestMd5Request request) Bind to the server using a DigestMd5Request object.
BindResponse	bind(SaslGssApiRequest request) Bind to the server using a GssApiRequest object.
BindFuture	bindAsync() Asynchronous Bind on a server, using the LdapConnectionConfig informations.
BindFuture	bindAsync(BindRequest bindRequest) Do an asynchronous bind, based on a BindRequest.
BindFuture	bindAsync(Dn name) Asynchronous unauthenticated authentication Bind on a server.
BindFuture	bindAsync(Dn name, java.lang.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(java.lang.String name) Asynchronous unauthenticated authentication bind
BindFuture	bindAsync(java.lang.String name, java.lang.String credentials) Simple asynchronous Bind on a server.
private BindFuture	bindSasl(SaslRequest saslRequest) Process the SASL Bind.
BindResponse	bindSaslPlain(java.lang.String authcid, java.lang.String credentials) SASL PLAIN Bind on a server.
BindResponse	bindSaslPlain(java.lang.String authzid, java.lang.String authcid, java.lang.String credentials) SASL PLAIN Bind on a server.
private static LdapConnectionConfig	buildConfig(java.lang.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.
CompareResponse	compare(CompareRequest compareRequest) Compares an entry's attribute's value with that of the given value.
boolean	compare(Dn dn, java.lang.String attributeName, byte[] value) Compares whether a given attribute's value matches that of the existing value of the attribute present in the entry with the given distinguished name.
boolean	compare(Dn dn, java.lang.String attributeName, java.lang.String value) Compares whether a given attribute's value matches that of the existing value of the attribute present in the entry with the given distinguished name.
boolean	compare(Dn dn, java.lang.String attributeName, Value<?> value) Compares whether a given attribute's value matches that of the existing value of the attribute present in the entry with the given distinguished name.
boolean	compare(java.lang.String dn, java.lang.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(java.lang.String dn, java.lang.String attributeName, java.lang.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(java.lang.String dn, java.lang.String attributeName, Value<?> value) Compares whether a given attribute's value matches that of the existing value of the attribute present in the entry with the given distinguished name.
CompareFuture	compareAsync(CompareRequest compareRequest) Asynchronously compares an entry's attribute's value with that of the given value
boolean	connect() Connect to the remote LDAP server.
private BindRequest	createBindRequest(Dn name, byte[] credentials) Create a Simple BindRequest ready to be sent.
private BindRequest	createBindRequest(java.lang.String name, byte[] credentials) Create a Simple BindRequest ready to be sent.
private void	createConnector() Create the connector
private java.lang.String	createKrb5ConfFile(java.lang.String realmName, java.lang.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
DeleteResponse	delete(DeleteRequest deleteRequest) Performs a delete operation based on the delete request object.
void	delete(Dn dn) Deletes the entry with the given distinguished name.
void	delete(java.lang.String dn) Deletes the entry with the given distinguished name.
DeleteFuture	deleteAsync(DeleteRequest deleteRequest) Performs an asynchronous delete operation based on the delete request object.
void	deleteTree(Dn dn) deletes the entry with the given Dn, and all its children
void	deleteTree(java.lang.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, java.lang.Throwable cause) Handle the exception we got.
boolean	exists(Dn dn) Tells if an Entry exists in the server.
boolean	exists(java.lang.String dn) Tells if an entry exists in the server.
ExtendedResponse	extended(ExtendedRequest extendedRequest) Performs an extended operation based on the extended request object.
ExtendedResponse	extended(Oid oid) Sends a extended operation request to the server with the given OID and no value.
ExtendedResponse	extended(Oid oid, byte[] value) Sends a extended operation request to the server with the given OID and value.
ExtendedResponse	extended(java.lang.String oid) Sends a extended operation request to the server with the given OID and no value.
ExtendedResponse	extended(java.lang.String oid, byte[] value) Sends a extended operation request to the server with the given OID and value.
ExtendedFuture	extendedAsync(ExtendedRequest extendedRequest) Asynchronously requests the server to perform an extended operation based on the given request.
private void	fetchRootDSE(java.lang.String... explicitAttributes) fetches the rootDSE from the server
BinaryAttributeDetector	getBinaryAttributeDetector()
LdapApiService	getCodecService() Gets the LDAP CODEC service responsible for encoding and decoding messages.
LdapConnectionConfig	getConfig() gives the configuration information of the connection
private ResponseFuture<? extends Response>	getFromFutureMap(int messageId)
Entry	getRootDse() Get back the RooDSE from the connected server.
Entry	getRootDse(java.lang.String... attributes) Get back the RooDSE from the connected server.
SchemaManager	getSchemaManager()
java.util.List<java.lang.String>	getSupportedControls() Get the Controls supported by server.
(package private) static long	getTimeout(long connectionTimoutInMS, int searchTimeLimitInSeconds) Get the largest timeout from the search time limit and the connection timeout.
boolean	isAuthenticated() Check if we are authenticated.
boolean	isConnected() Check if we are connected.
boolean	isControlSupported(java.lang.String controlOID) Checks if a control with the given OID is supported.
private boolean	isNoticeOfDisconnect(Message message) Check if the message is a NoticeOfDisconnect message
void	loadSchema() Loads all the default schemas that are bundled with the API. Note: This method enables all schemas prior to loading.
void	loadSchema(SchemaLoader loader) loads schema using the specified schema loader
void	loadSchemaRelaxed() Loads all the default schemas that are bundled with the API, in a relaxed mode. Note: This method enables all schemas prior to loading. The relaxed mode will allow inconsistencies in the schema.
Entry	lookup(Dn dn) Searches for an entry having the given Dn.
Entry	lookup(Dn dn, Control[] controls, java.lang.String... attributes) Searches for an entry having the given Dn.
Entry	lookup(Dn dn, java.lang.String... attributes) Searches for an entry having the given Dn.
Entry	lookup(java.lang.String dn) Searches for an entry having the given Dn.
Entry	lookup(java.lang.String dn, Control[] controls, java.lang.String... attributes) Searches for an entry having the given Dn.
Entry	lookup(java.lang.String dn, java.lang.String... attributes) Searches for an entry having the given Dn.
void	messageReceived(org.apache.mina.core.session.IoSession session, java.lang.Object message) Handle the incoming LDAP messages.
void	modify(Dn dn, Modification... modifications) Applies all the modifications to the entry specified by its distinguished name.
void	modify(Entry entry, ModificationOperation modOp) Modifies all the attributes present in the entry by applying the same operation.
ModifyResponse	modify(ModifyRequest modRequest) Performs an modify operation based on the modifications present in the modify request.
void	modify(java.lang.String dn, Modification... modifications) Applies all the modifications to the entry specified by its distinguished name.
ModifyFuture	modifyAsync(ModifyRequest modRequest) Performs an asynchronous modify operation based on the modifications present in the ModifyRequest.
ModifyDnResponse	modifyDn(ModifyDnRequest modDnRequest) Performs the modifyDn operation based on the given request object.
ModifyDnFuture	modifyDnAsync(ModifyDnRequest modDnRequest) Performs the modifyDn operation based on the given ModifyDnRequest.
void	move(Dn entryDn, Dn newSuperiorDn) Moves the given entry Dn under the new superior Dn.
void	move(java.lang.String entryDn, java.lang.String newSuperiorDn) Moves the given entry Dn under the new superior Dn.
void	moveAndRename(Dn entryDn, Dn newDn) Moves and renames the given entryDn.
void	moveAndRename(Dn entryDn, Dn newDn, boolean deleteOldRdn) Moves and renames the given entryDn.
void	moveAndRename(java.lang.String entryDn, java.lang.String newDn) Moves and renames the given entryDn.The old Rdn will be deleted
void	moveAndRename(java.lang.String entryDn, java.lang.String newDn, boolean deleteOldRdn) Moves and renames the given entryDn.
private ResponseFuture<? extends 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(Dn entryDn, Rdn newRdn) Renames the given entryDn with new Rdn and deletes the old Rdn.
void	rename(Dn entryDn, Rdn newRdn, boolean deleteOldRdn) Renames the given entryDn with new Rdn and deletes the old Rdn if deleteOldRdn is set to true.
void	rename(java.lang.String entryDn, java.lang.String newRdn) Renames the given entryDn with new Rdn and deletes the old Rdn.
void	rename(java.lang.String entryDn, java.lang.String newRdn, boolean deleteOldRdn) Renames the given entryDn with new Rdn and deletes the old Rdn if deleteOldRdn is set to true.
EntryCursor	search(Dn baseDn, java.lang.String filter, SearchScope scope, java.lang.String... attributes) Do a search, on the base object, using the given filter and scope.
SearchCursor	search(SearchRequest searchRequest) Performs search using a search request object.
EntryCursor	search(java.lang.String baseDn, java.lang.String filter, SearchScope scope, java.lang.String... attributes) Do a search, on the base object, using the given filter and scope.
SearchFuture	searchAsync(Dn baseDn, java.lang.String filter, SearchScope scope, java.lang.String... attributes) Do an asynchronous search, on the base object, using the given filter.
SearchFuture	searchAsync(SearchRequest searchRequest) Do a search, on the base object, using the given filter.
SearchFuture	searchAsync(java.lang.String baseDn, java.lang.String filter, SearchScope scope, java.lang.String... attributes) Do an asynchronous search, on the base object, using the given filter.
void	sessionClosed(org.apache.mina.core.session.IoSession session)
void	sessionCreated(org.apache.mina.core.session.IoSession session) This method is called when a new session is created.
void	setBinaryAttributeDetector(BinaryAttributeDetector binaryAttributeDetector) Sets the object responsible for the detection of binary attributes.
void	setConnector(org.apache.mina.core.service.IoConnector connector) Set the connector to use.
void	setSchemaManager(SchemaManager schemaManager) sets a SchemaManager to be used by this connection
void	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(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

inputClosed, 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

connector

private org.apache.mina.core.service.IoConnector connector

The connector open with the remote server

connectorMutex

private java.util.concurrent.locks.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 java.util.Map<java.lang.Integer,ResponseFuture<? extends Response>> futureMap

a map to hold the ResponseFutures for all operations

supportedControls

private java.util.List<java.lang.String> supportedControls

list of controls supported by the server

rootDse

private Entry rootDse

The ROOT DSE entry

authenticated

private java.util.concurrent.atomic.AtomicBoolean authenticated

A flag indicating that the BindRequest has been issued and successfully authenticated the user

connected

private java.util.concurrent.atomic.AtomicBoolean connected

A flag indicating that the connection is connected or not

conCloseListeners

private java.util.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 java.lang.String SSL_FILTER_KEY

the SslFilter key

See Also:

Constant Field Values

EXCEPTION_KEY

private static final java.lang.String EXCEPTION_KEY

The exception stored in the session if we've got one

See Also:

Constant Field Values

TIME_OUT_ERROR

static final java.lang.String TIME_OUT_ERROR

See Also:

Constant Field Values

NO_RESPONSE_ERROR

static final java.lang.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,
                             LdapApiService ldapApiService)

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,
                             LdapApiService ldapApiService)

LdapNetworkConnection

public LdapNetworkConnection(java.lang.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(java.lang.String server,
                             LdapApiService ldapApiService)

LdapNetworkConnection

public LdapNetworkConnection(java.lang.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(java.lang.String server,
                             boolean useSsl,
                             LdapApiService ldapApiService)

LdapNetworkConnection

public LdapNetworkConnection(java.lang.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

port - The port the server is listening to

LdapNetworkConnection

public LdapNetworkConnection(java.lang.String server,
                             int port,
                             LdapApiService ldapApiService)

LdapNetworkConnection

public LdapNetworkConnection(java.lang.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(java.lang.String server,
                             int port,
                             boolean useSsl,
                             LdapApiService ldapApiService)

Method Detail

isConnected

public boolean isConnected()

Check if we are connected.

Specified by:

isConnected in interface LdapConnection

Returns:

true if we are connected.

isAuthenticated

public boolean isAuthenticated()

Check if we are authenticated.

Specified by:

isAuthenticated in interface LdapConnection

Returns:

true if we are connected.

checkSession

private void checkSession()
                   throws InvalidConnectionException

Check that a session is valid, ie we can send requests to the server

Throws:

java.lang.Exception - If the session is not valid

InvalidConnectionException

addToFutureMap

private void addToFutureMap(int messageId,
                            ResponseFuture<? extends Response> future)

getFromFutureMap

private ResponseFuture<? extends Response> getFromFutureMap(int messageId)

peekFromFutureMap

private ResponseFuture<? extends Response> peekFromFutureMap(int messageId)

getTimeout

static long getTimeout(long connectionTimoutInMS,
                       int searchTimeLimitInSeconds)

Get the largest timeout from the search time limit and the connection timeout.

buildConfig

private static LdapConnectionConfig buildConfig(java.lang.String server,
                                                int port,
                                                boolean useSsl)

createConnector

private void createConnector()
                      throws LdapException

Create the connector

Throws:

LdapException

connect

public boolean connect()
                throws LdapException

Connect to the remote LDAP server.

Specified by:

connect in interface LdapConnection

Returns:

true if the connection is established, false otherwise

Throws:

LdapException - if some error occurred

close

public void close()
           throws java.io.IOException

Disconnect from the remote LDAP server.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface LdapConnection

Throws:

java.io.IOException - if some I/O error occurs

add

public void add(Entry entry)
         throws LdapException

Add an entry to the server.

Specified by:

add in interface LdapConnection

Parameters:

entry - The entry to add

Throws:

LdapException - if some error occurred

addAsync

public AddFuture addAsync(Entry entry)
                   throws LdapException

Add an entry to the server asynchronously. This is a non blocking add : the user has to get for the response from the returned Future.

Specified by:

addAsync in interface LdapAsyncConnection

Parameters:

entry - The entry to add

Returns:

the add operation's future

Throws:

LdapException - if some error occurred

add

public AddResponse add(AddRequest addRequest)
                throws 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:

LdapException - if some error occurred

addAsync

public AddFuture addAsync(AddRequest addRequest)
                   throws 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:

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(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(AbandonRequest abandonRequest)

Internal AbandonRequest handling

bind

public void bind()
          throws LdapException

Bind on a server, using the LdapConnectionConfig information of this connection.

Specified by:

bind in interface LdapConnection

Throws:

LdapException - if some error occurred

anonymousBind

public void anonymousBind()
                   throws LdapException

Anonymous bind on a server.

Specified by:

anonymousBind in interface LdapConnection

Throws:

LdapException - if some error occurred

bindAsync

public BindFuture bindAsync()
                     throws LdapException

Asynchronous Bind on a server, using the LdapConnectionConfig informations.

Specified by:

bindAsync in interface LdapAsyncConnection

Returns:

the bind operation's future

Throws:

LdapException - if some error occurred

anonymousBindAsync

public BindFuture anonymousBindAsync()
                              throws LdapException

Anonymous asynchronous Bind on a server.

Specified by:

anonymousBindAsync in interface LdapAsyncConnection

Returns:

the bind operation's future

Throws:

LdapException - if some error occurred

bindAsync

public BindFuture bindAsync(java.lang.String name)
                     throws 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:

LdapException - if some error occurred

bindAsync

public BindFuture bindAsync(java.lang.String name,
                            java.lang.String credentials)
                     throws 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:

LdapException - if some error occurred

bindAsync

public BindFuture bindAsync(Dn name)
                     throws 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:

LdapException - if some error occurred

bindAsync

public BindFuture bindAsync(Dn name,
                            java.lang.String credentials)
                     throws 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:

LdapException - if some error occurred

bind

public BindResponse bind(BindRequest bindRequest)
                  throws 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:

LdapException - if some error occurred

createBindRequest

private BindRequest createBindRequest(java.lang.String name,
                                      byte[] credentials)
                               throws LdapException

Create a Simple BindRequest ready to be sent.

Throws:

LdapException

createBindRequest

private BindRequest createBindRequest(Dn name,
                                      byte[] credentials)
                               throws LdapException

Create a Simple BindRequest ready to be sent.

Throws:

LdapException

bindAsync

public BindFuture bindAsync(BindRequest bindRequest)
                     throws 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:

LdapException - if some error occurred

bindSaslPlain

public BindResponse bindSaslPlain(java.lang.String authcid,
                                  java.lang.String credentials)
                           throws 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:

{@link - LdapException} if some error occurred

LdapException

bindSaslPlain

public BindResponse bindSaslPlain(java.lang.String authzid,
                                  java.lang.String authcid,
                                  java.lang.String credentials)
                           throws 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:

{@link - LdapException} if some error occurred

LdapException

bind

public BindResponse bind(SaslCramMd5Request request)
                  throws 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:

LdapException - if some error occurred

bindAsync

public BindFuture bindAsync(SaslRequest request)
                     throws 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:

LdapException - if some error occurred

bind

public BindResponse bind(SaslDigestMd5Request request)
                  throws 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:

LdapException - if some error occurred

bind

public BindResponse bind(SaslGssApiRequest request)
                  throws 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:

LdapException - if some error occurred

bindAsync

public BindFuture bindAsync(SaslGssApiRequest request)
                     throws 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:

LdapException - if some error occurred

search

public EntryCursor search(Dn baseDn,
                          java.lang.String filter,
                          SearchScope scope,
                          java.lang.String... attributes)
                   throws 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:

LdapException - if some error occurred

search

public EntryCursor search(java.lang.String baseDn,
                          java.lang.String filter,
                          SearchScope scope,
                          java.lang.String... attributes)
                   throws 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:

LdapException - if some error occurred

searchAsync

public SearchFuture searchAsync(Dn baseDn,
                                java.lang.String filter,
                                SearchScope scope,
                                java.lang.String... attributes)
                         throws LdapException

Do an asynchronous search, on the base object, using the given filter. The SearchRequest parameters default to :

 Scope : ONE
 DerefAlias : ALWAYS
 SizeLimit : none
 TimeLimit : none
 TypesOnly : false
 Attributes : all the user's attributes.
 This method is blocking.
 

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:

LdapException - if some error occurred

searchAsync

public SearchFuture searchAsync(java.lang.String baseDn,
                                java.lang.String filter,
                                SearchScope scope,
                                java.lang.String... attributes)
                         throws LdapException

Do an asynchronous search, on the base object, using the given filter. The SearchRequest parameters default to :

 Scope : ONE
 DerefAlias : ALWAYS
 SizeLimit : none
 TimeLimit : none
 TypesOnly : false
 Attributes : all the user's attributes.
 This method is blocking.
 

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:

LdapException - if some error occurred

searchAsync

public SearchFuture searchAsync(SearchRequest searchRequest)
                         throws LdapException

Do a search, on the base object, using the given filter. The SearchRequest parameters default to :

 Scope : ONE
 DerefAlias : ALWAYS
 SizeLimit : none
 TimeLimit : none
 TypesOnly : false
 Attributes : all the user's attributes.
 This method is blocking.
 

Specified by:

searchAsync in interface LdapAsyncConnection

Parameters:

searchRequest - The search request to send to the server

Returns:

the search operation's future

Throws:

LdapException - if some error occurred

search

public SearchCursor search(SearchRequest searchRequest)
                    throws 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:

LdapException - if some error occurred

unBind

public void unBind()
            throws LdapException

UnBind from a server. This is a request which expects no response.

Specified by:

unBind in interface LdapConnection

Throws:

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,
                            java.lang.Throwable cause)
                     throws java.lang.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:

java.lang.Exception - The t

isNoticeOfDisconnect

private boolean isNoticeOfDisconnect(Message message)

Check if the message is a NoticeOfDisconnect message

messageReceived

public void messageReceived(org.apache.mina.core.session.IoSession session,
                            java.lang.Object message)
                     throws java.lang.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:

java.lang.Exception - If there is some error while processing the message

modify

public void modify(Entry entry,
                   ModificationOperation modOp)
            throws 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:

LdapException - in case of modify operation failure or timeout happens

modify

public void modify(Dn dn,
                   Modification... modifications)
            throws 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:

LdapException - in case of modify operation failure or timeout happens

modify

public void modify(java.lang.String dn,
                   Modification... modifications)
            throws 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 Dn

modifications - The list of modifications to be applied

Throws:

LdapException - in case of modify operation failure or timeout happens

modify

public ModifyResponse modify(ModifyRequest modRequest)
                      throws 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:

LdapException - in case of modify operation failure or timeout happens

modifyAsync

public ModifyFuture modifyAsync(ModifyRequest modRequest)
                         throws 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:

LdapException - in case of modify operation failure or timeout happens

rename

public void rename(java.lang.String entryDn,
                   java.lang.String newRdn)
            throws LdapException

Renames the given entryDn with new Rdn and deletes the old Rdn.

Specified by:

rename in interface LdapConnection

Parameters:

entryDn - the target Dn

newRdn - new Rdn for the target Dn

Throws:

LdapException - if some error occurred

See Also:

LdapConnection.rename(String, String, boolean)

rename

public void rename(Dn entryDn,
                   Rdn newRdn)
            throws LdapException

Renames the given entryDn with new Rdn and deletes the old Rdn.

Specified by:

rename in interface LdapConnection

Parameters:

entryDn - the target Dn

newRdn - new Rdn for the target Dn

Throws:

LdapException - if some error occurred

See Also:

LdapConnection.rename(Dn, Rdn, boolean)

rename

public void rename(java.lang.String entryDn,
                   java.lang.String newRdn,
                   boolean deleteOldRdn)
            throws LdapException

Renames the given entryDn with new Rdn and deletes the old Rdn if deleteOldRdn is set to true.

Specified by:

rename in interface LdapConnection

Parameters:

entryDn - the target Dn

newRdn - new Rdn for the target Dn

deleteOldRdn - flag to indicate whether to delete the old Rdn

Throws:

LdapException - if some error occurred

See Also:

LdapConnection.rename(Dn, Rdn, boolean)

rename

public void rename(Dn entryDn,
                   Rdn newRdn,
                   boolean deleteOldRdn)
            throws LdapException

Renames the given entryDn with new Rdn and deletes the old Rdn if deleteOldRdn is set to true.

Specified by:

rename in interface LdapConnection

Parameters:

entryDn - the target Dn

newRdn - new Rdn for the target Dn

deleteOldRdn - flag to indicate whether to delete the old Rdn

Throws:

LdapException - if some error occurred

move

public void move(java.lang.String entryDn,
                 java.lang.String newSuperiorDn)
          throws LdapException

Moves the given entry Dn under the new superior Dn.

Specified by:

move in interface LdapConnection

Parameters:

entryDn - the Dn of the target entry

newSuperiorDn - Dn of the new parent/superior

Throws:

LdapException - if some error occurred

See Also:

LdapConnection.move(Dn, Dn)

move

public void move(Dn entryDn,
                 Dn newSuperiorDn)
          throws LdapException

Moves the given entry Dn under the new superior Dn.

Specified by:

move in interface LdapConnection

Parameters:

entryDn - the Dn of the target entry

newSuperiorDn - Dn of the new parent/superior

Throws:

LdapException - if some error occurred

moveAndRename

public void moveAndRename(Dn entryDn,
                          Dn newDn)
                   throws LdapException

Moves and renames the given entryDn. The old Rdn will be deleted.

Specified by:

moveAndRename in interface LdapConnection

Parameters:

entryDn - The original entry Dn

newDn - The new entry Dn

Throws:

LdapException - if some error occurred

See Also:

LdapConnection.moveAndRename(Dn, Dn, boolean)

moveAndRename

public void moveAndRename(java.lang.String entryDn,
                          java.lang.String newDn)
                   throws LdapException

Moves and renames the given entryDn.The old Rdn will be deleted

Specified by:

moveAndRename in interface LdapConnection

Parameters:

entryDn - The original entry Dn

newDn - The new entry Dn

Throws:

LdapException - if some error occurred

See Also:

LdapConnection.moveAndRename(Dn, Dn, boolean)

moveAndRename

public void moveAndRename(Dn entryDn,
                          Dn newDn,
                          boolean deleteOldRdn)
                   throws LdapException

Moves and renames the given entryDn. The old Rdn will be deleted if requested.

Specified by:

moveAndRename in interface LdapConnection

Parameters:

entryDn - The original entry Dn

newDn - The new entry Dn

deleteOldRdn - Tells if the old Rdn must be removed

Throws:

LdapException - if some error occurred

moveAndRename

public void moveAndRename(java.lang.String entryDn,
                          java.lang.String newDn,
                          boolean deleteOldRdn)
                   throws LdapException

Moves and renames the given entryDn. The old Rdn will be deleted if requested.

Specified by:

moveAndRename in interface LdapConnection

Parameters:

entryDn - The original entry Dn

newDn - The new entry Dn

deleteOldRdn - Tells if the old Rdn must be removed

Throws:

LdapException - if some error occurred

modifyDn

public ModifyDnResponse modifyDn(ModifyDnRequest modDnRequest)
                          throws 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:

LdapException - if some error occurred

modifyDnAsync

public ModifyDnFuture modifyDnAsync(ModifyDnRequest modDnRequest)
                             throws 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:

LdapException - if some error occurred

delete

public void delete(java.lang.String dn)
            throws 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 Dn

Throws:

LdapException - If the Dn is not valid or if the deletion failed

delete

public void delete(Dn dn)
            throws LdapException

Deletes the entry with the given distinguished name.

Specified by:

delete in interface LdapConnection

Parameters:

dn - the target entry's distinguished name

Throws:

LdapException - If the Dn is not valid or if the deletion failed

deleteTree

public void deleteTree(Dn dn)
                throws LdapException

deletes the entry with the given Dn, and all its children

Parameters:

dn - the target entry's Dn

Throws:

LdapException - If the Dn is not valid or if the deletion failed

deleteTree

public void deleteTree(java.lang.String dn)
                throws LdapException

deletes the entry with the given Dn, and all its children

Parameters:

dn - the target entry's Dn as a String

Throws:

LdapException - If the Dn is not valid or if the deletion failed

delete

public DeleteResponse delete(DeleteRequest deleteRequest)
                      throws 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:

LdapException - If the Dn is not valid or if the deletion failed

deleteAsync

public DeleteFuture deleteAsync(DeleteRequest deleteRequest)
                         throws 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:

LdapException - If the Dn is not valid or if the deletion failed

compare

public boolean compare(java.lang.String dn,
                       java.lang.String attributeName,
                       java.lang.String value)
                throws 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 Dn

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:

LdapException - if some error occurred

compare

public boolean compare(java.lang.String dn,
                       java.lang.String attributeName,
                       byte[] value)
                throws 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 Dn

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:

LdapException - if some error occurred

compare

public boolean compare(java.lang.String dn,
                       java.lang.String attributeName,
                       Value<?> value)
                throws 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 Dn

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:

LdapException - if some error occurred

compare

public boolean compare(Dn dn,
                       java.lang.String attributeName,
                       java.lang.String value)
                throws 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:

LdapException - if some error occurred

compare

public boolean compare(Dn dn,
                       java.lang.String attributeName,
                       byte[] value)
                throws 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:

LdapException - if some error occurred

compare

public boolean compare(Dn dn,
                       java.lang.String attributeName,
                       Value<?> value)
                throws 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:

LdapException - if some error occurred

compare

public CompareResponse compare(CompareRequest compareRequest)
                        throws 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 Dn, attribute name and value

Returns:

compare operation's response

Throws:

LdapException - if some error occurred

compareAsync

public CompareFuture compareAsync(CompareRequest compareRequest)
                           throws 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:

LdapException - if some error occurred

extended

public ExtendedResponse extended(java.lang.String oid)
                          throws 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:

LdapException - if some error occurred

See Also:

LdapConnection.extended(org.apache.directory.api.asn1.util.Oid, byte[])

extended

public ExtendedResponse extended(java.lang.String oid,
                                 byte[] value)
                          throws 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:

LdapException - if some error occurred

See Also:

LdapConnection.extended(org.apache.directory.api.asn1.util.Oid, byte[])

extended

public ExtendedResponse extended(Oid oid)
                          throws 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:

LdapException - if some error occurred

See Also:

LdapConnection.extended(org.apache.directory.api.asn1.util.Oid, byte[])

extended

public ExtendedResponse extended(Oid oid,
                                 byte[] value)
                          throws 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:

LdapException - if some error occurred

extended

public ExtendedResponse extended(ExtendedRequest extendedRequest)
                          throws 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:

LdapException - if the extended operation failed

extendedAsync

public ExtendedFuture extendedAsync(ExtendedRequest extendedRequest)
                             throws 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:

LdapException - if some error occurred

exists

public boolean exists(java.lang.String dn)
               throws LdapException

Tells if an entry exists in the server.

Specified by:

exists in interface LdapConnection

Parameters:

dn - The distinguished name of the entry we want to check the existence, must be a valid Dn

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:

LdapException - if some error occurred

exists

public boolean exists(Dn dn)
               throws LdapException

Tells if an Entry exists in the server.

Specified by:

exists in interface LdapConnection

Parameters:

dn - The distinguished name of the entry we want to check the 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:

LdapException - if some error occurred

getRootDse

public Entry getRootDse()
                 throws 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:

LdapException - If the rootDSE can't be read

getRootDse

public Entry getRootDse(java.lang.String... attributes)
                 throws 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:

LdapException - If the rootDSE can't be read

lookup

public Entry lookup(Dn dn)
             throws LdapException

Searches for an entry having the given Dn.

Specified by:

lookup in interface LdapConnection

Parameters:

dn - the Dn of the entry to be fetched

Returns:

the Entry with the given Dn or null if no entry exists with that Dn

Throws:

LdapException - in case of any problems while searching for the Dn or if the returned response contains a referral

See Also:

LdapConnection.lookup(org.apache.directory.api.ldap.model.name.Dn, String...)

lookup

public Entry lookup(java.lang.String dn)
             throws LdapException

Searches for an entry having the given Dn.

Specified by:

lookup in interface LdapConnection

Parameters:

dn - the Dn of the entry to be fetched

Returns:

the Entry with the given Dn or null if no entry exists with that Dn

Throws:

LdapException - in case of any problems while searching for the Dn or if the returned response contains a referral

See Also:

LdapConnection.lookup(String, String...)

lookup

public Entry lookup(Dn dn,
                    java.lang.String... attributes)
             throws LdapException

Searches for an entry having the given Dn.

Specified by:

lookup in interface LdapConnection

Parameters:

dn - the Dn of the entry to be fetched

attributes - the attributes to be returned along with entry

Returns:

the Entry with the given Dn or null if no entry exists with that Dn

Throws:

LdapException - in case of any problems while searching for the Dn or if the returned response contains a referral

lookup

public Entry lookup(Dn dn,
                    Control[] controls,
                    java.lang.String... attributes)
             throws LdapException

Searches for an entry having the given Dn.

Specified by:

lookup in interface LdapConnection

Parameters:

dn - the Dn 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 Dn or null if no entry exists with that Dn

Throws:

LdapException - in case of any problems while searching for the Dn or if the returned response contains a referral

lookup

public Entry lookup(java.lang.String dn,
                    java.lang.String... attributes)
             throws LdapException

Searches for an entry having the given Dn.

Specified by:

lookup in interface LdapConnection

Parameters:

dn - the Dn of the entry to be fetched

attributes - the attributes to be returned along with entry

Returns:

the Entry with the given Dn or null if no entry exists with that Dn

Throws:

LdapException - in case of any problems while searching for the Dn or if the returned response contains a referral

See Also:

LdapConnection.lookup(org.apache.directory.api.ldap.model.name.Dn, String...)

lookup

public Entry lookup(java.lang.String dn,
                    Control[] controls,
                    java.lang.String... attributes)
             throws LdapException

Searches for an entry having the given Dn.

Specified by:

lookup in interface LdapConnection

Parameters:

dn - the Dn 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 Dn or null if no entry exists with that Dn

Throws:

LdapException - in case of any problems while searching for the Dn or if the returned response contains a referral

See Also:

LdapConnection.lookup(org.apache.directory.api.ldap.model.name.Dn, String...)

isControlSupported

public boolean isControlSupported(java.lang.String controlOID)
                           throws 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:

LdapException - if some error occurred

getSupportedControls

public java.util.List<java.lang.String> getSupportedControls()
                                                      throws LdapException

Get the Controls supported by server.

Specified by:

getSupportedControls in interface LdapConnection

Returns:

a list of control OIDs supported by server

Throws:

LdapException - if some error occurred

loadSchema

public void loadSchema()
                throws 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:

LdapException - in case of problems while loading the schema

loadSchemaRelaxed

public void loadSchemaRelaxed()
                       throws 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:

LdapException - in case of problems while loading the schema

loadSchema

public void loadSchema(SchemaLoader loader)
                throws LdapException

loads schema using the specified schema loader

Parameters:

loader - the SchemaLoader to be used to load schema

Throws:

LdapException

addSchema

public void addSchema(java.io.File schemaFile)
               throws 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:

LdapException - in case of any errors while parsing

addSchema

public void addSchema(java.lang.String schemaFileName)
               throws LdapException

Throws:

LdapException

See Also:

addSchema(File)

getCodecService

public 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 SchemaManager getSchemaManager()

Specified by:

getSchemaManager in interface LdapConnection

Returns:

The SchemaManager associated with this LdapConection if any

fetchRootDSE

private void fetchRootDSE(java.lang.String... explicitAttributes)
                   throws LdapException

fetches the rootDSE from the server

Throws:

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(Message codec,
                         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

addConnectionClosedEventListener

public void addConnectionClosedEventListener(ConnectionClosedEventListener ccListener)

Adds the connection closed event listener.

Parameters:

ccListener - the connection closed listener

sessionCreated

public void sessionCreated(org.apache.mina.core.session.IoSession session)
                    throws java.lang.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:

java.lang.Exception

sessionClosed

public void sessionClosed(org.apache.mina.core.session.IoSession session)
                   throws java.lang.Exception

Specified by:

sessionClosed in interface org.apache.mina.core.service.IoHandler

Overrides:

sessionClosed in class org.apache.mina.core.service.IoHandlerAdapter

Throws:

java.lang.Exception

startTls

public void startTls()
              throws 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:

LdapException

addSslFilter

private void addSslFilter()
                   throws LdapException

adds SslFilter to the IOConnector or IOSession's filter chain

Throws:

LdapException

bindSasl

private BindFuture bindSasl(SaslRequest saslRequest)
                     throws 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:

LdapException

writeRequest

private void writeRequest(Request request)
                   throws LdapException

a reusable code block to be used in various bind methods

Throws:

LdapException

createKrb5ConfFile

private java.lang.String createKrb5ConfFile(java.lang.String realmName,
                                            java.lang.String kdcHost,
                                            int kdcPort)
                                     throws java.io.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:

java.io.IOException

getBinaryAttributeDetector

public BinaryAttributeDetector getBinaryAttributeDetector()

Specified by:

getBinaryAttributeDetector in interface LdapConnection

Returns:

the object responsible for the detection of binary attributes

setBinaryAttributeDetector

public void setBinaryAttributeDetector(BinaryAttributeDetector binaryAttributeDetector)

Sets the object responsible for the detection of binary attributes.

Specified by:

setBinaryAttributeDetector in interface LdapConnection

setSchemaManager

public void setSchemaManager(SchemaManager schemaManager)

sets a SchemaManager to be used by this connection

Specified by:

setSchemaManager in interface LdapConnection