JBoss EAP 6.1 Model Reference

  1. JBoss EAP 6.1
  2. subsystem=resource-adapters
  3. resource-adapter
  4. connection-definitions

Specifies a connection definition.

Children (1)

Attributes (33)

  • allocation-retry The allocation retry element indicates the number of times that allocating a connection should be tried before throwing an exception.
    • Attribute Value
    Type INT
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • allocation-retry-wait-millis The allocation retry wait millis element specifies the amount of time, in milliseconds, to wait between retrying to allocate a connection.
    • Attribute Value
    Type LONG
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • background-validation An 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.
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • background-validation-millis The background-validation-millis element specifies the amount of time, in milliseconds, that background validation will run. Changing this value requires a server restart.
    • Attribute Value
    Type LONG
    Nillable true
    Expressions Allowed true
    Min 1
    Max 2,147,483,647
    Unit MILLISECONDS
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • blocking-timeout-wait-millis The 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.
    • Attribute Value
    Type LONG
    Nillable true
    Expressions Allowed true
    Unit MILLISECONDS
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • class-name Specifies the fully qualified class name of a managed connection factory or admin object.
    • Attribute Value
    Type STRING
    Nillable false
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • enabled Specifies if the resource adapter should be enabled.
    • Attribute Value
    Default Value true
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • flush-strategy Specifies how the pool should be flush in case of an error. Valid values are: FailingConnectionOnly (default), IdleConnections and EntirePool.
    • Attribute Value
    Default Value FailingConnectionOnly
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
    Allowed Values UNKNOWN
    FailingConnectionOnly
    IdleConnections
    EntirePool
  • idle-timeout-minutes The 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..
    • Attribute Value
    Type LONG
    Nillable true
    Expressions Allowed true
    Unit MINUTES
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • interleaving An element to enable interleaving for XA connections.
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • jndi-name Specifies the JNDI name for the connection factory.
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • max-pool-size The max-pool-size element specifies the maximum number of connections for a pool. No more connections will be created in each sub-pool.
    • Attribute Value
    Default Value 20
    Type INT
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • min-pool-size The min-pool-size element specifies the minimum number of connections for a pool.
    • Attribute Value
    Default Value 0
    Type INT
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • no-recovery Specifies if the connection pool should be excluded from recovery.
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • no-tx-separate-pool 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.
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • pad-xid Should the Xid be padded.
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • pool-prefill Should the pool be prefilled. Changing this value requires a server restart.
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • pool-use-strict-min Specifies if the min-pool-size should be considered strictly.
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • recovery-password The password used for recovery.
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • recovery-plugin-class-name The fully qualified class name of the recovery plugin implementation.
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • recovery-plugin-properties The properties for the recovery plugin.
    • Attribute Value
    Type OBJECT
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • recovery-security-domain The security domain used for recovery.
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • recovery-username The user name used for recovery.
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • 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.
    • Attribute Value
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • security-application Indicates that app supplied parameters (such as from getConnection(user, pw)) are used to distinguish connections in the pool.
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • security-domain Specifies the security domain which defines the javax.security.auth.Subject that are used to distinguish connections in the pool.
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • security-domain-and-application Indicates that either app supplied parameters (such as from getConnection(user, pw)) or Subject (from security domain) are used to distinguish connections in the pool.
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • use-ccm Enable the use of a cached connection manager.
    • Attribute Value
    Default Value true
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • use-fast-fail Whether 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).
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • use-java-context Setting this to false will bind the object into global JNDI.
    • Attribute Value
    Default Value true
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • use-try-lock Any configured timeout for internal locks on the resource adapter objects in seconds.
    • Attribute Value
    Type LONG
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • wrap-xa-resource Should the XAResource instances be wrapped in a org.jboss.tm.XAResourceWrapper instance.
    • Attribute Value
    Default Value true
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • xa-resource-timeout The value is passed to XAResource.setTransactionTimeout(), in seconds. Default is zero.
    • Attribute Value
    Type INT
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services

Operations (2)

  • add Add a connection definition.
    Request Parameter Type Required Expressions Allowed Default value Description
    pool-prefill BOOLEAN false true false Should the pool be prefilled. Changing this value requires a server restart.
    no-tx-separate-pool BOOLEAN false true false 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.
    use-fast-fail BOOLEAN false true false Whether 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).
    recovery-security-domain STRING false true The security domain used for recovery.
    flush-strategy STRING false true FailingConnectionOnly Specifies how the pool should be flush in case of an error. Valid values are: FailingConnectionOnly (default), IdleConnections and EntirePool.
    background-validation BOOLEAN false true false An 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.
    class-name STRING true true Specifies the fully qualified class name of a managed connection factory or admin object.
    interleaving BOOLEAN false true false An element to enable interleaving for XA connections.
    recovery-plugin-class-name STRING false true The fully qualified class name of the recovery plugin implementation.
    use-ccm BOOLEAN false true true Enable the use of a cached connection manager.
    recovery-password STRING false true The password used for recovery.
    wrap-xa-resource BOOLEAN false true true Should the XAResource instances be wrapped in a org.jboss.tm.XAResourceWrapper instance.
    max-pool-size INT false true 20 The max-pool-size element specifies the maximum number of connections for a pool. No more connections will be created in each sub-pool.
    jndi-name STRING false true Specifies the JNDI name for the connection factory.
    enabled BOOLEAN false true true Specifies if the resource adapter should be enabled.
    recovery-plugin-properties OBJECT false true The properties for the recovery plugin.
    idle-timeout-minutes LONG false true The 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..
    same-rm-override BOOLEAN false true The is-same-rm-override element allows one to unconditionally set whether the javax.transaction.xa.XAResource.isSameRM(XAResource) returns true or false.
    blocking-timeout-wait-millis LONG false true The 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.
    use-java-context BOOLEAN false true true Setting this to false will bind the object into global JNDI.
    pool-use-strict-min BOOLEAN false true false Specifies if the min-pool-size should be considered strictly.
    security-domain-and-application STRING false true Indicates that either app supplied parameters (such as from getConnection(user, pw)) or Subject (from security domain) are used to distinguish connections in the pool.
    security-application BOOLEAN false true false Indicates that app supplied parameters (such as from getConnection(user, pw)) are used to distinguish connections in the pool.
    min-pool-size INT false true 0 The min-pool-size element specifies the minimum number of connections for a pool.
    allocation-retry INT false true The allocation retry element indicates the number of times that allocating a connection should be tried before throwing an exception.
    security-domain STRING false true Specifies the security domain which defines the javax.security.auth.Subject that are used to distinguish connections in the pool.
    xa-resource-timeout INT false true The value is passed to XAResource.setTransactionTimeout(), in seconds. Default is zero.
    recovery-username STRING false true The user name used for recovery.
    no-recovery BOOLEAN false true false Specifies if the connection pool should be excluded from recovery.
    pad-xid BOOLEAN false true false Should the Xid be padded.
    allocation-retry-wait-millis LONG false true The allocation retry wait millis element specifies the amount of time, in milliseconds, to wait between retrying to allocate a connection.
    use-try-lock LONG false true Any configured timeout for internal locks on the resource adapter objects in seconds.
    background-validation-millis LONG false true The background-validation-millis element specifies the amount of time, in milliseconds, that background validation will run. Changing this value requires a server restart.
  • remove Remove the connection definition.