ConnectionPool

Connection pool properties that can be modified to change the behavior of the J2C connection pool manager. Default values are provided for non-production use. Reviewing and possible modification of these configuration values is recommended.



Attributes Summary
connectionTimeout : longConnection timeout is the interval, in seconds, after which a connection request times out and a ConnectionWaitTimeoutException is thrown.
maxConnections : intThe maximum number of managed connections that can be created by a particular ManagedConnectionFactory.
minConnections : intThe minimum number of managed connections to maintain.
reapTime : longNumber of seconds between runs of the garbage collector.
unusedTimeout : longInterval, in seconds, after which an unused connection is discarded by the pool maintenance thread.
agedTimeout : longInterval, in seconds, after which an unused, aged connection is discarded (regardless of recent usage activity) by the pool maintenance thread.
purgePolicy : PurgePolicyKindWhenever a fatal connection error signal is received by the Connection Pool Manager, the Connection Pool Manager needs to either remove just the failing connection or to remove all of the connections in the pool.
numberOfSharedPoolPartitions : int@since 6.
numberOfUnsharedPoolPartitions : int@since 6.
numberOfFreePoolPartitions : int@since 6.
freePoolDistributionTableSize : int@since 6.
surgeThreshold : int@since 6.
surgeCreationInterval : int@since 6.
testConnection : boolean@since 6.
testConnectionInterval : int@since 6.
stuckTimerTime : int@since 6.
stuckTime : int@since 6.
stuckThreshold : int@since 6.
properties : Property * @since 6.

Attribute Details

connectionTimeout    -    Connection timeout is the interval, in seconds, after which a connection request times out and a ConnectionWaitTimeoutException is thrown. The wait may be necessary if the maximum value of connections to a particular connection pool has been reached (Max Connections) . This value has no meaning if Max Connections is set to 0 (infinite number of ManagedConnections). If Connection Timeout is set to 0 the Pool Manager waits until a connection can be allocated (which happens when the number of connections falls below Max Connections).
     data type:  long
     default Value:   180



maxConnections    -    The maximum number of managed connections that can be created by a particular ManagedConnectionFactory. After this number is reached, no new connections are created and either the requester waits for the Connection Timeout or the ResourceAllocationException is thrown. If Maximum Connections is set to 0 (zero), the number of connections can grow indefinitely. Maximum Connections must be larger than or equal to Minimum Connections.
     data type:  int
     default Value:   10



minConnections    -    The minimum number of managed connections to maintain. If this number is reached, the garbage collector will not discard any managed connections. Note, if the actual number of connections is lower than the value specified by the minimum connections settings, no attempt will be made to increase the number of connections to the minimum. Minimum Connections must be less than or equal to Maximum Connections.
     data type:  int
     default Value:   1



reapTime    -    Number of seconds between runs of the garbage collector. The garbage collector discards all connections that have been unused for the value specified by the Unused Timeout. To disable the garbage collector, set the reap time to 0 (zero) or set the Unused Timeout to 0 (zero).
     data type:  long
     default Value:   180



unusedTimeout    -    Interval, in seconds, after which an unused connection is discarded by the pool maintenance thread.
     data type:  long
     default Value:   1800



agedTimeout    -    Interval, in seconds, after which an unused, aged connection is discarded (regardless of recent usage activity) by the pool maintenance thread.
     data type:  long
     default Value:   0



purgePolicy    -    Whenever a fatal connection error signal is received by the Connection Pool Manager, the Connection Pool Manager needs to either remove just the failing connection or to remove all of the connections in the pool. This Purge Policy setting will determine the action of the Connection Pool Manager.
     data type: PurgePolicyKind
     default Value:   unspecified
     Allowed Values:  FailingConnectionOnly   EntirePool  



numberOfSharedPoolPartitions    -    @since 6.0.0The number of buckets or partitions that are created in each of the shared pools
     data type:  int
     default Value:   0



numberOfUnsharedPoolPartitions    -    @since 6.0.0The number of buckets or partitions that are created in each of the unshared pools.
     data type:  int
     default Value:   0



numberOfFreePoolPartitions    -    @since 6.0.0The number of buckets or partitions that are created in each of the free pools.
     data type:  int
     default Value:   0



freePoolDistributionTableSize    -    @since 6.0.0If there are many incoming requests with varying credentials, this value can help with the distribution of finding a free pool for a connection for that user. Larger values are more common for installations that have many different credentials accessing the resource. Smaller values (0) should be used if the same credentials apply to all incoming requests for the resource.0=Random Distribution
     data type:  int
     default Value:   0



surgeThreshold    -    @since 6.0.0Once the number of connections in the pool exceeds this threshold, The rate at which connections are created will be throttled/limited based on the surgeCreationInterval setting.Once the threshold has been reached, the surge creation interval will be applied until the number of connections in the pool drops below the threshold again.Must be less than the max connections setting for this pool and greater than the min connections settingA value of -1 disables surge protection.
     data type:  int
     default Value:   -1



surgeCreationInterval    -    @since 6.0.0The period of time to wait before connections are created again once the surge threshold has been reached.
     data type:  int
     default Value:   0



testConnection    -    @since 6.0.0true or false
     data type: boolean
     default Value:   false
     Allowed Values:  true   false  



testConnectionInterval    -    @since 6.0.0Interval of the test connection retry thread
     data type:  int
     default Value:   0



stuckTimerTime    -    @since 6.0.0Frequency of stuck time thread
     data type:  int
     default Value:   0



stuckTime    -    @since 6.0.0Connection stuck time
     data type:  int
     default Value:   0



stuckThreshold    -    @since 6.0.0Number of connections threshold
     data type:  int
     default Value:   0



properties    -    @since 6.0.0A collection of custom settings for the connection pool.
     data type: Property*


Copyright IBM Corp. 1997-2004