LdapClient

extends Object
implements PooledConnection

java.lang.Object
↳	com.sun.jndi.ldap.LdapClient

Class Overview

LDAP (RFC-1777) and LDAPv3 (RFC-2251) compliant client This class represents a connection to an LDAP client. Callers interact with this class at an LDAP operation level. That is, the caller invokes a method to do a SEARCH or MODRDN operation and gets back the result. The caller uses the constructor to create a connection to the server. It then needs to use authenticate() to perform an LDAP BIND. Note that for v3, BIND is optional so authenticate() might not actually send a BIND. authenticate() can be used later on to issue a BIND, for example, for a v3 client that wants to change the connection's credentials.

Multiple LdapCtx might share the same LdapClient. For example, contexts derived from the same initial context would share the same LdapClient until changes to a context's properties necessitates its own LdapClient. LdapClient methods that access shared data are thread-safe (i.e., caller does not have to sync).

Fields: isLdapv3 - no sync; initialized and updated within sync authenticate(); always updated when connection is "quiet" and not shared; read access from outside LdapClient not sync referenceCount - sync within LdapClient; exception is forceClose() which is used by Connection thread to close connection upon receiving an Unsolicited Notification. access from outside LdapClient must sync; conn - no sync; Connection takes care of its own sync unsolicited - sync Vector; multiple operations sync'ed

Summary

Public Methods
synchronized void	closeConnection() Closes the physical connection.
synchronized LdapResult	ldapBind(String dn, byte[] toServer, Control[] bindCtls, String auth, boolean pauseAfterReceipt) Sends an LDAP Bind request.

Protected Methods
void	finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.

[Expand]

Inherited Methods

From class java.lang.Object

Object	clone() Creates and returns a copy of this object.
boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
void	finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
final Class<?>	getClass() Returns the runtime class of this `Object`.
int	hashCode() Returns a hash code value for the object.
final void	notify() Wakes up a single thread that is waiting on this object's monitor.
final void	notifyAll() Wakes up all threads that are waiting on this object's monitor.
String	toString() Returns a string representation of the object.
final void	wait() Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.
final void	wait(long timeout, int nanos) Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
final void	wait(long timeout) Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.

From interface com.sun.jndi.ldap.pool.PooledConnection

Public Methods

public synchronized void closeConnection ()

Closes the physical connection.

public synchronized LdapResult ldapBind (String dn, byte[] toServer, Control[] bindCtls, String auth, boolean pauseAfterReceipt)

Sends an LDAP Bind request. Cannot be private; called by LdapSasl

Parameters

dn	The possibly null DN to use in the BIND request. null if anonymous.
toServer	The possibly null array of bytes to send to the server.
auth	The authentication mechanism

Throws

IOException
NamingException

Protected Methods

protected void finalize ()

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. A subclass overrides the finalize method to dispose of system resources or to perform other cleanup.

The general contract of finalize is that it is invoked if and when the Java^TM virtual machine has determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, except as a result of an action taken by the finalization of some other object or class which is ready to be finalized. The finalize method may take any action, including making this object available again to other threads; the usual purpose of finalize, however, is to perform cleanup actions before the object is irrevocably discarded. For example, the finalize method for an object that represents an input/output connection might perform explicit I/O transactions to break the connection before the object is permanently discarded.

The finalize method of class Object performs no special action; it simply returns normally. Subclasses of Object may override this definition.

The Java programming language does not guarantee which thread will invoke the finalize method for any given object. It is guaranteed, however, that the thread that invokes finalize will not be holding any user-visible synchronization locks when finalize is invoked. If an uncaught exception is thrown by the finalize method, the exception is ignored and finalization of that object terminates.

After the finalize method has been invoked for an object, no further action is taken until the Java virtual machine has again determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, including possible actions by other objects or classes which are ready to be finalized, at which point the object may be discarded.

The finalize method is never invoked more than once by a Java virtual machine for any given object.

Any exception thrown by the finalize method causes the finalization of this object to be halted, but is otherwise ignored.

Classes

Exceptions