org.apache.directory.ldap.client.api

Class MonitoringLdapConnection

java.lang.Object

org.apache.directory.ldap.client.api.LdapConnectionWrapper

org.apache.directory.ldap.client.api.MonitoringLdapConnection

All Implemented Interfaces:

Closeable, AutoCloseable, LdapConnection, Wrapper<LdapConnection>

public final class MonitoringLdapConnection
extends LdapConnectionWrapper

A class used to monitor the use of a LdapConnection

Author:

Apache Directory Project

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	bindCalled
private static org.apache.directory.api.asn1.util.Oid	START_TLS_OID
private boolean	startTlsCalled

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

connection

Constructor Summary

Constructors

Constructor and Description
MonitoringLdapConnection(LdapConnection connection)

Method Summary

Modifier and Type	Method and Description
void	anonymousBind() Anonymous 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.
void	bind(org.apache.directory.api.ldap.model.name.Dn name) Unauthenticated authentication bind on a server.
void	bind(org.apache.directory.api.ldap.model.name.Dn name, String credentials) Simple bind on a server.
void	bind(String name) Unauthenticated authentication bind on a server.
void	bind(String name, String credentials) Simple bind on a server.
boolean	bindCalled()
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.
void	resetMonitors() Reset the Bind and StartTLS flags
boolean	startTlsCalled()

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

abandon, abandon, add, add, bind, close, compare, compare, compare, compare, compare, compare, compare, connect, delete, delete, delete, doesFutureExistFor, exists, exists, getBinaryAttributeDetector, getCodecService, getRootDse, getRootDse, getSchemaManager, getSupportedControls, isAuthenticated, isConnected, isControlSupported, isRequestCompleted, loadSchema, loadSchemaRelaxed, lookup, lookup, lookup, lookup, lookup, lookup, modify, modify, modify, modify, modifyDn, move, move, moveAndRename, moveAndRename, moveAndRename, moveAndRename, rename, rename, rename, rename, search, search, search, setBinaryAttributeDetector, setSchemaManager, setTimeOut, unBind, wrapped

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

START_TLS_OID

private static final org.apache.directory.api.asn1.util.Oid START_TLS_OID

bindCalled

private boolean bindCalled

startTlsCalled

private boolean startTlsCalled

Constructor Detail

MonitoringLdapConnection

MonitoringLdapConnection(LdapConnection connection)

Method Detail

bindCalled

public boolean bindCalled()

Returns:

tells if a Bind has been issued

resetMonitors

public void resetMonitors()

Reset the Bind and StartTLS flags

startTlsCalled

public boolean startTlsCalled()

Returns:

tells if the StarTLS extended operation has been called

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

Overrides:

bind in class LdapConnectionWrapper

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

Overrides:

anonymousBind in class LdapConnectionWrapper

Throws:

org.apache.directory.api.ldap.model.exception.LdapException - if some error occurred

bind

public void bind(String name)
          throws org.apache.directory.api.ldap.model.exception.LdapException

Unauthenticated authentication bind on a server.

Specified by:

bind in interface LdapConnection

Overrides:

bind in class LdapConnectionWrapper

Parameters:

name - The name used to authenticate the user. It must be a valid distinguished name.

Throws:

org.apache.directory.api.ldap.model.exception.LdapException - if some error occurred

bind

public void bind(String name,
                 String credentials)
          throws org.apache.directory.api.ldap.model.exception.LdapException

Simple bind on a server.

Specified by:

bind in interface LdapConnection

Overrides:

bind in class LdapConnectionWrapper

Parameters:

name - The name used to authenticate the user. It must be a valid distinguished name.

credentials - The password, it can't be null

Throws:

org.apache.directory.api.ldap.model.exception.LdapException - if some error occurred

bind

public void bind(org.apache.directory.api.ldap.model.name.Dn name)
          throws org.apache.directory.api.ldap.model.exception.LdapException

Unauthenticated authentication bind on a server.

Specified by:

bind in interface LdapConnection

Overrides:

bind in class LdapConnectionWrapper

Parameters:

name - The name used to authenticate the user.

Throws:

org.apache.directory.api.ldap.model.exception.LdapException - if some error occurred

bind

public void bind(org.apache.directory.api.ldap.model.name.Dn name,
                 String credentials)
          throws org.apache.directory.api.ldap.model.exception.LdapException

Simple bind on a server.

Specified by:

bind in interface LdapConnection

Overrides:

bind in class LdapConnectionWrapper

Parameters:

name - The name used to authenticate the user.

credentials - The password, it can't be null

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

Overrides:

bind in class LdapConnectionWrapper

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

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

Overrides:

extended in class LdapConnectionWrapper

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

Overrides:

extended in class LdapConnectionWrapper

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

Overrides:

extended in class LdapConnectionWrapper

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

Overrides:

extended in class LdapConnectionWrapper

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

Overrides:

extended in class LdapConnectionWrapper

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