Package com.kheops.jmap.db

Class DatabaseNamedConnectionPool

java.lang.Object

com.kheops.util.KObjectPool

com.kheops.jmap.db.DatabaseConnectionPool

com.kheops.jmap.db.DatabaseNamedConnectionPool

All Implemented Interfaces:

JMapServerSessionListener, KSchedulerClient

public class DatabaseNamedConnectionPool
extends DatabaseConnectionPool
implements JMapServerSessionListener

Field Summary

Fields inherited from class com.kheops.jmap.db.DatabaseConnectionPool

currentSchema, databaseConfig, listeners, poolInfo

Fields inherited from class com.kheops.util.KObjectPool

cleanupPeriod, recyclePeriod, shrinkTime, TIMEOUT_UNDEFINED, TIMEOUT_UNLIMITED

Constructor Summary

Constructors

Constructor	Description
DatabaseNamedConnectionPool(JMapServerSessionCtrl sessionCtrl)	Creates a new DatabaseNamedConnectionPool instance.
DatabaseNamedConnectionPool(JMapServerSessionCtrl connCtrl, DatabaseConnectionPoolInfo poolInfo)	Deprecated. use the DatabaseNamedConnectionPool(JMapServerSessionCtrl) constructor and init(DatabaseConnectionPoolInfo, DatabaseConfig)
DatabaseNamedConnectionPool(JMapServerSessionCtrl connCtrl, DatabaseConnectionPoolInfo poolInfo, DatabaseConfig config)	Deprecated. use the default constructor and init(DatabaseConnectionPoolInfo, DatabaseConfig)

Method Summary

Modifier and Type	Method	Description
Connection	borrowConnection()	Borrows a connection from the main connection pool.
Connection	borrowConnection(int id)	Borrows a connection from the pool for exclusive use until it is returned by calling the method returnConnection.
void	close()	This method closes one by one all the objects currently opened for this the pool
void	expire(Object o)	Should not be called.
PoolMonitoringInfo	getMonitoringInfo()	This method gets the PoolMonitorInfo associated with the KObject pool instance.
boolean	init(DatabaseConnectionPoolInfo poolInfo, DatabaseConfig databaseConfig)	Initializes the connection pool with the specified pool info.
void	initialize(int minimumSize, long shrinkTime, long cleanupPeriod, long recyclePeriod)	Initializes a KObjectPool instance with the specified minimum size, recycle period, clean up period and shrink period
void	returnConnection(int id, Connection conn)	Returns a connection to the poll that was obtained using the method borrowConnection.
void	returnConnection(Connection conn)	Returns the specified connection to the main connection pool.
void	schCallback(int jobId)	This method is automatically called by the KScheduler to either perform the clean up or object recycle jobs
void	sessionCreated(JMapServerSessionEvent event)
void	sessionDestroyed(JMapServerSessionEvent event)

Methods inherited from class com.kheops.jmap.db.DatabaseConnectionPool

activate, addListener, borrowConnection, create, deactivate, getCurrentSchema, getDatabaseConfig, getDatabaseConnectionPoolInfo, getId, getLastException, getStatus, getSystemDefaultTimeout, internalErrorOccurred, isInactive, removeListener, reset, setDatabaseConfig, setStatus, validate

Methods inherited from class com.kheops.util.KObjectPool

apply, checkIn, checkOut, checkOut, createUnlockedInstance, getDefaultTimeout, getPoolMaximumSize, getPoolSize, getPoolUsageCount, getPoolUsagePeak, initialize, initialize, resourceAdded, setDefaultTimeout, setPoolMaximumSize, setPoolMinimumSize

Methods inherited from class java.lang.Object

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

Constructor Details

DatabaseNamedConnectionPool

public DatabaseNamedConnectionPool(JMapServerSessionCtrl sessionCtrl)

Creates a new DatabaseNamedConnectionPool instance.

Parameters:

sessionCtrl - a valid JMapServerSessionCtrl instance.

Since:

6.5

See Also:

• init(DatabaseConnectionPoolInfo, DatabaseConfig)

DatabaseNamedConnectionPool

@Deprecated
public DatabaseNamedConnectionPool(JMapServerSessionCtrl connCtrl,
 DatabaseConnectionPoolInfo poolInfo)

Deprecated.

use the DatabaseNamedConnectionPool(JMapServerSessionCtrl) constructor and init(DatabaseConnectionPoolInfo, DatabaseConfig)

Creates a new connection pool instance.

Parameters:

poolInfo - the DatabaseConnectionPoolInfo instance associated with this DatabaseconnectionPool

sessionCtrl - a valid JMapServerSessionCtrl instance.

DatabaseNamedConnectionPool

@Deprecated
public DatabaseNamedConnectionPool(JMapServerSessionCtrl connCtrl,
 DatabaseConnectionPoolInfo poolInfo,
 DatabaseConfig config)

Deprecated.

use the default constructor and init(DatabaseConnectionPoolInfo, DatabaseConfig)

Creates a new connection pool instance.

Parameters:

poolInfo - the DatabaseConnectionPoolInfo instance associated with this DatabaseconnectionPool

sessionCtrl - a valid JMapServerSessionCtrl instance.

databaseConfig - the database configuration to use with borrowed connections.

Method Details

init

public boolean init(DatabaseConnectionPoolInfo poolInfo,
 DatabaseConfig databaseConfig)

Initializes the connection pool with the specified pool info.

Overrides:

init in class DatabaseConnectionPool

Parameters:

poolInfo - the DatabaseConnectionPoolInfo instance associated with this DatabaseconnectionPool

databaseConfig - the database configuration to use with borrowed connections.

Returns:

true if no error occurred during the initialization.

initialize

public void initialize(int minimumSize,
 long shrinkTime,
 long cleanupPeriod,
 long recyclePeriod)
                throws Exception

Description copied from class: KObjectPool

Initializes a KObjectPool instance with the specified minimum size, recycle period, clean up period and shrink period

Overrides:

initialize in class KObjectPool

Parameters:

minimumSize - the minimum number of objects in this pool

shrinkTime - the amount of time extra objects can remain inactive before it eligible for cleanup

cleanupPeriod - the amount of time between cleanups

recyclePeriod - the amount of time an initial object can remain inactive before it is recycled (closed than reopen).

Throws:

Exception - if an error occurred while initializing the object pool

schCallback

public void schCallback(int jobId)

This method is automatically called by the KScheduler to either perform the clean up or object recycle jobs

Specified by:

schCallback in interface KSchedulerClient

Overrides:

schCallback in class KObjectPool

Parameters:

jobId - the job Id to determine which job will be done

borrowConnection

public Connection borrowConnection()
                            throws SQLException

Borrows a connection from the main connection pool.

Overrides:

borrowConnection in class DatabaseConnectionPool

Returns:

a connection from the main connection pool.

Throws:

SQLException

borrowConnection

public Connection borrowConnection(int id)
                            throws SQLException

Borrows a connection from the pool for exclusive use until it is returned by calling the method returnConnection.

Overrides:

borrowConnection in class DatabaseConnectionPool

Parameters:

id - an object which identifies the connection borrower.

Returns:

a database connection

Throws:

SQLException

returnConnection

public void returnConnection(Connection conn)

Returns the specified connection to the main connection pool.

Overrides:

returnConnection in class DatabaseConnectionPool

Parameters:

conn - the connection to return.

returnConnection

public void returnConnection(int id,
 Connection conn)

Returns a connection to the poll that was obtained using the method borrowConnection. This method MUST ABSOLUTELY be called when the connection not needed anymore otherwise it will stay unavailable for ever for other users.

Overrides:

returnConnection in class DatabaseConnectionPool

Parameters:

id - an integer which identifies the connection borrower.

conn - the corresponding connection

expire

public void expire(Object o)

Should not be called.

Overrides:

expire in class DatabaseConnectionPool

Parameters:

o - object (DatabaseConnectionPool) to close

sessionCreated

public void sessionCreated(JMapServerSessionEvent event)

Specified by:

sessionCreated in interface JMapServerSessionListener

sessionDestroyed

public void sessionDestroyed(JMapServerSessionEvent event)

Specified by:

sessionDestroyed in interface JMapServerSessionListener

getMonitoringInfo

public PoolMonitoringInfo getMonitoringInfo()

This method gets the PoolMonitorInfo associated with the KObject pool instance. The PoolMonitorInfo maintains the pool statistics

Overrides:

getMonitoringInfo in class KObjectPool

Returns:

the corresponding PoolMonitorInfo instance

See Also:

• PoolMonitoringInfo

close

public void close()

Description copied from class: KObjectPool

This method closes one by one all the objects currently opened for this the pool

Overrides:

close in class KObjectPool