このコンテンツは選択した言語では利用できません。
3.2.4. JBossAS5 - XA Datasource Service
Overview
Description: | XA Datasources deployed in the instance of JBoss AS |
Singleton: | no |
Plugin: | JBossAS5 |
Child Resource Types
none
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Component Type | yes | componentType | |
Component Subtype | yes | componentSubtype | |
Component Name | yes | componentName | |
Template Name | yes | templateName | |
Component Name Property | The name of the Resource configuration property whose value should be used as the underlying ManagedComponent name when creating a new Resource of this type. | yes | componentNameProperty |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Name | Type | Description | Internal Name |
---|---|---|---|
Run State | trait | Run State | runState |
Connection Available? | trait | could a connection to the underlying data provider be obtained? Please see the documentation before enabling this metric. | custom.connectionAvailable |
Pool JNDI Name | trait | the JNDI name of the connection pool for this datasource | poolJndiName |
Available Connection Count | measurement | the maximum number of connections that are available | availableConnectionCount |
Connection Count | measurement | the number of connections that are currently in the pool | connectionCount |
Connection Created Count | measurement | the number of connections that have been created since the datasource was last started | connectionCreatedCount |
Connection Destroyed Count | measurement | the number of connections that have been destroyed since the datasource was last started | connectionDestroyedCount |
In Use Connection Count | measurement | the number of connections that are currently in use | inUseConnectionCount |
Local Transaction | trait | Local Transaction | local-transaction |
Max Connections In Use Count | measurement | the most connections that have been simultaneously in use since this datasource was started | maxConnectionsInUseCount |
Max Size | measurement | Max Size | maxSize |
Min Size | measurement | Min Size | minSize |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
JNDI Name | The global JNDI Name under which to bind the datasource | yes | jndi-name |
Username | The default username when creating a new connection. | no | user-name |
Password | The default password when creating a new connection. | no | password |
Minimum Pool Size | The minimum number of connections the pool should hold. The default is 0. | no | min-pool-size |
Maximum Pool Size | The maximum number of connections the pool should hold. The default is 10. | no | max-pool-size |
XA DataSource Class | The fully qualified name of the javax.sql.XADataSource implementation class. | yes | xa-datasource-class |
XA Datasource Properties | The properties to assign to the XADataSource implementation class. Each property is mapped onto the XADataSource implementation by looking for a JavaBeans style getter method for the property name. If found, the value of the property is set using the JavaBeans setter with the element text translated to the true property type using the java.beans.PropertyEditor for the type. | no | xa-datasource-properties |
XA Resource Timeout | XA transaction timeout, in seconds (passed to XAResource.setTransactionTimeout()) - default is zero which does not invoke the setter. | no | xa-resource-timeout |
URL Property | For HA XA datasources, specifies the name of an XADataSource property that contains a list of URLs. | no | url-property |
Allocation Retry | The number of times that allocating a connection should be tried before throwing an exception. The default is 0. | no | allocation-retry |
Allocation Retry Wait Millis | The time in milliseconds to wait between retrying to allocate a connection. The default is 5000 (5 seconds). | no | allocation-retry-wait-millis |
Background Validation | Specify if connections should be validated on a background thread versus being validated prior to use. Background validation is meant to reduce the overall load on the RDBMS system when validating a connection. The default is No. | no | background-validation |
Background Validation Millis | The interval, in milliseconds, at which the ConnectionValidator will run. Set to 0 to disable background validation. The default is 0. | no | background-validation-millis |
Blocking Timeout in Milliseconds | 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. The default is 30000 (30 seconds). | no | blocking-timeout-millis |
Idle Timeout | The maximum time, in minutes, a connection may be idle before being closed. The default is 30. | no | idle-timeout-minutes |
Is Same RM Override Value | If set, unconditionally sets the boolean return value of javax.transaction.xa.XAResource.isSameRM(XAResource). | no | isSameRM-override-value |
Jmx Invoker Name | The ObjectName of the JMX Invoker MBean associated with this datasource. | no | jmx-invoker-name |
Metadata | Metadata properties. | no | metadata |
No Tx Separate Pools | If true, the datasource cannot reuse a connection outside a transaction once enlisted in a global transaction and vice-versa. The default is Yes. | no | no-tx-separate-pools |
Prefill | Whether to attempt to prefill the connection pool to the minimum number of connections. NOTE: Only supporting pools (OnePool) support this feature. A warning can be found in the logs if the pool does not support this. The default is No. | no | prefill |
Security Settings | Security settings for connections in the pool. | no | security-domain |
Statistics Formatter | The fully qualified class name of the class to use for formatting managed connection pool statistics for this datasource. The class must implement the org.jboss.resource.statistic.formatter.StatisticsFormatter. interface. The default is "org.jboss.resource.statistic.pool.JBossDefaultSubPoolStatisticFormatter". | no | statistics-formatter |
Type Mapping | The name of the corresponding type-mapping in conf/standardjbosscmp-jdbc.xml. The type mappings provided by default: DB2, InformixDB, MaxDB, mySQL, Oracle9i, PointBase, InterBase, Mimer SQL, McKoi, SapDB, DB2/400, SOLID, Hypersonic SQL, FirstSQL/J, MS SQLSERVER2000, MS SQLSERVER, Cloudscape, Derby, Firebird, PostgreSQL 8.0, PostgreSQL, Sybase, Ingres. Note, there may be custom type mappings defined in addition to these predefined mappings. | no | type-mapping |
Use Java Context | Indicates whether the JNDI name should be bound under the "java" context, which causes the DataSource to only be accessible from within the JBossAS VM. The default is Yes. | no | use-java-context |
Use Strict Min | Whether idle connections below the min-pool-size should be closed. The default is No. | no | use-strict-min |
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. The default is Yes. | no | validate-on-match |
Check Valid Connection SQL | The SQL statement to use to check the validity of a pool connection. | no | check-valid-connection-sql |
Connection Definition | The connection definition inside the RAR deployment uniquely identified by the connection factory interface, e.g. "javax.sql.DataSource". | no | connection-definition |
Exception Sorter Class Name | The fully qualified name of a Java class implementing the org.jboss.resource.adapter.jdbc.ExceptionSorter interface that should be used to check if a JDBC exception should be broadcast. | no | exception-sorter-class-name |
New Connection SQL | An SQL statement to execute whenever a new connection is added to the pool; this can be used to set the connection schema, etc. | no | new-connection-sql |
Prepared Statement Cache Size | The number of prepared statements per connection to be kept open and reused in subsequent requests. They are stored in an LRU cache. Set to 0 to disable the cache. The default is 0. | no | prepared-statement-cache-size |
Query Timeout | Any configured query timeout in seconds. A value of 0 means no timeout. The default is 0. | no | query-timeout |
Rar Name | The RAR deployment to associate with the connection manager MBean. e.g. jms-ra.rar or myapplication.ear#my.rar for nested rars. | no | rar-name |
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 is No. | no | set-tx-query-timeout |
Share Prepared Statements | Should prepared statements be shared? The default is No. | no | share-prepared-statements |
Stale Connection Checker Class Name | Fully qualified name of the Java class used to check if a connection has become stale. | no | stale-connection-checker-class-name |
Track Statements | Whether to check for unclosed Statements and ResultSets when connections are returned to the pool. The default is "yes-no-warnings". | no | track-statements |
Transaction Isolation | The Transaction Isolation level. The default setting is to use whichever isolation level is provided by default by the database. | no | transaction-isolation |
Url Delimiter | Specifies the delimiter for URLs in the value of the connection-url property for HA datasources. The default is "|". | no | url-delimiter |
Url Selector Strategy Class Name | The fully qualified class name of a Java class implementing the org.jboss.resource.adapter.jdbc.URLSelectorStrategy interface. | no | url-selector-strategy-class-name |
Use Try Lock | Any configured timeout, in milliseconds, for internal locks on the resource adapter objects. A value of 0 means no timeout. The default is 0. | no | use-try-lock |
Valid Connection Checker Class Name | The fully qualified name of a Java class implementing the org.jboss.resource.adapter.jdbc.ValidConnectionChecker whose pingDatabase method should be used to check if a connection is still valid before handing it out from the pool. | no | valid-connection-checker-class-name |
Interleaving | If true, enable transaction interleaving if the DB vendor supports it (most do not). This property supersedes the "track-connection-by-tx" property from earlier versions of JBoss AS. The default is false. | no | interleaving |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Name | Description |
---|---|
Flush | Flush the connections in the pool |
List Formatted Sub Pool Statistics | Obtain a formatted sub pool statistics report |
List Statistics | Obtain a statistics report |
Test Connection | Test if a connection can be obtained - returns true if a connection was obtained, or false if not; NOTE: this operation will always return a status of Successful - the results of the operation must be inspected to see whether or not a connection was obtained |
Package Types
none