WildFly Full 28 Model Reference

  1. home
  2. subsystem=resource-adapters
  3. resource-adapter
  4. connection-definitions

Specifies a connection definition.

Children (1)

Attributes (51)

  • 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 all-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 all-services
  • authentication-context The Elytron authentication context which defines the javax.security.auth.Subject that is used to distinguish connections in the pool.
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • authentication-context-and-application Indicates that either application-supplied parameters, such as from getConnection(user, pw), or Subject (provided by Elytron after authenticating using configured authentication-context), are used to distinguish connections in the pool.
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required all-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
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-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 all-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
  • capacity-decrementer-class Class defining the policy for decrementing connections in the pool.
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • capacity-decrementer-properties Properties to inject in class defining the policy for decrementing connections in the pool.
    • Attribute Value
    Type OBJECT
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • capacity-incrementer-class Class defining the policy for incrementing connections in the pool.
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • capacity-incrementer-properties Properties to inject in class defining the policy for incrementing connections in the pool.
    • Attribute Value
    Type OBJECT
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-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 all-services
  • connectable Enable the use of CMR. This feature means that a local resource can reliably participate in an XA transaction.
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • elytron-enabled Enables Elytron security for handling authentication of connections. The Elytron authentication-context to be used will be current context if no context is specified (see authentication-context).
    • Deprecated Since 6.1.0
    Elytron is enabled by default and this field is ignored.
    Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-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 all-services
  • enlistment Defines if lazy enlistment should be used if supported by the resource adapter.
    • Attribute Value
    Default Value true
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • enlistment-trace Defines if WildFly/IronJacamar should record enlistment traces.
    • Attribute Value
    Default Value false
    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 flushed in case of an error.
    • Attribute Value
    Default Value FailingConnectionOnly
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
    Allowed Values FailingConnectionOnly
    InvalidIdleConnections
    IdleConnections
    Gracefully
    EntirePool
    AllInvalidIdleConnections
    AllIdleConnections
    AllGracefully
    AllConnections
  • idle-timeout-minutes 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
    Min 0
    Max 2,147,483,647
    Unit MINUTES
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • initial-pool-size Specifies the initial number of connections a pool should hold.
    • Attribute Value
    Type INT
    Nillable true
    Expressions Allowed true
    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 all-services
  • jndi-name Specifies the JNDI name for the connection factory.
    • Attribute Value
    Type STRING
    Nillable false
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • max-pool-size 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 all-services
  • mcp Defines the ManagedConnectionPool implementation. For example: org.jboss.jca.core.connectionmanager.pool.mcp.SemaphoreArrayListManagedConnectionPool.
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • min-pool-size 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 all-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 all-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 all-services
  • pad-xid Specifies whether the Xid should be padded.
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • pool-fair Defines if pool use should be fair.
    • Attribute Value
    Default Value true
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • pool-prefill Specifies if the pool should 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 all-services
  • pool-use-strict-min Specifies if the min-pool-size should be considered strict.
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • recovery-authentication-context The Elytron authentication context used for recovery (current authentication-context will be used if unspecified).
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • recovery-credential-reference Credential (from Credential Store) to authenticate on recovery connection
    • Attribute Value
    Type OBJECT
    Nillable true
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • recovery-elytron-enabled Indicates that an Elytron authentication context will be used for recovery.
    • Deprecated Since 6.1.0
    Elytron is enabled by default and this field is ignored.
    Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-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 all-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 all-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 all-services
  • recovery-security-domain The PicketBox security domain used for recovery.
    • Deprecated Since 6.1.0
    PicketBox security domains are not supported in servers running the current version of the datasources subsystem. Use 'authentication-context' to configure Elytron security.
    Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-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 all-services
  • same-rm-override Using this attribute, you can unconditionally set whether 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 all-services
  • security-application Indicates that application-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 all-services
  • security-domain Specifies the PicketBox security domain which defines the javax.security.auth.Subject that is used to distinguish connections in the pool.
    • Deprecated Since 6.1.0
    PicketBox security domains are not supported in servers running the current version of the datasources subsystem. Use 'authentication-context' to configure Elytron security.
    Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • security-domain-and-application Indicates that either application-supplied parameters, such as from getConnection(user, pw) 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 all-services
  • sharable Enable the use of sharable connections, which allows lazy association to be enabled if supported.
    • Attribute Value
    Default Value true
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • tracking Defines if IronJacamar should track connection handles across transaction boundaries.
    • Attribute Value
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-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 all-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 all-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 all-services
  • validate-on-match This specifies if connection validation should be done when a connection factory attempts to match a managed connection. This is typically exclusive to the use of background validation.
    • Attribute Value
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • wrap-xa-resource Specifies whether XAResource instances should be wrapped in an 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 all-services
  • xa-resource-timeout The value is passed to XAResource.setTransactionTimeout(), in seconds.
    • Attribute Value
    Type INT
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services

Operations (8)

  • add Add a connection definition.
    Request Parameter Type Required Expressions Allowed Default value Description
    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.
    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.
    authentication-context STRING false false The Elytron authentication context which defines the javax.security.auth.Subject that is used to distinguish connections in the pool.
    authentication-context-and-application STRING false false Indicates that either application-supplied parameters, such as from getConnection(user, pw), or Subject (provided by Elytron after authenticating using configured authentication-context), are used to distinguish connections in the pool.
    background-validation BOOLEAN false true 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.
    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.
    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.
    capacity-decrementer-class STRING false true Class defining the policy for decrementing connections in the pool.
    capacity-decrementer-properties OBJECT false true Properties to inject in class defining the policy for decrementing connections in the pool.
    capacity-incrementer-class STRING false true Class defining the policy for incrementing connections in the pool.
    capacity-incrementer-properties OBJECT false true Properties to inject in class defining the policy for incrementing connections in the pool.
    class-name STRING true true Specifies the fully qualified class name of a managed connection factory or admin object.
    connectable BOOLEAN false true false Enable the use of CMR. This feature means that a local resource can reliably participate in an XA transaction.
    elytron-enabled BOOLEAN false true false Enables Elytron security for handling authentication of connections. The Elytron authentication-context to be used will be current context if no context is specified (see authentication-context).
    enabled BOOLEAN false true true Specifies if the resource adapter should be enabled.
    enlistment BOOLEAN false true true Defines if lazy enlistment should be used if supported by the resource adapter.
    enlistment-trace BOOLEAN false true false Defines if WildFly/IronJacamar should record enlistment traces.
    flush-strategy STRING false true FailingConnectionOnly Specifies how the pool should be flushed in case of an error.
    idle-timeout-minutes LONG false true 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.
    initial-pool-size INT false true Specifies the initial number of connections a pool should hold.
    interleaving BOOLEAN false true false An element to enable interleaving for XA connections.
    jndi-name STRING true true Specifies the JNDI name for the connection factory.
    max-pool-size INT false true 20 Specifies the maximum number of connections for a pool. No more connections will be created in each sub-pool.
    mcp STRING false true Defines the ManagedConnectionPool implementation. For example: org.jboss.jca.core.connectionmanager.pool.mcp.SemaphoreArrayListManagedConnectionPool.
    min-pool-size INT false true 0 Specifies the minimum number of connections for a pool.
    no-recovery BOOLEAN false true false Specifies if the connection pool should be excluded from recovery.
    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.
    pad-xid BOOLEAN false true false Specifies whether the Xid should be padded.
    pool-fair BOOLEAN false true true Defines if pool use should be fair.
    pool-prefill BOOLEAN false true false Specifies if the pool should be prefilled. Changing this value requires a server restart.
    pool-use-strict-min BOOLEAN false true false Specifies if the min-pool-size should be considered strict.
    recovery-authentication-context STRING false false The Elytron authentication context used for recovery (current authentication-context will be used if unspecified).
    recovery-credential-reference OBJECT false false Credential (from Credential Store) to authenticate on recovery connection
    recovery-elytron-enabled BOOLEAN false true false Indicates that an Elytron authentication context will be used for recovery.
    recovery-password STRING false true The password used for recovery.
    recovery-plugin-class-name STRING false true The fully qualified class name of the recovery plugin implementation.
    recovery-plugin-properties OBJECT false true The properties for the recovery plugin.
    recovery-security-domain STRING false true The PicketBox security domain used for recovery.
    recovery-username STRING false true The user name used for recovery.
    same-rm-override BOOLEAN false true Using this attribute, you can unconditionally set whether javax.transaction.xa.XAResource.isSameRM(XAResource) returns true or false.
    security-application BOOLEAN false true false Indicates that application-supplied parameters, such as from getConnection(user, pw), are used to distinguish connections in the pool.
    security-domain STRING false true Specifies the PicketBox security domain which defines the javax.security.auth.Subject that is used to distinguish connections in the pool.
    security-domain-and-application STRING false true Indicates that either application-supplied parameters, such as from getConnection(user, pw) are used to distinguish connections in the pool.
    sharable BOOLEAN false true true Enable the use of sharable connections, which allows lazy association to be enabled if supported.
    tracking BOOLEAN false true Defines if IronJacamar should track connection handles across transaction boundaries.
    use-ccm BOOLEAN false true true Enable the use of a cached connection manager.
    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).
    use-java-context BOOLEAN false true true Setting this to false will bind the object into global JNDI.
    validate-on-match BOOLEAN false true This specifies if connection validation should be done when a connection factory attempts to match a managed connection. This is typically exclusive to the use of background validation.
    wrap-xa-resource BOOLEAN false true true Specifies whether XAResource instances should be wrapped in an org.jboss.tm.XAResourceWrapper instance.
    xa-resource-timeout INT false true The value is passed to XAResource.setTransactionTimeout(), in seconds.
  • dump-queued-threads-in-pool Dump queued threads in the pool
  • flush-all-connection-in-pool Flushes all connections in the pool.
  • flush-gracefully-connection-in-pool Flushes all connections gracefully in the pool.
  • flush-idle-connection-in-pool Flushes all idle connections in the pool.
  • flush-invalid-connection-in-pool Flushes all invalid connections in the pool.
  • remove Remove the connection definition.
  • test-connection-in-pool Test if a connection can be obtained.