このコンテンツは選択した言語では利用できません。
3.2.6. JBossAS5 - Tx ConnectionFactory Service
Overview
Description: | A ConnectionFactory that takes part in JTA transactions. |
Singleton: | no |
Plugin: | JBossAS5 |
Child Resource Types
none
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Custom Properties | Maps a list of custom property names to the the fully qualified class names of the org.rhq.plugins.jbossas5.adapter.api.PropertyAdapter implementations that should be used for those properties. | no | customProperties |
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 |
---|---|---|---|
Transaction Type | trait | The type of transactions used by this connection factory - Local or XA | custom.transactionType |
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 | Pool JNDI Name | poolJndiName |
Available Connection Count | measurement | Number of available connections. | availableConnectionCount |
Connection Count | measurement | Connection Count | connectionCount |
Connection Created Count | measurement | Connection Created Count | connectionCreatedCount |
Connection Destroyed Count | measurement | Connection Destroyed Count | connectionDestroyedCount |
In Use Connection Count | measurement | Mumber of connections currently in use. | inUseConnectionCount |
Max Connections In Use Count | measurement | Maximum number of maximum connections that have been in use. | 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 to bind the connection factory under. | yes | jndi-name |
RAR Name | The name of the RAR file that contains the definition for the resource we want to provide. For nested RAR files, the name would look like myapplication.ear#my.rar. | yes | rar-name |
Connection Definition | The connection factory interface class. It should match the connectionfactory-interface in the ra.xml file. | yes | connection-definition |
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 Transaction | Whether on not to use XA transactions. The default is No. | no | xa-transaction |
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 |
Config Property | Properties to supply to the ManagedConnectionFactory (MCF) MBean service configuration. | no | config-property |
Interleaving | If true, enable transaction interleaving if the DB vendor supports it (most do not). Can only be set to true if XA transactions are enabled. This property supersedes the "track-connection-by-tx" property from earlier versions of JBoss AS. The default is false. | no | interleaving |
XA Resource Timeout | The maximum time, in minutes, an XA Resource can be idle before it is removed. 0 means no timeout. The default is 0. | no | xa-resource-timeout |
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