FileDocCategorySizeDatePackage
JDBCConnectionPoolConfig.javaAPI DocGlassfish v2 API12561Fri May 04 22:30:34 BST 2007com.sun.appserv.management.config

JDBCConnectionPoolConfig

public interface JDBCConnectionPoolConfig implements Description, PropertiesAccess, ResourceRefConfigReferent, NamedConfigElement
Configuration for the <jdbc-connection-pool> element.

NOTE: some getters/setters use java.lang.boolean. This is a problem; these methods cannot use the AppServer template facility, whereby an Attribute value can be of the form attr-name=${ATTR_VALUE}. For an example of where/how this facility is used, see the <http-listener> element, which looks like this:

<http-listener id="http-listener-1" address="0.0.0.0" port="${HTTP_LISTENER_PORT}" acceptor-threads="1" security-enabled="false" default-virtual server="server" server-name="" xpowered-by="true" enabled="true">
The 'port' attribute above is set to the value "${HTTP_LISTENER_PORT}", which is a system property. Obviously no method that uses 'boolean' could get or set a String.

Fields Summary
public static final String
J2EE_TYPE
The j2eeType as returned by {@link com.sun.appserv.management.base.AMX#getJ2EEType}.
Constructors Summary
Methods Summary
public booleangetAllowNonComponentCallers()
A pool with this property set to true, can be used by non-J2EE components (i.e components other than EJBs or Servlets). The returned connection is enlisted automatically with the transaction context obtained from the transaction manager. This property is to enable the pool to be used by non-component callers such as ServletFilters, Lifecycle modules, and 3rd party persistence managers. Standard J2EE components can continue to use such pools. Connections obtained by non-component callers are not automatically cleaned at the end of a transaction by the container. They need to be explicitly closed by the the caller.

since
AppServer 9.0

public java.lang.StringgetAssociateWithThread()
associate-with-thread (boolean)
Associate a connection with the thread such that when the same thread is in need of a connection, it can reuse the connection already associated with that thread, thereby not incurring the overhead of getting a connection from the pool. Default value is false.

since
AppServer 9.1

public java.lang.StringgetConnectionCreationRetryAttempts()
connection-creation-retry-attempts (integer)
The number of attempts to create a new connection. Default is 0, which implies no retries.

since
AppServer 9.1

public java.lang.StringgetConnectionCreationRetryIntervalInSeconds()
connection-creation-retry-interval-in-seconds (integer)
The time interval between retries while attempting to create a connection Default is 10 seconds. Effective when connection-creation-retry-attempts is greater than 0.

since
AppServer 9.1

public java.lang.StringgetConnectionLeakReclaim()
connection-leak-reclaim (boolean)
If enabled, connection will be re-usable (put back to pool) after connection-leak-timeout-in-seconds occurs. Default value is false.

since
AppServer 9.1

public java.lang.StringgetConnectionLeakTimeoutInSeconds()
connection-leak-timeout-in-seconds (integer)
To aid user in detecting potential connection leaks by the application. When a connection is not returned back to the pool by the application within the specified period, it is assumed to be a potential leak and stack trace of the caller will be logged. Default is 0 seconds, which implies there is no leak detection, by default. A non-zero value turns on leak tracing.

since
AppServer 9.1

public java.lang.StringgetConnectionValidationMethod()

public java.lang.StringgetDatasourceClassname()

public booleangetFailAllConnections()

public java.lang.StringgetIdleTimeoutInSeconds()

public booleangetIsConnectionValidationRequired()

public booleangetIsIsolationLevelGuaranteed()

public java.lang.StringgetLazyConnectionAssociation()
lazy-connection-association (boolean)
Connections are lazily associated when an operation is performed on them. Also they are disassociated when the transaction is completed and a component method ends, which helps to reuse the physical connections. Default value is false.

since
AppServer 9.1

public java.lang.StringgetLazyConnectionEnlistment()
lazy-connection-enlistment (boolean)
Enlist a resource to the transaction only when it is actually used in a method, which avoids enlistment of connections, that are not used, in a transaction. This also prevents unnecessary enlistment of connections cached in the calling components. Default value is false.

since
AppServer 9.1

public java.lang.StringgetMatchConnections()
match-connections (boolean)
To switch on/off connection matching for the pool. It can be set to false if the administrator knows that the connections in the pool will always be homogeneous and hence a connection picked from the pool need not be matched by the resource adapter. Default value is true.

since
AppServer 9.1

public java.lang.StringgetMaxConnectionUsageCount()
max-connection-usage-count
When specified, connections will be re-used by the pool for the specified number of times after which it will be closed. eg : To avoid statement-leaks. Default value is 0, which implies the feature is not enabled.

since
AppServer 9.1

public java.lang.StringgetMaxPoolSize()

public java.lang.StringgetMaxWaitTimeInMillis()

public booleangetNonTransactionalConnections()
A pool with this property set to true returns non-transactional connections. This connection does not get automatically enlisted with the transaction manager.

since
AppServer 9.0

public java.lang.StringgetPoolResizeQuantity()

public java.lang.StringgetResType()

public java.lang.StringgetStatementTimeoutInSeconds()
associate-with-thread (integer)

since
AppServer 9.1

public java.lang.StringgetSteadyPoolSize()

public java.lang.StringgetTransactionIsolationLevel()

public java.lang.StringgetValidateAtMostOncePeriodInSeconds()
validate-atmost-once-period-in-seconds (integer)
Used to set the time-interval within which a connection is validated atmost once. Default is 0 seconds, not enabled.

since
AppServer 9.1

public java.lang.StringgetValidationTableName()

public java.lang.StringgetWrapJDBCObjects()
wrap-jdbc-objects (boolean)
When set to true, application will get wrapped jdbc objects for Statement, PreparedStatement, CallableStatement, ResultSet, DatabaseMetaData.

since
AppServer 9.1

public voidsetAllowNonComponentCallers(boolean enabled)

see
#getAllowNonComponentCallers
since
AppServer 9.0

public voidsetAssociateWithThread(java.lang.String associate)

see
#getAssociateWithThread
since
AppServer 9.1

public voidsetConnectionCreationRetryAttempts(java.lang.String count)

see
#getConnectionCreationRetryAttempts
since
AppServer 9.1

public voidsetConnectionCreationRetryIntervalInSeconds(java.lang.String seconds)

see
#getConnectionCreationRetryIntervalInSeconds
since
AppServer 9.1

public voidsetConnectionLeakReclaim(java.lang.String reclaim)

see
#getConnectionLeakReclaim
since
AppServer 9.1

public voidsetConnectionLeakTimeoutInSeconds(java.lang.String timeout)

see
#getConnectionLeakTimeoutInSeconds
since
AppServer 9.1

public voidsetConnectionValidationMethod(java.lang.String value)

public voidsetDatasourceClassname(java.lang.String value)

public voidsetFailAllConnections(boolean value)

public voidsetIdleTimeoutInSeconds(java.lang.String value)

public voidsetIsConnectionValidationRequired(boolean value)

public voidsetIsIsolationLevelGuaranteed(boolean value)

public voidsetLazyConnectionAssociation(java.lang.String associate)

see
#getLazyConnectionAssociation
since
AppServer 9.1

public voidsetLazyConnectionEnlistment(java.lang.String enlist)

see
#getLazyConnectionEnlistment
since
AppServer 9.1

public voidsetMatchConnections(java.lang.String match)

see
#getMatchConnections
since
AppServer 9.1

public voidsetMaxConnectionUsageCount(java.lang.String count)

see
#getMaxConnectionUsageCount
since
AppServer 9.1

public voidsetMaxPoolSize(java.lang.String value)

public voidsetMaxWaitTimeInMillis(java.lang.String value)

public voidsetNonTransactionalConnections(boolean enabled)

see
#getNonTransactionalConnections
since
AppServer 9.0

public voidsetPoolResizeQuantity(java.lang.String value)

public voidsetResType(java.lang.String value)

public voidsetStatementTimeoutInSeconds(java.lang.String value)
associate-with-thread (integer)

since
AppServer 9.1

public voidsetSteadyPoolSize(java.lang.String value)

public voidsetTransactionIsolationLevel(java.lang.String value)
See {@link IsolationValues}.

public voidsetValidateAtMostOncePeriodInSeconds(java.lang.String seconds)

see
#getValidateAtMostOncePeriodInSeconds
since
AppServer 9.1

public voidsetValidationTableName(java.lang.String value)

public voidsetWrapJDBCObjects(java.lang.String wrap)

see
#getWrapJDBCObjects
since
AppServer 9.1