Red Hat Training

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

3.3.5. JBoss AS 7 and EAP 6 - Datasources (Standalone) Service

Overview

Table 3.320. Overview

Description: Datasources subsystem for Standalone servers.
Singleton: yes
Plugin: JBossAS7

Child Resource Types

Connection Properties

Table 3.321. 

Name Description Required Internal Name
Path yes path

Note

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

Metrics

none

Configuration Properties

none

Operations

none

Package Types

none

3.3.5.1. JBoss AS 7 and EAP 6 - DataSource (Standalone) Service

Overview

Table 3.322. Overview

Description: A non-XA data source
Singleton: no
Plugin: JBossAS7
Child Resource Types
none
Connection Properties

Table 3.323. 

Name Description Required Internal Name
Path yes path

Note

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

Table 3.324. Metrics

Name Type Description Internal Name
Prepared Statement Cache Current Size measurement The number of prepared and callable statements currently cached in the statement cache PreparedStatementCacheCurrentSize
Prepared Statement Cache Miss Count measurement The number of times that a statement request could not be satisfied with a statement from the cache PreparedStatementCacheMissCount
Prepared Statement Cache Miss Count per Minute measurement The number of times that a statement request could not be satisfied with a statement from the cache PreparedStatementCacheMissCount
Prepared Statement Cache Add Count measurement The number of statements added to the statement cache PreparedStatementCacheAddCount
Prepared Statement Cache Access Count measurement The number of times that the statement cache was accessed PreparedStatementCacheAccessCount
Prepared Statement Cache Access Count per Minute measurement The number of times that the statement cache was accessed PreparedStatementCacheAccessCount
Prepared Statement Cache Delete Count measurement The number of statements discarded from the cache PreparedStatementCacheDeleteCount
Prepared Statement Cache Delete Count per Minute measurement The number of statements discarded from the cache PreparedStatementCacheDeleteCount
Prepared Statement Cache Hit Count measurement The number of times that statements from the cache were used PreparedStatementCacheHitCount
Prepared Statement Cache Hit Count per Minute measurement The number of times that statements from the cache were used PreparedStatementCacheHitCount
Active Count measurement The active count ActiveCount
Available Count measurement The available count AvailableCount
Average Blocking Time measurement The average time spent blocking for a connection AverageBlockingTime
Average Creation Time measurement The average time spent creating a physical connection AverageCreationTime
Created Count measurement The created count CreatedCount
Created Count per Minute measurement The created count CreatedCount
Destroyed Count measurement The destroyed count DestroyedCount
Destroyed Count per Minute measurement The destroyed count DestroyedCount
Max Creation Time measurement The maximum time for creating a physical connection MaxCreationTime
Max Used Count measurement The maximum number of connections used MaxUsedCount
Max Wait Time measurement The maximum wait time for a connection MaxWaitTime
Timed Out measurement The timed out count TimedOut
Timed Out per Minute measurement The timed out count TimedOut
Total Creation Time measurement The total time spent creating physical connections TotalCreationTime
Total Creation Time per Minute measurement The total time spent creating physical connections TotalCreationTime
Total Blocking Time measurement The total blocking time TotalBlockingTime
Total Blocking Time per Minute measurement The total blocking time TotalBlockingTime
Connection Available? trait Connection Available? connectionAvailable
Min Pool Size setting measurement The min pool size setting min-pool-size
Max Pool Size setting measurement The max pool size setting max-pool-size

Note

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

Table 3.325. 

Name Description Required Internal Name
Connection Property no *1
Connection Url The JDBC driver connection URL yes connection-url
Driver Name Name of the (existing) JDBC driver to use yes driver-name
Driver Class The fully qualified name of the JDBC driver class no driver-class
Jndi Name Specifies the JNDI name for the datasource yes jndi-name
Driver Defines the JDBC driver the datasource should use with this format: driver-name>#major-version.minor-version where driver-name is the fully qualified name of the JDBC driver class no driver
User Name Specify the username used when creating a new connection. no user-name
Password Specify the password used when creating a new connection. no password
New Connection Sql Specifies an SQL statement to execute whenever a connection is added to the connection pool. no new-connection-sql
Url Delimiter Specifies the delimiter for URLs in connection-url for HA datasources no url-delimiter
Url Selector Strategy Class Name A class that implements org.jboss.jca.adapters.jdbc.URLSelectorStrategy no url-selector-strategy-class-name
Use Java Context Setting this to false will bind the DataSource into global JNDI; no use-java-context
Enabled Specifies if the datasource should be enabled no enabled
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. no max-pool-size
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. no min-pool-size
Pool Prefill Whether to attempt to prefill the connection pool. Changing this value require a server restart. no pool-prefill
Pool Use Strict Min Define if the min-pool-size should be considered a strictly. no pool-use-strict-min
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 handleauthentication. This name correlates to the JAAS login-config.xml descriptor application-policy/name attribute. no security-domain
Reauth Plugin Class Name re-authentication plugin implementation provided for specific purpose (i.e vendor) no reauth-plugin-class-name
Flush Strategy Specifies how the pool should be flush in case of an error. no flush-strategy
Prepared Statements Cache Size The number of prepared statements per connection in an LRU cache no prepared-statements-cacheSize
Share Prepared Statements Whether to share prepare statements, i.e. whether asking for same statement twice without closing uses the same underlying prepared statement no share-prepared-statements
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 no track-statements
Allocation Retry The allocation retry element indicates the number of times that allocating a connection should be tried before throwing an exception. no allocation-retry
Allocation Retry Wait Millis Indicates the time in milliseconds to wait between retrying to allocate a connection. no allocation-retry-wait-millis
Blocking Timeout Wait 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. no blocking-timeout-wait-millis
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. Changing this value require a server restart. no idle-timeout-minutes
Query Timeout Any configured query timeout in seconds The default is no timeout no query-timeout
Use Try Lock Any configured timeout for internal locks on the resource adapter objects in seconds no use-try-lock
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. no set-tx-query-timeout
Transaction Isolation Set java.sql.Connection transaction isolation level to use. The constants defined by transaction-isolation-values are the possible transaction isolation levels. no transaction-isolation
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. no check-valid-connection-sql
Exception Sorter Class Name 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 no exception-sorter-class-name
Stale Connection Checker Class Name 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 no stale-connection-checker-class-name
Valid Connection Checker Class Name 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. no valid-connection-checker-class-name
Background Validation Minutes The background-validation-minutes element specifies the amount of time, in minutes, that background validation will run. Changing this value require a server restart. no background-validation-minutes
Background Validation An element to specify that connections should be validated on a background thread versus being validated prior to use. Changing this value require a server restart. no background-validation
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) no use-fast-fail
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 no validate-on-match
Spy whatever spy or not the jdbc connection no spy
Use Ccm Enable the use of a cached connection manager no use-ccm

Note

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

Table 3.326. Metrics

Name Description
Enable Enables the data-source
Disable Disables the data-source
Flush All Connection In Pool Flushes the pool for all connections
Flush Idle Connection In Pool Flushes the pool for idle connections
Test Connection In Pool Tests if a connection can be obtained
Package Types
none