org.tentackle.persist

Class DefaultDbPool

java.lang.Object

org.tentackle.persist.DefaultDbPool

All Implemented Interfaces:

ReturnableSessionProvider, SessionPool, SessionProvider

public class DefaultDbPool
extends Object
implements SessionPool

An implementation of a database pool.
It allows min/max sizes, fixed increments and timeouts for unused instances.

The pool can be used with any ConnectionManager. If used with the DefaultConnectionManager, each Db instance corresponds to a physical JDBC-connection. If used with an MpxConnectionManager, the Db instances map to virtual connections that will be attached temporarily during db-operations, i.e. the PdoCache will retain its data across sessions (if not closed due to idle timeout). This is the preferred configuration in server applications with a lot of clients. In order to clear the PdoCache on db-close, you have to override the closeDb method.

Constructor Summary

Constructors

Constructor and Description
DefaultDbPool(ConnectionManager conMgr, SessionInfo ui) Creates a pool useful for most servers. Using the default connection manager.
DefaultDbPool(String name, ConnectionManager conMgr, SessionInfo sessionInfo, int iniSize, int incSize, int minSize, int maxSize, long maxIdleMinutes, long maxUsageMinutes) Creates a pool.

Method Summary

Modifier and Type	Method and Description
protected void	closeDb(Db db) Closes a db. The method can be overridden if there is something to do after/before close.
ConnectionManager	getConnectionManager() Gets the connection manager.
int	getIncSize() Gets the minimum increment to enlarge the pool.
int	getIniSize() Gets the initial size.
long	getMaxIdleMinutes() Gets the idle timeout in minutes.
int	getMaxSize()
long	getMaxUsageMinutes() Gets the usage timeout in minutes.
int	getMinSize() Gets the minimum size.
String	getName() Gets the name of this pool.
Db	getSession()
SessionInfo	getSessionInfo() Gets the server's session info.
int	getSize()
boolean	isShutdown()
void	putSession(Session session)
void	setIncSize(int incSize) Sets the minimum increment to enlarge the pool.
void	setMaxIdleMinutes(long maxIdleMinutes) Sets the idle minutes. Sessions are closed if unused for given minutes.
void	setMaxSize(int maxSize) Sets the maximum size.
void	setMaxUsageMinutes(long maxUsageMinutes) Sets the maximum usage minutes. Sessions are closed if unused and first used foe given timeout.
void	setMinSize(int minSize) Sets the minimum size.
void	shutdown() Closes all databases in the pool, cleans up and makes the pool unusable.
String	toString() Gets the pool's name

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultDbPool

public DefaultDbPool(String name,
                     ConnectionManager conMgr,
                     SessionInfo sessionInfo,
                     int iniSize,
                     int incSize,
                     int minSize,
                     int maxSize,
                     long maxIdleMinutes,
                     long maxUsageMinutes)

Creates a pool.

Parameters:

name - the name of the pool

conMgr - the connection manager to use for new Db instances

sessionInfo - the server's session info

iniSize - the initial poolsize

incSize - the number of Db instances to enlarge the pool if all in use

minSize - the minimum number of Db instances to keep in pool

maxSize - the maximum number of Db instances, 0 = unlimited

maxIdleMinutes - the idle timeout in minutes to close unused Db instances, 0 = unlimited

maxUsageMinutes - the max. used time in minutes, 0 = unlimited

DefaultDbPool

public DefaultDbPool(ConnectionManager conMgr,
                     SessionInfo ui)

Creates a pool useful for most servers.
Using the default connection manager. Starts with 8 Db instances, increments by 2, minSize 4, maxSize from connection manager. Idle timeout 1 hour, usage timeout 1 day.

Parameters:

conMgr - the connection manager

ui - the userinfo for the created Db

Method Detail

toString

public String toString()

Gets the pool's name

Overrides:

toString in class Object

getName

public String getName()

Gets the name of this pool.

Specified by:

getName in interface SessionPool

Returns:

the name

getSessionInfo

public SessionInfo getSessionInfo()

Gets the server's session info.

Returns:

the session info

getConnectionManager

public ConnectionManager getConnectionManager()

Gets the connection manager.

Returns:

the connection manager

getIniSize

public int getIniSize()

Gets the initial size.

Returns:

the initial size

getIncSize

public int getIncSize()

Gets the minimum increment to enlarge the pool.

Returns:

the increment size

setIncSize

public void setIncSize(int incSize)

Sets the minimum increment to enlarge the pool.

Parameters:

incSize - the minimum increment (at least 1)

getMinSize

public int getMinSize()

Gets the minimum size.

Returns:

the minimum size

setMinSize

public void setMinSize(int minSize)

Sets the minimum size.

Parameters:

minSize - the minimum size (at least 1)

getMaxSize

public int getMaxSize()

Specified by:

getMaxSize in interface SessionPool

setMaxSize

public void setMaxSize(int maxSize)

Sets the maximum size.

Parameters:

maxSize - the maximum size (at least minSize)

getMaxIdleMinutes

public long getMaxIdleMinutes()

Gets the idle timeout in minutes.

Returns:

the idle timeout

setMaxIdleMinutes

public void setMaxIdleMinutes(long maxIdleMinutes)

Sets the idle minutes.
Sessions are closed if unused for given minutes.

Parameters:

maxIdleMinutes - the idle timeout, 0 if unlimited

getMaxUsageMinutes

public long getMaxUsageMinutes()

Gets the usage timeout in minutes.

Returns:

the usage timeout

setMaxUsageMinutes

public void setMaxUsageMinutes(long maxUsageMinutes)

Sets the maximum usage minutes.
Sessions are closed if unused and first used foe given timeout.

Parameters:

maxUsageMinutes - the usage timeout, 0 if unlimited

closeDb

protected void closeDb(Db db)

Closes a db.
The method can be overridden if there is something to do after/before close. For example, cleaning up the cache, etc...

Parameters:

db - the Db instance to close

shutdown

public void shutdown()

Closes all databases in the pool, cleans up and makes the pool unusable.

Specified by:

shutdown in interface SessionPool

isShutdown

public boolean isShutdown()

Specified by:

isShutdown in interface SessionPool

getSize

public int getSize()

Specified by:

getSize in interface SessionPool

getSession

public Db getSession()

Specified by:

getSession in interface SessionProvider

putSession

public void putSession(Session session)

Specified by:

putSession in interface ReturnableSessionProvider