JBoss Community Archive (Read Only)

RHQ 4.9

JBossAS - Datasource Service

Overview

Internal Name:

Datasource

Description:

 

Singleton:

no

Plugin:

JBossAS

Connection Settings

Name

Description

Required

Internal Name

Object Name

 

yes

objectName

Name Template

 

yes

nameTemplate

Description Template

 

yes

descriptionTemplate

Name

The name of this datasource

yes

name

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

Metrics

Name

Type

Description

Internal Name

Total Connections

measurement

Total Number of Connections for the Connection Pool, both active and in-active.

ConnectionCount

Available Connections

measurement

Number of available connections in the connection pool in-active and waiting.

AvailableConnectionCount

Active Connections

measurement

Number of Connections currently supporting clients.

InUseConnectionCount

Connections Created

measurement

Number of Connections created since the Connection Pool was created.

ConnectionCreatedCount

Connections Created per Minute

measurement

Number of Connections created since the Connection Pool was created.

ConnectionCreatedCount

Connections Destroyed

measurement

Number of Connections destroyed since the Connection Pool was created.

ConnectionDestroyedCount

Connections Destroyed per Minute

measurement

Number of Connections destroyed since the Connection Pool was created.

ConnectionDestroyedCount

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

Configuration Properties

Name

Description

Required

Internal Name

Type

 

yes

type

JNDI Name

The JNDI name under which the DataSource wrapper will be bound.

yes

jndi-name

Driver Class

The fully qualified name of the JDBC driver or datasource class. Not used for XA-Datasources

no

driver-class

Connection Url

The JDBC driver connection URL string. Needed for Tx and Non-Tx datasources

no

connection-url

User Name

 

no

user-name

Password

 

no

password

Min Pool Size

 

no

min-pool-size

Max Pool Size

 

no

max-pool-size

Transaction Isolation

The Transaction Isolation level. The default setting is to use whichever isolation level is provided by default by the database.

no

transaction-isolation

Blocking Timeout Millis

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. If nothing is specified the default of 30000 milliseconds is used.

no

blocking-timeout-millis

Idle Timeout Minutes

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. If nothing is specified the default of 15 minutes is used.

no

idle-timeout-minutes

Prepared Statement Cache Size

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

no

prepared-statement-cache-size

Valid Connection Checker Class Name

An org.jboss.resource.adapter.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

Use Java Context

Indicates if the JNDI name should be prefixed with java: which causes the DataSource to only be accessible from within the JBoss server vm. The default is Yes.

no

use-java-context

Security Domain

Indicates Subjects (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. Must be specified if either Container Based or Container and Application Based authentication types are specified.

no

security-domain

New Connection Sql

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

no

new-connection-sql

Exception Sorter Class Name

An org.jboss.resource.adapter.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.

no

exception-sorter-class-name

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

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/returned to the prepared statement cache. The default is Yes, but no warnings.

no

track-statements

Xa Datasource Class

The datasource class for XA connections.

no

xa-datasource-class

Connection Property

 

no

connection-property

No Tx Separate Pools

Whether to use separate pools for connections retrieved in a transaction and those retrieved outside a transaction. The default is Yes.

no

no-tx-separate-pools

Application Managed Security

 

no

application-managed-security

Security Domain and Application

 

no

security-domain-and-application

Track Connection By Tx

Whether the connection should be "locked" to the transaction, returning it to the pool at the end of the transaction. The default is No.

no

track-connection-by-tx

Is Same RM Override Value

Allows one to unconditionally set whether the javax.transaction.xa.XAResource.isSameRM(XAResource) returns true or false. The default is not to override the return value.

no

isSameRM-override-value

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

Operations

Name

Description

Flush

Resets the connection pool for this datasource. Performs the following steps: 1) all idle connections are immediately closed, 2) any in use connections are closed when the application finishes with them, and 3) new connections are created.

JBoss.org Content Archive (Read Only), exported from JBoss Community Documentation Editor at 2020-03-13 08:24:25 UTC, last content change 2013-09-18 19:43:07 UTC.