Management API Reference for connection-definitions

Children (1)

• config-properties

Attributes (51)

• allocation-retry - The allocation retry element indicates the number of times that allocating a connection should be tried before throwing an exception.

  Type	INT
  Is the attribute nillable?	true
  Does the attribute allow expression?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	all-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The allocation retry element indicates the number of times that allocating a connection should be tried before throwing an exception.", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

• 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.

  Type	LONG
  Is the attribute nillable?	true
  Does the attribute allow expression?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	all-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "LONG" }, "description" : "The allocation retry wait millis element specifies the amount of time, in milliseconds, to wait between retrying to allocate a connection.", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

• authentication-context - The Elytron authentication context which defines the javax.security.auth.Subject that is used to distinguish connections in the pool.

  Type	STRING
  Is the attribute nillable?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	all-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The Elytron authentication context which defines the javax.security.auth.Subject that is used to distinguish connections in the pool.", "expressions-allowed" : false, "required" : false, "nillable" : true, "alternatives" : [ "security-domain", "security-domain-and-application", "security-application", "authentication-context-and-application" ], "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-constraints" : {"sensitive" : { "authentication-client-ref" : {"type" : "core"}, "resource-adapter-security" : {"type" : "resource-adapters"} }}, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

• 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.

  Type	STRING
  Is the attribute nillable?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	all-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "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.", "expressions-allowed" : false, "required" : false, "nillable" : true, "alternatives" : [ "security-domain", "security-domain-and-application", "security-application", "authentication-context" ], "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-constraints" : {"sensitive" : { "authentication-client-ref" : {"type" : "core"}, "resource-adapter-security" : {"type" : "resource-adapters"} }}, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

• 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.

  Type	BOOLEAN
  Is the attribute nillable?	true
  Does the attribute allow expression?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	all-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "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.", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

• 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.

  Type	LONG
  Unit	MILLISECONDS
  Is the attribute nillable?	true
  Does the attribute allow expression?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	all-services
  Min	1
  Max	2147483647
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "LONG" }, "description" : "The background-validation-millis element specifies the amount of time, in milliseconds, that background validation will run. Changing this value requires a server restart.", "expressions-allowed" : true, "required" : false, "nillable" : true, "unit" : "MILLISECONDS", "min" : 1, "max" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

• 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.

  Type	LONG
  Unit	MILLISECONDS
  Is the attribute nillable?	true
  Does the attribute allow expression?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	no-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "LONG" }, "description" : "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.", "expressions-allowed" : true, "required" : false, "nillable" : true, "unit" : "MILLISECONDS", "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }

• capacity-decrementer-class - Class defining the policy for decrementing connections in the pool.

  Type	STRING
  Is the attribute nillable?	true
  Does the attribute allow expression?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	all-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Class defining the policy for decrementing connections in the pool.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

• capacity-decrementer-properties - Properties to inject in class defining the policy for decrementing connections in the pool.

  Type	OBJECT
  Is the attribute nillable?	true
  Does the attribute allow expression?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	all-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "Properties to inject in class defining the policy for decrementing connections in the pool.", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

• capacity-incrementer-class - Class defining the policy for incrementing connections in the pool.

  Type	STRING
  Is the attribute nillable?	true
  Does the attribute allow expression?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	all-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Class defining the policy for incrementing connections in the pool.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

• capacity-incrementer-properties - Properties to inject in class defining the policy for incrementing connections in the pool.

  Type	OBJECT
  Is the attribute nillable?	true
  Does the attribute allow expression?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	all-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "Properties to inject in class defining the policy for incrementing connections in the pool.", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

• class-name - Specifies the fully qualified class name of a managed connection factory or admin object.

  Type	STRING
  Does the attribute allow expression?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	all-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Specifies the fully qualified class name of a managed connection factory or admin object.", "expressions-allowed" : true, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

• connectable - Enable the use of CMR. This feature means that a local resource can reliably participate in an XA transaction.

  Type	BOOLEAN
  Default Value	false
  Is the attribute nillable?	true
  Does the attribute allow expression?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	all-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Enable the use of CMR. This feature means that a local resource can reliably participate in an XA transaction.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

• 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.

  Type	BOOLEAN
  Default Value	false
  Is the attribute nillable?	true
  Does the attribute allow expression?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	all-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "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).", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "deprecated" : { "since" : "6.1.0", "reason" : "Elytron is enabled by default and this field is ignored." }, "access-constraints" : {"sensitive" : {"resource-adapter-security" : {"type" : "resource-adapters"}}}, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

• enabled - Specifies if the resource adapter should be enabled.

  Type	BOOLEAN
  Default Value	true
  Is the attribute nillable?	true
  Does the attribute allow expression?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	all-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Specifies if the resource adapter should be enabled.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

• enlistment - Defines if lazy enlistment should be used if supported by the resource adapter.

  Type	BOOLEAN
  Default Value	true
  Is the attribute nillable?	true
  Does the attribute allow expression?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	all-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Defines if lazy enlistment should be used if supported by the resource adapter.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

• enlistment-trace - Defines if WildFly/IronJacamar should record enlistment traces.

  Type	BOOLEAN
  Default Value	false
  Is the attribute nillable?	true
  Does the attribute allow expression?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	no-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Defines if WildFly/IronJacamar should record enlistment traces.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }

• flush-strategy - Specifies how the pool should be flushed in case of an error.

  Type	STRING
  Default Value	FailingConnectionOnly
  Is the attribute nillable?	true
  Does the attribute allow expression?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	all-services
  Allowed Values	FailingConnectionOnly InvalidIdleConnections AllGracefully Gracefully AllIdleConnections IdleConnections AllConnections EntirePool AllInvalidIdleConnections
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Specifies how the pool should be flushed in case of an error.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "FailingConnectionOnly", "allowed" : [ "FailingConnectionOnly", "InvalidIdleConnections", "IdleConnections", "Gracefully", "EntirePool", "AllInvalidIdleConnections", "AllIdleConnections", "AllGracefully", "AllConnections" ], "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

• 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.

  Type	LONG
  Unit	MINUTES
  Is the attribute nillable?	true
  Does the attribute allow expression?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	all-services
  Min	0
  Max	2147483647
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "LONG" }, "description" : "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.", "expressions-allowed" : true, "required" : false, "nillable" : true, "unit" : "MINUTES", "min" : 0, "max" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

• initial-pool-size - Specifies the initial number of connections a pool should hold.

  Type	INT
  Is the attribute nillable?	true
  Does the attribute allow expression?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	no-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "Specifies the initial number of connections a pool should hold.", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }

• interleaving - An element to enable interleaving for XA connections.

  Type	BOOLEAN
  Default Value	false
  Is the attribute nillable?	true
  Does the attribute allow expression?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	all-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "An element to enable interleaving for XA connections.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

• jndi-name - Specifies the JNDI name for the connection factory.

  Type	STRING
  Does the attribute allow expression?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	all-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Specifies the JNDI name for the connection factory.", "expressions-allowed" : true, "required" : true, "nillable" : false, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

• max-pool-size - Specifies the maximum number of connections for a pool. No more connections will be created in each sub-pool.

  Type	INT
  Default Value	20
  Is the attribute nillable?	true
  Does the attribute allow expression?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	all-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "Specifies the maximum number of connections for a pool. No more connections will be created in each sub-pool.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 20, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

• mcp - Defines the ManagedConnectionPool implementation. For example: org.jboss.jca.core.connectionmanager.pool.mcp.SemaphoreArrayListManagedConnectionPool.

  Type	STRING
  Is the attribute nillable?	true
  Does the attribute allow expression?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	all-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Defines the ManagedConnectionPool implementation. For example: org.jboss.jca.core.connectionmanager.pool.mcp.SemaphoreArrayListManagedConnectionPool.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

• min-pool-size - Specifies the minimum number of connections for a pool.

  Type	INT
  Default Value	0
  Is the attribute nillable?	true
  Does the attribute allow expression?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	all-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "Specifies the minimum number of connections for a pool.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 0, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

• no-recovery - Specifies if the connection pool should be excluded from recovery.

  Type	BOOLEAN
  Default Value	false
  Is the attribute nillable?	true
  Does the attribute allow expression?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	all-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Specifies if the connection pool should be excluded from recovery.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

• 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.

  Type	BOOLEAN
  Default Value	false
  Is the attribute nillable?	true
  Does the attribute allow expression?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	all-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "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.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

• pad-xid - Specifies whether the Xid should be padded.

  Type	BOOLEAN
  Default Value	false
  Is the attribute nillable?	true
  Does the attribute allow expression?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	all-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Specifies whether the Xid should be padded.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

• pool-fair - Defines if pool use should be fair.

  Type	BOOLEAN
  Default Value	true
  Is the attribute nillable?	true
  Does the attribute allow expression?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	no-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Defines if pool use should be fair.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }

• pool-prefill - Specifies if the pool should be prefilled. Changing this value requires a server restart.

  Type	BOOLEAN
  Default Value	false
  Is the attribute nillable?	true
  Does the attribute allow expression?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	all-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Specifies if the pool should be prefilled. Changing this value requires a server restart.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

• pool-use-strict-min - Specifies if the min-pool-size should be considered strict.

  Type	BOOLEAN
  Default Value	false
  Is the attribute nillable?	true
  Does the attribute allow expression?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	no-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Specifies if the min-pool-size should be considered strict.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }

• recovery-authentication-context - The Elytron authentication context used for recovery (current authentication-context will be used if unspecified).

  Type	STRING
  Is the attribute nillable?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	all-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The Elytron authentication context used for recovery (current authentication-context will be used if unspecified).", "expressions-allowed" : false, "required" : false, "nillable" : true, "alternatives" : ["recovery-security-domain"], "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-constraints" : {"sensitive" : { "authentication-client-ref" : {"type" : "core"}, "resource-adapter-security" : {"type" : "resource-adapters"} }}, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

• recovery-credential-reference - Credential (from Credential Store) to authenticate on recovery connection

  Type	OBJECT
  Is the attribute nillable?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	all-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "Credential (from Credential Store) to authenticate on recovery connection", "expressions-allowed" : false, "required" : false, "nillable" : true, "alternatives" : ["recovery-password"], "stability" : "default", "access-constraints" : {"sensitive" : { "credential" : {"type" : "core"}, "resource-adapter-security" : {"type" : "resource-adapters"} }}, "value-type" : { "store" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The name of the credential store holding the alias to credential", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "alias" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The alias which denotes stored secret or credential in the store", "expressions-allowed" : true, "required" : false, "nillable" : true, "requires" : ["store"], "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "type" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The type of credential this reference is denoting", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "clear-text" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Secret specified using clear text (check credential store way of supplying credential/secrets to services)", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" } }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

• 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.

  Type	BOOLEAN
  Default Value	false
  Is the attribute nillable?	true
  Does the attribute allow expression?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	all-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Indicates that an Elytron authentication context will be used for recovery.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "deprecated" : { "since" : "6.1.0", "reason" : "Elytron is enabled by default and this field is ignored." }, "access-constraints" : {"sensitive" : {"resource-adapter-security" : {"type" : "resource-adapters"}}}, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

• recovery-password - The password used for recovery.

  Type	STRING
  Is the attribute nillable?	true
  Does the attribute allow expression?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	all-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The password used for recovery.", "expressions-allowed" : true, "required" : false, "nillable" : true, "alternatives" : ["recovery-credential-reference"], "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-constraints" : {"sensitive" : { "credential" : {"type" : "core"}, "resource-adapter-security" : {"type" : "resource-adapters"} }}, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

• recovery-plugin-class-name - The fully qualified class name of the recovery plugin implementation.

  Type	STRING
  Is the attribute nillable?	true
  Does the attribute allow expression?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	all-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The fully qualified class name of the recovery plugin implementation.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

• recovery-plugin-properties - The properties for the recovery plugin.

  Type	OBJECT
  Is the attribute nillable?	true
  Does the attribute allow expression?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	all-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "The properties for the recovery plugin.", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

• 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.

  Type	STRING
  Is the attribute nillable?	true
  Does the attribute allow expression?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	all-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The PicketBox security domain used for recovery.", "expressions-allowed" : true, "required" : false, "nillable" : true, "alternatives" : ["recovery-authentication-context"], "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "deprecated" : { "since" : "6.1.0", "reason" : "PicketBox security domains are not supported in servers running the current version of the datasources subsystem. Use 'authentication-context' to configure Elytron security." }, "access-constraints" : {"sensitive" : { "security-domain-ref" : {"type" : "core"}, "resource-adapter-security" : {"type" : "resource-adapters"} }}, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

• recovery-username - The user name used for recovery.

  Type	STRING
  Is the attribute nillable?	true
  Does the attribute allow expression?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	all-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The user name used for recovery.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-constraints" : {"sensitive" : { "credential" : {"type" : "core"}, "resource-adapter-security" : {"type" : "resource-adapters"} }}, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

• same-rm-override - Using this attribute, you can unconditionally set whether javax.transaction.xa.XAResource.isSameRM(XAResource) returns true or false.

  Type	BOOLEAN
  Is the attribute nillable?	true
  Does the attribute allow expression?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	all-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Using this attribute, you can unconditionally set whether javax.transaction.xa.XAResource.isSameRM(XAResource) returns true or false.", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

• security-application - Indicates that application-supplied parameters, such as from getConnection(user, pw), are used to distinguish connections in the pool.

  Type	BOOLEAN
  Default Value	false
  Is the attribute nillable?	true
  Does the attribute allow expression?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	all-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Indicates that application-supplied parameters, such as from getConnection(user, pw), are used to distinguish connections in the pool.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "alternatives" : [ "security-domain", "security-domain-and-application", "authentication-context", "authentication-context-and-application" ], "stability" : "default", "access-constraints" : {"sensitive" : { "security-domain-ref" : {"type" : "core"}, "resource-adapter-security" : {"type" : "resource-adapters"} }}, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

• 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.

  Type	STRING
  Is the attribute nillable?	true
  Does the attribute allow expression?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	all-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Specifies the PicketBox security domain which defines the javax.security.auth.Subject that is used to distinguish connections in the pool.", "expressions-allowed" : true, "required" : false, "nillable" : true, "alternatives" : [ "security-domain-and-application", "security-application", "authentication-context", "authentication-context-and-application" ], "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "deprecated" : { "since" : "6.1.0", "reason" : "PicketBox security domains are not supported in servers running the current version of the datasources subsystem. Use 'authentication-context' to configure Elytron security." }, "access-constraints" : {"sensitive" : { "security-domain-ref" : {"type" : "core"}, "resource-adapter-security" : {"type" : "resource-adapters"} }}, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

• security-domain-and-application - Indicates that either application-supplied parameters, such as from getConnection(user, pw) are used to distinguish connections in the pool.
  Deprecated Since 6.1.0

  PicketBox is no longer supported. Use Elytron configuration instead.

  Type	STRING
  Is the attribute nillable?	true
  Does the attribute allow expression?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	all-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Indicates that either application-supplied parameters, such as from getConnection(user, pw) are used to distinguish connections in the pool.", "expressions-allowed" : true, "required" : false, "nillable" : true, "alternatives" : [ "security-domain", "security-application", "authentication-context", "authentication-context-and-application" ], "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "deprecated" : { "since" : "6.1.0", "reason" : "PicketBox is no longer supported. Use Elytron configuration instead." }, "access-constraints" : {"sensitive" : { "security-domain-ref" : {"type" : "core"}, "resource-adapter-security" : {"type" : "resource-adapters"} }}, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

• sharable - Enable the use of sharable connections, which allows lazy association to be enabled if supported.

  Type	BOOLEAN
  Default Value	true
  Is the attribute nillable?	true
  Does the attribute allow expression?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	all-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Enable the use of sharable connections, which allows lazy association to be enabled if supported.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

• tracking - Defines if IronJacamar should track connection handles across transaction boundaries.

  Type	BOOLEAN
  Is the attribute nillable?	true
  Does the attribute allow expression?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	all-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Defines if IronJacamar should track connection handles across transaction boundaries.", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

• use-ccm - Enable the use of a cached connection manager.

  Type	BOOLEAN
  Default Value	true
  Is the attribute nillable?	true
  Does the attribute allow expression?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	all-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Enable the use of a cached connection manager.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

• 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).

  Type	BOOLEAN
  Default Value	false
  Is the attribute nillable?	true
  Does the attribute allow expression?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	all-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "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).", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

• use-java-context - Setting this to false will bind the object into global JNDI.

  Type	BOOLEAN
  Default Value	true
  Is the attribute nillable?	true
  Does the attribute allow expression?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	all-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Setting this to false will bind the object into global JNDI.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

• 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.

  Type	BOOLEAN
  Is the attribute nillable?	true
  Does the attribute allow expression?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	all-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "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.", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

• wrap-xa-resource - Specifies whether XAResource instances should be wrapped in an org.jboss.tm.XAResourceWrapper instance.

  Type	BOOLEAN
  Default Value	true
  Is the attribute nillable?	true
  Does the attribute allow expression?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	all-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Specifies whether XAResource instances should be wrapped in an org.jboss.tm.XAResourceWrapper instance.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

• xa-resource-timeout - The value is passed to XAResource.setTransactionTimeout(), in seconds.

  Type	INT
  Is the attribute nillable?	true
  Does the attribute allow expression?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	all-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The value is passed to XAResource.setTransactionTimeout(), in seconds.", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

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.

  Raw DMR model

  { "operation-name" : "add", "description" : "Add a connection definition.", "request-properties" : { "allocation-retry" : { "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The allocation retry element indicates the number of times that allocating a connection should be tried before throwing an exception.", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default" }, "allocation-retry-wait-millis" : { "type" : { "TYPE_MODEL_VALUE" : "LONG" }, "description" : "The allocation retry wait millis element specifies the amount of time, in milliseconds, to wait between retrying to allocate a connection.", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default" }, "authentication-context" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The Elytron authentication context which defines the javax.security.auth.Subject that is used to distinguish connections in the pool.", "expressions-allowed" : false, "required" : false, "nillable" : true, "alternatives" : [ "security-domain", "security-domain-and-application", "security-application", "authentication-context-and-application" ], "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "authentication-context-and-application" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "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.", "expressions-allowed" : false, "required" : false, "nillable" : true, "alternatives" : [ "security-domain", "security-domain-and-application", "security-application", "authentication-context" ], "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "background-validation" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "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.", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default" }, "background-validation-millis" : { "type" : { "TYPE_MODEL_VALUE" : "LONG" }, "description" : "The background-validation-millis element specifies the amount of time, in milliseconds, that background validation will run. Changing this value requires a server restart.", "expressions-allowed" : true, "required" : false, "nillable" : true, "unit" : "MILLISECONDS", "min" : 1, "max" : 2147483647, "stability" : "default" }, "blocking-timeout-wait-millis" : { "type" : { "TYPE_MODEL_VALUE" : "LONG" }, "description" : "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.", "expressions-allowed" : true, "required" : false, "nillable" : true, "unit" : "MILLISECONDS", "stability" : "default" }, "capacity-decrementer-class" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Class defining the policy for decrementing connections in the pool.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "capacity-decrementer-properties" : { "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "Properties to inject in class defining the policy for decrementing connections in the pool.", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" } }, "capacity-incrementer-class" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Class defining the policy for incrementing connections in the pool.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "capacity-incrementer-properties" : { "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "Properties to inject in class defining the policy for incrementing connections in the pool.", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" } }, "class-name" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Specifies the fully qualified class name of a managed connection factory or admin object.", "expressions-allowed" : true, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "connectable" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Enable the use of CMR. This feature means that a local resource can reliably participate in an XA transaction.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default" }, "elytron-enabled" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "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).", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "deprecated" : { "since" : "6.1.0", "reason" : "Elytron is enabled by default and this field is ignored." } }, "enabled" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Specifies if the resource adapter should be enabled.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : true, "stability" : "default" }, "enlistment" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Defines if lazy enlistment should be used if supported by the resource adapter.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : true, "stability" : "default" }, "enlistment-trace" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Defines if WildFly/IronJacamar should record enlistment traces.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default" }, "flush-strategy" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Specifies how the pool should be flushed in case of an error.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "FailingConnectionOnly", "allowed" : [ "FailingConnectionOnly", "InvalidIdleConnections", "IdleConnections", "Gracefully", "EntirePool", "AllInvalidIdleConnections", "AllIdleConnections", "AllGracefully", "AllConnections" ], "stability" : "default" }, "idle-timeout-minutes" : { "type" : { "TYPE_MODEL_VALUE" : "LONG" }, "description" : "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.", "expressions-allowed" : true, "required" : false, "nillable" : true, "unit" : "MINUTES", "min" : 0, "max" : 2147483647, "stability" : "default" }, "initial-pool-size" : { "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "Specifies the initial number of connections a pool should hold.", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default" }, "interleaving" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "An element to enable interleaving for XA connections.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default" }, "jndi-name" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Specifies the JNDI name for the connection factory.", "expressions-allowed" : true, "required" : true, "nillable" : false, "stability" : "default" }, "max-pool-size" : { "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "Specifies the maximum number of connections for a pool. No more connections will be created in each sub-pool.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 20, "stability" : "default" }, "mcp" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Defines the ManagedConnectionPool implementation. For example: org.jboss.jca.core.connectionmanager.pool.mcp.SemaphoreArrayListManagedConnectionPool.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "min-pool-size" : { "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "Specifies the minimum number of connections for a pool.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 0, "stability" : "default" }, "no-recovery" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Specifies if the connection pool should be excluded from recovery.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default" }, "no-tx-separate-pool" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "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.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default" }, "pad-xid" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Specifies whether the Xid should be padded.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default" }, "pool-fair" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Defines if pool use should be fair.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : true, "stability" : "default" }, "pool-prefill" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Specifies if the pool should be prefilled. Changing this value requires a server restart.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default" }, "pool-use-strict-min" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Specifies if the min-pool-size should be considered strict.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default" }, "recovery-authentication-context" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The Elytron authentication context used for recovery (current authentication-context will be used if unspecified).", "expressions-allowed" : false, "required" : false, "nillable" : true, "alternatives" : ["recovery-security-domain"], "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "recovery-credential-reference" : { "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "Credential (from Credential Store) to authenticate on recovery connection", "expressions-allowed" : false, "required" : false, "nillable" : true, "alternatives" : ["recovery-password"], "stability" : "default", "value-type" : { "store" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The name of the credential store holding the alias to credential", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "alias" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The alias which denotes stored secret or credential in the store", "expressions-allowed" : true, "required" : false, "nillable" : true, "requires" : ["store"], "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "type" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The type of credential this reference is denoting", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "clear-text" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Secret specified using clear text (check credential store way of supplying credential/secrets to services)", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" } } }, "recovery-elytron-enabled" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Indicates that an Elytron authentication context will be used for recovery.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "deprecated" : { "since" : "6.1.0", "reason" : "Elytron is enabled by default and this field is ignored." } }, "recovery-password" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The password used for recovery.", "expressions-allowed" : true, "required" : false, "nillable" : true, "alternatives" : ["recovery-credential-reference"], "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "recovery-plugin-class-name" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The fully qualified class name of the recovery plugin implementation.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "recovery-plugin-properties" : { "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "The properties for the recovery plugin.", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" } }, "recovery-security-domain" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The PicketBox security domain used for recovery.", "expressions-allowed" : true, "required" : false, "nillable" : true, "alternatives" : ["recovery-authentication-context"], "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "deprecated" : { "since" : "6.1.0", "reason" : "PicketBox security domains are not supported in servers running the current version of the datasources subsystem. Use 'authentication-context' to configure Elytron security." } }, "recovery-username" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The user name used for recovery.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "same-rm-override" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Using this attribute, you can unconditionally set whether javax.transaction.xa.XAResource.isSameRM(XAResource) returns true or false.", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default" }, "security-application" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Indicates that application-supplied parameters, such as from getConnection(user, pw), are used to distinguish connections in the pool.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "alternatives" : [ "security-domain", "security-domain-and-application", "authentication-context", "authentication-context-and-application" ], "stability" : "default" }, "security-domain" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Specifies the PicketBox security domain which defines the javax.security.auth.Subject that is used to distinguish connections in the pool.", "expressions-allowed" : true, "required" : false, "nillable" : true, "alternatives" : [ "security-domain-and-application", "security-application", "authentication-context", "authentication-context-and-application" ], "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "deprecated" : { "since" : "6.1.0", "reason" : "PicketBox security domains are not supported in servers running the current version of the datasources subsystem. Use 'authentication-context' to configure Elytron security." } }, "security-domain-and-application" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Indicates that either application-supplied parameters, such as from getConnection(user, pw) are used to distinguish connections in the pool.", "expressions-allowed" : true, "required" : false, "nillable" : true, "alternatives" : [ "security-domain", "security-application", "authentication-context", "authentication-context-and-application" ], "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "deprecated" : { "since" : "6.1.0", "reason" : "PicketBox is no longer supported. Use Elytron configuration instead." } }, "sharable" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Enable the use of sharable connections, which allows lazy association to be enabled if supported.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : true, "stability" : "default" }, "tracking" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Defines if IronJacamar should track connection handles across transaction boundaries.", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default" }, "use-ccm" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Enable the use of a cached connection manager.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : true, "stability" : "default" }, "use-fast-fail" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "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).", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default" }, "use-java-context" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Setting this to false will bind the object into global JNDI.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : true, "stability" : "default" }, "validate-on-match" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "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.", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default" }, "wrap-xa-resource" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Specifies whether XAResource instances should be wrapped in an org.jboss.tm.XAResourceWrapper instance.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : true, "stability" : "default" }, "xa-resource-timeout" : { "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The value is passed to XAResource.setTransactionTimeout(), in seconds.", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default" } }, "reply-properties" : {}, "stability" : "default", "read-only" : false, "runtime-only" : false }

• dump-queued-threads-in-pool - Dump queued threads in the pool

  Raw DMR model

  { "operation-name" : "dump-queued-threads-in-pool", "description" : "Dump queued threads in the pool", "request-properties" : {}, "reply-properties" : {}, "stability" : "default", "read-only" : true, "runtime-only" : true }

• flush-all-connection-in-pool - Flushes all connections in the pool.

  Raw DMR model

  { "operation-name" : "flush-all-connection-in-pool", "description" : "Flushes all connections in the pool.", "request-properties" : {}, "reply-properties" : {}, "stability" : "default", "read-only" : false, "runtime-only" : true }

• flush-gracefully-connection-in-pool - Flushes all connections gracefully in the pool.

  Raw DMR model

  { "operation-name" : "flush-gracefully-connection-in-pool", "description" : "Flushes all connections gracefully in the pool.", "request-properties" : {}, "reply-properties" : {}, "stability" : "default", "read-only" : false, "runtime-only" : true }

• flush-idle-connection-in-pool - Flushes all idle connections in the pool.

  Raw DMR model

  { "operation-name" : "flush-idle-connection-in-pool", "description" : "Flushes all idle connections in the pool.", "request-properties" : {}, "reply-properties" : {}, "stability" : "default", "read-only" : false, "runtime-only" : true }

• flush-invalid-connection-in-pool - Flushes all invalid connections in the pool.

  Raw DMR model

  { "operation-name" : "flush-invalid-connection-in-pool", "description" : "Flushes all invalid connections in the pool.", "request-properties" : {}, "reply-properties" : {}, "stability" : "default", "read-only" : false, "runtime-only" : true }

• remove - Remove the connection definition.

  Raw DMR model

  { "operation-name" : "remove", "description" : "Remove the connection definition.", "request-properties" : {}, "reply-properties" : {}, "stability" : "default", "read-only" : false, "restart-required" : "all-services", "runtime-only" : false }

• test-connection-in-pool - Test if a connection can be obtained.

  Raw DMR model

  { "operation-name" : "test-connection-in-pool", "description" : "Test if a connection can be obtained.", "request-properties" : {}, "reply-properties" : {}, "stability" : "default", "read-only" : false, "runtime-only" : true }