Package org.apache.tomcat.jdbc.pool.jmx
Class ConnectionPool
java.lang.Object
javax.management.NotificationBroadcasterSupport
org.apache.tomcat.jdbc.pool.jmx.ConnectionPool
- All Implemented Interfaces:
MBeanRegistration,NotificationBroadcaster,NotificationEmitter,ConnectionPoolMBean,PoolConfiguration
public class ConnectionPool
extends NotificationBroadcasterSupport
implements ConnectionPoolMBean, MBeanRegistration
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Stringprotected ConcurrentLinkedQueue<NotificationListener> Listeners that are local and interested in our notifications, no need for JMXstatic final Stringstatic final Stringstatic final Stringprotected ConnectionPoolthe connection poolstatic final Stringprotected AtomicIntegersequence for JMX notificationsstatic final Stringstatic final Stringstatic final StringFields inherited from interface org.apache.tomcat.jdbc.pool.PoolConfiguration
PKG_PREFIX -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidvoidvoidintConnections 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.intlongbooleanThe connection properties that will be sent to the JDBC driver when establishing new connections.longReturns a datasource, if one exists that is being used to create connections.Returns the JNDI string configured for data source usage.Returns the database properties that are passed into theDriver.connect(String, Properties)method.The default auto-commit state of connections created by this pool.If non null, during connection creation the methodConnection.setCatalog(String)will be called with the set value.static MBeanNotificationInfo[]If non null, during connection creation the methodConnection.setReadOnly(boolean)will be called with the set value.intReturns the default transaction isolation level.The fully qualified Java class name of the JDBC driver to be used.intgetIdle()intReturns the number of connections that will be established when the connection pool is started.A custom query to be run when a connection is first created.A semicolon separated list of classnames extendingJdbcInterceptorclass.Returns thePoolConfiguration.getJdbcInterceptors()as an array of objects with properties and the classes.booleanReturns true if errors that happen during validation will be loggedintThe maximum number of active connections that can be allocated from this pool at the same time.longTime in milliseconds to keep this connection before reconnecting.intThe maximum number of connections that should be kept in the idle pool ifPoolConfiguration.isPoolSweeperEnabled()returns false.intThe maximum number of milliseconds that the pool will wait (when there are no available connections and thePoolConfiguration.getMaxActive()has been reached) for a connection to be returned before throwing an exception.intThe minimum amount of time an object must sit idle in the pool before it is eligible for eviction.intThe minimum number of established connections that should be kept in the pool at all times.getName()Returns the name of the connection pool.intintintProperty not usedReturns the password used when establishing connections to the database.getPool()booleanReturns true if the pool is configured to propagate interrupt state of a thread.longlonglonglongintThe time in seconds before a connection can be considered abandoned.longbooleanintgetSize()intReturns the time in seconds to pass before a connection is marked an abandoned suspect.intThe number of milliseconds to sleep between runs of the idle connection validation, abandoned cleaner and idle pool resizing.getUrl()The URL used to connect to the databasebooleanReturnstrueif this connection pool is configured to use a connection facade to prevent re-use of connection afterConnection.close()has been invokedbooleanReturn true if a lock should be used when operations are performed on the connection object.Returns the username used to establish the connection withbooleanReturnstrueif this connection pool is configured to wrap statements in order to enable equals() and hashCode() methods to be called on the closed statements if any statement proxy is set.longavoid excess validation, only run validation at most at this frequency - time in milliseconds.The SQL query that will be used to validate connections from this pool before returning them to the caller or pool.intThe timeout in seconds before a connection validation queries fail.Return the name of the optional validator class - may be null.intbooleanProperty not used.booleanReturns true if the callgetConnection(username,password)is allowed.The default auto-commit state of connections created by this pool.If non null, during connection creation the methodConnection.setReadOnly(boolean)will be called with the set value.booleanReturnstrueif a fair queue is being used by the connection poolbooleanbooleanIf set to true, the connection pool creates aConnectionPoolMBeanobject that can be registered with JMX to receive notifications and state about the pool.booleanboolean flag to set if stack traces should be logged for application code which abandoned a Connection.booleanReturns true if the pool sweeper is enabled for the connection pool.booleanboolean flag to remove abandoned connections if they exceed the removeAbandonedTimeout.booleanThe indication of whether objects will be validated before being borrowed from the pool.booleanReturns true if we should run the validation query when connecting to the database for the first time on a connection.booleanThe indication of whether objects will be validated after being returned to the pool.booleanSet to true if query validation should take place while the connection is idle.booleanSet to true if you wish theProxyConnectionclass to useString.equalsinstead of==when comparing method names.booleanReturn true if the notification was sent successfully, false otherwise.voidvoidpostRegister(Boolean registrationDone) voidpreRegister(MBeanServer server, ObjectName name) voidpurge()Purges all connections in the pool.voidPurges connections when they are returned from the pool.booleanvoidreset the statistics of this pool.voidsetAbandonWhenPercentageFull(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.voidsetAccessToUnderlyingConnectionAllowed(boolean accessToUnderlyingConnectionAllowed) No-opvoidsetAlternateUsernameAllowed(boolean alternateUsernameAllowed) Set to true if the callgetConnection(username,password)is allowed and honored..voidsetCommitOnReturn(boolean commitOnReturn) Set to true if you want the connection pool to commit any pending transaction when a connection is returned.voidsetConnectionProperties(String connectionProperties) The properties that will be passed intoDriver.connect(String, Properties)method.voidsetDataSource(Object ds) Injects a datasource that will be used to retrieve/create connections.voidsetDataSourceJNDI(String jndiDS) Configure the connection pool to use a DataSource according toPoolConfiguration.setDataSource(Object)But instead of injecting the object, specify the JNDI location.voidsetDbProperties(Properties dbProperties) Overrides the database properties passed into theDriver.connect(String, Properties)method.voidsetDefaultAutoCommit(Boolean defaultAutoCommit) The default auto-commit state of connections created by this pool.voidsetDefaultCatalog(String defaultCatalog) If non null, during connection creation the methodConnection.setCatalog(String)will be called with the set value.voidsetDefaultReadOnly(Boolean defaultReadOnly) If non null, during connection creation the methodConnection.setReadOnly(boolean)will be called with the set value.voidsetDefaultTransactionIsolation(int defaultTransactionIsolation) If set toDataSourceFactory.UNKNOWN_TRANSACTIONISOLATIONthe methodConnection.setTransactionIsolation(int)will not be called during connection creation.voidsetDriverClassName(String driverClassName) The fully qualified Java class name of the JDBC driver to be used.voidsetFairQueue(boolean fairQueue) Set to true if you wish that calls to getConnection should be treated fairly in a true FIFO fashion.voidsetIgnoreExceptionOnPreLoad(boolean ignoreExceptionOnPreLoad) Set to true if you want to ignore error of connection creation while initializing the pool.voidsetInitialSize(int initialSize) Set the number of connections that will be established when the connection pool is started.voidsetInitSQL(String initSQL) A custom query to be run when a connection is first created.voidsetJdbcInterceptors(String jdbcInterceptors) A semicolon separated list of classnames extendingJdbcInterceptorclass.voidsetJmxEnabled(boolean jmxEnabled) If set to true, the connection pool creates aConnectionPoolMBeanobject that can be registered with JMX to receive notifications and state about the pool.voidsetLogAbandoned(boolean logAbandoned) boolean flag to set if stack traces should be logged for application code which abandoned a Connection.voidsetLogValidationErrors(boolean logValidationErrors) Set to true if you wish that errors from validation should be logged as error messages.voidsetMaxActive(int maxActive) The maximum number of active connections that can be allocated from this pool at the same time.voidsetMaxAge(long maxAge) Time in milliseconds to keep this connection before reconnecting.voidsetMaxIdle(int maxIdle) The maximum number of connections that should be kept in the idle pool ifPoolConfiguration.isPoolSweeperEnabled()returns false.voidsetMaxWait(int maxWait) The maximum number of milliseconds that the pool will wait (when there are no available connections and thePoolConfiguration.getMaxActive()has been reached) for a connection to be returned before throwing an exception.voidsetMinEvictableIdleTimeMillis(int minEvictableIdleTimeMillis) The minimum amount of time an object must sit idle in the pool before it is eligible for eviction.voidsetMinIdle(int minIdle) The minimum number of established connections that should be kept in the pool at all times.voidSets the name of the connection poolvoidsetNumTestsPerEvictionRun(int numTestsPerEvictionRun) Property not usedvoidsetPassword(String password) Sets the password to establish the connection with.voidsetPropagateInterruptState(boolean propagateInterruptState) Configure the pool to propagate interrupt state for interrupted threads waiting for a connection A thread waiting for a connection, can have its wait interrupted, and by default will clear the interrupt flag and throw aPoolExhaustedExceptionIf set to true, this behavior will change, while thePoolExhaustedExceptionis still thrown, the threads interrupted state is still set.voidsetRemoveAbandoned(boolean removeAbandoned) boolean flag to remove abandoned connections if they exceed the removeAbandonedTimeout.voidsetRemoveAbandonedTimeout(int removeAbandonedTimeout) The time in seconds before a connection can be considered abandoned.voidsetRollbackOnReturn(boolean rollbackOnReturn) Set to true if you want the connection pool to rollback any pending transaction when a connection is returned.voidsetSuspectTimeout(int seconds) Similar toPoolConfiguration.setRemoveAbandonedTimeout(int)but instead of treating the connection as abandoned, and potentially closing the connection, this simply logs the warning ifPoolConfiguration.isLogAbandoned()returns true.voidsetTestOnBorrow(boolean testOnBorrow) The indication of whether objects will be validated before being borrowed from the pool.voidsetTestOnConnect(boolean testOnConnect) Set to true if we should run the validation query when connecting to the database for the first time on a connection.voidsetTestOnReturn(boolean testOnReturn) The indication of whether objects will be validated after being returned to the pool.voidsetTestWhileIdle(boolean testWhileIdle) Set to true if query validation should take place while the connection is idle.voidsetTimeBetweenEvictionRunsMillis(int timeBetweenEvictionRunsMillis) The number of milliseconds to sleep between runs of the idle connection validation, abandoned cleaner and idle pool resizing.voidSets the URL used to connect to the databasevoidsetUseDisposableConnectionFacade(boolean useDisposableConnectionFacade) If set totrue, the connection will be wrapped with facade that will disallow the connection to be used afterConnection.close()is called.voidsetUseEquals(boolean useEquals) Set to true if you wish theProxyConnectionclass to useString.equalsinstead of==when comparing method names.voidsetUseLock(boolean useLock) Set to true if a lock should be used when operations are performed on the connection object.voidsetUsername(String username) Sets the username used to establish the connection with It will also be a property called 'user' in the database properties.voidsetUseStatementFacade(boolean useStatementFacade) Set this to true if you wish to wrap statements in order to enable equals() and hashCode() methods to be called on the closed statements if any statement proxy is set.voidsetValidationInterval(long validationInterval) avoid excess validation, only run validation at most at this frequency - time in milliseconds.voidsetValidationQuery(String validationQuery) The SQL query that will be used to validate connections from this pool before returning them to the caller or pool.voidsetValidationQueryTimeout(int validationQueryTimeout) The timeout in seconds before a connection validation queries fail.voidsetValidator(Validator validator) Sets the validator object If this is a non null object, it will be used as a validator instead of the validationQuery If this is null, remove the usage of the validator.voidsetValidatorClassName(String className) Set the name for an optional validator class which will be used in place of test queries.voidtestIdle()Methods inherited from class javax.management.NotificationBroadcasterSupport
addNotificationListener, handleNotification, removeNotificationListener, removeNotificationListener, sendNotification
-
Field Details
-
pool
the connection pool -
sequence
sequence for JMX notifications -
listeners
Listeners that are local and interested in our notifications, no need for JMX -
NOTIFY_INIT
- See Also:
-
NOTIFY_CONNECT
- See Also:
-
NOTIFY_ABANDON
- See Also:
-
SLOW_QUERY_NOTIFICATION
- See Also:
-
FAILED_QUERY_NOTIFICATION
- See Also:
-
SUSPECT_ABANDONED_NOTIFICATION
- See Also:
-
POOL_EMPTY
- See Also:
-
SUSPECT_RETURNED_NOTIFICATION
- See Also:
-
-
Constructor Details
-
ConnectionPool
-
-
Method Details
-
getPool
-
getPoolProperties
-
getObjectName
-
preRegister
- Specified by:
preRegisterin interfaceMBeanRegistration- Throws:
Exception
-
postRegister
- Specified by:
postRegisterin interfaceMBeanRegistration
-
preDeregister
- Specified by:
preDeregisterin interfaceMBeanRegistration- Throws:
Exception
-
postDeregister
public void postDeregister()- Specified by:
postDeregisterin interfaceMBeanRegistration
-
getNotificationInfo
- Specified by:
getNotificationInfoin interfaceNotificationBroadcaster- Overrides:
getNotificationInfoin classNotificationBroadcasterSupport
-
getDefaultNotificationInfo
-
notify
-
addListener
-
removeListener
-
getSize
public int getSize()- Specified by:
getSizein interfaceConnectionPoolMBean
-
getIdle
public int getIdle()- Specified by:
getIdlein interfaceConnectionPoolMBean
-
getActive
public int getActive()- Specified by:
getActivein interfaceConnectionPoolMBean
-
getNumIdle
public int getNumIdle()- Specified by:
getNumIdlein interfaceConnectionPoolMBean
-
getNumActive
public int getNumActive()- Specified by:
getNumActivein interfaceConnectionPoolMBean
-
getWaitCount
public int getWaitCount()- Specified by:
getWaitCountin interfaceConnectionPoolMBean
-
getBorrowedCount
public long getBorrowedCount()- Specified by:
getBorrowedCountin interfaceConnectionPoolMBean
-
getReturnedCount
public long getReturnedCount()- Specified by:
getReturnedCountin interfaceConnectionPoolMBean
-
getCreatedCount
public long getCreatedCount()- Specified by:
getCreatedCountin interfaceConnectionPoolMBean
-
getReleasedCount
public long getReleasedCount()- Specified by:
getReleasedCountin interfaceConnectionPoolMBean
-
getReconnectedCount
public long getReconnectedCount()- Specified by:
getReconnectedCountin interfaceConnectionPoolMBean
-
getRemoveAbandonedCount
public long getRemoveAbandonedCount()- Specified by:
getRemoveAbandonedCountin interfaceConnectionPoolMBean
-
getReleasedIdleCount
public long getReleasedIdleCount()- Specified by:
getReleasedIdleCountin interfaceConnectionPoolMBean
-
checkIdle
public void checkIdle()- Specified by:
checkIdlein interfaceConnectionPoolMBean
-
checkAbandoned
public void checkAbandoned()- Specified by:
checkAbandonedin interfaceConnectionPoolMBean
-
testIdle
public void testIdle()- Specified by:
testIdlein interfaceConnectionPoolMBean
-
resetStats
public void resetStats()Description copied from interface:ConnectionPoolMBeanreset the statistics of this pool.- Specified by:
resetStatsin interfaceConnectionPoolMBean
-
getConnectionProperties
Description copied from interface:PoolConfigurationThe connection properties that will be sent to the JDBC driver when establishing new connections. Format of the string is [propertyName=property;]
NOTE - The "user" and "password" properties will be passed explicitly, so they do not need to be included here. The default value is null.- Specified by:
getConnectionPropertiesin interfacePoolConfiguration- Returns:
- the connection properties
-
getDbProperties
Description copied from interface:PoolConfigurationReturns the database properties that are passed into theDriver.connect(String, Properties)method.- Specified by:
getDbPropertiesin interfacePoolConfiguration- Returns:
- database properties that are passed into the
Driver.connect(String, Properties)method.
-
getDefaultCatalog
Description copied from interface:PoolConfigurationIf non null, during connection creation the methodConnection.setCatalog(String)will be called with the set value.- Specified by:
getDefaultCatalogin interfacePoolConfiguration- Returns:
- the default catalog, null if not set and accepting the driver default.
-
getDefaultTransactionIsolation
public int getDefaultTransactionIsolation()Description copied from interface:PoolConfigurationReturns the default transaction isolation level. If set toDataSourceFactory.UNKNOWN_TRANSACTIONISOLATIONthe methodConnection.setTransactionIsolation(int)will not be called during connection creation.- Specified by:
getDefaultTransactionIsolationin interfacePoolConfiguration- Returns:
- driver transaction isolation level, or -1
DataSourceFactory.UNKNOWN_TRANSACTIONISOLATIONif not set.
-
getDriverClassName
Description copied from interface:PoolConfigurationThe fully qualified Java class name of the JDBC driver to be used. The driver has to be accessible from the same classloader as tomcat-jdbc.jar- Specified by:
getDriverClassNamein interfacePoolConfiguration- Returns:
- fully qualified JDBC driver name.
-
getInitialSize
public int getInitialSize()Description copied from interface:PoolConfigurationReturns the number of connections that will be established when the connection pool is started. Default value is 10- Specified by:
getInitialSizein interfacePoolConfiguration- Returns:
- number of connections to be started when pool is started
-
getInitSQL
Description copied from interface:PoolConfigurationA custom query to be run when a connection is first created. The default value is null. This query only runs once per connection, and that is when a new connection is established to the database. If this value is non null, it will replace the validation query during connection creation.- Specified by:
getInitSQLin interfacePoolConfiguration- Returns:
- the init SQL used to run against the DB or null if not set
-
getJdbcInterceptors
Description copied from interface:PoolConfigurationA semicolon separated list of classnames extendingJdbcInterceptorclass. These interceptors will be inserted as an interceptor into the chain of operations on a java.sql.Connection object. Example interceptors areStatementFinalizerto close all used statements during the session.ResetAbandonedTimerresets the timer upon every operation on the connection or a statement.ConnectionStatecaches the auto commit, read only and catalog settings to avoid round trips to the DB. The default value is null.- Specified by:
getJdbcInterceptorsin interfacePoolConfiguration- Returns:
- the interceptors that are used for connections. Example format: 'ConnectionState(useEquals=true,fast=yes);ResetAbandonedTimer'
-
getMaxActive
public int getMaxActive()Description copied from interface:PoolConfigurationThe maximum number of active connections that can be allocated from this pool at the same time. The default value is 100- Specified by:
getMaxActivein interfacePoolConfiguration- Returns:
- the maximum number of connections used by this pool
-
getMaxIdle
public int getMaxIdle()Description copied from interface:PoolConfigurationThe maximum number of connections that should be kept in the idle pool ifPoolConfiguration.isPoolSweeperEnabled()returns false. If the IfPoolConfiguration.isPoolSweeperEnabled()returns true, then the idle pool can grow up toPoolConfiguration.getMaxActive()and will be shrunk according toPoolConfiguration.getMinEvictableIdleTimeMillis()setting. Default value is maxActive:100- Specified by:
getMaxIdlein interfacePoolConfiguration- Returns:
- the maximum number of idle connections.
-
getMaxWait
public int getMaxWait()Description copied from interface:PoolConfigurationThe maximum number of milliseconds that the pool will wait (when there are no available connections and thePoolConfiguration.getMaxActive()has been reached) for a connection to be returned before throwing an exception. Default value is 30000 (30 seconds)- Specified by:
getMaxWaitin interfacePoolConfiguration- Returns:
- the number of milliseconds to wait for a connection to become available if the pool is maxed out.
-
getMinEvictableIdleTimeMillis
public int getMinEvictableIdleTimeMillis()Description copied from interface:PoolConfigurationThe 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).- Specified by:
getMinEvictableIdleTimeMillisin interfacePoolConfiguration- Returns:
- the minimum amount of idle time in milliseconds before a connection is considered idle and eligible for eviction.
-
getMinIdle
public int getMinIdle()Description copied from interface:PoolConfigurationThe 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 fromPoolConfiguration.getInitialSize()(also seePoolConfiguration.setTestWhileIdle(boolean)The idle pool will not shrink below this value during an eviction run, hence the number of actual connections can be betweenPoolConfiguration.getMinIdle()and somewhere betweenPoolConfiguration.getMaxIdle()andPoolConfiguration.getMaxActive()- Specified by:
getMinIdlein interfacePoolConfiguration- Returns:
- the minimum number of idle or established connections
-
getMaxAge
public long getMaxAge()Description copied from interface:PoolConfigurationTime in milliseconds to keep this connection before reconnecting. When a connection is idle, returned to the pool or borrowed from the pool, the pool will check to see if the ((now - time-when-connected) > maxAge) has been reached, and if so, it reconnects. Note that the age of idle connections will only be checked ifPoolConfiguration.getTimeBetweenEvictionRunsMillis()returns a value greater than 0. The default value is 0, which implies that connections will be left open and no age checks will be done. This is a useful setting for database sessions that leak memory as it ensures that the session will have a finite life span.- Specified by:
getMaxAgein interfacePoolConfiguration- Returns:
- the time in milliseconds a connection will be open for when used
-
getName
Description copied from interface:PoolConfigurationReturns the name of the connection pool. By default a JVM unique random name is assigned.- Specified by:
getNamein interfacePoolConfiguration- Returns:
- the name of the pool, should be unique in a JVM
-
getNumTestsPerEvictionRun
public int getNumTestsPerEvictionRun()Description copied from interface:PoolConfigurationProperty not used- Specified by:
getNumTestsPerEvictionRunin interfacePoolConfiguration- Returns:
- unknown value
-
getPassword
Description copied from interface:PoolConfigurationReturns the password used when establishing connections to the database.- Specified by:
getPasswordin interfacePoolConfiguration- Returns:
- DOES NOT RETURN THE PASSWORD, IT WOULD SHOW UP IN JMX
-
getRemoveAbandonedTimeout
public int getRemoveAbandonedTimeout()Description copied from interface:PoolConfigurationThe time in seconds before a connection can be considered abandoned. The timer can be reset upon queries using an interceptor.- Specified by:
getRemoveAbandonedTimeoutin interfacePoolConfiguration- Returns:
- the time in seconds before a used connection can be considered abandoned
- See Also:
-
getTimeBetweenEvictionRunsMillis
public int getTimeBetweenEvictionRunsMillis()Description copied from interface:PoolConfigurationThe 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)- Specified by:
getTimeBetweenEvictionRunsMillisin interfacePoolConfiguration- Returns:
- the sleep time in between validations in milliseconds
-
getUrl
Description copied from interface:PoolConfigurationThe URL used to connect to the database- Specified by:
getUrlin interfacePoolConfiguration- Returns:
- the configured URL for this connection pool
- See Also:
-
getUsername
Description copied from interface:PoolConfigurationReturns the username used to establish the connection with- Specified by:
getUsernamein interfacePoolConfiguration- Returns:
- the username used to establish the connection with
-
getValidationInterval
public long getValidationInterval()Description copied from interface:PoolConfigurationavoid 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 3000 (3 seconds).- Specified by:
getValidationIntervalin interfacePoolConfiguration- Returns:
- the validation interval in milliseconds
-
getValidationQuery
Description copied from interface:PoolConfigurationThe SQL query that will be used to validate connections from this pool before returning them to the caller or pool. If specified, this query does not have to return any data, it just can't throw an SQLException. The default value is null. Example values are SELECT 1(mysql), select 1 from dual(oracle), SELECT 1(MS Sql Server)- Specified by:
getValidationQueryin interfacePoolConfiguration- Returns:
- the query used for validation or null if no validation is performed
-
getValidationQueryTimeout
public int getValidationQueryTimeout()Description copied from interface:PoolConfigurationThe timeout in seconds before a connection validation queries fail. A value less than or equal to zero will disable this feature. Defaults to -1.- Specified by:
getValidationQueryTimeoutin interfacePoolConfiguration- Returns:
- the timeout value in seconds
-
getValidatorClassName
Description copied from interface:PoolConfigurationReturn the name of the optional validator class - may be null.- Specified by:
getValidatorClassNamein interfacePoolConfiguration- Returns:
- the name of the optional validator class - may be null
-
getValidator
- Specified by:
getValidatorin interfacePoolConfiguration- Returns:
- the optional validator object - may be null
-
isAccessToUnderlyingConnectionAllowed
public boolean isAccessToUnderlyingConnectionAllowed()Description copied from interface:PoolConfigurationProperty not used. Access is always allowed. Access can be achieved by calling unwrap on the pooled connection. seeDataSourceinterface or call getConnection through reflection or cast the object asPooledConnection- Specified by:
isAccessToUnderlyingConnectionAllowedin interfacePoolConfiguration- Returns:
true
-
isDefaultAutoCommit
Description copied from interface:PoolConfigurationThe default auto-commit state of connections created by this pool. If not set (null), default is JDBC driver default (If set to null then theConnection.setAutoCommit(boolean)method will not be called.)- Specified by:
isDefaultAutoCommitin interfacePoolConfiguration- Returns:
- the default auto commit setting, null is Driver default.
-
isDefaultReadOnly
Description copied from interface:PoolConfigurationIf non null, during connection creation the methodConnection.setReadOnly(boolean)will be called with the set value.- Specified by:
isDefaultReadOnlyin interfacePoolConfiguration- Returns:
- null if not set and accepting the driver default otherwise the read only value
-
isLogAbandoned
public boolean isLogAbandoned()Description copied from interface:PoolConfigurationboolean 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.- Specified by:
isLogAbandonedin interfacePoolConfiguration- Returns:
- true if the connection pool logs stack traces when connections are borrowed from the pool.
-
isPoolSweeperEnabled
public boolean isPoolSweeperEnabled()Description copied from interface:PoolConfigurationReturns 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 onboolean result = getTimeBetweenEvictionRunsMillis()>0; result = result && (isRemoveAbandoned() && getRemoveAbandonedTimeout()>0); result = result || (isTestWhileIdle() && getValidationQuery()!=null); return result;- Specified by:
isPoolSweeperEnabledin interfacePoolConfiguration- Returns:
- true if a background thread is or will be enabled for this pool
-
isRemoveAbandoned
public boolean isRemoveAbandoned()Description copied from interface:PoolConfigurationboolean flag to remove abandoned connections if they exceed the removeAbandonedTimeout. If set to true a connection is considered abandoned and eligible for removal if it has been in use longer than thePoolConfiguration.getRemoveAbandonedTimeout()and the condition forPoolConfiguration.getAbandonWhenPercentageFull()is met. Setting this to true can recover db connections from applications that fail to close a connection. See alsoPoolConfiguration.isLogAbandoned()The default value is false.- Specified by:
isRemoveAbandonedin interfacePoolConfiguration- Returns:
- true if abandoned connections can be closed and expelled out of the pool
-
getAbandonWhenPercentageFull
public int getAbandonWhenPercentageFull()Description copied from interface:PoolConfigurationConnections 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.- Specified by:
getAbandonWhenPercentageFullin interfacePoolConfiguration- Returns:
- percentage - a value between 0 and 100 to indicate when connections that have been abandoned/timed out are considered abandoned
-
isTestOnBorrow
public boolean isTestOnBorrow()Description copied from interface:PoolConfigurationThe 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, seePoolConfiguration.setValidationInterval(long)- Specified by:
isTestOnBorrowin interfacePoolConfiguration- Returns:
- true if the connection is to be validated upon borrowing a connection from the pool
- See Also:
-
isTestOnConnect
public boolean isTestOnConnect()Description copied from interface:PoolConfigurationReturns 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, unless one wants to use the validationQuery as an init query.- Specified by:
isTestOnConnectin interfacePoolConfiguration- Returns:
- true if we should run the validation query upon connect
-
isTestOnReturn
public boolean isTestOnReturn()Description copied from interface:PoolConfigurationThe 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, seePoolConfiguration.setValidationInterval(long)- Specified by:
isTestOnReturnin interfacePoolConfiguration- Returns:
- true if validation should take place after a connection is returned to the pool
- See Also:
-
isTestWhileIdle
public boolean isTestWhileIdle()Description copied from interface:PoolConfigurationSet to true if query validation should take place while the connection is idle.- Specified by:
isTestWhileIdlein interfacePoolConfiguration- Returns:
- true if validation should take place during idle checks
- See Also:
-
getDefaultAutoCommit
Description copied from interface:PoolConfigurationThe default auto-commit state of connections created by this pool. If not set (null), default is JDBC driver default (If set to null then theConnection.setAutoCommit(boolean)method will not be called.)- Specified by:
getDefaultAutoCommitin interfacePoolConfiguration- Returns:
- the default auto commit setting, null is Driver default.
-
getDefaultReadOnly
Description copied from interface:PoolConfigurationIf non null, during connection creation the methodConnection.setReadOnly(boolean)will be called with the set value.- Specified by:
getDefaultReadOnlyin interfacePoolConfiguration- Returns:
- null if not set and accepting the driver default otherwise the read only value
-
getJdbcInterceptorsAsArray
Description copied from interface:PoolConfigurationReturns thePoolConfiguration.getJdbcInterceptors()as an array of objects with properties and the classes.- Specified by:
getJdbcInterceptorsAsArrayin interfacePoolConfiguration- Returns:
- an array of interceptors that have been configured
-
getUseLock
public boolean getUseLock()Description copied from interface:PoolConfigurationReturn 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.- Specified by:
getUseLockin interfacePoolConfiguration- Returns:
- true if a lock is used.
-
isFairQueue
public boolean isFairQueue()Description copied from interface:PoolConfigurationReturnstrueif a fair queue is being used by the connection pool- Specified by:
isFairQueuein interfacePoolConfiguration- Returns:
trueif a fair waiting queue is being used
-
isJmxEnabled
public boolean isJmxEnabled()Description copied from interface:PoolConfigurationIf set to true, the connection pool creates aConnectionPoolMBeanobject 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.- Specified by:
isJmxEnabledin interfacePoolConfiguration- Returns:
- true if the mbean object will be created upon startup.
-
isUseEquals
public boolean isUseEquals()Description copied from interface:PoolConfigurationSet to true if you wish theProxyConnectionclass to useString.equalsinstead of==when comparing method names. This property does not apply to added interceptors as those are configured individually. The default value isfalse.- Specified by:
isUseEqualsin interfacePoolConfiguration- Returns:
- true if pool uses
String.equals(Object)instead of == when comparing method names onConnectionmethods
-
setAbandonWhenPercentageFull
public void setAbandonWhenPercentageFull(int percentage) Description copied from interface:PoolConfigurationConnections 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.- Specified by:
setAbandonWhenPercentageFullin interfacePoolConfiguration- Parameters:
percentage- a value between 0 and 100 to indicate when connections that have been abandoned/timed out are considered abandoned
-
setAccessToUnderlyingConnectionAllowed
public void setAccessToUnderlyingConnectionAllowed(boolean accessToUnderlyingConnectionAllowed) Description copied from interface:PoolConfigurationNo-op- Specified by:
setAccessToUnderlyingConnectionAllowedin interfacePoolConfiguration- Parameters:
accessToUnderlyingConnectionAllowed- parameter ignored
-
setDbProperties
Description copied from interface:PoolConfigurationOverrides the database properties passed into theDriver.connect(String, Properties)method.- Specified by:
setDbPropertiesin interfacePoolConfiguration- Parameters:
dbProperties- The database properties
-
setDefaultReadOnly
Description copied from interface:PoolConfigurationIf non null, during connection creation the methodConnection.setReadOnly(boolean)will be called with the set value.- Specified by:
setDefaultReadOnlyin interfacePoolConfiguration- Parameters:
defaultReadOnly- null if not set and accepting the driver default.
-
setMaxAge
public void setMaxAge(long maxAge) Description copied from interface:PoolConfigurationTime in milliseconds to keep this connection before reconnecting. When a connection is idle, returned to the pool or borrowed from the pool, the pool will check to see if the ((now - time-when-connected) > maxAge) has been reached, and if so, it reconnects. Note that the age of idle connections will only be checked ifPoolConfiguration.getTimeBetweenEvictionRunsMillis()returns a value greater than 0. The default value is 0, which implies that connections will be left open and no age checks will be done. This is a useful setting for database sessions that leak memory as it ensures that the session will have a finite life span.- Specified by:
setMaxAgein interfacePoolConfiguration- Parameters:
maxAge- the time in milliseconds a connection will be open for when used
-
setName
Description copied from interface:PoolConfigurationSets the name of the connection pool- Specified by:
setNamein interfacePoolConfiguration- Parameters:
name- the name of the pool, should be unique in a runtime JVM
-
getPoolName
- Specified by:
getPoolNamein interfacePoolConfiguration- Returns:
- the pool name
- See Also:
-
setConnectionProperties
Description copied from interface:PoolConfigurationThe properties that will be passed intoDriver.connect(String, Properties)method. Username and password do not need to be stored here, they will be passed into the properties right before the connection is established.- Specified by:
setConnectionPropertiesin interfacePoolConfiguration- Parameters:
connectionProperties- properties - Format of the string is [propertyName=property;]* Example: prop1=value1;prop2=value2
-
setDefaultAutoCommit
Description copied from interface:PoolConfigurationThe default auto-commit state of connections created by this pool. If not set (null), default is JDBC driver default (If set to null then theConnection.setAutoCommit(boolean)method will not be called.)- Specified by:
setDefaultAutoCommitin interfacePoolConfiguration- Parameters:
defaultAutoCommit- default auto commit setting, null is Driver default.
-
setDefaultCatalog
Description copied from interface:PoolConfigurationIf non null, during connection creation the methodConnection.setCatalog(String)will be called with the set value.- Specified by:
setDefaultCatalogin interfacePoolConfiguration- Parameters:
defaultCatalog- null if not set and accepting the driver default.
-
setDefaultTransactionIsolation
public void setDefaultTransactionIsolation(int defaultTransactionIsolation) Description copied from interface:PoolConfigurationIf set toDataSourceFactory.UNKNOWN_TRANSACTIONISOLATIONthe methodConnection.setTransactionIsolation(int)will not be called during connection creation. Otherwise the method will be called with the isolation level set by this property.- Specified by:
setDefaultTransactionIsolationin interfacePoolConfiguration- Parameters:
defaultTransactionIsolation- a value ofConnection.TRANSACTION_NONE,Connection.TRANSACTION_READ_COMMITTED,Connection.TRANSACTION_READ_UNCOMMITTED,Connection.TRANSACTION_REPEATABLE_READ,Connection.TRANSACTION_SERIALIZABLEorDataSourceFactory.UNKNOWN_TRANSACTIONISOLATIONThe last value will not be set on the connection.
-
setDriverClassName
Description copied from interface:PoolConfigurationThe fully qualified Java class name of the JDBC driver to be used. The driver has to be accessible from the same classloader as tomcat-jdbc.jar- Specified by:
setDriverClassNamein interfacePoolConfiguration- Parameters:
driverClassName- a fully qualified Java class name of aDriverimplementation.
-
setFairQueue
public void setFairQueue(boolean fairQueue) Description copied from interface:PoolConfigurationSet to true if you wish that calls to getConnection should be treated fairly in a true FIFO fashion. This uses theFairBlockingQueueimplementation for the list of the idle connections. The default value is true. This flag is required when you want to use asynchronous connection retrieval.- Specified by:
setFairQueuein interfacePoolConfiguration- Parameters:
fairQueue-trueto use a fair queue
-
setInitialSize
public void setInitialSize(int initialSize) Description copied from interface:PoolConfigurationSet the number of connections that will be established when the connection pool is started. Default value is 10. If this value exceedsPoolConfiguration.setMaxActive(int)it will automatically be lowered.- Specified by:
setInitialSizein interfacePoolConfiguration- Parameters:
initialSize- the number of connections to be established.
-
setInitSQL
Description copied from interface:PoolConfigurationA custom query to be run when a connection is first created. The default value is null. This query only runs once per connection, and that is when a new connection is established to the database. If this value is non null, it will replace the validation query during connection creation.- Specified by:
setInitSQLin interfacePoolConfiguration- Parameters:
initSQL- the init SQL used to run against the DB or null if no query should be executed
-
setJdbcInterceptors
Description copied from interface:PoolConfigurationA semicolon separated list of classnames extendingJdbcInterceptorclass. These interceptors will be inserted as an interceptor into the chain of operations on a java.sql.Connection object. Example interceptors areStatementFinalizerto close all used statements during the session.ResetAbandonedTimerresets the timer upon every operation on the connection or a statement.ConnectionStatecaches the auto commit, read only and catalog settings to avoid round trips to the DB. The default value is null.- Specified by:
setJdbcInterceptorsin interfacePoolConfiguration- Parameters:
jdbcInterceptors- the interceptors that are used for connections. Example format: 'ConnectionState(useEquals=true,fast=yes);ResetAbandonedTimer'
-
setJmxEnabled
public void setJmxEnabled(boolean jmxEnabled) Description copied from interface:PoolConfigurationIf set to true, the connection pool creates aConnectionPoolMBeanobject 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.- Specified by:
setJmxEnabledin interfacePoolConfiguration- Parameters:
jmxEnabled- set to to if the mbean object should be created upon startup.
-
setLogAbandoned
public void setLogAbandoned(boolean logAbandoned) Description copied from interface:PoolConfigurationboolean 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.- Specified by:
setLogAbandonedin interfacePoolConfiguration- Parameters:
logAbandoned- set to true if stack traces should be recorded whenDataSourceProxy.getConnection()is called.
-
setMaxActive
public void setMaxActive(int maxActive) Description copied from interface:PoolConfigurationThe maximum number of active connections that can be allocated from this pool at the same time. The default value is 100- Specified by:
setMaxActivein interfacePoolConfiguration- Parameters:
maxActive- hard limit for number of managed connections by this pool
-
setMaxIdle
public void setMaxIdle(int maxIdle) Description copied from interface:PoolConfigurationThe maximum number of connections that should be kept in the idle pool ifPoolConfiguration.isPoolSweeperEnabled()returns false. If the IfPoolConfiguration.isPoolSweeperEnabled()returns true, then the idle pool can grow up toPoolConfiguration.getMaxActive()and will be shrunk according toPoolConfiguration.getMinEvictableIdleTimeMillis()setting. Default value is maxActive:100- Specified by:
setMaxIdlein interfacePoolConfiguration- Parameters:
maxIdle- the maximum size of the idle pool
-
setMaxWait
public void setMaxWait(int maxWait) Description copied from interface:PoolConfigurationThe maximum number of milliseconds that the pool will wait (when there are no available connections and thePoolConfiguration.getMaxActive()has been reached) for a connection to be returned before throwing an exception. Default value is 30000 (30 seconds)- Specified by:
setMaxWaitin interfacePoolConfiguration- Parameters:
maxWait- the maximum number of milliseconds to wait.
-
setMinEvictableIdleTimeMillis
public void setMinEvictableIdleTimeMillis(int minEvictableIdleTimeMillis) Description copied from interface:PoolConfigurationThe 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).- Specified by:
setMinEvictableIdleTimeMillisin interfacePoolConfiguration- Parameters:
minEvictableIdleTimeMillis- the number of milliseconds a connection must be idle to be eligible for eviction.
-
setMinIdle
public void setMinIdle(int minIdle) Description copied from interface:PoolConfigurationThe 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 fromPoolConfiguration.getInitialSize()(also seePoolConfiguration.setTestWhileIdle(boolean)The idle pool will not shrink below this value during an eviction run, hence the number of actual connections can be betweenPoolConfiguration.getMinIdle()and somewhere betweenPoolConfiguration.getMaxIdle()andPoolConfiguration.getMaxActive()- Specified by:
setMinIdlein interfacePoolConfiguration- Parameters:
minIdle- the minimum number of idle or established connections
-
setNumTestsPerEvictionRun
public void setNumTestsPerEvictionRun(int numTestsPerEvictionRun) Description copied from interface:PoolConfigurationProperty not used- Specified by:
setNumTestsPerEvictionRunin interfacePoolConfiguration- Parameters:
numTestsPerEvictionRun- parameter ignored.
-
setPassword
Description copied from interface:PoolConfigurationSets the password to establish the connection with. The password will be included as a database property with the name 'password'.- Specified by:
setPasswordin interfacePoolConfiguration- Parameters:
password- The password- See Also:
-
setRemoveAbandoned
public void setRemoveAbandoned(boolean removeAbandoned) Description copied from interface:PoolConfigurationboolean flag to remove abandoned connections if they exceed the removeAbandonedTimeout. If set to true a connection is considered abandoned and eligible for removal if it has been in use longer than thePoolConfiguration.getRemoveAbandonedTimeout()and the condition forPoolConfiguration.getAbandonWhenPercentageFull()is met. Setting this to true can recover db connections from applications that fail to close a connection. See alsoPoolConfiguration.isLogAbandoned()The default value is false.- Specified by:
setRemoveAbandonedin interfacePoolConfiguration- Parameters:
removeAbandoned- set to true if abandoned connections can be closed and expelled out of the pool
-
setRemoveAbandonedTimeout
public void setRemoveAbandonedTimeout(int removeAbandonedTimeout) Description copied from interface:PoolConfigurationThe time in seconds before a connection can be considered abandoned. The timer can be reset upon queries using an interceptor.- Specified by:
setRemoveAbandonedTimeoutin interfacePoolConfiguration- Parameters:
removeAbandonedTimeout- the time in seconds before a used connection can be considered abandoned- See Also:
-
setTestOnBorrow
public void setTestOnBorrow(boolean testOnBorrow) Description copied from interface:PoolConfigurationThe 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, seePoolConfiguration.setValidationInterval(long)- Specified by:
setTestOnBorrowin interfacePoolConfiguration- Parameters:
testOnBorrow- set to true if validation should take place before a connection is handed out to the application- See Also:
-
setTestOnConnect
public void setTestOnConnect(boolean testOnConnect) Description copied from interface:PoolConfigurationSet 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, unless one wants to use the validationQuery as an init query. Setting anPoolConfiguration.setInitSQL(String)will override this setting, as the init SQL will be used instead of the validation query- Specified by:
setTestOnConnectin interfacePoolConfiguration- Parameters:
testOnConnect- set to true if we should run the validation query upon connect
-
setTestOnReturn
public void setTestOnReturn(boolean testOnReturn) Description copied from interface:PoolConfigurationThe 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, seePoolConfiguration.setValidationInterval(long)- Specified by:
setTestOnReturnin interfacePoolConfiguration- Parameters:
testOnReturn- true if validation should take place after a connection is returned to the pool- See Also:
-
setTestWhileIdle
public void setTestWhileIdle(boolean testWhileIdle) Description copied from interface:PoolConfigurationSet to true if query validation should take place while the connection is idle.- Specified by:
setTestWhileIdlein interfacePoolConfiguration- Parameters:
testWhileIdle- true if validation should take place during idle checks- See Also:
-
setTimeBetweenEvictionRunsMillis
public void setTimeBetweenEvictionRunsMillis(int timeBetweenEvictionRunsMillis) Description copied from interface:PoolConfigurationThe 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)- Specified by:
setTimeBetweenEvictionRunsMillisin interfacePoolConfiguration- Parameters:
timeBetweenEvictionRunsMillis- the sleep time in between validations in milliseconds
-
setUrl
Description copied from interface:PoolConfigurationSets the URL used to connect to the database- Specified by:
setUrlin interfacePoolConfiguration- Parameters:
url- the configured URL for this connection pool- See Also:
-
setUseEquals
public void setUseEquals(boolean useEquals) Description copied from interface:PoolConfigurationSet to true if you wish theProxyConnectionclass to useString.equalsinstead of==when comparing method names. This property does not apply to added interceptors as those are configured individually. The default value isfalse.- Specified by:
setUseEqualsin interfacePoolConfiguration- Parameters:
useEquals- set to true if the pool should useString.equals(Object)instead of == when comparing method names onConnectionmethods
-
setUseLock
public void setUseLock(boolean useLock) Description copied from interface:PoolConfigurationSet 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.- Specified by:
setUseLockin interfacePoolConfiguration- Parameters:
useLock- set to true if a lock should be used on connection operations
-
setUsername
Description copied from interface:PoolConfigurationSets the username used to establish the connection with It will also be a property called 'user' in the database properties.- Specified by:
setUsernamein interfacePoolConfiguration- Parameters:
username- The user name- See Also:
-
setValidationInterval
public void setValidationInterval(long validationInterval) Description copied from interface:PoolConfigurationavoid 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 3000 (3 seconds).- Specified by:
setValidationIntervalin interfacePoolConfiguration- Parameters:
validationInterval- the validation interval in milliseconds
-
setValidationQuery
Description copied from interface:PoolConfigurationThe SQL query that will be used to validate connections from this pool before returning them to the caller or pool. If specified, this query does not have to return any data, it just can't throw an SQLException. The default value is null. Example values are SELECT 1(mysql), select 1 from dual(oracle), SELECT 1(MS Sql Server)- Specified by:
setValidationQueryin interfacePoolConfiguration- Parameters:
validationQuery- the query used for validation or null if no validation is performed
-
setValidationQueryTimeout
public void setValidationQueryTimeout(int validationQueryTimeout) Description copied from interface:PoolConfigurationThe timeout in seconds before a connection validation queries fail. A value less than or equal to zero will disable this feature. Defaults to -1.- Specified by:
setValidationQueryTimeoutin interfacePoolConfiguration- Parameters:
validationQueryTimeout- The timeout value
-
setValidatorClassName
Description copied from interface:PoolConfigurationSet the name for an optional validator class which will be used in place of test queries. If set to null, standard validation will be used.- Specified by:
setValidatorClassNamein interfacePoolConfiguration- Parameters:
className- the name of the optional validator class
-
getSuspectTimeout
public int getSuspectTimeout()Description copied from interface:PoolConfigurationReturns the time in seconds to pass before a connection is marked an abandoned suspect. Any value lesser than or equal to 0 means the check is disabled.- Specified by:
getSuspectTimeoutin interfacePoolConfiguration- Returns:
- Returns the time in seconds to pass before a connection is marked an abandoned suspect.
-
setSuspectTimeout
public void setSuspectTimeout(int seconds) Description copied from interface:PoolConfigurationSimilar toPoolConfiguration.setRemoveAbandonedTimeout(int)but instead of treating the connection as abandoned, and potentially closing the connection, this simply logs the warning ifPoolConfiguration.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.- Specified by:
setSuspectTimeoutin interfacePoolConfiguration- Parameters:
seconds- - the amount of time in seconds that has to pass before a connection is marked suspect.
-
setDataSource
Description copied from interface:PoolConfigurationInjects a datasource that will be used to retrieve/create connections. If a data source is set, thePoolConfiguration.getUrl()andPoolConfiguration.getDriverClassName()methods are ignored and not used by the pool. If thePoolConfiguration.getUsername()andPoolConfiguration.getPassword()values are set, the methodDataSource.getConnection(String, String)method will be called instead of theDataSource.getConnection()method. If the data source implementsXADataSourcethe methodsXADataSource.getXAConnection()andXADataSource.getXAConnection(String,String)will be invoked.- Specified by:
setDataSourcein interfacePoolConfiguration- Parameters:
ds- theDataSourceto be used for creating connections to be pooled.
-
getDataSource
Description copied from interface:PoolConfigurationReturns a datasource, if one exists that is being used to create connections. This method will return null if the pool is using aDriver- Specified by:
getDataSourcein interfacePoolConfiguration- Returns:
- the
DataSourceto be used for creating connections to be pooled or null if a Driver is used.
-
setDataSourceJNDI
Description copied from interface:PoolConfigurationConfigure the connection pool to use a DataSource according toPoolConfiguration.setDataSource(Object)But instead of injecting the object, specify the JNDI location. After a successful JNDI look, thePoolConfiguration.getDataSource()will not return null.- Specified by:
setDataSourceJNDIin interfacePoolConfiguration- Parameters:
jndiDS- -the JNDI string @TODO specify the rules here.
-
getDataSourceJNDI
Description copied from interface:PoolConfigurationReturns the JNDI string configured for data source usage.- Specified by:
getDataSourceJNDIin interfacePoolConfiguration- Returns:
- the JNDI string or null if not set
-
isAlternateUsernameAllowed
public boolean isAlternateUsernameAllowed()Description copied from interface:PoolConfigurationReturns true if the callgetConnection(username,password)is allowed. This is used for when the pool is used by an application accessing multiple schemas. There is a performance impact turning this option on.- Specified by:
isAlternateUsernameAllowedin interfacePoolConfiguration- Returns:
- true if
getConnection(username,password)is honored, false if it is ignored.
-
setAlternateUsernameAllowed
public void setAlternateUsernameAllowed(boolean alternateUsernameAllowed) Description copied from interface:PoolConfigurationSet to true if the callgetConnection(username,password)is allowed and honored.. This is used for when the pool is used by an application accessing multiple schemas. There is a performance impact turning this option on, even when not used due to username checks.- Specified by:
setAlternateUsernameAllowedin interfacePoolConfiguration- Parameters:
alternateUsernameAllowed- - set true ifgetConnection(username,password)is honored, false if it is to be ignored.
-
setValidator
Description copied from interface:PoolConfigurationSets the validator object If this is a non null object, it will be used as a validator instead of the validationQuery If this is null, remove the usage of the validator.- Specified by:
setValidatorin interfacePoolConfiguration- Parameters:
validator- The validator object
-
setCommitOnReturn
public void setCommitOnReturn(boolean commitOnReturn) Description copied from interface:PoolConfigurationSet to true if you want the connection pool to commit any pending transaction when a connection is returned. The default value is false, as this could result in committing data. This parameter is only looked at if thePoolConfiguration.getDefaultAutoCommit()returns false- Specified by:
setCommitOnReturnin interfacePoolConfiguration- Parameters:
commitOnReturn- set to true if the pool should callConnection.commit()when a connection is returned to the pool. Default is false
-
getCommitOnReturn
public boolean getCommitOnReturn()- Specified by:
getCommitOnReturnin interfacePoolConfiguration- Returns:
trueif the pool should commit when a connection is returned to it- See Also:
-
setRollbackOnReturn
public void setRollbackOnReturn(boolean rollbackOnReturn) Description copied from interface:PoolConfigurationSet to true if you want the connection pool to rollback any pending transaction when a connection is returned. The default value is false, as this could result in committing data. This parameter is only looked at if thePoolConfiguration.getDefaultAutoCommit()returns false- Specified by:
setRollbackOnReturnin interfacePoolConfiguration- Parameters:
rollbackOnReturn- set to true if the pool should callConnection.rollback()when a connection is returned to the pool. Default is false
-
getRollbackOnReturn
public boolean getRollbackOnReturn()- Specified by:
getRollbackOnReturnin interfacePoolConfiguration- Returns:
trueif the pool should rollback when a connection is returned to it- See Also:
-
setUseDisposableConnectionFacade
public void setUseDisposableConnectionFacade(boolean useDisposableConnectionFacade) Description copied from interface:PoolConfigurationIf set totrue, the connection will be wrapped with facade that will disallow the connection to be used afterConnection.close()is called. If set totrue, afterConnection.close()all calls exceptConnection.close()andConnection.isClosed()will throw an exception.- Specified by:
setUseDisposableConnectionFacadein interfacePoolConfiguration- Parameters:
useDisposableConnectionFacade-trueto use a facade
-
getUseDisposableConnectionFacade
public boolean getUseDisposableConnectionFacade()Description copied from interface:PoolConfigurationReturnstrueif this connection pool is configured to use a connection facade to prevent re-use of connection afterConnection.close()has been invoked- Specified by:
getUseDisposableConnectionFacadein interfacePoolConfiguration- Returns:
trueifConnection.close()has been invoked.
-
setLogValidationErrors
public void setLogValidationErrors(boolean logValidationErrors) Description copied from interface:PoolConfigurationSet to true if you wish that errors from validation should be logged as error messages.- Specified by:
setLogValidationErrorsin interfacePoolConfiguration- Parameters:
logValidationErrors- set to true to log validation errors
-
getLogValidationErrors
public boolean getLogValidationErrors()Description copied from interface:PoolConfigurationReturns true if errors that happen during validation will be logged- Specified by:
getLogValidationErrorsin interfacePoolConfiguration- Returns:
- true if errors that happen during validation will be logged
-
getPropagateInterruptState
public boolean getPropagateInterruptState()Description copied from interface:PoolConfigurationReturns true if the pool is configured to propagate interrupt state of a thread. A thread waiting for a connection, can have its wait interrupted, and by default will clear the interrupt flag and throw aPoolExhaustedException- Specified by:
getPropagateInterruptStatein interfacePoolConfiguration- Returns:
- true if the pool is configured to propagate and not clear the thread interrupt state
-
setPropagateInterruptState
public void setPropagateInterruptState(boolean propagateInterruptState) Description copied from interface:PoolConfigurationConfigure the pool to propagate interrupt state for interrupted threads waiting for a connection A thread waiting for a connection, can have its wait interrupted, and by default will clear the interrupt flag and throw aPoolExhaustedExceptionIf set to true, this behavior will change, while thePoolExhaustedExceptionis still thrown, the threads interrupted state is still set.- Specified by:
setPropagateInterruptStatein interfacePoolConfiguration- Parameters:
propagateInterruptState- - set to true to not clear, but propagate, a threads interrupted state.
-
isIgnoreExceptionOnPreLoad
public boolean isIgnoreExceptionOnPreLoad()- Specified by:
isIgnoreExceptionOnPreLoadin interfacePoolConfiguration- Returns:
trueto ignore exceptions- See Also:
-
setIgnoreExceptionOnPreLoad
public void setIgnoreExceptionOnPreLoad(boolean ignoreExceptionOnPreLoad) Description copied from interface:PoolConfigurationSet to true if you want to ignore error of connection creation while initializing the pool. Set to false if you want to fail the initialization of the pool by throwing exception.- Specified by:
setIgnoreExceptionOnPreLoadin interfacePoolConfiguration- Parameters:
ignoreExceptionOnPreLoad- set to true if you want to ignore error of connection creation while initializing the pool.
-
getUseStatementFacade
public boolean getUseStatementFacade()Description copied from interface:PoolConfigurationReturnstrueif this connection pool is configured to wrap statements in order to enable equals() and hashCode() methods to be called on the closed statements if any statement proxy is set.- Specified by:
getUseStatementFacadein interfacePoolConfiguration- Returns:
trueif the statements are wrapped
-
setUseStatementFacade
public void setUseStatementFacade(boolean useStatementFacade) Description copied from interface:PoolConfigurationSet this to true if you wish to wrap statements in order to enable equals() and hashCode() methods to be called on the closed statements if any statement proxy is set.- Specified by:
setUseStatementFacadein interfacePoolConfiguration- Parameters:
useStatementFacade- set totrueto wrap statements
-
purge
public void purge()Description copied from interface:ConnectionPoolMBeanPurges all connections in the pool. For connections currently in use, these connections will be purged when returned on the pool. This call also purges connections that are idle and in the pool To only purge used/active connections seeConnectionPoolMBean.purgeOnReturn()- Specified by:
purgein interfaceConnectionPoolMBean
-
purgeOnReturn
public void purgeOnReturn()Description copied from interface:ConnectionPoolMBeanPurges connections when they are returned from the pool. This call does not purge idle connections until they are used. To purge idle connections seeConnectionPoolMBean.purge()- Specified by:
purgeOnReturnin interfaceConnectionPoolMBean
-