Red Hat Training

A Red Hat training course is available for Red Hat JBoss Operations Network

3.4.5.11.2. JBoss AS 7 and EAP 6 - XADataSource (Profile) Service

Overview

Table 3.1785. Overview

Description: An XA data source
Singleton: no
Plugin: JBossAS7
Child Resource Types
none
Connection Properties

Table 3.1786. 

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.1787. 

Name Description Required Internal Name
Properties no *2
Xa Datasource Class The fully qualified name of the javax.sql.XADataSource implementation yes xa-datasource-class
Jndi Name Specifies the JNDI name for the datasource yes jndi-name
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
User Name Specify the username used when creating a new connection. no user-name
Password Specify the password used when creating a new connection. no password
New Connection Sql Specifies an SQL statement to execute whenever a connection is added to the connection pool. no new-connection-sql
Url Delimiter Specifies the delimiter 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 Java Context Setting this to false will bind the DataSource into global JNDI; no use-java-context
Enabled Specifies if the datasource should be enabled no enabled
Max Pool Size The max-pool-size element indicates the maximum number of connections for a pool. No more connections will be created in each sub-pool. no max-pool-size
Min Pool Size The min-pool-size element indicates the minimum number of connections a pool should hold. These are not created until a Subject is known from a request for a connection. no min-pool-size
Pool Prefill Whether to attempt to prefill the connection pool. Changing this value require a server restart. no pool-prefill
Pool Use Strict Min Define if the min-pool-size should be considered a strictly. no pool-use-strict-min
Interleaving An element to enable interleaving for XA connection factories no interleaving
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 context no no-tx-separate-pool
Pad Xid Should the Xid be padded no pad-xid
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
Wrap Xa Datasource Should the XAResource instances be wrapped in a org.jboss.tm.XAResourceWrapper instance no wrap-xa-datasource
Security Domain Indicates Subject (from security domain) are used to distinguish connections in the pool. The content of the security-domain is the name of the JAAS security manager that will handleauthentication. This name correlates to the JAAS login-config.xml descriptor application-policy/name attribute. no security-domain
Recovery Plugin Class Name recovery plugin implementation provided for specific purpose (i.e vendor) no recovery-plugin-class-name
Reauth Plugin Class Name re-authentication plugin implementation provided for specific purpose (i.e vendor) no reauth-plugin-class-name
Flush Strategy Specifies how the pool should be flush in case of an error. no flush-strategy
Prepared Statements Cache Size The number of prepared statements per connection in an LRU cache no prepared-statements-cacheSize
Share Prepared Statements Whether to share prepare statements, i.e. whether asking for same statement twice without closing uses the same underlying prepared statement no share-prepared-statements
Track Statements Whether to check for unclosed statements when a connection is returned to the pool and result sets are closed when a statement is closed/return to the prepared statement cache. valid values are: false - do not track statements and results true - track statements and result sets and warn when they are not closed nowarn - track statements but do no warn about them being unclosed no track-statements
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 he allocation retry wait millis element indicates the time in milliseconds to wait between retrying to allocate a connection. no allocation-retry-wait-millis
Blocking Timeout Wait Millis The blocking-timeout-millis element indicates the maximum time in milliseconds to block while waiting for a connection before throwing an exception. Note that this blocks only while waiting for a permit for a connection, and will never throw an exception if creating a new connection takes an inordinately long time. no blocking-timeout-wait-millis
Idle Timeout Minutes The idle-timeout-minutes elements indicates 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 1/2 the smallest idle-timeout-minutes of any pool. Changing this value require a server restart. no idle-timeout-minutes
Query Timeout Any configured query timeout in seconds The default is no timeout no query-timeout
Use Try Lock Any configured timeout for internal locks on the resource adapter objects in seconds no use-try-lock
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. no set-tx-query-timeout
Transaction Isolation Set java.sql.Connection transaction isolation level to use. The constants defined by transaction-isolation-values are the possible transaction isolation levels. no transaction-isolation
Check Valid Connection Sql Specify an SQL statement to check validity of a pool connection. This may be called when managed connection is taken from pool for use. no check-valid-connection-sql
Exception Sorter Class Name An org.jboss.jca.adapters.jdbc.ExceptionSorter that provides a boolean isExceptionFatal(SQLException e) method to validate is an exception should be broadcast to all javax.resource.spi.ConnectionEventListener as a connectionErrorOccurred no exception-sorter-class-name
Stale Connection Checker Class Name An org.jboss.jca.adapters.jdbc.StaleConnectionChecker that provides a boolean isStaleConnection(SQLException e) method which if it it returns true will wrap the exception in an org.jboss.jca.adapters.jdbc.StaleConnectionException no stale-connection-checker-class-name
Valid Connection Checker Class Name An org.jboss.jca.adapters.jdbc.ValidConnectionChecker that provides a SQLException isValidConnection(Connection e) method to validate is a connection is valid. An exception means the connection is destroyed. This overrides the check-valid-connection-sql when present. no valid-connection-checker-class-name
Background Validation Minutes The background-validation-minutes element specifies the amount of time, in minutes, that background validation will run. Changing this value require a server restart. no background-validation-minutes
Background Validation An element to specify that connections should be validated on a background thread versus being validated prior to use. Changing this value require a server restart. no background-validation
Use Fast Fail Whether fail a connection allocation on the first connection if it is invalid (true) or keep trying until the pool is exhausted of all potential connections (false) no use-fast-fail
Validate On Match The validate-on-match element indicates whether or not connection level validation should be done when a connection factory attempts to match a managed connection for a given set. This is typically exclusive to the use of background validation no validate-on-match
Xa Resource Timeout Passed to XAResource.setTransactionTimeout() Default is zero which does not invoke the setter. In seconds no xa-resource-timeout
Spy whatever spy or not the jdbc connection no spy
Use Ccm Enable the use of a cached connection manager no use-ccm
Recovery Username username used to try connection recovery no recovery-username
Recovery Password password used to try connection recovery no recovery-password
Recovery Security Domain security-domain used to try connection recovery no recovery-security-domain
No Recovery if true no recovery are tried for this connection pool no no-recovery

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations

Table 3.1788. Metrics

Name Description
Enable Enables the data-source
Disable Disables the data-source
Package Types
none