3.11.32 /resources/connector-connection-pool
/resources/connector-connection-pool defines a connector connection pool.
Description
/resources/connector-connection-pool defines the properties that are required for creating a connector connection pool.
Repetition pattern
0 or more times
Specifiable attributes
Attribute name |
Description |
Specifiable values |
Default value# |
Dependencies |
Repetition pattern |
---|---|---|---|---|---|
name |
Specifies the name of the connection pool. A connector-resource element pool-name attribute refers to this name. |
Type: String |
No default value |
N/A |
Only one time |
resource-adapter-name |
Specifies the name of the deployed connector module or application. If no name is specified during deployment, then the name of the .rar file is used. If the resource adapter is embedded in an application, then it is app_name#rar_name. |
Type: String |
No default value |
N/A |
Only one time |
connection-definition-name |
Specifies a unique name, identifying the connection-definition element of a resource adapter in the ra.xml file. This is usually the connectionfactory-interface of the connection-definition element. |
Type: String |
No default value |
N/A |
Only one time |
steady-pool-size |
Specifies the initial and minimum number of connections maintained in the pool. |
Type: Integer 0 to 2147483647 |
24 |
N/A |
0 or 1 time |
max-pool-size |
Specifies the maximum number of connections that can be created to satisfy client requests. |
Type: Integer 1 to 2147483647 |
24 |
N/A |
0 or 1 time |
max-wait-time-in-millis |
Specifies the amount of time, in milliseconds, that the caller is willing to wait for a connection. If 0 millisecond, then the caller is blocked indefinitely until a resource is available or an error occurs. |
Type: Integer 0 to 2147483647 |
60000 |
N/A |
0 or 1 time |
pool-resize-quantity |
Specifies the number of idle connections to be destroyed if the existing number of connections is above the steady-pool-size (subject to the max-pool-size limit). This is enforced periodically at the idle-timeout-in-seconds interval. An idle connection is one that has not been used for a period of idle-timeout-in-seconds. When the pool size reaches steady-pool-size, the process of connection removal stops. |
Type: Integer 1 to 2147483647 |
2 |
N/A |
0 or 1 time |
idle-timeout-in-seconds |
Specifies the maximum time that a connection can remain idle in the pool. After this amount of time, the pool can close this connection. |
Type: Integer 1 to 2147483647 |
300 |
N/A |
0 or 1 time |
transaction-support |
Specifies the transaction support for this connection pool. It overrides the transaction support defined in the resource adapter in a downward compatible way to support a transaction level lower than or equal to the resource adapter, but not higher.
|
Type: String {XATransaction | LocalTransaction | NoTransaction} |
No default value |
N/A |
0 or 1 time |
is-connection-validation-required |
Specifies whether connections have to be validated before being given to the application. If the validation of a resource fails, then it is destroyed, and a new resource is created and returned. The connection failure detection at a regular interval is always enabled, regardless of the specified value. |
Type: Boolean {true | false} |
false |
N/A |
0 or 1 time |
validate-atmost-once-period-in-seconds |
Specifies the time interval within which a connection is validated at most once. Minimizes the number of validation calls. A value of zero allows unlimited validation calls. |
Type: Integer 0 to 2147483647 |
0 |
N/A |
Only one time |
connection-leak-timeout-in-seconds |
Detects potential connection leaks by the application. A connection that is not returned back to the pool by the application within the specified period is assumed to be potentially leaking, and a stack trace of the caller is logged. A zero value disables leak detection. A value other than zero enables leak tracing. |
Type: Integer 0 to 2147483647 |
0 |
N/A |
Only one time |
connection-leak-reclaim |
If true, then the pool reclaims a connection after connection-leak-timeout-in-seconds occurs. |
Type: Boolean {true | false} |
false |
N/A |
Only one time |
connection-creation-retry-attempts |
Specifies the number of attempts of creating a new connection. |
Type: Integer 0 to 2147483647 |
0 |
N/A |
Only one time |
connection-creation-retry-interval-in-seconds |
Specifies the time interval between attempts to create a connection when connection-creation-retry-attempts is greater than 0. |
Type: Integer 0 to 2147483647 |
10 |
N/A |
Only one time |
lazy-connection-enlistment |
If true, then a connection is not enlisted in a transaction until it is used. If false, then any connection object available to a transaction is enlisted in the transaction. |
Type: Boolean {true | false} |
false |
N/A |
Only one time |
lazy-connection-association |
If true, then a physical connection is not associated with a logical connection until it is used. If false, then a physical connection is associated with a logical connection even before it is used. |
Type: Boolean {true | false} |
false |
N/A |
Only one time |
match-connections |
If true, then enables connection matching. It can be set to false if connections are homogeneous. |
Type: Boolean {true | false} |
true |
N/A |
Only one time |
max-connection-usage-count |
Specifies the number of times a connections is reused by the pool, after which it is closed. A zero value disables this feature. |
Type: Integer 0 to 2147483647 |
0 |
N/A |
Only one time |
ping |
Specifies whether to ping the pool during pool creation or reconfiguration to identify and warn of any erroneous attribute values. |
Type: Boolean {true | false} |
false |
N/A |
0 or 1 time |
pooling |
If false, then disables connection pooling. |
Type: Boolean {true | false} |
true |
N/A |
0 or 1 time |
- Legend:
-
N/A: Not applicable
#: This is the default value that is set when a definition item is excluded.