com.jolbox.bonecp

Class CachedConnectionStrategy

java.lang.Object

com.jolbox.bonecp.AbstractConnectionStrategy

com.jolbox.bonecp.CachedConnectionStrategy

All Implemented Interfaces:

ConnectionStrategy, Serializable

public class CachedConnectionStrategy
extends AbstractConnectionStrategy

A connection strategy that is optimized to store/retrieve the connection inside a thread local variable. This makes getting a connection in a managed thread environment such as Tomcat very fast but has the limitation that it only works if # of threads <= # of connections. Should it detect that this isn't the case anymore, this class will flip back permanently to the configured fallback strategy (i.e. default strategy) and makes sure that currently assigned and unused connections are taken back.

Author:

wallacew

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	CachedConnectionStrategy.CachedConnectionStrategyThreadLocal<T> This is moved here to aid testing by exposing a dumbGet() method.

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<ConnectionHandle,Reference<Thread>>	threadFinalizableRefs Keep track of connections tied to thread.
protected CachedConnectionStrategy.CachedConnectionStrategyThreadLocal<AbstractMap.SimpleEntry<ConnectionHandle,Boolean>>	tlConnections Connections are stored here.

Fields inherited from class com.jolbox.bonecp.AbstractConnectionStrategy

pool, terminationLock

Constructor Summary

Constructors

Constructor and Description
CachedConnectionStrategy(BoneCP pool, ConnectionStrategy fallbackStrategy)

Method Summary

Methods

Modifier and Type	Method and Description
void	cleanupConnection(ConnectionHandle oldHandle, ConnectionHandle newHandle) Give a chance to do some cleanups before closing off the connection.
protected Connection	getConnectionInternal() Actual call that returns a connection
ConnectionHandle	pollConnection() Obtains a connection using the configured strategy without blocking.
protected void	stealExistingAllocations() Tries to close off all the unused assigned connections back to the pool.
void	terminateAllConnections() Destroys all connections using this strategy.
protected void	threadWatch(ConnectionHandle c) Keep track of this handle tied to which thread so that if the thread is terminated we can reclaim our connection handle.

Methods inherited from class com.jolbox.bonecp.AbstractConnectionStrategy

getConnection, postConnection, preConnection

Methods inherited from class java.lang.Object

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

Field Detail

threadFinalizableRefs

protected final Map<ConnectionHandle,Reference<Thread>> threadFinalizableRefs

Keep track of connections tied to thread.

tlConnections

protected CachedConnectionStrategy.CachedConnectionStrategyThreadLocal<AbstractMap.SimpleEntry<ConnectionHandle,Boolean>> tlConnections

Connections are stored here.

Constructor Detail

CachedConnectionStrategy

public CachedConnectionStrategy(BoneCP pool,
                        ConnectionStrategy fallbackStrategy)

Parameters:

defaultConnectionStrategy -

boneCP -

Method Detail

stealExistingAllocations

protected void stealExistingAllocations()

Tries to close off all the unused assigned connections back to the pool. Assumes that the strategy mode has already been flipped prior to calling this routine. Called whenever our no of connection requests > no of threads.

threadWatch

protected void threadWatch(ConnectionHandle c)

Keep track of this handle tied to which thread so that if the thread is terminated we can reclaim our connection handle. We also

Parameters:

c - connection handle to track.

getConnectionInternal

protected Connection getConnectionInternal()
                                    throws SQLException

Description copied from class: AbstractConnectionStrategy

Actual call that returns a connection

Specified by:

getConnectionInternal in class AbstractConnectionStrategy

Returns:

Connection

Throws:

SQLException

pollConnection

public ConnectionHandle pollConnection()

Description copied from interface: ConnectionStrategy

Obtains a connection using the configured strategy without blocking.

Specified by:

pollConnection in interface ConnectionStrategy

Overrides:

pollConnection in class AbstractConnectionStrategy

Returns:

Connection

terminateAllConnections

public void terminateAllConnections()

Description copied from interface: ConnectionStrategy

Destroys all connections using this strategy.

cleanupConnection

public void cleanupConnection(ConnectionHandle oldHandle,
                     ConnectionHandle newHandle)

Description copied from interface: ConnectionStrategy

Give a chance to do some cleanups before closing off the connection.

Specified by:

cleanupConnection in interface ConnectionStrategy

Overrides:

cleanupConnection in class AbstractConnectionStrategy