Search

3.3.12.3. JBoss AS 7 and EAP 6 - Datasources Runtime Service

download PDF
Overview
Table 3.497. Overview
Description: Runtime resources exposed by data sources included in this deployment.
Singleton: yes
Plugin: JBossAS7
Child Resource Types
Connection Properties
Table 3.498. 
Name Description Required Internal Name
Path yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.3.12.3.1. JBoss AS 7 and EAP 6 - XA Datasource Runtime Service
Overview
Table 3.499. Overview
Description: A JDBC XA data-source configuration
Singleton: no
Plugin: JBossAS7
Child Resource Types
none
Connection Properties
Table 3.500. 
Name Description Required Internal Name
Path yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.501. 
Name Description Required Internal Name
Properties no *2
Allocation Retry The allocation retry element indicates the number of times that allocating a connection should be tried before throwing an exception no allocation-retry
Allocation Retry Wait Millis The allocation retry wait millis element specifies the amount of time, in milliseconds, to wait between retrying to allocate a connection no allocation-retry-wait-millis
Background Validation An element to specify that connections should be validated on a background thread versus being validated prior to use. Changing this value can be done only on disabled datasource, requires a server restart otherwise. The default value is false. no background-validation
Background Validation Millis The background-validation-millis element specifies the amount of time, in milliseconds, that background validation will run. Changing this value can be done only on disabled datasource, requires a server restart otherwise no background-validation-millis
Blocking Timeout Wait Millis The blocking-timeout-millis element specifies the maximum time, in milliseconds, to block while waiting for a connection before throwing an exception. Note that this blocks only while waiting for locking a connection, and will never throw an exception if creating a new connection takes an inordinately long time no blocking-timeout-wait-millis
Check Valid Connection Sql Specify an SQL statement to check validity of a pool connection. This may be called when managed connection is obtained from the pool no check-valid-connection-sql
Driver Name Defines the JDBC driver the datasource should use. It is a symbolic name matching the the name of installed driver. In case the driver is deployed as jar, the name is the name of deployment unit yes driver-name
Enabled Specifies if the datasource should be enabled no enabled
Exception Sorter Class Name An org.jboss.jca.adapters.jdbc.ExceptionSorter that provides an isExceptionFatal(SQLException) method to validate if an exception should broadcast an error no exception-sorter-class-name
Exception Sorter Properties The exception sorter properties no exception-sorter-properties
Flush Strategy Specifies how the pool should be flush in case of an error. no flush-strategy
Idle Timeout Minutes The idle-timeout-minutes elements specifies the maximum time, in minutes, a connection may be idle before being closed. The actual maximum time depends also on the IdleRemover scan time, which is half of the smallest idle-timeout-minutes value of any pool. Changing this value can be done only on disabled datasource, requires a server restart otherwise. no idle-timeout-minutes
Interleaving An element to enable interleaving for XA connections. The default value is false. no interleaving
Jndi Name Specifies the JNDI name for the datasource yes jndi-name
Jta Enable JTA integration. The default value is true. no jta
Max Pool Size The max-pool-size element specifies the maximum number of connections for a pool. No more connections will be created in each sub-pool. The default value is 20. no max-pool-size
Min Pool Size The min-pool-size element specifies the minimum number of connections for a pool. The default value is 0. no min-pool-size
New Connection Sql Specifies an SQL statement to execute whenever a connection is added to the connection pool no new-connection-sql
No Recovery Specifies if the connection pool should be excluded from recovery no no-recovery
No Tx Separate Pool Oracle does not like XA connections getting used both inside and outside a JTA transaction. To workaround the problem you can create separate sub-pools for the different contexts. The default value is false. no no-tx-separate-pool
Pad Xid Should the Xid be padded. The default value is false. no pad-xid
Password Specifies the password used when creating a new connection no password
Pool Prefill Should the pool be prefilled. Changing this value can be done only on disabled datasource, requires a server restart otherwise. The default value is false. no pool-prefill
Pool Use Strict Min Specifies if the min-pool-size should be considered strictly. The default value is false. no pool-use-strict-min
Prepared Statements Cache Size The number of prepared statements per connection in an LRU cache no prepared-statements-cache-size
Query Timeout Any configured query timeout in seconds. If not provided no timeout will be set no query-timeout
Reauth Plugin Class Name The fully qualified class name of the reauthentication plugin implementation no reauth-plugin-class-name
Reauth Plugin Properties The properties for the reauthentication plugin no reauth-plugin-properties
Recovery Password The password used for recovery no recovery-password
Recovery Plugin Class Name The fully qualified class name of the recovery plugin implementation no recovery-plugin-class-name
Recovery Plugin Properties The properties for the recovery plugin no recovery-plugin-properties
Recovery Security Domain The security domain used for recovery no recovery-security-domain
Recovery Username The user name used for recovery no recovery-username
Same Rm Override The is-same-rm-override element allows one to unconditionally set whether the javax.transaction.xa.XAResource.isSameRM(XAResource) returns true or false no same-rm-override
Security Domain Specifies the security domain which defines the javax.security.auth.Subject that are used to distinguish connections in the pool no security-domain
Set Tx Query Timeout Whether to set the query timeout based on the time remaining until transaction timeout. Any configured query timeout will be used if there is no transaction. The default value is false. no set-tx-query-timeout
Share Prepared Statements Whether to share prepared statements, i.e. whether asking for same statement twice without closing uses the same underlying prepared statement. The default value is false. no share-prepared-statements
Spy Enable spying of SQL statements. The default value is false. no spy
Stale Connection Checker Class Name An org.jboss.jca.adapters.jdbc.StaleConnectionChecker that provides an isStaleConnection(SQLException) method which if it returns true will wrap the exception in an org.jboss.jca.adapters.jdbc.StaleConnectionException no stale-connection-checker-class-name
Stale Connection Checker Properties The stale connection checker properties no stale-connection-checker-properties
Track Statements Whether to check for unclosed statements when a connection is returned to the pool, result sets are closed, a statement is closed or return to the prepared statement cache. Valid values are: 'false' - do not track statements, 'true' - track statements and result sets and warn when they are not closed, 'nowarn' - track statements but do not warn about them being unclosed. The default value is 'NOWARN'. no track-statements
Transaction Isolation Set the java.sql.Connection transaction isolation level. Valid values are: TRANSACTION_READ_UNCOMMITTED, TRANSACTION_READ_COMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE and TRANSACTION_NONE no transaction-isolation
Url Delimiter Specifies the delimeter for URLs in connection-url for HA datasources no url-delimiter
Url Selector Strategy Class Name A class that implements org.jboss.jca.adapters.jdbc.URLSelectorStrategy no url-selector-strategy-class-name
Use Ccm Enable the use of a cached connection manager. The default value is true. no use-ccm
Use Fast Fail Whether to fail a connection allocation on the first try if it is invalid (true) or keep trying until the pool is exhausted of all potential connections (false). The default value is false. no use-fast-fail
Use Java Context Setting this to false will bind the datasource into global JNDI. The default value is true. no use-java-context
Use Try Lock Any configured timeout for internal locks on the resource adapter objects in seconds no use-try-lock
User Name Specify the user name used when creating a new connection no user-name
Valid Connection Checker Class Name An org.jboss.jca.adapters.jdbc.ValidConnectionChecker that provides an isValidConnection(Connection) method to validate a connection. If an exception is returned that means the connection is invalid. This overrides the check-valid-connection-sql element no valid-connection-checker-class-name
Valid Connection Checker Properties The valid connection checker properties no valid-connection-checker-properties
Validate On Match The validate-on-match element specifies if connection validation should be done when a connection factory attempts to match a managed connection. This is typically exclusive to the use of background validation. The default value is false. no validate-on-match
Wrap Xa Resource Should the XAResource instances be wrapped in a org.jboss.tm.XAResourceWrapper instance. The default value is true. no wrap-xa-resource
Xa Datasource Class The fully qualifed name of the javax.sql.XADataSource implementation no xa-datasource-class
Xa Resource Timeout The value is passed to XAResource.setTransactionTimeout(), in seconds. Default is zero no xa-resource-timeout

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.502. Metrics
Name Description
Subsystem:flush All Connection In Pool Flushes all connections in the pool
Subsystem:flush Idle Connection In Pool Flushes all idle connections in the pool
Subsystem:test Connection In Pool Test if a connection can be obtained
Package Types
none
Red Hat logoGithubRedditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

© 2024 Red Hat, Inc.