org.vibur.dbcp.stcache

Class ClhmStatementCache

java.lang.Object

org.vibur.dbcp.stcache.ClhmStatementCache

All Implemented Interfaces:

StatementCache

public class ClhmStatementCache
extends Object
implements StatementCache

Implements and encapsulates all JDBC Statement caching functionality and logic. The cache implementation is based on ConcurrentLinkedHashMap.

Author:

Simeon Malchev

Constructor Summary

Constructors

Constructor and Description
ClhmStatementCache(int maxSize)

Method Summary

Modifier and Type	Method and Description
protected ConcurrentMap<StatementMethod,StatementHolder>	buildStatementCache(int maxSize)
void	close() Closes this ClhmStatementCache and removes all entries from it.
boolean	isClosed() Returns true if this StatementCache is closed; false otherwise.
boolean	remove(StatementHolder statement) Removes an entry from the cache (if such) for the given statement.
int	removeAll(Connection rawConnection) Removes all entries from the cache (if any) for the given rawConnection.
boolean	restore(StatementHolder statement, boolean clearWarnings) Restores (i.e.
StatementHolder	take(StatementMethod statementMethod) Returns a possibly cached StatementHolder object for the given connection statement method.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClhmStatementCache

public ClhmStatementCache(int maxSize)

Method Detail

buildStatementCache

protected ConcurrentMap<StatementMethod,StatementHolder> buildStatementCache(int maxSize)

take

public StatementHolder take(StatementMethod statementMethod)
                     throws SQLException

Description copied from interface: StatementCache

Returns a possibly cached StatementHolder object for the given connection statement method.

Specified by:

take in interface StatementCache

Parameters:

statementMethod - the statement method

Returns:

a retrieved from the cache or newly created StatementHolder object wrapping the raw PreparedStatement object

Throws:

SQLException - if the invoked underlying "prepare..." method throws an exception

restore

public boolean restore(StatementHolder statement,
                       boolean clearWarnings)

Description copied from interface: StatementCache

Restores (i.e. marks as available) the given StatementHolder back in the cache.

Specified by:

restore in interface StatementCache

Parameters:

statement - the given StatementHolder

clearWarnings - if true will execute Statement.clearWarnings() on the underlying raw PreparedStatement

Returns:

true if successfully restored the statement in the cache, false otherwise

remove

public boolean remove(StatementHolder statement)

Description copied from interface: StatementCache

Removes an entry from the cache (if such) for the given statement. Does not close the removed statement.

Specified by:

remove in interface StatementCache

Parameters:

statement - the StatementHolder to be removed

Returns:

true if success, false otherwise

removeAll

public int removeAll(Connection rawConnection)

Description copied from interface: StatementCache

Removes all entries from the cache (if any) for the given rawConnection. Closes all removed statements.

Specified by:

removeAll in interface StatementCache

Parameters:

rawConnection - the connection for which the entries to be removed

Returns:

the number of removed entries

close

public void close()

Closes this ClhmStatementCache and removes all entries from it.

Specified by:

close in interface StatementCache

isClosed

public boolean isClosed()

Description copied from interface: StatementCache

Returns true if this StatementCache is closed; false otherwise.

Specified by:

isClosed in interface StatementCache