Package net.officefloor.jdbc.pool

Class ThreadLocalJdbcConnectionPool

java.lang.Object

net.officefloor.jdbc.pool.ThreadLocalJdbcConnectionPool

All Implemented Interfaces:

ManagedObjectPool, ThreadCompletionListener

public class ThreadLocalJdbcConnectionPool
extends java.lang.Object
implements ManagedObjectPool, ThreadCompletionListener

Connection ManagedObjectPool implementation that uses ThreadLocal instances to reduce contention of retrieving Connection from singleton pool.

Author:

Daniel Sagenschneider

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ThreadLocalJdbcConnectionPool.CompiledConnectionWrapper	Interface on compiled Connection wrapper extract details of the Connection.
static interface	ThreadLocalJdbcConnectionPool.ConnectionReference	Reference to a Connection.
static class	ThreadLocalJdbcConnectionPool.ConnectionReferenceImpl	Connection reference.
static interface	ThreadLocalJdbcConnectionPool.PooledConnectionContext	Context for the pooled Connection.
static interface	ThreadLocalJdbcConnectionPool.PooledConnectionWrapperFactory	Factory to create wrapper for the PooledConnection.

Constructor Summary

Constructors

Constructor	Description
ThreadLocalJdbcConnectionPool(javax.sql.ConnectionPoolDataSource dataSource, ThreadLocalJdbcConnectionPool.PooledConnectionWrapperFactory wrapperFactory, int maximumConnections, long connectionWaitTime)	Instantiate.

Method Summary

Modifier and Type	Method	Description
static ThreadLocalJdbcConnectionPool.PooledConnectionWrapperFactory	createWrapperFactory(SourceContext sourceContext)	Creates the ThreadLocalJdbcConnectionPool.PooledConnectionWrapperFactory.
void	empty()	Invoked on close of the OfficeFloor to allow handling pooled ManagedObject instances.
java.sql.Connection	getThreadLocalConnection()	Obtains the ThreadLocal Connection.
void	lostManagedObject(ManagedObject managedObject, java.lang.Throwable cause)	Flags that the ManagedObject is lost.
void	returnManagedObject(ManagedObject managedObject)	Returns an instance to the pool.
void	sourceManagedObject(ManagedObjectUser user)	Sources the ManagedObject from this ManagedObjectPool.
void	threadComplete()	Notifies that the Thread has completed.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.officefloor.frame.api.managedobject.pool.ManagedObjectPool

getSourcedManagedObject

Constructor Detail

ThreadLocalJdbcConnectionPool

public ThreadLocalJdbcConnectionPool(javax.sql.ConnectionPoolDataSource dataSource,
                                     ThreadLocalJdbcConnectionPool.PooledConnectionWrapperFactory wrapperFactory,
                                     int maximumConnections,
                                     long connectionWaitTime)

Instantiate.

Parameters:

dataSource - ConnectionPoolDataSource.

wrapperFactory - ThreadLocalJdbcConnectionPool.PooledConnectionWrapperFactory.

maximumConnections - Maximum number of connections. 0 (or negative) for unbounded number of Connection instances.

connectionWaitTime - Wait time in milliseconds for a Connection to become available.

Method Detail

createWrapperFactory

public static ThreadLocalJdbcConnectionPool.PooledConnectionWrapperFactory createWrapperFactory(SourceContext sourceContext)
                                                                                         throws java.lang.Exception

Creates the ThreadLocalJdbcConnectionPool.PooledConnectionWrapperFactory.

Parameters:

sourceContext - SourceContext.

Returns:

ThreadLocalJdbcConnectionPool.PooledConnectionWrapperFactory.

Throws:

java.lang.Exception - If fails to create ThreadLocalJdbcConnectionPool.PooledConnectionWrapperFactory.

getThreadLocalConnection

public java.sql.Connection getThreadLocalConnection()

Obtains the ThreadLocal Connection.

Returns:

ThreadLocal Connection.

sourceManagedObject

public void sourceManagedObject(ManagedObjectUser user)

Description copied from interface: ManagedObjectPool

Sources the ManagedObject from this ManagedObjectPool.

Specified by:

sourceManagedObject in interface ManagedObjectPool

Parameters:

user - ManagedObjectUser requiring the ManagedObject.

returnManagedObject

public void returnManagedObject(ManagedObject managedObject)

Description copied from interface: ManagedObjectPool

Returns an instance to the pool.

Specified by:

returnManagedObject in interface ManagedObjectPool

Parameters:

managedObject - ManagedObject.

lostManagedObject

public void lostManagedObject(ManagedObject managedObject,
                              java.lang.Throwable cause)

Description copied from interface: ManagedObjectPool

Flags that the ManagedObject is lost.

Specified by:

lostManagedObject in interface ManagedObjectPool

Parameters:

managedObject - ManagedObject to no longer be used.

cause - Cause for the ManagedObject to be lost.

empty

public void empty()

Description copied from interface: ManagedObjectPool

Invoked on close of the OfficeFloor to allow handling pooled ManagedObject instances.

Specified by:

empty in interface ManagedObjectPool

threadComplete

public void threadComplete()

Description copied from interface: ThreadCompletionListener

Notifies that the Thread has completed.

Specified by:

threadComplete in interface ThreadCompletionListener