Internal Name: |
Local Tx Datasource |
Description: |
Local Transaction Datasources deployed in the instance of JBoss AS |
Singleton: |
no |
Plugin: |
JBossAS5 |
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 |
yes |
componentNameProperty |
You must use the internal name to reference properties in Dynamic Group Definition expressions.
Name |
Type |
Description |
Internal Name |
Run State |
trait |
Run State |
runState |
Connection Available? |
trait |
could a connection to the underlying data provider be obtained? |
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 |
You must use the internal name to reference traits in Dynamic Group Definition expressions.
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 |
JDBC Driver Class |
The fully qualified name of the JDBC driver class (e.g. "oracle.jdbc.driver.OracleDriver"). |
yes |
driver-class |
Connection URL |
The JDBC URL for the database (e.g. "jdbc:oracle:thin:@host.example.com:1521:db"). To define a high |
yes |
connection-url |
Connection Properties |
Arbitrary connection properties that should be passed to the java.sql.Driver.connect(url, props) method. |
no |
connection-properties |
Allocation Retry |
The number of times that allocating a connection should be tried before throwing an exception. The default |
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 |
no |
background-validation |
Background Validation Millis |
The interval, in milliseconds, at which the ConnectionValidator will run. Set to 0 to disable background |
no |
background-validation-millis |
Blocking Timeout in Milliseconds |
Indicates the maximum time in milliseconds to block while waiting for a connection before throwing |
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 |
no |
no-tx-separate-pools |
Prefill |
Whether to attempt to prefill the connection pool to the minimum number of connections. NOTE: Only |
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 |
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. |
no |
type-mapping |
Use Java Context |
Indicates whether the JNDI name should be bound under the "java" context, |
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 |
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, |
no |
connection-definition |
Exception Sorter Class Name |
The fully qualified name of a Java class implementing the org.jboss.resource.adapter.jdbc.ExceptionSorter |
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 |
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 |
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 |
no |
rar-name |
Set Tx Query Timeout |
Whether to set the query timeout based on the time remaining until transaction timeout; |
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 |
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. |
no |
url-delimiter |
Url Selector Strategy Class Name |
The fully qualified class name of a Java class implementing the |
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 |
no |
use-try-lock |
Valid Connection Checker Class Name |
The fully qualified name of a Java class implementing the |
no |
valid-connection-checker-class-name |
You must use the internal name to reference properties in Dynamic Group Definition expressions.
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 |