Red Hat Training

A Red Hat training course is available for Red Hat JBoss Operations Network

3.3.25. JBoss AS 7 and EAP 6 - Resource Adapters Service

Overview

Table 3.741. Overview

Description:Configuration of the resource adapters subsystem.
Singleton: yes
Plugin:JBossAS7

Child Resource Types

Connection Properties

Table 3.742. 

NameDescriptionRequiredInternal Name
Path  yes path

Note

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

Metrics

none

Configuration Properties

none

Operations

none

Package Types

none

3.3.25.1. JBoss AS 7 and EAP 6 - Resource Adapter Service

Overview

Table 3.743. Overview

Description:The configuration of a resource adapter.
Singleton: no
Plugin:JBossAS7
Child Resource Types
Connection Properties

Table 3.744. 

NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties

Table 3.745. 

NameDescriptionRequiredInternal Name
ArchiveSpecifies the resource adapter archive yes archive
BeanvalidationgroupsSpecifies the bean validation groups that should be used no beanvalidationgroups
BootstrapcontextSpecifies the unique name of the bootstrap context that should be used no bootstrapcontext
Transaction SupportSpecifies the transaction support level of the resource adapter yes transaction-support

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.25.1.1. JBoss AS 7 and EAP 6 - Admin Objects Service
Overview

Table 3.746. Overview

Description:Specifies the administration objects.
Singleton: no
Plugin:JBossAS7
Child Resource Types
none
Connection Properties

Table 3.747. 

NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties

Table 3.748. 

NameDescriptionRequiredInternal Name
Class NameSpecifies the fully qualified class name of a managed connection factory or admin object yes class-name
EnabledSpecifies if the resource adapter should be enabled. The default value is true. no enabled
Jndi NameSpecifies the JNDI name for the connection factory or admin object no jndi-name
Use Java ContextSetting this to false will bind the object into global JNDI. The default value is true. no use-java-context

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.25.1.2. JBoss AS 7 and EAP 6 - Connection Definitions Service
Overview

Table 3.749. Overview

Description:Specifies the connection definitions.
Singleton: no
Plugin:JBossAS7
Child Resource Types
Connection Properties

Table 3.750. 

NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties

Table 3.751. 

NameDescriptionRequiredInternal Name
Allocation RetryThe allocation retry element indicates the number of times that allocating a connection should be tried before throwing an exception no allocation-retry:expr
Allocation Retry Wait MillisThe allocation retry wait millis element specifies the amount of time, in milliseconds, to wait between retrying to allocate a connection no allocation-retry-wait-millis:expr
Background ValidationAn element to specify that connections should be validated on a background thread versus being validated prior to use. Changing this value requires a server restart. The default value is false. no background-validation
Background Validation MillisThe background-validation-millis element specifies the amount of time, in milliseconds, that background validation will run. Changing this value requires a server restart no background-validation-millis:expr
Blocking Timeout Wait MillisThe blocking-timeout-millis element specifies the maximum time, in milliseconds, to block while waiting for a connection before throwing an exception. Note that this blocks only while waiting for locking a connection, and will never throw an exception if creating a new connection takes an inordinately long time no blocking-timeout-wait-millis:expr
Class NameSpecifies the fully qualified class name of a managed connection factory or admin object yes class-name
EnabledSpecifies if the resource adapter should be enabled. The default value is true. no enabled
Flush StrategySpecifies how the pool should be flush in case of an error. no flush-strategy
Idle Timeout MinutesThe idle-timeout-minutes elements specifies 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 half of the smallest idle-timeout-minutes value of any pool. Changing this value requires a server restart. no idle-timeout-minutes:expr
InterleavingAn element to enable interleaving for XA connections. The default value is false. no interleaving
Jndi NameSpecifies the JNDI name for the connection factory or admin object no jndi-name
Max Pool SizeThe max-pool-size element specifies the maximum number of connections for a pool. No more connections will be created in each sub-pool. The default value is 20. no max-pool-size:expr
Min Pool SizeThe min-pool-size element specifies the minimum number of connections for a pool. The default value is 0. no min-pool-size:expr
No RecoverySpecifies if the connection pool should be excluded from recovery no no-recovery
No Tx Separate PoolOracle 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. The default value is false. no no-tx-separate-pool
Pad XidShould the Xid be padded. The default value is false. no pad-xid
Pool PrefillShould the pool be prefilled. Changing this value requires a server restart. The default value is false. no pool-prefill
Pool Use Strict MinSpecifies if the min-pool-size should be considered strictly. The default value is false. no pool-use-strict-min
Recovery PasswordThe password used for recovery no recovery-password
Recovery Plugin Class NameThe fully qualified class name of the recovery plugin implementation no recovery-plugin-class-name
Recovery Plugin PropertiesThe properties for the recovery plugin no recovery-plugin-properties
Recovery Security DomainThe security domain used for recovery no recovery-security-domain
Recovery UsernameThe user name used for recovery no recovery-username
Same Rm OverrideThe is-same-rm-override element allows one to unconditionally set whether the javax.transaction.xa.XAResource.isSameRM(XAResource) returns true or false no same-rm-override
Security ApplicationIndicates that app supplied parameters (such as from getConnection(user, pw)) are used to distinguish connections in the pool no security-application
Security DomainSpecifies the security domain which defines the javax.security.auth.Subject that are used to distinguish connections in the pool no security-domain
Security Domain and ApplicationIndicates that either app supplied parameters (such as from getConnection(user, pw)) or Subject (from security domain) are used to distinguish connections in the pool no security-domain-and-application
Use CcmEnable the use of a cached connection manager. The default value is true. no use-ccm
Use Fast FailWhether to fail a connection allocation on the first try if it is invalid (true) or keep trying until the pool is exhausted of all potential connections (false). The default value is false. no use-fast-fail
Use Java ContextSetting this to false will bind the object into global JNDI. The default value is true. no use-java-context
Use Try LockAny configured timeout for internal locks on the resource adapter objects in seconds no use-try-lock:expr
Wrap Xa ResourceShould the XAResource instances be wrapped in a org.jboss.tm.XAResourceWrapper instance. The default value is true. no wrap-xa-resource
XA Resource TimeoutThe value is passed to XAResource.setTransactionTimeout(), in seconds. Default is zero no xa-resource-timeout:expr

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations

Table 3.752. Metrics

NameDescription
Flush All Connections in PoolFlushes all connections in the pool
Flush Idle Connections in PoolFlushes all idle connections in the pool
Test Connection in PoolTest if a connection can be obtained
Package Types
none
3.3.25.1.2.1. JBoss AS 7 and EAP 6 - Config Properties Service
Overview

Table 3.753. Overview

Description:Custom defined config properties.
Singleton: no
Plugin:JBossAS7
Child Resource Types
none
Connection Properties

Table 3.754. 

NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties

Table 3.755. 

NameDescriptionRequiredInternal Name
ValueCustom defined config property value no value

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.25.1.3. JBoss AS 7 and EAP 6 - Config Properties Service
Overview

Table 3.756. Overview

Description:Custom defined config properties.
Singleton: no
Plugin:JBossAS7
Child Resource Types
none
Connection Properties

Table 3.757. 

NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties

Table 3.758. 

NameDescriptionRequiredInternal Name
ValueCustom defined config property value no value

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none