ConnectionPool

ConnectionPool

This type is a class for model objects.

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.
Package: resources

Classifier ID:  -1
Instance class name:  * Unspecified *
Instance class:  * Unspecified *

Reference attributes having this type:
  ConnectionFactory.connectionPool
  JMSConnectionFactory.sessionPool

Attributes Summary

connectionTimeout : ELong 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).

maxConnections : EInt 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.

minConnections : EInt 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.

reapTime : ELong 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).

unusedTimeout : ELong Interval, in seconds, after which an unused connection is discarded by the pool maintenance thread.

agedTimeout : ELong Interval, in seconds, after which an unused, aged connection is discarded (regardless of recent usage activity) by the pool maintenance thread.

purgePolicy : PurgePolicyKind 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.

numberOfSharedPoolPartitions : EInt @since 6.0.0 The number of buckets or partitions that are created in each of the shared pools

numberOfUnsharedPoolPartitions : EInt @since 6.0.0 The number of buckets or partitions that are created in each of the unshared pools.

numberOfFreePoolPartitions : EInt @since 6.0.0 The number of buckets or partitions that are created in each of the free pools.

freePoolDistributionTableSize : EInt @since 6.0.0 If 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

surgeThreshold : EInt @since 6.0.0 Once 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 setting A value of -1 disables surge protection.

surgeCreationInterval : EInt @since 6.0.0 The period of time to wait before connections are created again once the surge threshold has been reached.

testConnection : EBoolean @since 6.0.0 true or false

testConnectionInterval : EInt @since 6.0.0 Interval of the test connection retry thread

stuckTimerTime : EInt @since 6.0.0 Frequency of stuck time thread

stuckTime : EInt @since 6.0.0 Connection stuck time

stuckThreshold : EInt @since 6.0.0 Number of connections threshold

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

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: ELong
    Default value:  180
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

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: EInt
    Default value:  10
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

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: EInt
    Default value:  1
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

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: ELong
    Default value:  180
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

unusedTimeout  -  Interval, in seconds, after which an unused connection is discarded by the pool maintenance thread.
    Data Type: ELong
    Default value:  1800
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

agedTimeout  -  Interval, in seconds, after which an unused, aged connection is discarded (regardless of recent usage activity) by the pool maintenance thread.
    Data Type: ELong
    Default value:  0
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

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:
        0 - FailingConnectionOnly
        1 - EntirePool
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

numberOfSharedPoolPartitions  -  @since 6.0.0 The number of buckets or partitions that are created in each of the shared pools
    Data Type: EInt
    Default value:  0
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

numberOfUnsharedPoolPartitions  -  @since 6.0.0 The number of buckets or partitions that are created in each of the unshared pools.
    Data Type: EInt
    Default value:  0
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

numberOfFreePoolPartitions  -  @since 6.0.0 The number of buckets or partitions that are created in each of the free pools.
    Data Type: EInt
    Default value:  0
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

freePoolDistributionTableSize  -  @since 6.0.0 If 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: EInt
    Default value:  0
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

surgeThreshold  -  @since 6.0.0 Once 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 setting A value of -1 disables surge protection.
    Data Type: EInt
    Default value:  -1
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

surgeCreationInterval  -  @since 6.0.0 The period of time to wait before connections are created again once the surge threshold has been reached.
    Data Type: EInt
    Default value:  0
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

testConnection  -  @since 6.0.0 true or false
    Data Type: EBoolean
    Default value:  false
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

testConnectionInterval  -  @since 6.0.0 Interval of the test connection retry thread
    Data Type: EInt
    Default value:  0
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

stuckTimerTime  -  @since 6.0.0 Frequency of stuck time thread
    Data Type: EInt
    Default value:  0
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

stuckTime  -  @since 6.0.0 Connection stuck time
    Data Type: EInt
    Default value:  0
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

stuckThreshold  -  @since 6.0.0 Number of connections threshold
    Data Type: EInt
    Default value:  0
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

properties  -  @since 6.0.0 A collection of custom settings for the connection pool.
    Reference Type: Property *
    Containment:  true
    Container:  false
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  true
    Ordered:  true
    Lower bound:  0
    Upper bound:  Unbounded
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

(C) COPYRIGHT International Business Machines Corp. 1996-2006

Attributes Summary
connectionTimeout : ELong	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).
maxConnections : EInt	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.
minConnections : EInt	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.
reapTime : ELong	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).
unusedTimeout : ELong	Interval, in seconds, after which an unused connection is discarded by the pool maintenance thread.
agedTimeout : ELong	Interval, in seconds, after which an unused, aged connection is discarded (regardless of recent usage activity) by the pool maintenance thread.
purgePolicy : PurgePolicyKind	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.
numberOfSharedPoolPartitions : EInt	@since 6.0.0 The number of buckets or partitions that are created in each of the shared pools
numberOfUnsharedPoolPartitions : EInt	@since 6.0.0 The number of buckets or partitions that are created in each of the unshared pools.
numberOfFreePoolPartitions : EInt	@since 6.0.0 The number of buckets or partitions that are created in each of the free pools.
freePoolDistributionTableSize : EInt	@since 6.0.0 If 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
surgeThreshold : EInt	@since 6.0.0 Once 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 setting A value of -1 disables surge protection.
surgeCreationInterval : EInt	@since 6.0.0 The period of time to wait before connections are created again once the surge threshold has been reached.
testConnection : EBoolean	@since 6.0.0 true or false
testConnectionInterval : EInt	@since 6.0.0 Interval of the test connection retry thread
stuckTimerTime : EInt	@since 6.0.0 Frequency of stuck time thread
stuckTime : EInt	@since 6.0.0 Connection stuck time
stuckThreshold : EInt	@since 6.0.0 Number of connections threshold
properties : Property *	@since 6.0.0 A collection of custom settings for the connection pool.