OpenJDK 27 · com.sun.jndi.ldap.pool.Connections · APIdia, the JavaDoc alternative

Represents a list of PooledConnections (actually, ConnectionDescs) with the same pool id. The list starts out with an initial number of connections. Additional PooledConnections are created lazily upon demand. The list has a maximum size. When the number of connections reaches the maximum size, a request for a PooledConnection blocks until a connection is returned to the list. A maximum size of zero means that there is no maximum: connection creation will be attempted when no idle connection is available. The list may also have a preferred size. If the current list size is less than the preferred size, a request for a connection will result in a PooledConnection being created (even if an idle connection is available). If the current list size is greater than the preferred size, a connection being returned to the list will be closed and removed from the list. A preferred size of zero means that there is no preferred size: connections are created only when no idle connection is available and a connection being returned to the list is not closed. Regardless of the preferred size, connection creation always observes the maximum size: a connection won't be created if the list size is at or exceeds the maximum size.

Field Summary

Modifier and Type	Field and Description
private boolean	closed
private final Condition	connectionsAvailable
private final List<ConnectionDesc>	conns
private static final boolean	debug
private static final int	DEFAULT_SIZE
private final PooledConnectionFactory	factory
private boolean	initialized
private final int	initSize
private final ReentrantLock	lock
private final int	maxSize
private final int	prefSize
private Reference<Object>	ref
private static final boolean	trace

Constructor Summary

Access	Constructor and Description
pack-priv	Connections(Object the identity (connection request) of the connections in the list id, int the number of connections to create initially initSize, int the preferred size of the pool. The pool will try to maintain a pool of this size by creating and closing connections as needed. prefSize, int the maximum size of the pool. The pool will not exceed this size. If the pool is at this size, a request for a connection will block until an idle connection is released to the pool or when one is removed. maxSize, PooledConnectionFactory The factory responsible for creating a connection factory, ReentrantLock lock)

Access

Constructor and Description

pack-priv

Connections(Object

the identity (connection request) of the connections in the list

id, int

the number of connections to create initially

initSize, int

the preferred size of the pool. The pool will try to maintain a pool of this size by creating and closing connections as needed.

prefSize, int

the maximum size of the pool. The pool will not exceed this size. If the pool is at this size, a request for a connection will block until an idle connection is released to the pool or when one is removed.

maxSize, PooledConnectionFactory

The factory responsible for creating a connection

factory, ReentrantLock lock)

Method Summary

Modifier and Type	Method and Description
pack-priv void	close() Called when this instance of Connections has been removed from Pool.
pack-priv PooledConnection	createConnection(PooledConnectionFactory factory, long timeout)
private void	d(String msg, Object o1)
private void	d(String msg, int i)
private void	d(String msg)
pack-priv boolean	Returns: true if no more connections in list expire(long an entry idle since this time has expired. threshold) Goes through all entries in list, removes and closes ones that have been idle before threshold.
pack-priv PooledConnection	getAvailableConnection(long timeout) Retrieves an idle connection from this list if one is available.
pack-priv String	getStats()
pack-priv boolean	grabLock(long timeout)
public boolean	releasePooledConnection(PooledConnection conn) Implements com.sun.jndi.ldap.pool.PoolCallback.releasePooledConnection. Releases connection back into list.
public boolean	Returns: true if conn removed; false if it was not in pool public because implemented as part of PoolCallback. removePooledConnection(PooledConnection conn) Implements com.sun.jndi.ldap.pool.PoolCallback.removePooledConnection. Removes PooledConnection from list of connections.
private void	td(String msg, Object o1, Object o2)
private void	td(String msg, Object o1)
private void	td(String msg)
pack-priv void	unlock()
pack-priv void	waitForAvailableConnection()
pack-priv void	waitForAvailableConnection(long waitTime)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

closed	back to summary
private boolean closed

connectionsAvailable	back to summary
private final Condition connectionsAvailable

conns	back to summary
private final List<ConnectionDesc> conns

debug	back to summary
private static final boolean debug

DEFAULT_SIZE	back to summary
private static final int DEFAULT_SIZE

factory	back to summary
private final PooledConnectionFactory factory

initialized	back to summary
private boolean initialized

initSize	back to summary
private final int initSize

lock	back to summary
private final ReentrantLock lock

maxSize	back to summary
private final int maxSize

prefSize	back to summary
private final int prefSize

ref	back to summary
private Reference<Object> ref

trace	back to summary
private static final boolean trace

Constructor Detail

Connections	back to summary
pack-priv Connections(Object id, int initSize, int prefSize, int maxSize, PooledConnectionFactory factory, ReentrantLock lock) throws NamingException Parameters id:Object the identity (connection request) of the connections in the list initSize:int the number of connections to create initially prefSize:int the preferred size of the pool. The pool will try to maintain a pool of this size by creating and closing connections as needed. maxSize:int the maximum size of the pool. The pool will not exceed this size. If the pool is at this size, a request for a connection will block until an idle connection is released to the pool or when one is removed. factory:PooledConnectionFactory The factory responsible for creating a connection

Connections

back to summary

pack-priv Connections(Object id, int initSize, int prefSize, int maxSize, PooledConnectionFactory factory, ReentrantLock lock) throws NamingException

Parameters

id:Object: the identity (connection request) of the connections in the list
initSize:int: the number of connections to create initially
prefSize:int: the preferred size of the pool. The pool will try to maintain a pool of this size by creating and closing connections as needed.
maxSize:int: the maximum size of the pool. The pool will not exceed this size. If the pool is at this size, a request for a connection will block until an idle connection is released to the pool or when one is removed.
factory:PooledConnectionFactory: The factory responsible for creating a connection

Method Detail

close	back to summary
pack-priv void close() Called when this instance of Connections has been removed from Pool. This means that no one can get any pooled connections from this Connections any longer. Expire all idle connections as of 'now' and leave indicator so that any in-use connections will be closed upon their return.

createConnection	back to summary
pack-priv PooledConnection createConnection(PooledConnectionFactory factory, long timeout) throws NamingException

d	back to summary
private void d(String msg, Object o1)

d	back to summary
private void d(String msg, int i)

d	back to summary
private void d(String msg)

expire	back to summary
pack-priv boolean expire(long threshold) Goes through all entries in list, removes and closes ones that have been idle before threshold. Parameters threshold:long an entry idle since this time has expired. Returns:boolean true if no more connections in list

expire

back to summary

pack-priv boolean expire(long threshold)

Goes through all entries in list, removes and closes ones that have been idle before threshold.

Parameters

threshold:long: an entry idle since this time has expired.

Returns:boolean

true if no more connections in list

getAvailableConnection	back to summary
pack-priv PooledConnection getAvailableConnection(long timeout) throws NamingException Retrieves an idle connection from this list if one is available.

getStats	back to summary
pack-priv String getStats()

grabLock	back to summary
pack-priv boolean grabLock(long timeout) throws InterruptedNamingException

releasePooledConnection	back to summary
public boolean releasePooledConnection(PooledConnection conn) Implements com.sun.jndi.ldap.pool.PoolCallback.releasePooledConnection. Releases connection back into list. If the list size is below prefSize, the connection may be reused. If the list size exceeds prefSize, then the connection is closed and removed from the list. public because implemented as part of PoolCallback.

releasePooledConnection

back to summary

public boolean releasePooledConnection(PooledConnection conn)

Implements com.sun.jndi.ldap.pool.PoolCallback.releasePooledConnection.

Releases connection back into list. If the list size is below prefSize, the connection may be reused. If the list size exceeds prefSize, then the connection is closed and removed from the list.

public because implemented as part of PoolCallback.

removePooledConnection	back to summary
public boolean removePooledConnection(PooledConnection conn) Implements com.sun.jndi.ldap.pool.PoolCallback.removePooledConnection. Removes PooledConnection from list of connections. The closing of the connection is separate from this method. This method is called usually when the caller encounters an error when using the connection and wants it removed from the pool. Returns:boolean true if conn removed; false if it was not in pool public because implemented as part of PoolCallback.

removePooledConnection

back to summary

public boolean removePooledConnection(PooledConnection conn)

Implements com.sun.jndi.ldap.pool.PoolCallback.removePooledConnection.

Removes PooledConnection from list of connections. The closing of the connection is separate from this method. This method is called usually when the caller encounters an error when using the connection and wants it removed from the pool.

Returns:boolean

true if conn removed; false if it was not in pool

public because implemented as part of PoolCallback.

td	back to summary
private void td(String msg, Object o1, Object o2)

td	back to summary
private void td(String msg, Object o1)

td	back to summary
private void td(String msg)

unlock	back to summary
pack-priv void unlock()

waitForAvailableConnection	back to summary
pack-priv void waitForAvailableConnection() throws InterruptedNamingException

waitForAvailableConnection	back to summary
pack-priv void waitForAvailableConnection(long waitTime) throws InterruptedNamingException

pack-priv final Class Connections

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail