22.5. Resource Adapter Descriptor Reference

The following tables describe the resource adapter descriptor elements.

Expand

Table 22.7. Main elements
Element	Description
`bean-validation-groups`	Specifies bean validation group that should be used
`bootstrap-context`	Specifies the unique name of the bootstrap context that should be used
`config-property`	The config-property specifies resource adapter configuration properties.
`transaction-support`	Define the type of transaction supported by this resource adapter. Valid values are: `NoTransaction`, `LocalTransaction`, `XATransaction`
`connection-definitions`	Specifies the connection definitions
`admin-objects`	Specifies the administration objects

Expand

Table 22.8. Bean validation groups elements
Element	Description
`bean-validation-group`	Specifies the fully qualified class name for a bean validation group that should be used for validation

Expand

Table 22.9. Connection definition / admin object attributes
Attribute	Description
`class-name`	Specifies the fully qualified class name of a managed connection factory or admin object
`jndi-name`	Specifies the JNDI name
`enabled`	Should the object be activated
`use-java-context`	Specifies if a `java:/` JNDI context should be used
`pool-name`	Specifies the pool name for the object
`use-ccm`	Enable the cached connection manager

Expand

Table 22.10. Connection definition elements
Element	Description
`config-property`	The config-property specifies managed connection factory configuration properties.
`pool`	Specifies pooling settings
`xa-pool`	Specifies XA pooling settings
`security`	Specifies security settings
`timeout`	Specifies time out settings
`validation`	Specifies validation settings
`recovery`	Specifies the XA recovery settings

Expand

Table 22.11. Pool elements
Element	Description
`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. This default to 0
`max-pool-size`	The max-pool-size element indicates the maximum number of connections for a pool. No more than max-pool-size connections will be created in each sub-pool. This defaults to `20`.
`prefill`	Whether to attempt to prefill the connection pool. Default is `false`
`use-strict-min`	Specifies if the min-pool-size should be considered strictly. Default `false`
`flush-strategy`	Specifies how the pool should be flush in case of an error. Valid values are: `FailingConnectionOnly` (default), `IdleConnections`, `EntirePool`

Expand

Table 22.12. XA pool elements
Element	Description
`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. This default to `0`
`max-pool-size`	The max-pool-size element indicates the maximum number of connections for a pool. No more than max-pool-size connections will be created in each sub-pool. This defaults to `20`.
`prefill`	Whether to attempt to prefill the connection pool. Default is `false`
`use-strict-min`	Specifies if the min-pool-size should be considered strictly. Default `false`
`flush-strategy`	Specifies how the pool should be flush in case of an error. Valid values are: `FailingConnectionOnly` (default), `IdleConnections`, `EntirePool`
`is-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`
`interleaving`	An element to enable interleaving for XA connection factories
`no-tx-separate-pools`	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 contexts
`pad-xid`	Should the Xid be padded
`wrap-xa-resource`	Should the XAResource instances be wrapped in a org.jboss.tm.XAResourceWrapper instance

Expand

Table 22.13. Security elements
Element	Description
`application`	Indicates that application supplied parameters (such as from `getConnection(user, pw)`) are used to distinguish connections in the pool.
`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 handle authentication. This name correlates to the JAAS `login-config.xml` descriptor application-policy/name attribute.
`security-domain-and-application`	Indicates that either application supplied parameters (such as from `getConnection(user, pw)`) or 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 handle authentication. This name correlates to the JAAS `login-config.xml` descriptor application-policy/name attribute.

Expand

Table 22.14. Time out elements
Element	Description
`blocking-timeout-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. The default is `30000` (30 seconds).
`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.
`allocation-retry`	The allocation retry element indicates the number of times that allocating a connection should be tried before throwing an exception. The default is `0`.
`allocation-retry-wait-millis`	The allocation retry wait millis element indicates the time in milliseconds to wait between retrying to allocate a connection. The default is `5000` (5 seconds).
`xa-resource-timeout`	Passed to `XAResource.setTransactionTimeout()`. Default is zero which does not invoke the setter. Specified in seconds

Expand

Table 22.15. Validation elements
Element	Description
`background-validation`	An element to specify that connections should be validated on a background thread versus being validated prior to use
`background-validation-minutes`	The background-validation-minutes element specifies the amount of time, in minutes, that background validation will run.
`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). Default is `false`

Expand

Table 22.16. Admin object elements
Element	Description
`config-property`	Specifies an administration object configuration property.

Expand

Table 22.17. Recovery elements
Element	Description
`recover-credential`	Specifies the user name / password pair or security domain that should be used for recovery.
`recover-plugin`	Specifies an implementation of the org.jboss.jca.core.spi.recovery.RecoveryPlugin class.

The deployment schemas are defined in jboss-as-resource-adapters_1_0.xsd and http://www.ironjacamar.org/doc/schema/ironjacamar_1_0.xsd for automatic activation.

返回顶部