urn:jboss:domain:datasources:5.0

subsystem

datasources

datasource

[ Specifies a non-XA datasource, using local transactions

NameTypeDefaultDescription
jtabooleantrue [ Enable JTA integration

connection-url

[ The JDBC driver connection URL Ex: <connection-url>jdbc:hsqldb:hsql://localhost:1701</connection-url>

driver-class?

[ The fully qualifed name of the JDBC driver class Ex: <driver-class>org.hsqldb.jdbcDriver</driver-class>

datasource-class?

[ The fully qualifed name of the JDBC datasource class Ex: <datasource-class>org.h2.jdbcx.JdbcDataSource</datasource-class>

driver?

[ An unique reference to the classloader module which contains the JDBC driver The accepted format is driverName#majorVersion.minorVersion

connection-property*

[ The connection-property element allows you to pass in arbitrary connection properties to the Driver.connect(url, props) method. Each connection-property specifies a string name/value pair with the property name coming from the name attribute and the value coming from the element content. Ex: <connection-property name="char.encoding">UTF-8</connection-property>

NameTypeDefaultDescription
nametoken

new-connection-sql?

[ Specify an SQL statement to execute whenever a connection is added to the connection pool.

transaction-isolation?

[ Set java.sql.Connection transaction isolation level to use. The constants defined by transaction-isolation-values are the possible transaction isolation levels and include: TRANSACTION_READ_UNCOMMITTED TRANSACTION_READ_COMMITTED TRANSACTION_REPEATABLE_READ TRANSACTION_SERIALIZABLE TRANSACTION_NONE

url-delimiter?

[ Specifies the delimeter for URLs in connection-url for HA datasources

url-property?

[ Specifies the property for the URL property in the xa-datasource-property values

url-selector-strategy-class-name?

[ A class that implements org.jboss.jca.adapters.jdbc.URLSelectorStrategy

pool?

[ Specifies the pooling settings

min-pool-size?

[ The min-pool-size element indicates the minimum number of connections a pool should hold. These are not created until a Subject is known from a request for a connection. This default to 0. Ex: <min-pool-size>1</min-pool-size>

initial-pool-size?

[ The initial-pool-size element indicates the initial number of connections a pool should hold. This default to 0. Ex: <initial-pool-size>1</initial-pool-size>

max-pool-size?

[ The max-pool-size element indicates the maximum number of connections for a pool. No more connections will be created in each sub-pool. This defaults to 20.

prefill?

[ Whether to attempt to prefill the connection pool. Empty element denotes a true value. e.g. <prefill>true</prefill>. Default is false

fair?

[ Defines if pool use should be fair Default true

use-strict-min?

[ Define if the min-pool-size should be considered a strictly. Default false

flush-strategy?

[ Specifies how the pool should be flush in case of an error. Valid values are: FailingConnectionOnly (default), InvalidIdleConnections, IdleConnections, Gracefully, EntirePool, AllInvalidIdleConnections, AllIdleConnections, AllGracefully, AllConnections

allow-multiple-users?

[ Specifies if multiple users will access the datasource through the getConnection(user, password) method and hence if the internal pool type should account for that

capacity?

[ Specifies the capacity policies for the pool

incrementer?

[ Defines the policy for incrementing connections in the pool

NameTypeDefaultDescription
class-nametoken

config-property*

[ Specifies a Java bean property value

decrementer?

[ Defines the policy for decrementing connections in the pool

NameTypeDefaultDescription
class-nametoken

config-property*

[ Specifies a Java bean property value

connection-listener?

[ An org.jboss.jca.adapters.jdbc.spi.listener.ConnectionListener that provides a possible to listen for connection activation and passivation in order to perform actions before the connection is returned to the application or returned to the pool. Ex: <connection-listener class-name="com.acme.jdbc.OracleConnectionListener"/>

NameTypeDefaultDescription
class-nametoken

config-property*

[ Specifies a Java bean property value

security?

[ Specifies the security settings

user-name?

[ Specify the username used when creating a new connection. Ex: <user-name>sa</user-name>

password?

[ Specify the password used when creating a new connection. Ex: <password>sa-pass</password>

credential-reference?

Credential to be used by the configuration.

NameTypeDefaultDescription
clear-textstring Credential/password in clear text. Use just for testing purpose. Otherwise use credential store to mask the actual credential from your configuration.

security-domain?

[ Indicates Subject (from security domain) are used to distinguish connections in the pool. The content of the security-domain is the name of the JAAS security manager that will handle authentication. This name correlates to the JAAS login-config.xml descriptor application-policy/name attribute. Ex: <security-domain>HsqlDbRealm</security-domain>

elytron-enabled

[ Indicates that Elytron is responsible for authenticating connections. If authentication-context is configured (via authentication-context), Elytron will use the specified context for authenticating. Else, Elytron will use the current authentication context of the caller that is retrieving the connection. Ex: <elytron-enabled/>

authentication-context?

[ Indicates the Elytron context that will be used for authenticating connections during container-managed sign-on. The resulting Subject will be used to distinguish connections in the pool. The authentication-context name correlates to the authentication context defined in the Elytron subsystem. Ex: <elytron-enabled/> <authentication-context>HsqlDbContext</authentication-context>

reauth-plugin?

NameTypeDefaultDescription
class-nametoken

config-property*

[ Specifies a Java bean property value

validation?

[ Specifies the validation settings

valid-connection-checker?

[ An org.jboss.jca.adapters.jdbc.ValidConnectionChecker that provides a SQLException isValidConnection(Connection e) method to validate is a connection is valid. An exception means the connection is destroyed. This overrides the check-valid-connection-sql when present. Ex: <valid-connection-checker class-name="org.jboss.jca.adapters.jdbc.vendor.OracleValidConnectionChecker"/>

NameTypeDefaultDescription
class-nametoken

config-property*

[ Specifies a Java bean property value

check-valid-connection-sql?

[ Specify an SQL statement to check validity of a pool connection. This may be called when managed connection is taken from pool for use.

validate-on-match?

[ The validate-on-match element indicates whether or not connection level validation should be done when a connection factory attempts to match a managed connection for a given set. This is typically exclusive to the use of background validation

background-validation?

[ An element to specify that connections should be validated on a background thread versus being validated prior to use

background-validation-millis?

[ The background-validation-millis element specifies the amount of time, in millis, that background validation will run.

use-fast-fail?

[ Whether fail a connection allocation on the first connection if it is invalid (true) or keep trying until the pool is exhausted of all potential connections (false) default false. e.g. <use-fast-fail>true</use-fast-fail>

stale-connection-checker?

[ An org.jboss.jca.adapters.jdbc.StaleConnectionChecker that provides a boolean isStaleConnection(SQLException e) method which if it it returns true will wrap the exception in an org.jboss.jca.adapters.jdbc.StaleConnectionException which is a subclass of SQLException. Ex: <stale-connection-checker class-name="org.jboss.jca.adapters.jdbc.vendor.OracleStaleConnectionChecker"/>

NameTypeDefaultDescription
class-nametoken

config-property*

[ Specifies a Java bean property value

exception-sorter?

[ An org.jboss.jca.adapters.jdbc.ExceptionSorter that provides a boolean isExceptionFatal(SQLException e) method to validate is an exception should be broadcast to all javax.resource.spi.ConnectionEventListener as a connectionErrorOccurred message. Ex: <exception-sorter class-name="org.jboss.jca.adapters.jdbc.vendor.OracleExceptionSorter"/>

NameTypeDefaultDescription
class-nametoken

config-property*

[ Specifies a Java bean property value

timeout?

[ Specifies the time out settings

blocking-timeout-millis?

[ The blocking-timeout-millis element indicates the maximum time in milliseconds to block while waiting for a connection before throwing an exception. Note that this blocks only while waiting for a permit for a connection, and will never throw an exception if creating a new connection takes an inordinately long time. The default is 30000 (30 seconds).

idle-timeout-minutes?

[ The idle-timeout-minutes elements indicates the maximum time in minutes a connection may be idle before being closed. The actual maximum time depends also on the IdleRemover scan time, which is 1/2 the smallest idle-timeout-minutes of any pool.

set-tx-query-timeout?

[ Whether to set the query timeout based on the time remaining until transaction timeout, any configured query timeout will be used if there is no transaction. The default is false. e.g. <set-tx-query-timeout/>

query-timeout?

[ Any configured query timeout in seconds The default is no timeout e.g. 5 minutes <query-timeout>300</query-timeout>

use-try-lock?

[ Any configured timeout for internal locks on the resource adapter objects in seconds The default is a 60 second timeout e.g. 5 minutes <use-try-lock>300</use-try-lock>

allocation-retry?

[ The allocation retry element indicates the number of times that allocating a connection should be tried before throwing an exception. The default is 0.

allocation-retry-wait-millis?

[ The allocation retry wait millis element indicates the time in milliseconds to wait between retrying to allocate a connection. The default is 5000 (5 seconds).

xa-resource-timeout?

[ Passed to XAResource.setTransactionTimeout() Default is zero which does not invoke the setter. In seconds e.g. 5 minutes <xa-resource-timeout>300</xa-resource-timeout>

statement?

[ Specifies the statement settings

track-statements?

[ Whether to check for unclosed statements when a connection is returned to the pool and result sets are closed when a statement is closed/return to the prepared statement cache. valid values are: false - do not track statements and results true - track statements and result sets and warn when they are not closed nowarn - track statements but do no warn about them being unclosed (the default) e.g. <track-statements>nowarn</track-statements>

prepared-statement-cache-size?

[ The number of prepared statements per connection in an LRU cache

share-prepared-statements?

[ Whether to share prepare statements, i.e. whether asking for same statement twice without closing uses the same underlying prepared statement. The default is false. e.g. <share-prepared-statements/>

xa-datasource

[ Specifies a XA datasource

xa-datasource-property+

[ Specifies a property to assign to the XADataSource implementation class. Each property is identified by the name attribute and the property value is given by the xa-datasource-property element content. The property is mapped onto the XADataSource implementation by looking for a JavaBeans style getter method for the property name. If found, the value of the property is set using the JavaBeans setter with the element text translated to the true property type using the java.beans.PropertyEditor for the type. Ex: <xa-datasource-property name="IfxWAITTIME">10</xa-datasource-property> <xa-datasource-property name="IfxIFXHOST">myhost.mydomain.com</xa-datasource-property> <xa-datasource-property name="PortNumber">1557</xa-datasource-property> <xa-datasource-property name="DatabaseName">mydb</xa-datasource-property> <xa-datasource-property name="ServerName">myserver</xa-datasource-property>

NameTypeDefaultDescription
nametoken

xa-datasource-class?

[ The fully qualifed name of the javax.sql.XADataSource implementation class. Ex: <xa-datasource-class>oracle.jdbc.xa.client.OracleXADataSource</xa-datasource-class>

driver?

[ An unique reference to the classloader module which contains the JDBC driver The accepted format is driverName#majorVersion.minorVersion

url-delimiter?

[ Specifies the delimeter for URLs in the connection url for HA datasources

url-selector-strategy-class-name?

[ A class that implements org.jboss.jca.adapters.jdbc.URLSelectorStrategy

new-connection-sql?

[ Specifies an SQL statement to execute whenever a connection is added to the connection pool.

transaction-isolation?

[ Set java.sql.Connection transaction isolation level to use. The constants defined by transaction-isolation-values are the possible transaction isolation levels and include: TRANSACTION_READ_UNCOMMITTED TRANSACTION_READ_COMMITTED TRANSACTION_REPEATABLE_READ TRANSACTION_SERIALIZABLE TRANSACTION_NONE

xa-pool?

[ Specifies the pooling settings

is-same-rm-override?

[ The is-same-rm-override element allows one to unconditionally set whether the javax.transaction.xa.XAResource.isSameRM(XAResource) returns true or false. Ex: <is-same-rm-override>true</is-same-rm-override>

interleaving?

[ An element to enable interleaving for XA connection factories Ex: <interleaving/>

no-tx-separate-pools?

[ Oracle does not like XA connections getting used both inside and outside a JTA transaction. To workaround the problem you can create separate sub-pools for the different contexts using <no-tx-separate-pools/> Ex: <no-tx-separate-pools/>

pad-xid?

[ Should the Xid be padded Ex: <pad-xid>true</pad-xid>

wrap-xa-resource?

[ Should the XAResource instances be wrapped in an org.jboss.tm.XAResourceWrapper instance Ex: <wrap-xa-resource>true</wrap-xa-resource>

min-pool-size?

[ The min-pool-size element indicates the minimum number of connections a pool should hold. These are not created until a Subject is known from a request for a connection. This default to 0. Ex: <min-pool-size>1</min-pool-size>

initial-pool-size?

[ The initial-pool-size element indicates the initial number of connections a pool should hold. This default to 0. Ex: <initial-pool-size>1</initial-pool-size>

max-pool-size?

[ The max-pool-size element indicates the maximum number of connections for a pool. No more connections will be created in each sub-pool. This defaults to 20.

prefill?

[ Whether to attempt to prefill the connection pool. Empty element denotes a true value. e.g. <prefill>true</prefill>. Default is false

fair?

[ Defines if pool use should be fair Default true

use-strict-min?

[ Define if the min-pool-size should be considered a strictly. Default false

flush-strategy?

[ Specifies how the pool should be flush in case of an error. Valid values are: FailingConnectionOnly (default), InvalidIdleConnections, IdleConnections, Gracefully, EntirePool, AllInvalidIdleConnections, AllIdleConnections, AllGracefully, AllConnections

allow-multiple-users?

[ Specifies if multiple users will access the datasource through the getConnection(user, password) method and hence if the internal pool type should account for that

capacity?

[ Specifies the capacity policies for the pool

incrementer?

[ Defines the policy for incrementing connections in the pool

NameTypeDefaultDescription
class-nametoken

config-property*

[ Specifies a Java bean property value

decrementer?

[ Defines the policy for decrementing connections in the pool

NameTypeDefaultDescription
class-nametoken

config-property*

[ Specifies a Java bean property value

connection-listener?

[ An org.jboss.jca.adapters.jdbc.spi.listener.ConnectionListener that provides a possible to listen for connection activation and passivation in order to perform actions before the connection is returned to the application or returned to the pool. Ex: <connection-listener class-name="com.acme.jdbc.OracleConnectionListener"/>

NameTypeDefaultDescription
class-nametoken

config-property*

[ Specifies a Java bean property value

security?

[ Specifies the security settings

user-name?

[ Specify the username used when creating a new connection. Ex: <user-name>sa</user-name>

password?

[ Specify the password used when creating a new connection. Ex: <password>sa-pass</password>

credential-reference?

Credential to be used by the configuration.

NameTypeDefaultDescription
clear-textstring Credential/password in clear text. Use just for testing purpose. Otherwise use credential store to mask the actual credential from your configuration.

security-domain?

[ Indicates Subject (from security domain) are used to distinguish connections in the pool. The content of the security-domain is the name of the JAAS security manager that will handle authentication. This name correlates to the JAAS login-config.xml descriptor application-policy/name attribute. Ex: <security-domain>HsqlDbRealm</security-domain>

elytron-enabled

[ Indicates that Elytron is responsible for authenticating connections. If authentication-context is configured (via authentication-context), Elytron will use the specified context for authenticating. Else, Elytron will use the current authentication context of the caller that is retrieving the connection. Ex: <elytron-enabled/>

authentication-context?

[ Indicates the Elytron context that will be used for authenticating connections during container-managed sign-on. The resulting Subject will be used to distinguish connections in the pool. The authentication-context name correlates to the authentication context defined in the Elytron subsystem. Ex: <elytron-enabled/> <authentication-context>HsqlDbContext</authentication-context>

reauth-plugin?

NameTypeDefaultDescription
class-nametoken

config-property*

[ Specifies a Java bean property value

validation?

[ Specifies the validation settings

valid-connection-checker?

[ An org.jboss.jca.adapters.jdbc.ValidConnectionChecker that provides a SQLException isValidConnection(Connection e) method to validate is a connection is valid. An exception means the connection is destroyed. This overrides the check-valid-connection-sql when present. Ex: <valid-connection-checker class-name="org.jboss.jca.adapters.jdbc.vendor.OracleValidConnectionChecker"/>

NameTypeDefaultDescription
class-nametoken

config-property*

[ Specifies a Java bean property value

check-valid-connection-sql?

[ Specify an SQL statement to check validity of a pool connection. This may be called when managed connection is taken from pool for use.

validate-on-match?

[ The validate-on-match element indicates whether or not connection level validation should be done when a connection factory attempts to match a managed connection for a given set. This is typically exclusive to the use of background validation

background-validation?

[ An element to specify that connections should be validated on a background thread versus being validated prior to use

background-validation-millis?

[ The background-validation-millis element specifies the amount of time, in millis, that background validation will run.

use-fast-fail?

[ Whether fail a connection allocation on the first connection if it is invalid (true) or keep trying until the pool is exhausted of all potential connections (false) default false. e.g. <use-fast-fail>true</use-fast-fail>

stale-connection-checker?

[ An org.jboss.jca.adapters.jdbc.StaleConnectionChecker that provides a boolean isStaleConnection(SQLException e) method which if it it returns true will wrap the exception in an org.jboss.jca.adapters.jdbc.StaleConnectionException which is a subclass of SQLException. Ex: <stale-connection-checker class-name="org.jboss.jca.adapters.jdbc.vendor.OracleStaleConnectionChecker"/>

NameTypeDefaultDescription
class-nametoken

config-property*

[ Specifies a Java bean property value

exception-sorter?

[ An org.jboss.jca.adapters.jdbc.ExceptionSorter that provides a boolean isExceptionFatal(SQLException e) method to validate is an exception should be broadcast to all javax.resource.spi.ConnectionEventListener as a connectionErrorOccurred message. Ex: <exception-sorter class-name="org.jboss.jca.adapters.jdbc.vendor.OracleExceptionSorter"/>

NameTypeDefaultDescription
class-nametoken

config-property*

[ Specifies a Java bean property value

timeout?

[ Specifies the time out settings

blocking-timeout-millis?

[ The blocking-timeout-millis element indicates the maximum time in milliseconds to block while waiting for a connection before throwing an exception. Note that this blocks only while waiting for a permit for a connection, and will never throw an exception if creating a new connection takes an inordinately long time. The default is 30000 (30 seconds).

idle-timeout-minutes?

[ The idle-timeout-minutes elements indicates the maximum time in minutes a connection may be idle before being closed. The actual maximum time depends also on the IdleRemover scan time, which is 1/2 the smallest idle-timeout-minutes of any pool.

set-tx-query-timeout?

[ Whether to set the query timeout based on the time remaining until transaction timeout, any configured query timeout will be used if there is no transaction. The default is false. e.g. <set-tx-query-timeout/>

query-timeout?

[ Any configured query timeout in seconds The default is no timeout e.g. 5 minutes <query-timeout>300</query-timeout>

use-try-lock?

[ Any configured timeout for internal locks on the resource adapter objects in seconds The default is a 60 second timeout e.g. 5 minutes <use-try-lock>300</use-try-lock>

allocation-retry?

[ The allocation retry element indicates the number of times that allocating a connection should be tried before throwing an exception. The default is 0.

allocation-retry-wait-millis?

[ The allocation retry wait millis element indicates the time in milliseconds to wait between retrying to allocate a connection. The default is 5000 (5 seconds).

xa-resource-timeout?

[ Passed to XAResource.setTransactionTimeout() Default is zero which does not invoke the setter. In seconds e.g. 5 minutes <xa-resource-timeout>300</xa-resource-timeout>

statement?

[ Specifies the statement settings

track-statements?

[ Whether to check for unclosed statements when a connection is returned to the pool and result sets are closed when a statement is closed/return to the prepared statement cache. valid values are: false - do not track statements and results true - track statements and result sets and warn when they are not closed nowarn - track statements but do no warn about them being unclosed (the default) e.g. <track-statements>nowarn</track-statements>

prepared-statement-cache-size?

[ The number of prepared statements per connection in an LRU cache

share-prepared-statements?

[ Whether to share prepare statements, i.e. whether asking for same statement twice without closing uses the same underlying prepared statement. The default is false. e.g. <share-prepared-statements/>

recovery?

NameTypeDefaultDescription
no-recoverybooleanfalse [ Specify if the xa-datasource should be excluded from recovery. Default false.

recover-credential?

[ Specifies the security options used when creating a connection during recovery. Note: if this credential are not specified the security credential are used for recover too

user-name?

[ Specify the username used when creating a new connection. Ex: <user-name>sa</user-name>

password?

[ Specify the password used when creating a new connection. Ex: <password>sa-pass</password>

credential-reference?

Credential to be used by the configuration.

NameTypeDefaultDescription
clear-textstring Credential/password in clear text. Use just for testing purpose. Otherwise use credential store to mask the actual credential from your configuration.

security-domain?

[ Indicates Subject (from security domain) are used to distinguish connections in the pool. The content of the security-domain is the name of the JAAS security manager that will handle authentication. This name correlates to the JAAS login-config.xml descriptor application-policy/name attribute. Ex: <security-domain>HsqlDbRealm</security-domain>

elytron-enabled

[ Indicates that Elytron is responsible for authenticating connections. If authentication-context is configured (via authentication-context), Elytron will use the specified context for authenticating. Else, Elytron will use the current authentication context of the caller that is retrieving the connection. Ex: <elytron-enabled/>

authentication-context?

[ Indicates the Elytron context that will be used for authenticating connections during container-managed sign-on. The resulting Subject will be used to distinguish connections in the pool. The authentication-context name correlates to the authentication context defined in the Elytron subsystem. Ex: <elytron-enabled/> <authentication-context>HsqlDbContext</authentication-context>

reauth-plugin?

NameTypeDefaultDescription
class-nametoken

config-property*

[ Specifies a Java bean property value

recover-plugin?

[ Specifies the extension plugin used in spi (core.spi.xa) which can be implemented by various plugins to provide better feedback to the XA recovery system.

NameTypeDefaultDescription
class-nametoken

config-property*

[ Specifies a Java bean property value

drivers?

driver+

NameTypeDefaultDescription
nametoken [ Specifies the symbolic name of this driver used to reference this driver
moduletoken [ Specifies the name of AS7 module providing this driver. This tag is not used in IronJacamar standalone container.
major-versionint [ Specifies the major version of this driver. If the major and minor versions are omitted the first available Driver in module will be used.
minor-versionint [ Specifies the minor version of this driver. If the major and minor versions are omitted the first available Driver in module will be used.

driver-class?

[ The fully qualifed name of the JDBC driver class Ex: <driver-class>org.hsqldb.jdbcDriver</driver-class>

xa-datasource-class?

[ The fully qualifed name of the javax.sql.XADataSource implementation class. Ex: <xa-datasource-class>oracle.jdbc.xa.client.OracleXADataSource</xa-datasource-class>

datasource-class?

[ The fully qualifed name of the javax.sql.DataSource implementation class.

Expand/Collapse All