Red Hat Summit Red Hat SummitSupportConsoleDevelopersStart a trialContact

3.2.6. JBossAS5 - Tx ConnectionFactory Service

Overview

Expand
Table 3.121. Overview
Description:A ConnectionFactory that takes part in JTA transactions.
Singleton: no
Plugin:JBossAS5

Child Resource Types

none

Connection Properties

Expand
Table 3.122. 
NameDescriptionRequiredInternal Name
Custom PropertiesMaps 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 PropertyThe 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

Expand
Table 3.123. Metrics
NameTypeDescriptionInternal Name
Transaction TypetraitThe type of transactions used by this connection factory - Local or XAcustom.transactionType
Run StatetraitRun StaterunState
Connection Available?traitcould a connection to the underlying data provider be obtained? Please see the documentation before enabling this metriccustom.connectionAvailable
Pool JNDI NametraitPool JNDI NamepoolJndiName
Available Connection CountmeasurementNumber of available connections.availableConnectionCount
Connection CountmeasurementConnection CountconnectionCount
Connection Created CountmeasurementConnection Created CountconnectionCreatedCount
Connection Destroyed CountmeasurementConnection Destroyed CountconnectionDestroyedCount
In Use Connection CountmeasurementMumber of connections currently in use.inUseConnectionCount
Max Connections In Use CountmeasurementMaximum number of maximum connections that have been in use.maxConnectionsInUseCount
Max SizemeasurementMax SizemaxSize
Min SizemeasurementMin SizeminSize

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

Expand
Table 3.124. 
NameDescriptionRequiredInternal Name
JNDI NameThe global JNDI name to bind the connection factory under. yes jndi-name
RAR NameThe 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 DefinitionThe connection factory interface class. It should match the connectionfactory-interface in the ra.xml file. yes connection-definition
Minimum Pool SizeThe minimum number of connections the pool should hold. The default is 0. no min-pool-size
Maximum Pool SizeThe maximum number of connections the pool should hold. The default is 10. no max-pool-size
XA TransactionWhether on not to use XA transactions. The default is No. no xa-transaction
Allocation RetryThe number of times that allocating a connection should be tried before throwing an exception. The default is 0. no allocation-retry
Allocation Retry Wait MillisThe time in milliseconds to wait between retrying to allocate a connection. The default is 5000 (5 seconds). no allocation-retry-wait-millis
Background ValidationSpecify 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 MillisThe 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 MillisecondsIndicates 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 TimeoutThe maximum time, in minutes, a connection may be idle before being closed. The default is 30. no idle-timeout-minutes
Is Same RM Override ValueIf set, unconditionally sets the boolean return value of javax.transaction.xa.XAResource.isSameRM(XAResource). no isSameRM-override-value
Jmx Invoker NameThe ObjectName of the JMX Invoker MBean associated with this datasource. no jmx-invoker-name
MetadataMetadata properties. no metadata
No Tx Separate PoolsIf 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
PrefillWhether 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 SettingsSecurity settings for connections in the pool. no security-domain
Statistics FormatterThe 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 MappingThe 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 ContextIndicates 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 MinWhether idle connections below the min-pool-size should be closed. The default is No. no use-strict-min
Validate On MatchThe 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 PropertyProperties to supply to the ManagedConnectionFactory (MCF) MBean service configuration. no config-property
InterleavingIf 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 TimeoutThe 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

Expand
Table 3.125. Metrics
NameDescription
FlushFlush the connections in the pool
List Formatted Sub Pool StatisticsObtain a formatted sub pool statistics report
List StatisticsObtain a statistics report
Test ConnectionTest 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
Back to top
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. Explore our recent updates.

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.

Theme

© 2025 Red Hat