net.dataforte.cassandra.pool
Interface PoolConfiguration

All Known Implementing Classes:

DataSource, PoolProperties

public interface PoolConfiguration

A list of properties that are configurable for a connection pool.

Author:

Tristan Tarrant

Method Summary

Object	get(String name) Provides a generic getter for any of the declared properties of the PoolConfiguration
int	getAbandonWhenPercentageFull() Connections that have been abandoned (timed out) wont get closed and reported up unless the number of connections in use are above the percentage defined by abandonWhenPercentageFull.
String[]	getConfiguredHosts() Returns an array of configured hosts (may be different from the actual list if dynamic discovery is enabled)
Object	getDataSource() Returns a datasource, if one exists that is being used to create connections.
String	getDataSourceJNDI() Returns the JNDI string configured for data source usage.
HostFailoverPolicy	getFailoverPolicy() Returns the failover policy.
String	getHost() Returns the Cassandra hosts
long	getHostRetryInterval() Returns the interval in milliseconds before retrying a host to which a connection has failed in the past.
int	getInitialSize() Returns the number of connections that will be established when the connection pool is started.
String	getKeySpace() Returns the keyspace
int	getMaxActive() The maximum number of active connections that can be allocated from this pool at the same time.
long	getMaxAge() Time in milliseconds to keep this connection alive even when used.
int	getMaxIdle() The maximum number of connections that should be kept in the idle pool if isPoolSweeperEnabled() returns false.
int	getMaxWait() The maximum number of milliseconds that the pool will wait (when there are no available connections and the getMaxActive() has been reached) for a connection to be returned before throwing an exception.
int	getMinEvictableIdleTimeMillis() The minimum amount of time an object must sit idle in the pool before it is eligible for eviction.
int	getMinIdle() The minimum number of established connections that should be kept in the pool at all times.
String	getName() Returns the name of the connection pool.
int	getNumTestsPerEvictionRun() Property not used
String	getPassword() Returns the password used when establishing connections to the database.
String	getPoolName()
int	getPort() Returns the Cassandra port (defaults to 9160)
int	getRemoveAbandonedTimeout() The time in seconds before a connection can be considered abandoned.
int	getSocketTimeout() Returns the socket timeout in milliseconds
int	getSuspectTimeout() Returns the time in seconds to pass before a connection is marked an abanoned suspect.
int	getTimeBetweenEvictionRunsMillis() The number of milliseconds to sleep between runs of the idle connection validation, abandoned cleaner and idle pool resizing.
String	getUrl() Returns the Cassandra connection URL
boolean	getUseLock() Return true if a lock should be used when operations are performed on the connection object.
String	getUsername() Returns the username used to establish the connection with
long	getValidationInterval() avoid excess validation, only run validation at most at this frequency - time in milliseconds.
boolean	isAutomaticHostDiscovery() Returns whether automatic host discovery is being used
boolean	isFairQueue() Returns true if a fair queue is being used by the connection pool
boolean	isFramed() Returns whether framed connection mode is being used
boolean	isJmxEnabled() If set to true, the connection pool creates a ConnectionPoolMBean object that can be registered with JMX to receive notifications and state about the pool.
boolean	isLogAbandoned() boolean flag to set if stack traces should be logged for application code which abandoned a Connection.
boolean	isPoolSweeperEnabled() Returns true if the pool sweeper is enabled for the connection pool.
boolean	isRemoveAbandoned() boolean flag to remove abandoned connections if they exceed the removeAbandonedTimout.
boolean	isTestOnBorrow() The indication of whether objects will be validated before being borrowed from the pool.
boolean	isTestOnConnect() Returns true if we should run the validation query when connecting to the database for the first time on a connection.
boolean	isTestOnReturn() The indication of whether objects will be validated after being returned to the pool.
boolean	isTestWhileIdle() Set to true if query validation should take place while the connection is idle.
boolean	isUseEquals() Set to true if you wish the ProxyConnection class to use String.equals instead of == when comparing method names.
void	set(String name, Object value) Provides a generic setter for any of the declared properties of the PoolConfiguration
void	setAbandonWhenPercentageFull(int percentage) Connections that have been abandoned (timed out) wont get closed and reported up unless the number of connections in use are above the percentage defined by abandonWhenPercentageFull.
void	setAutomaticHostDiscovery(boolean autoDiscovery) Sets whether Cassandra hosts should be queried to automatically obtain a list of other hosts
void	setDataSource(Object ds) Injects a datasource that will be used to retrieve/create connections.
void	setDataSourceJNDI(String jndiDS) Configure the connection pool to use a DataSource according to setDataSource(Object) But instead of injecting the object, specify the JNDI location.
void	setFailoverPolicy(HostFailoverPolicy failoverPolicy) Sets the host failover policy, i.e. what to do when connecting to a host fails
void	setFairQueue(boolean fairQueue) Set to true if you wish that calls to getConnection should be treated fairly in a true FIFO fashion.
void	setFramed(boolean framed) Sets whether to use framed connection mode (default false)
void	setHost(String host) Sets the Cassandra host.
void	setHostRetryInterval(long hostRetryInterval) Sets the interval in milliseconds before retrying a host to which a connection has failed in the past.
void	setInitialSize(int initialSize) Set the number of connections that will be established when the connection pool is started.
void	setJmxEnabled(boolean jmxEnabled) If set to true, the connection pool creates a ConnectionPoolMBean object that can be registered with JMX to receive notifications and state about the pool.
void	setKeySpace(String keySpace) Sets the keyspace
void	setLogAbandoned(boolean logAbandoned) boolean flag to set if stack traces should be logged for application code which abandoned a Connection.
void	setMaxActive(int maxActive) The maximum number of active connections that can be allocated from this pool at the same time.
void	setMaxAge(long maxAge) Time in milliseconds to keep this connection alive even when used.
void	setMaxIdle(int maxIdle) The maximum number of connections that should be kept in the idle pool if isPoolSweeperEnabled() returns false.
void	setMaxWait(int maxWait) The maximum number of milliseconds that the pool will wait (when there are no available connections and the getMaxActive() has been reached) for a connection to be returned before throwing an exception.
void	setMinEvictableIdleTimeMillis(int minEvictableIdleTimeMillis) The minimum amount of time an object must sit idle in the pool before it is eligible for eviction.
void	setMinIdle(int minIdle) The minimum number of established connections that should be kept in the pool at all times.
void	setName(String name) Sets the name of the connection pool
void	setNumTestsPerEvictionRun(int numTestsPerEvictionRun) Property not used
void	setPassword(String password) Sets the password to establish the connection with.
void	setPort(int port) Sets the Cassandra port
void	setRemoveAbandoned(boolean removeAbandoned) boolean flag to remove abandoned connections if they exceed the removeAbandonedTimout.
void	setRemoveAbandonedTimeout(int removeAbandonedTimeout) The time in seconds before a connection can be considered abandoned.
void	setSocketTimeout(int socketTimeout) Sets the socket timeout in milliseconds
void	setSuspectTimeout(int seconds) Similar to setRemoveAbandonedTimeout(int) but instead of treating the connection as abandoned, and potentially closing the connection, this simply logs the warning if isLogAbandoned() returns true.
void	setTestOnBorrow(boolean testOnBorrow) The indication of whether objects will be validated before being borrowed from the pool.
void	setTestOnConnect(boolean testOnConnect) Set to true if we should run the validation query when connecting to the database for the first time on a connection.
void	setTestOnReturn(boolean testOnReturn) The indication of whether objects will be validated after being returned to the pool.
void	setTestWhileIdle(boolean testWhileIdle) Set to true if query validation should take place while the connection is idle.
void	setTimeBetweenEvictionRunsMillis(int timeBetweenEvictionRunsMillis) The number of milliseconds to sleep between runs of the idle connection validation, abandoned cleaner and idle pool resizing.
void	setUrl(String url) Sets the Cassandra connection URL.
void	setUseEquals(boolean useEquals) Set to true if you wish the ProxyConnection class to use String.equals instead of == when comparing method names.
void	setUseLock(boolean useLock) Set to true if a lock should be used when operations are performed on the connection object.
void	setUsername(String username) Sets the username used to establish the connection with
void	setValidationInterval(long validationInterval) avoid excess validation, only run validation at most at this frequency - time in milliseconds.

Method Detail

set

void set(String name,
         Object value)

Provides a generic setter for any of the declared properties of the PoolConfiguration

Parameters:

name - the name of the property

value - the new value of the property

get

Object get(String name)

Provides a generic getter for any of the declared properties of the PoolConfiguration

Parameters:

name - the name of the property

Returns:

the value of the property

setHost

void setHost(String host)

Sets the Cassandra host. May be a comma-separated list of addresses

Parameters:

host -

getHost

String getHost()

Returns the Cassandra hosts

Returns:

a single string representing the Cassandra host addresses separated by commas

setUrl

void setUrl(String url)

Sets the Cassandra connection URL. The url is in the form cassandra:thrift://[host]:[port]

Parameters:

url -

getUrl

String getUrl()

Returns the Cassandra connection URL

Returns:

setPort

void setPort(int port)

Sets the Cassandra port

Parameters:

port -

getPort

int getPort()

Returns the Cassandra port (defaults to 9160)

Returns:

the Cassandra port

setFramed

void setFramed(boolean framed)

Sets whether to use framed connection mode (default false)

Parameters:

framed -

isFramed

boolean isFramed()

Returns whether framed connection mode is being used

Returns:

whether framed connection mode is being used

setAutomaticHostDiscovery

void setAutomaticHostDiscovery(boolean autoDiscovery)

Sets whether Cassandra hosts should be queried to automatically obtain a list of other hosts

Parameters:

autoDiscovery -

isAutomaticHostDiscovery

boolean isAutomaticHostDiscovery()

Returns whether automatic host discovery is being used

Returns:

whether automatic host discovery is being used

setFailoverPolicy

void setFailoverPolicy(HostFailoverPolicy failoverPolicy)

Sets the host failover policy, i.e. what to do when connecting to a host fails

getFailoverPolicy

HostFailoverPolicy getFailoverPolicy()

Returns the failover policy.

Returns:

the failover policy

setAbandonWhenPercentageFull

void setAbandonWhenPercentageFull(int percentage)

Connections that have been abandoned (timed out) wont get closed and reported up unless the number of connections in use are above the percentage defined by abandonWhenPercentageFull. The value should be between 0-100. The default value is 0, which implies that connections are eligible for closure as soon as removeAbandonedTimeout has been reached.

Parameters:

percentage - a value between 0 and 100 to indicate when connections that have been abandoned/timed out are considered abandoned

getAbandonWhenPercentageFull

int getAbandonWhenPercentageFull()

Connections that have been abandoned (timed out) wont get closed and reported up unless the number of connections in use are above the percentage defined by abandonWhenPercentageFull. The value should be between 0-100. The default value is 0, which implies that connections are eligible for closure as soon as removeAbandonedTimeout has been reached.

Returns:

percentage - a value between 0 and 100 to indicate when connections that have been abandoned/timed out are considered abandoned

isFairQueue

boolean isFairQueue()

Returns true if a fair queue is being used by the connection pool

Returns:

true if a fair waiting queue is being used

setFairQueue

void setFairQueue(boolean fairQueue)

Set to true if you wish that calls to getConnection should be treated fairly in a true FIFO fashion. This uses the FairBlockingQueue implementation for the list of the idle connections. The default value is true. This flag is required when you want to use asynchronous connection retrieval.

Parameters:

fairQueue -

getInitialSize

int getInitialSize()

Returns the number of connections that will be established when the connection pool is started. Default value is 10

Returns:

number of connections to be started when pool is started

setInitialSize

void setInitialSize(int initialSize)

Set the number of connections that will be established when the connection pool is started. Default value is 10. If this value exceeds setMaxActive(int) it will automatically be lowered.

Parameters:

initialSize - the number of connections to be established.

isLogAbandoned

boolean isLogAbandoned()

boolean flag to set if stack traces should be logged for application code which abandoned a Connection. Logging of abandoned Connections adds overhead for every Connection borrow because a stack trace has to be generated. The default value is false.

Returns:

true if the connection pool logs stack traces when connections are borrowed from the pool.

setLogAbandoned

void setLogAbandoned(boolean logAbandoned)

boolean flag to set if stack traces should be logged for application code which abandoned a Connection. Logging of abandoned Connections adds overhead for every Connection borrow because a stack trace has to be generated. The default value is false.

Parameters:

logAbandoned - set to true if stack traces should be recorded when DataSourceProxy.getConnection() is called.

getMaxActive

int getMaxActive()

The maximum number of active connections that can be allocated from this pool at the same time. The default value is 100

Returns:

the maximum number of connections used by this pool

setMaxActive

void setMaxActive(int maxActive)

The maximum number of active connections that can be allocated from this pool at the same time. The default value is 100

Parameters:

maxActive - hard limit for number of managed connections by this pool

getMaxIdle

int getMaxIdle()

The maximum number of connections that should be kept in the idle pool if isPoolSweeperEnabled() returns false. If the If isPoolSweeperEnabled() returns true, then the idle pool can grow up to getMaxActive() and will be shrunk according to getMinEvictableIdleTimeMillis() setting. Default value is maxActive:100

Returns:

the maximum number of idle connections.

setMaxIdle

void setMaxIdle(int maxIdle)

The maximum number of connections that should be kept in the idle pool if isPoolSweeperEnabled() returns false. If the If isPoolSweeperEnabled() returns true, then the idle pool can grow up to getMaxActive() and will be shrunk according to getMinEvictableIdleTimeMillis() setting. Default value is maxActive:100

Parameters:

maxIdle - the maximum size of the idle pool

getMaxWait

int getMaxWait()

The maximum number of milliseconds that the pool will wait (when there are no available connections and the getMaxActive() has been reached) for a connection to be returned before throwing an exception. Default value is 30000 (30 seconds)

Returns:

the number of milliseconds to wait for a connection to become available if the pool is maxed out.

setMaxWait

void setMaxWait(int maxWait)

The maximum number of milliseconds that the pool will wait (when there are no available connections and the getMaxActive() has been reached) for a connection to be returned before throwing an exception. Default value is 30000 (30 seconds)

Parameters:

maxWait - the maximum number of milliseconds to wait.

getMinEvictableIdleTimeMillis

int getMinEvictableIdleTimeMillis()

The minimum amount of time an object must sit idle in the pool before it is eligible for eviction. The default value is 60000 (60 seconds).

Returns:

the minimum amount of idle time in milliseconds before a connection is considered idle and eligible for eviction.

setMinEvictableIdleTimeMillis

void setMinEvictableIdleTimeMillis(int minEvictableIdleTimeMillis)

The minimum amount of time an object must sit idle in the pool before it is eligible for eviction. The default value is 60000 (60 seconds).

Parameters:

minEvictableIdleTimeMillis - the number of milliseconds a connection must be idle to be eligible for eviction.

getMinIdle

int getMinIdle()

The minimum number of established connections that should be kept in the pool at all times. The connection pool can shrink below this number if validation queries fail and connections get closed. Default value is derived from getInitialSize() (also see setTestWhileIdle(boolean) The idle pool will not shrink below this value during an eviction run, hence the number of actual connections can be between getMinIdle() and somewhere between getMaxIdle() and getMaxActive()

Returns:

the minimum number of idle or established connections

setMinIdle

void setMinIdle(int minIdle)

The minimum number of established connections that should be kept in the pool at all times. The connection pool can shrink below this number if validation queries fail and connections get closed. Default value is derived from getInitialSize() (also see setTestWhileIdle(boolean) The idle pool will not shrink below this value during an eviction run, hence the number of actual connections can be between getMinIdle() and somewhere between getMaxIdle() and getMaxActive()

Parameters:

minIdle - the minimum number of idle or established connections

getName

String getName()

Returns the name of the connection pool. By default a JVM unique random name is assigned.

Returns:

the name of the pool, should be unique in a JVM

setName

void setName(String name)

Sets the name of the connection pool

Parameters:

name - the name of the pool, should be unique in a runtime JVM

getNumTestsPerEvictionRun

int getNumTestsPerEvictionRun()

Property not used

Returns:

unknown value

setNumTestsPerEvictionRun

void setNumTestsPerEvictionRun(int numTestsPerEvictionRun)

Property not used

Parameters:

numTestsPerEvictionRun - parameter ignored.

getPassword

String getPassword()

Returns the password used when establishing connections to the database.

Returns:

the password in string format

setPassword

void setPassword(String password)

Sets the password to establish the connection with.

Parameters:

password -

getPoolName

String getPoolName()

Returns:

name

See Also:

getName()

getKeySpace

String getKeySpace()

Returns the keyspace

setKeySpace

void setKeySpace(String keySpace)

Sets the keyspace

Parameters:

keySpace -

getUsername

String getUsername()

Returns the username used to establish the connection with

Returns:

the username used to establish the connection with

setUsername

void setUsername(String username)

Sets the username used to establish the connection with

Parameters:

username -

isRemoveAbandoned

boolean isRemoveAbandoned()

boolean flag to remove abandoned connections if they exceed the removeAbandonedTimout. If set to true a connection is considered abandoned and eligible for removal if it has been in use longer than the getRemoveAbandonedTimeout() and the condition for getAbandonWhenPercentageFull() is met. Setting this to true can recover db connections from applications that fail to close a connection. See also isLogAbandoned() The default value is false.

Returns:

true if abandoned connections can be closed and expelled out of the pool

setRemoveAbandoned

void setRemoveAbandoned(boolean removeAbandoned)

boolean flag to remove abandoned connections if they exceed the removeAbandonedTimout. If set to true a connection is considered abandoned and eligible for removal if it has been in use longer than the getRemoveAbandonedTimeout() and the condition for getAbandonWhenPercentageFull() is met. Setting this to true can recover db connections from applications that fail to close a connection. See also isLogAbandoned() The default value is false.

Parameters:

removeAbandoned - set to true if abandoned connections can be closed and expelled out of the pool

setRemoveAbandonedTimeout

void setRemoveAbandonedTimeout(int removeAbandonedTimeout)

The time in seconds before a connection can be considered abandoned. The timer can be reset upon queries using an interceptor.

Parameters:

removeAbandonedTimeout - the time in seconds before a used connection can be considered abandoned *

getRemoveAbandonedTimeout

int getRemoveAbandonedTimeout()

The time in seconds before a connection can be considered abandoned. The timer can be reset upon queries using an interceptor.

Returns:

the time in seconds before a used connection can be considered abandoned

isTestOnBorrow

boolean isTestOnBorrow()

The indication of whether objects will be validated before being borrowed from the pool. If the object fails to validate, it will be dropped from the pool, and we will attempt to borrow another. NOTE - for a true value to have any effect, the validationQuery parameter must be set to a non-null string. Default value is false In order to have a more efficient validation, see setValidationInterval(long)

Returns:

true if the connection is to be validated upon borrowing a connection from the pool

See Also:

getValidationInterval()

setTestOnBorrow

void setTestOnBorrow(boolean testOnBorrow)

The indication of whether objects will be validated before being borrowed from the pool. If the object fails to validate, it will be dropped from the pool, and we will attempt to borrow another. NOTE - for a true value to have any effect, the validationQuery parameter must be set to a non-null string. Default value is false In order to have a more efficient validation, see setValidationInterval(long)

Parameters:

testOnBorrow - set to true if validation should take place before a connection is handed out to the application

See Also:

getValidationInterval()

isTestOnReturn

boolean isTestOnReturn()

The indication of whether objects will be validated after being returned to the pool. If the object fails to validate, it will be dropped from the pool. NOTE - for a true value to have any effect, the validationQuery parameter must be set to a non-null string. Default value is false In order to have a more efficient validation, see setValidationInterval(long)

Returns:

true if validation should take place after a connection is returned to the pool

See Also:

getValidationInterval()

setTestOnReturn

void setTestOnReturn(boolean testOnReturn)

The indication of whether objects will be validated after being returned to the pool. If the object fails to validate, it will be dropped from the pool. NOTE - for a true value to have any effect, the validationQuery parameter must be set to a non-null string. Default value is false In order to have a more efficient validation, see setValidationInterval(long)

Parameters:

testOnReturn - true if validation should take place after a connection is returned to the pool

See Also:

getValidationInterval()

isTestWhileIdle

boolean isTestWhileIdle()

Set to true if query validation should take place while the connection is idle.

Returns:

true if validation should take place during idle checks

See Also:

setTimeBetweenEvictionRunsMillis(int)

setTestWhileIdle

void setTestWhileIdle(boolean testWhileIdle)

Set to true if query validation should take place while the connection is idle.

Parameters:

testWhileIdle - true if validation should take place during idle checks

See Also:

setTimeBetweenEvictionRunsMillis(int)

getTimeBetweenEvictionRunsMillis

int getTimeBetweenEvictionRunsMillis()

The number of milliseconds to sleep between runs of the idle connection validation, abandoned cleaner and idle pool resizing. This value should not be set under 1 second. It dictates how often we check for idle, abandoned connections, and how often we validate idle connection and resize the idle pool. The default value is 5000 (5 seconds)

Returns:

the sleep time in between validations in milliseconds

setTimeBetweenEvictionRunsMillis

void setTimeBetweenEvictionRunsMillis(int timeBetweenEvictionRunsMillis)

The number of milliseconds to sleep between runs of the idle connection validation, abandoned cleaner and idle pool resizing. This value should not be set under 1 second. It dictates how often we check for idle, abandoned connections, and how often we validate idle connection and resize the idle pool. The default value is 5000 (5 seconds)

Parameters:

timeBetweenEvictionRunsMillis - the sleep time in between validations in milliseconds

getValidationInterval

long getValidationInterval()

avoid excess validation, only run validation at most at this frequency - time in milliseconds. If a connection is due for validation, but has been validated previously within this interval, it will not be validated again. The default value is 30000 (30 seconds).

Returns:

the validation interval in milliseconds

setValidationInterval

void setValidationInterval(long validationInterval)

avoid excess validation, only run validation at most at this frequency - time in milliseconds. If a connection is due for validation, but has been validated previously within this interval, it will not be validated again. The default value is 30000 (30 seconds).

Parameters:

validationInterval - the validation interval in milliseconds

isTestOnConnect

boolean isTestOnConnect()

Returns true if we should run the validation query when connecting to the database for the first time on a connection. Normally this is always set to false.

Returns:

true if we should run the validation query upon connect

setTestOnConnect

void setTestOnConnect(boolean testOnConnect)

Set to true if we should run the validation query when connecting to the database for the first time on a connection. Normally this is always set to false.

Parameters:

testOnConnect - set to true if we should run the validation query upon connect

isJmxEnabled

boolean isJmxEnabled()

If set to true, the connection pool creates a ConnectionPoolMBean object that can be registered with JMX to receive notifications and state about the pool. The ConnectionPool object doesn't register itself, as there is no way to keep a static non changing ObjectName across JVM restarts.

Returns:

true if the mbean object will be created upon startup.

setJmxEnabled

void setJmxEnabled(boolean jmxEnabled)

If set to true, the connection pool creates a ConnectionPoolMBean object that can be registered with JMX to receive notifications and state about the pool. The ConnectionPool object doesn't register itself, as there is no way to keep a static non changing ObjectName across JVM restarts.

Parameters:

jmxEnabled - set to to if the mbean object should be created upon startup.

isPoolSweeperEnabled

boolean isPoolSweeperEnabled()

Returns true if the pool sweeper is enabled for the connection pool. The pool sweeper is enabled if any settings that require async intervention in the pool are turned on boolean result = getTimeBetweenEvictionRunsMillis()>0; result = result && (isRemoveAbandoned() && getRemoveAbandonedTimeout()>0); result = result || (isTestWhileIdle() && getValidationQuery()!=null); return result;

Returns:

true if a background thread is or will be enabled for this pool

isUseEquals

boolean isUseEquals()

Set to true if you wish the ProxyConnection class to use String.equals instead of == when comparing method names. This property does not apply to added interceptors as those are configured individually. The default value is false.

Returns:

true if pool uses String.equals(Object) instead of == when comparing method names on Connection methods

setUseEquals

void setUseEquals(boolean useEquals)

Set to true if you wish the ProxyConnection class to use String.equals instead of == when comparing method names. This property does not apply to added interceptors as those are configured individually. The default value is false.

Parameters:

useEquals - set to true if the pool should use String.equals(Object) instead of == when comparing method names on Connection methods

getMaxAge

long getMaxAge()

Time in milliseconds to keep this connection alive even when used. When a connection is returned to the pool, the pool will check to see if the ((now - time-when-connected) > maxAge) has been reached, and if so, it closes the connection rather than returning it to the pool. The default value is 0, which implies that connections will be left open and no age check will be done upon returning the connection to the pool. This is a useful setting for database sessions that leak memory as it ensures that the session will have a finite life span.

Returns:

the time in milliseconds a connection will be open for when used

setMaxAge

void setMaxAge(long maxAge)

Time in milliseconds to keep this connection alive even when used. When a connection is returned to the pool, the pool will check to see if the ((now - time-when-connected) > maxAge) has been reached, and if so, it closes the connection rather than returning it to the pool. The default value is 0, which implies that connections will be left open and no age check will be done upon returning the connection to the pool. This is a useful setting for database sessions that leak memory as it ensures that the session will have a finite life span.

Parameters:

maxAge - the time in milliseconds a connection will be open for when used

getUseLock

boolean getUseLock()

Return true if a lock should be used when operations are performed on the connection object. Should be set to false unless you plan to have a background thread of your own doing idle and abandon checking such as JMX clients. If the pool sweeper is enabled, then the lock will automatically be used regardless of this setting.

Returns:

true if a lock is used.

setUseLock

void setUseLock(boolean useLock)

Set to true if a lock should be used when operations are performed on the connection object. Should be set to false unless you plan to have a background thread of your own doing idle and abandon checking such as JMX clients. If the pool sweeper is enabled, then the lock will automatically be used regardless of this setting.

Parameters:

useLock - set to true if a lock should be used on connection operations

setSuspectTimeout

void setSuspectTimeout(int seconds)

Similar to setRemoveAbandonedTimeout(int) but instead of treating the connection as abandoned, and potentially closing the connection, this simply logs the warning if isLogAbandoned() returns true. If this value is equal or less than 0, no suspect checking will be performed. Suspect checking only takes place if the timeout value is larger than 0 and the connection was not abandoned or if abandon check is disabled. If a connection is suspect a WARN message gets logged and a JMX notification gets sent once.

Parameters:

seconds - - the amount of time in seconds that has to pass before a connection is marked suspect.

getSuspectTimeout

int getSuspectTimeout()

Returns the time in seconds to pass before a connection is marked an abanoned suspect. Any value lesser than or equal to 0 means the check is disabled.

Returns:

Returns the time in seconds to pass before a connection is marked an abanoned suspect.

getSocketTimeout

int getSocketTimeout()

Returns the socket timeout in milliseconds

Returns:

the socket timeout in milliseconds

setSocketTimeout

void setSocketTimeout(int socketTimeout)

Sets the socket timeout in milliseconds

Parameters:

socketTimeout -

getConfiguredHosts

String[] getConfiguredHosts()

Returns an array of configured hosts (may be different from the actual list if dynamic discovery is enabled)

Returns:

an array of strings representing the addresses of the configured Cassandra hosts

getHostRetryInterval

long getHostRetryInterval()

Returns the interval in milliseconds before retrying a host to which a connection has failed in the past. Default is 300000 (5 minutes)

Returns:

milliseconds before host retry

setHostRetryInterval

void setHostRetryInterval(long hostRetryInterval)

Sets the interval in milliseconds before retrying a host to which a connection has failed in the past.

Parameters:

hostRetryInterval - number of millieseconds before retrying a host

setDataSourceJNDI

void setDataSourceJNDI(String jndiDS)

Configure the connection pool to use a DataSource according to setDataSource(Object) But instead of injecting the object, specify the JNDI location. After a successful JNDI look, the getDataSource() will not return null.

Parameters:

jndiDS - -the JNDI string @TODO specify the rules here.

getDataSourceJNDI

String getDataSourceJNDI()

Returns the JNDI string configured for data source usage.

Returns:

the JNDI string or null if not set

setDataSource

void setDataSource(Object ds)

Injects a datasource that will be used to retrieve/create connections.

Parameters:

ds - the DataSource to be used for creating connections to be pooled.

getDataSource

Object getDataSource()

Returns a datasource, if one exists that is being used to create connections.

Returns:

the datasource object