com.intersystems.jdbc

Class IRISConnectionPoolDataSource

java.lang.Object

com.intersystems.jdbc.IRISWrapper

com.intersystems.jdbc.IRISDataSource

com.intersystems.jdbc.IRISConnectionPoolDataSource

All Implemented Interfaces:

Wrapper, CommonDataSource, ConnectionPoolDataSource, DataSource

public class IRISConnectionPoolDataSource
extends IRISDataSource
implements ConnectionPoolDataSource

IRISConnectionPoolDataSource object is an implementation of ConnectionPoolDataSource interface In addition to the apis defined by the interface, this class also includes a number of InterSystems IRIS specific apis. There are apis that can be used to limit (and view) the max connection pool size, view current pool size, and reset the current connection pool. Connections should always be obtained by calling getConnection apis, which are inherited from the DataSource class. getPooledConnection apis are meant for use within the driver only, and should not be used by the calling applications.

Constructor Summary

Constructors

Constructor and Description
IRISConnectionPoolDataSource()

Method Summary

Modifier and Type	Method and Description
int	getConnectionWaitTimeout() Returns the current Connection Wait Timeout.
int	getMaxPoolSize() Returns the current Connection Pool max size
int	getPoolCount() Returns the current Connection Pool size
PooledConnection	getPooledConnection() IMPORTANT: this api SHOULD NOT be used to obtain a pooled connection.
PooledConnection	getPooledConnection(String usr, String pwd) IMPORTANT: this api SHOULD NOT be used to obtain a pooled connection.
void	restartConnectionPool() Restarts a Connection Pool.
void	setConnectionWaitTimeout(int timeout) Set the connection wait timeout.
void	setMaxPoolSize(int max) Sets a Connection Pool max size.

Methods inherited from class com.intersystems.jdbc.IRISDataSource

getConnection, getConnection, getConnectionSecurityLevel, getDatabaseName, getDataSourceName, getDefaultTransactionIsolation, getDescription, getEventClass, getIPv6ServerAddress, getKeyRecoveryPassword, getLoginTimeout, getLogWriter, getNodelay, getParentLogger, getPassword, getPortNumber, getServerName, getServicePrincipalName, getSharedMemory, getSSLConfigurationName, getURL, getUser, setConnectionSecurityLevel, setDatabaseName, setDataSourceName, setDefaultTransactionIsolation, setDescription, setEventClass, setIPv6ServerAddress, setKeyRecoveryPassword, setLogFile, setLoginTimeout, setLogWriter, setNodelay, setPassword, setPortNumber, setServerName, setServicePrincipalName, setSharedMemory, setSSLConfigurationName, setURL, setUser

Methods inherited from class com.intersystems.jdbc.IRISWrapper

isWrapperFor, unwrap

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.sql.CommonDataSource

getLoginTimeout, getLogWriter, getParentLogger, setLoginTimeout, setLogWriter

Methods inherited from interface java.sql.Wrapper

isWrapperFor, unwrap

Constructor Detail

IRISConnectionPoolDataSource

public IRISConnectionPoolDataSource()

Method Detail

getPooledConnection

public PooledConnection getPooledConnection()
                                     throws SQLException

IMPORTANT: this api SHOULD NOT be used to obtain a pooled connection. Use getConnection() instead.

Specified by:

getPooledConnection in interface ConnectionPoolDataSource

Throws:

SQLException - throws SQLException

getPooledConnection

public PooledConnection getPooledConnection(String usr,
                                            String pwd)
                                     throws SQLException

IMPORTANT: this api SHOULD NOT be used to obtain a pooled connection. Use getConnection(String user, String pwd) instead.

Specified by:

getPooledConnection in interface ConnectionPoolDataSource

Parameters:

usr - username

pwd - password

Throws:

SQLException - throws SQLException

restartConnectionPool

public void restartConnectionPool()
                           throws SQLException

Restarts a Connection Pool. Closes all physical connections, and empties the Connection Pool.

Throws:

SQLException - throws SQLException

getPoolCount

public int getPoolCount()

Returns the current Connection Pool size

Returns:

pool size

setMaxPoolSize

public void setMaxPoolSize(int max)

Sets a Connection Pool max size. If the max size is not set, it defaults to 40.

Parameters:

max - max pool size

getMaxPoolSize

public int getMaxPoolSize()

Returns the current Connection Pool max size

Returns:

max pool size

getConnectionWaitTimeout

public int getConnectionWaitTimeout()

Returns the current Connection Wait Timeout. This is the time, in seconds, that a Connection Pool Manager will wait for any connections to become available. If the pool is not full, and the connection is available, it will immediately be returned, regardless of whether the Connection Wait Timeout value has been set. Otherwise, the Connection Pool Manager will wait exactly timeout seconds before making another attempt to acquire a connection. Should there be no connections available after the timout period has expired, an exception will be thrown. Connection Wait Timeout defaults to zero, which means that the connection will either be immediately made available, or an exception will be thrown indicating that the pool is full.

Returns:

the connectionWaitTimeout

setConnectionWaitTimeout

public void setConnectionWaitTimeout(int timeout)

Set the connection wait timeout. See getConnectionWaitTimeout for more details on Connection Wait Timeout.

Parameters:

timeout - the connectionWaitTimeout to set