Red Hat Training
A Red Hat training course is available for Red Hat JBoss Operations Network
3.2. Red Hat JBoss Enterprise Application Platform 5.x (EAP 5) and JBoss Application Server 5.x/6.x Plugin
Table 3.89. Basic Details
| Internal Name: | JBossAS5 |
| Description: | provides management and monitoring of JBoss AS 6.x and JBoss EAP/EWP/SOA-P 5.x |
| Version: | 4.4.0 |
Top-Level Resource Types
3.2.1. JBossAS5 - JBossAS Server
Overview
Table 3.90. Overview
| Description: | JBoss Application Server (AS), Enterprise Application Platform (EAP), Enterprise SOA Platform (SOA-P), or Enterprise Web Platform (EWP) 5.x or 6.x instance |
| Singleton: | no |
| Plugin: | JBossAS5 |
Note
The server can be started, restarted, or stopped via the Start, Restart, and Shutdown operations. The Start and Restart operations start the server by executing the server start script, typically run.sh on UNIX or run.bat on Windows. The following connection settings can be used to configure the start script execution: * Start Script - the absolute path of the start script (e.g. "/opt/jboss-eap-5.0/jboss-as/bin/run.sh") * Script Prefix - a prefix command line to be prepended to the start script command line (e.g. "nohup sudo -u jboss -g jboss") the prefix is also prepsended to the stop script command line if the Stop operation is configured to stop the app server via script. * Start Script Arguments - arguments to be passed to the start script (e.g. "--configuration=production") * Start Script Environment - environment variables to be set in the start script's environment (e.g. "JAVA_HOME=/usr/java/jdk1.6.0_30") These settings are automatically initialized by the JBossAS5 plugin discovery code to match the currently running server process' command line and environment. For more detailed descriptions of the settings, see the Connection Settings section below.
Child Resource Types
Autodiscovery Process Scans
Table 3.91. Metrics
| Name | Query |
|---|---|
| jbossas | process|basename|match=^java.*,arg|org.jboss.Main|match=.* |
Connection Properties
Table 3.92.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Naming Provider URL | The JBoss Naming Provider (JNP) URL with which to connect to the JBoss AS or EAP instance (e.g. jnp://127.0.0.1:1099). | yes | namingURL |
| Principal | The name of the principal (i.e. user) to authenticate. | no | principal |
| Credentials | The credentials (i.e. password) that should be used to authenticate the principal. | no | credentials |
| JBoss Home Directory | The absolute path to the directory where JBoss AS or EAP is installed (e.g. /opt/jboss-5.1.0.GA). | yes | homeDir |
| Server Home Dir | The path to the configuration directory under which this instance operates (e.g. /opt/jboss-5.2.0.GA/server/default); if the path is not absolute, then it will be resolved relative to {homeDir}. | yes | serverHomeDir |
| Server Name | The name of the server configuration (e.g. minimal, default, or all); if not specified, it will default to the last path component of {serverHomeDir}. If the 'startScriptArgs' property is not set, this property will be used by the Start and Restart operations as the value of the -c option that is passed to the start script. However, this property is deprecated for that purpose and 'startScriptArgs' should be used instead. | no | serverName |
| Client Url | The URL of the server's client JAR library directory; if not specified, it will default to {homeDir}/client. | no | clientUrl |
| Lib Url | The URL of the server's main JAR library directory; if not specified, it will default to {homeDir}/lib. | no | libUrl |
| Common Lib Url | The URL of the server's common JAR library directory; if not specified, it will default to {homeDir}/common/lib. | no | commonLibUrl |
| Script Prefix | A prefix applied to script execution commands; this prefix is applied verbatim. The full path of the executable is required (e.g. /usr/bin/sudo). For applicable platforms, this is typically a sudo command, so a sudo user must be configured appropriately for the specified command. Ignored if not set. | no | scriptPrefix |
| Start Script | The path to the script used by the 'Start' operation to start this JBossAS server (e.g. /opt/jboss-5.2.0.GA/bin/run.sh); if the path is not absolute, then it will be resolved relative to {jbossHomeDir}; defaults to 'bin/run.sh' on UNIX or 'bin\run.bat' on Windows. | no | startScript |
| Start Script Environment Variables | The variables that the Start and Restart operations will add to the environment of the server start script. Each name=value pair should be on a new line. Variable values should *not* be enclosed in quotes (e.g. JAVA_OPTS=-Xms512M -Xmx1024M). On UNIX systems, the typical minimum set of environment variables is: PATH=/usr/bin:/bin . And on Windows the typical minimum set is: PATH=C:\Windows\System32;C:\Windows , OS=Windows_NT , SYSTEMROOT=C:\Windows . In addition, it is good practice to set JAVA_HOME to the absolute path of the install directory of the JRE or JDK you wish to use to run the AS7 instance. However, if JAVA_HOME is not specified, the start script will attempt to find java in the PATH. There is currently a 2000 character limit for this value. | no | startScriptEnv |
| Start Script Arguments | The arguments that the Start and Restart operations will pass to the server start script. Each argument should be on a new line - for example: --server-config=standalone-ha-full.xml. As an exception, the value of a space-delimited option can optionally be on the same line as the option - for example: -c default. There is currently a 2000 character limit for this value. | no | startScriptArgs |
| Shutdown Script | The path to the script used by the Shut Down operation to shut down this JBossAS server (e.g. /opt/jboss-5.2.0.GA/bin/shutdown.sh); if the path is not absolute, then it will be resolved relative to {jbossHomeDir}; defaults to 'bin/shutdown.sh' on UNIX or 'bin\shutdown.bat' on Windows. | no | shutdownScript |
| Shutdown Method | The method used to execute the Shut Down operation; defaults to 'JMX MBean'. 'JMX MBean' is the preferred shutdown method and should be used unless there is a specific use case for using a script. | no | shutdownMethod |
| Bind Address | The host or IP address that all application server services should listen on (e.g. 10.11.14.233 or foo.example.com); specify 0.0.0.0 to tell the application server to bind to all available network interfaces; defaults to '127.0.0.1'. If the 'startScriptArgs' property is not set, this property will be used by the Start and Restart operations as the value of the -b option that is passed to the start script. However, this property is deprecated for that purpose and 'startScriptArgs' should be used instead. | no | bindAddress |
| Java Home | The absolute path to a JRE or JDK installation directory containing the JVM that should be used by the operations that start and/or shut down this JBoss AS server; for the Shutdown operation to work when the shutdown method is set to 'shutdown script', the property must be set. For the Start operation, this property is deprecated and will be ignored if the 'startScriptEnv' property is set. | no | javaHome |
| Start Wait Max | The time, in minutes,(e.g. 1 or 8) that must elapse before the server is considered to have failed to start up. The default is 5 minutes. | no | startWaitMax |
| Stop Wait Max | The time, in minutes,(e.g. 1 or 8) that must elapse before the server is considered to have failed to stop. The default is 2.5 minutes. | no | stopWaitMax |
| Shutdown MBean Name | Name of the MBean to use when shutting down this server through JMX. | yes | shutdownMBeanName |
| Shutdown MBean Operation | Name of the operation to invoke when shutting down this server through JMX. Note that only operations with no parameter or with one int parameter are supported. If the operation requires an int parameter, '0' will be supplied. | yes | shutdownMBeanOperation |
| Service Availability Refresh Interval | The amount of time, in minutes, that can elapse for service resource (e.g., EJBs, data sources) availability checks without having to refresh the managed object from the JBoss server. The information used to perform availability checks is cached. This property determines how frequently that data needs to be reloaded from the JBoss server. Any time the managed object is loaded from the server, like for collecting metrics, the availability information is updated and the interval is reset. | no | serviceAvailabilityRefreshInterval |
| JBoss AS JVM Name | The name of the JBoss AS JVM resource. | no | childJmxServerName |
| Log Event Sources | yes | logEventSources |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.93. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Cluster Partition Name | trait | the name of the cluster partition this server belongs to | MCBean|ServerConfig|*|partitionName |
| Server Name | trait | the name of the active profile (i.e. configuration set) this server is using | MCBean|ServerConfig|*|serverName |
| Server Home Dir | trait | the full path of the configuration set directory this server is using (e.g. /opt/jboss-5.1.0.CR1/server/default) | MCBean|ServerConfig|*|serverHomeDir |
| Version Name | trait | the code name for this app server's version (AS 5.0 = Morpheus, AS 5.1 = The Oracle, AS 6.x = Neo) | MCBean|MCServer|*|versionName |
| Build Date | trait | the date this app server was built | MCBean|MCServer|*|buildDate |
| Start Date | trait | the date and time this app server instance was started | MCBean|MCServer|*|startDate |
| Active Thread Count | measurement | The current number of active threads for this app server instance | MCBean|ServerInfo|*|activeThreadCount |
| Active Thread Group Count | measurement | The current number of active thread groups for this app server instance | MCBean|ServerInfo|*|activeThreadGroupCount |
| JVM Free Memory | measurement | An approximation of the total amount of memory currently available in the app server JVM for future allocated objects, measured in bytes | MCBean|ServerInfo|*|freeMemory |
| JVM Max Memory | measurement | The maximum amount of memory that the app server JVM will attempt to use, measured in bytes; if there is no inherent limit then the value Long.MAX_VALUE will be returned | MCBean|ServerInfo|*|maxMemory |
| JVM Total Memory | measurement | The total amount of memory currently available in the app server JVM for current and future objects, measured in bytes | MCBean|ServerInfo|*|totalMemory |
| Total Transactions | measurement | Total number of transactions since last restart | MCBean|JTA|*|transactionCount |
| Total Transactions per Minute | measurement | Total number of transactions since last restart | MCBean|JTA|*|transactionCount |
| Transactions Committed | measurement | Number of transactions committed since last restart | MCBean|JTA|*|commitCount |
| Transactions Committed per Minute | measurement | Number of transactions committed since last restart | MCBean|JTA|*|commitCount |
| Transactions Rolled Back | measurement | Number of transactions rolled back since last restart | MCBean|JTA|*|rollbackCount |
| Transactions Rolled Back per Minute | measurement | Number of transactions rolled back since last restart | MCBean|JTA|*|rollbackCount |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
Table 3.94. Metrics
| Name | Description |
|---|---|
| Start | Start this application server. The script used is specified in the Operations group of connection properties. This operation will fail if the server is already started. |
| Shut Down | Shut down this application server via script or JMX, depending on the settings in the Operations and Advanced groups of connection properties. This operation will fail if the server is already shut down. |
| Restart | Shut down (if started) and then start this application server. |
Package Types
Table 3.95. Package Types
| Name | Category | Description |
|---|---|---|
| Cumulative Patch | Deployable | Automatically installable application server patches |
| JAR Library | Deployable | Library Jar files deployed in JBoss AS |
3.2.1.1. JBossAS5 - JBoss Web Service
Overview
Table 3.96. Overview
| Description: | JBoss Web Servlet Container |
| Singleton: | yes |
| Plugin: | JBossAS5 |
Child Resource Types
Connection Properties
none
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.2.1.1.1. JBossAS5 - Connector Service
Overview
Table 3.97. Overview
| Description: | a JBoss Web Connector |
| Singleton: | no |
| Plugin: | JBossAS5 |
Child Resource Types
none
Connection Properties
Table 3.98.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Component Type | yes | componentType | |
| Component Subtype | yes | componentSubtype | |
| Component Name | yes | componentName | |
| Protocol | this connector's protocol (e.g. jk, ajp, http) | yes | protocol |
| Address | the IP address this connector listens on | yes | address |
| Port | the port this connector listens on | yes | port |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.99. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Maximum Request Time | measurement | the maximum time it took to process a request since the last restart | maxTime |
| Request Count | measurement | the total number of requests processed since the last restart | requestCount |
| Request Count per Minute | measurement | the total number of requests processed since the last restart | requestCount |
| Error Count | measurement | the number of errors while processing requests since the last restart | errorCount |
| Error Count per Minute | measurement | the number of errors while processing requests since the last restart | errorCount |
| Current Active Threads | measurement | the number of threads for this connector that are currently active | ThreadPool|currentThreadsBusy |
| Current Thread Count | measurement | the number of threads for this connector that currently exist | ThreadPool|currentThreadCount |
| Maximum Threads | trait | Maximum number of threads that can be allocated for the thread pool of this connector | ThreadPool|maxThreads |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
3.2.1.1.2. JBossAS5 - Virtual Host Service
Overview
Table 3.100. Overview
| Description: | a JBoss Web virtual host |
| Singleton: | no |
| Plugin: | JBossAS5 |
Child Resource Types
none
Connection Properties
Table 3.101.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Component Type | yes | componentType | |
| Component Subtype | yes | componentSubtype | |
| Component Name | yes | componentName | |
| Name | the virtual host's name (e.g. localhost) | yes | name |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.102. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Aliases | trait | the aliases for this virtual host, if any | aliases |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
3.2.1.2. JBossAS5 - No Tx Datasource Service
Overview
Table 3.103. Overview
| Description: | No Transaction Datasources deployed in the instance of JBoss AS |
| Singleton: | no |
| Plugin: | JBossAS5 |
Child Resource Types
none
Connection Properties
Table 3.104.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Component Type | yes | componentType | |
| Component Subtype | yes | componentSubtype | |
| Component Name | yes | componentName | |
| Template Name | yes | templateName | |
| Component Name Property | The name of the Resource configuration property whose value should be used as the ManagedComponent name when creating a new Resource of this type. | yes | componentNameProperty |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.105. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Run State | trait | Run State | runState |
| Connection Available? | trait | could a connection to the underlying data provider be obtained? Please see the documentation before enabling this metric | custom.connectionAvailable |
| Pool JNDI Name | trait | the JNDI name of the connection pool for this datasource | poolJndiName |
| Available Connection Count | measurement | the maximum number of connections that are available | availableConnectionCount |
| Connection Count | measurement | the number of connections that are currently in the pool | connectionCount |
| Connection Created Count | measurement | the number of connections that have been created since the datasource was last started | connectionCreatedCount |
| Connection Destroyed Count | measurement | the number of connections that have been destroyed since the datasource was last started | connectionDestroyedCount |
| In Use Connection Count | measurement | the number of connections that are currently in use | inUseConnectionCount |
| Local Transaction | trait | Local Transaction | local-transaction |
| Max Connections In Use Count | measurement | the most connections that have been simultaneously in use since this datasource was started | maxConnectionsInUseCount |
| Max Size | measurement | Max Size | maxSize |
| Min Size | measurement | Min Size | minSize |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.106.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| JNDI Name | The global JNDI Name under which to bind the datasource | yes | jndi-name |
| Username | The default username when creating a new connection. | no | user-name |
| Password | The default password when creating a new connection. | no | password |
| Minimum Pool Size | The minimum number of connections the pool should hold. The default is 0. | no | min-pool-size |
| Maximum Pool Size | The maximum number of connections the pool should hold. The default is 10. | no | max-pool-size |
| JDBC Driver Class | The fully qualified name of the JDBC driver class (e.g. "oracle.jdbc.driver.OracleDriver"). | yes | driver-class |
| Connection URL | The JDBC URL for the database (e.g. "jdbc:oracle:thin:@host.example.com:1521:db"). To define a high availablity (HA) datasource, specify a list of URLs separated by URL delimiters (e.g. "jdbc:oracle:thin:@host1.example.com:1521:db1|jdbc:oracle:thin:@host2.example.com:1521:db2"). | yes | connection-url |
| Connection Properties | Arbitrary connection properties that should be passed to the java.sql.Driver.connect(url, props) method. | no | connection-properties |
| Allocation Retry | The number of times that allocating a connection should be tried before throwing an exception. The default is 0. | no | allocation-retry |
| Allocation Retry Wait Millis | The time in milliseconds to wait between retrying to allocate a connection. The default is 5000 (5 seconds). | no | allocation-retry-wait-millis |
| Background Validation | Specify if connections should be validated on a background thread versus being validated prior to use. Background validation is meant to reduce the overall load on the RDBMS system when validating a connection. The default is No. | no | background-validation |
| Background Validation Millis | The interval, in milliseconds, at which the ConnectionValidator will run. Set to 0 to disable background validation. The default is 0. | no | background-validation-millis |
| Blocking Timeout in Milliseconds | 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). | no | blocking-timeout-millis |
| Idle Timeout | The maximum time, in minutes, a connection may be idle before being closed. The default is 30. | no | idle-timeout-minutes |
| Is Same RM Override Value | If set, unconditionally sets the boolean return value of javax.transaction.xa.XAResource.isSameRM(XAResource). | no | isSameRM-override-value |
| Jmx Invoker Name | The ObjectName of the JMX Invoker MBean associated with this datasource. | no | jmx-invoker-name |
| Metadata | Metadata properties. | no | metadata |
| No Tx Separate Pools | If true, the datasource cannot reuse a connection outside a transaction once enlisted in a global transaction and vice-versa. The default is Yes. | no | no-tx-separate-pools |
| Prefill | Whether to attempt to prefill the connection pool to the minimum number of connections. NOTE: Only supporting pools (OnePool) support this feature. A warning can be found in the logs if the pool does not support this. The default is No. | no | prefill |
| Security Settings | Security settings for connections in the pool. | no | security-domain |
| Statistics Formatter | The fully qualified class name of the class to use for formatting managed connection pool statistics for this datasource. The class must implement the org.jboss.resource.statistic.formatter.StatisticsFormatter. interface. The default is "org.jboss.resource.statistic.pool.JBossDefaultSubPoolStatisticFormatter". | no | statistics-formatter |
| Type Mapping | The name of the corresponding type-mapping in conf/standardjbosscmp-jdbc.xml. The type mappings provided by default: DB2, InformixDB, MaxDB, mySQL, Oracle9i, PointBase, InterBase, Mimer SQL, McKoi, SapDB, DB2/400, SOLID, Hypersonic SQL, FirstSQL/J, MS SQLSERVER2000, MS SQLSERVER, Cloudscape, Derby, Firebird, PostgreSQL 8.0, PostgreSQL, Sybase, Ingres. Note, there may be custom type mappings defined in addition to these predefined mappings. | no | type-mapping |
| Use Java Context | Indicates whether the JNDI name should be bound under the "java" context, which causes the DataSource to only be accessible from within the JBossAS VM. The default is Yes. | no | use-java-context |
| Use Strict Min | Whether idle connections below the min-pool-size should be closed. The default is No. | no | use-strict-min |
| 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. The default is Yes. | no | validate-on-match |
| Check Valid Connection SQL | The SQL statement to use to check the validity of a pool connection. | no | check-valid-connection-sql |
| Connection Definition | The connection definition inside the RAR deployment uniquely identified by the connection factory interface, e.g. "javax.sql.DataSource". | no | connection-definition |
| Exception Sorter Class Name | The fully qualified name of a Java class implementing the org.jboss.resource.adapter.jdbc.ExceptionSorter interface that should be used to check if a JDBC exception should be broadcast. | no | exception-sorter-class-name |
| New Connection SQL | An SQL statement to execute whenever a new connection is added to the pool; this can be used to set the connection schema, etc. | no | new-connection-sql |
| Prepared Statement Cache Size | The number of prepared statements per connection to be kept open and reused in subsequent requests. They are stored in an LRU cache. Set to 0 to disable the cache. The default is 0. | no | prepared-statement-cache-size |
| Query Timeout | Any configured query timeout in seconds. A value of 0 means no timeout. The default is 0. | no | query-timeout |
| Rar Name | The RAR deployment to associate with the connection manager MBean. e.g. jms-ra.rar or myapplication.ear#my.rar for nested rars. | no | rar-name |
| 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 No. | no | set-tx-query-timeout |
| Share Prepared Statements | Should prepared statements be shared? The default is No. | no | share-prepared-statements |
| Stale Connection Checker Class Name | Fully qualified name of the Java class used to check if a connection has become stale. | no | stale-connection-checker-class-name |
| Track Statements | Whether to check for unclosed Statements and ResultSets when connections are returned to the pool. The default is "yes-no-warnings". | no | track-statements |
| 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 |
| Url Delimiter | Specifies the delimiter for URLs in the value of the connection-url property for HA datasources. The default is "|". | no | url-delimiter |
| Url Selector Strategy Class Name | The fully qualified class name of a Java class implementing the org.jboss.resource.adapter.jdbc.URLSelectorStrategy interface. | no | url-selector-strategy-class-name |
| Use Try Lock | Any configured timeout, in milliseconds, for internal locks on the resource adapter objects. A value of 0 means no timeout. The default is 0. | no | use-try-lock |
| Valid Connection Checker Class Name | The fully qualified name of a Java class implementing the org.jboss.resource.adapter.jdbc.ValidConnectionChecker whose pingDatabase method should be used to check if a connection is still valid before handing it out from the pool. | no | valid-connection-checker-class-name |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.107. Metrics
| Name | Description |
|---|---|
| Flush | Flush the connections in the pool |
| List Formatted Sub Pool Statistics | Obtain a formatted sub pool statistics report |
| List Statistics | Obtain a statistics report |
| Test Connection | Test if a connection can be obtained - returns true if a connection was obtained, or false if not; NOTE: this operation will always return a status of Successful - the results of the operation must be inspected to see whether or not a connection was obtained |
Package Types
none
3.2.1.3. JBossAS5 - Local Tx Datasource Service
Overview
Table 3.108. Overview
| Description: | Local Transaction Datasources deployed in the instance of JBoss AS |
| Singleton: | no |
| Plugin: | JBossAS5 |
Child Resource Types
none
Connection Properties
Table 3.109.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Component Type | yes | componentType | |
| Component Subtype | yes | componentSubtype | |
| Component Name | yes | componentName | |
| Template Name | yes | templateName | |
| Component Name Property | The name of the Resource configuration property whose value should be used as the underlying ManagedComponent name when creating a new Resource of this type. | yes | componentNameProperty |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.110. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Run State | trait | Run State | runState |
| Connection Available? | trait | could a connection to the underlying data provider be obtained? Please see the documentation before enabling this metric | custom.connectionAvailable |
| Pool JNDI Name | trait | the JNDI name of the connection pool for this datasource | poolJndiName |
| Available Connection Count | measurement | the maximum number of connections that are available | availableConnectionCount |
| Connection Count | measurement | the number of connections that are currently in the pool | connectionCount |
| Connection Created Count | measurement | the number of connections that have been created since the datasource was last started | connectionCreatedCount |
| Connection Destroyed Count | measurement | the number of connections that have been destroyed since the datasource was last started | connectionDestroyedCount |
| In Use Connection Count | measurement | the number of connections that are currently in use | inUseConnectionCount |
| Local Transaction | trait | Local Transaction | local-transaction |
| Max Connections In Use Count | measurement | the most connections that have been simultaneously in use since this datasource was started | maxConnectionsInUseCount |
| Max Size | measurement | Max Size | maxSize |
| Min Size | measurement | Min Size | minSize |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.111.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| JNDI Name | The global JNDI Name under which to bind the datasource | yes | jndi-name |
| Username | The default username when creating a new connection. | no | user-name |
| Password | The default password when creating a new connection. | no | password |
| Minimum Pool Size | The minimum number of connections the pool should hold. The default is 0. | no | min-pool-size |
| Maximum Pool Size | The maximum number of connections the pool should hold. The default is 10. | no | max-pool-size |
| JDBC Driver Class | The fully qualified name of the JDBC driver class (e.g. "oracle.jdbc.driver.OracleDriver"). | yes | driver-class |
| Connection URL | The JDBC URL for the database (e.g. "jdbc:oracle:thin:@host.example.com:1521:db"). To define a high availablity (HA) datasource, specify a list of URLs separated by URL delimiters (e.g. "jdbc:oracle:thin:@host1.example.com:1521:db1|jdbc:oracle:thin:@host2.example.com:1521:db2"). | yes | connection-url |
| Connection Properties | Arbitrary connection properties that should be passed to the java.sql.Driver.connect(url, props) method. | no | connection-properties |
| Allocation Retry | The number of times that allocating a connection should be tried before throwing an exception. The default is 0. | no | allocation-retry |
| Allocation Retry Wait Millis | The time in milliseconds to wait between retrying to allocate a connection. The default is 5000 (5 seconds). | no | allocation-retry-wait-millis |
| Background Validation | Specify if connections should be validated on a background thread versus being validated prior to use. Background validation is meant to reduce the overall load on the RDBMS system when validating a connection. The default is No. | no | background-validation |
| Background Validation Millis | The interval, in milliseconds, at which the ConnectionValidator will run. Set to 0 to disable background validation. The default is 0. | no | background-validation-millis |
| Blocking Timeout in Milliseconds | 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). | no | blocking-timeout-millis |
| Idle Timeout | The maximum time, in minutes, a connection may be idle before being closed. The default is 30. | no | idle-timeout-minutes |
| Is Same RM Override Value | If set, unconditionally sets the boolean return value of javax.transaction.xa.XAResource.isSameRM(XAResource). | no | isSameRM-override-value |
| Jmx Invoker Name | The ObjectName of the JMX Invoker MBean associated with this datasource. | no | jmx-invoker-name |
| Metadata | Metadata properties. | no | metadata |
| No Tx Separate Pools | If true, the datasource cannot reuse a connection outside a transaction once enlisted in a global transaction and vice-versa. The default is Yes. | no | no-tx-separate-pools |
| Prefill | Whether to attempt to prefill the connection pool to the minimum number of connections. NOTE: Only supporting pools (OnePool) support this feature. A warning can be found in the logs if the pool does not support this. The default is No. | no | prefill |
| Security Settings | Security settings for connections in the pool. | no | security-domain |
| Statistics Formatter | The fully qualified class name of the class to use for formatting managed connection pool statistics for this datasource. The class must implement the org.jboss.resource.statistic.formatter.StatisticsFormatter. interface. The default is "org.jboss.resource.statistic.pool.JBossDefaultSubPoolStatisticFormatter". | no | statistics-formatter |
| Type Mapping | The name of the corresponding type-mapping in conf/standardjbosscmp-jdbc.xml. The type mappings provided by default: DB2, InformixDB, MaxDB, mySQL, Oracle9i, PointBase, InterBase, Mimer SQL, McKoi, SapDB, DB2/400, SOLID, Hypersonic SQL, FirstSQL/J, MS SQLSERVER2000, MS SQLSERVER, Cloudscape, Derby, Firebird, PostgreSQL 8.0, PostgreSQL, Sybase, Ingres. Note, there may be custom type mappings defined in addition to these predefined mappings. | no | type-mapping |
| Use Java Context | Indicates whether the JNDI name should be bound under the "java" context, which causes the DataSource to only be accessible from within the JBossAS VM. The default is Yes. | no | use-java-context |
| Use Strict Min | Whether idle connections below the min-pool-size should be closed. The default is No. | no | use-strict-min |
| 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. The default is Yes. | no | validate-on-match |
| Check Valid Connection SQL | The SQL statement to use to check the validity of a pool connection. | no | check-valid-connection-sql |
| Connection Definition | The connection definition inside the RAR deployment uniquely identified by the connection factory interface, e.g. "javax.sql.DataSource". | no | connection-definition |
| Exception Sorter Class Name | The fully qualified name of a Java class implementing the org.jboss.resource.adapter.jdbc.ExceptionSorter interface that should be used to check if a JDBC exception should be broadcast. | no | exception-sorter-class-name |
| New Connection SQL | An SQL statement to execute whenever a new connection is added to the pool; this can be used to set the connection schema, etc. | no | new-connection-sql |
| Prepared Statement Cache Size | The number of prepared statements per connection to be kept open and reused in subsequent requests. They are stored in an LRU cache. Set to 0 to disable the cache. The default is 0. | no | prepared-statement-cache-size |
| Query Timeout | Any configured query timeout in seconds. A value of 0 means no timeout. The default is 0. | no | query-timeout |
| Rar Name | The RAR deployment to associate with the connection manager MBean. e.g. jms-ra.rar or myapplication.ear#my.rar for nested rars. | no | rar-name |
| 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 No. | no | set-tx-query-timeout |
| Share Prepared Statements | Should prepared statements be shared? The default is No. | no | share-prepared-statements |
| Stale Connection Checker Class Name | Fully qualified name of the Java class used to check if a connection has become stale. | no | stale-connection-checker-class-name |
| Track Statements | Whether to check for unclosed Statements and ResultSets when connections are returned to the pool. The default is "yes-no-warnings". | no | track-statements |
| 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 |
| Url Delimiter | Specifies the delimiter for URLs in the value of the connection-url property for HA datasources. The default is "|". | no | url-delimiter |
| Url Selector Strategy Class Name | The fully qualified class name of a Java class implementing the org.jboss.resource.adapter.jdbc.URLSelectorStrategy interface. | no | url-selector-strategy-class-name |
| Use Try Lock | Any configured timeout, in milliseconds, for internal locks on the resource adapter objects. A value of 0 means no timeout. The default is 0. | no | use-try-lock |
| Valid Connection Checker Class Name | The fully qualified name of a Java class implementing the org.jboss.resource.adapter.jdbc.ValidConnectionChecker whose pingDatabase method should be used to check if a connection is still valid before handing it out from the pool. | no | valid-connection-checker-class-name |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.112. Metrics
| Name | Description |
|---|---|
| Flush | Flush the connections in the pool |
| List Formatted Sub Pool Statistics | Obtain a formatted sub pool statistics report |
| List Statistics | Obtain a statistics report |
| Test Connection | Test if a connection can be obtained - returns true if a connection was obtained, or false if not; NOTE: this operation will always return a status of Successful - the results of the operation must be inspected to see whether or not a connection was obtained |
Package Types
none
3.2.1.4. JBossAS5 - XA Datasource Service
Overview
Table 3.113. Overview
| Description: | XA Datasources deployed in the instance of JBoss AS |
| Singleton: | no |
| Plugin: | JBossAS5 |
Child Resource Types
none
Connection Properties
Table 3.114.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Component Type | yes | componentType | |
| Component Subtype | yes | componentSubtype | |
| Component Name | yes | componentName | |
| Template Name | yes | templateName | |
| Component Name Property | The name of the Resource configuration property whose value should be used as the underlying ManagedComponent name when creating a new Resource of this type. | yes | componentNameProperty |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.115. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Run State | trait | Run State | runState |
| Connection Available? | trait | could a connection to the underlying data provider be obtained? Please see the documentation before enabling this metric | custom.connectionAvailable |
| Pool JNDI Name | trait | the JNDI name of the connection pool for this datasource | poolJndiName |
| Available Connection Count | measurement | the maximum number of connections that are available | availableConnectionCount |
| Connection Count | measurement | the number of connections that are currently in the pool | connectionCount |
| Connection Created Count | measurement | the number of connections that have been created since the datasource was last started | connectionCreatedCount |
| Connection Destroyed Count | measurement | the number of connections that have been destroyed since the datasource was last started | connectionDestroyedCount |
| In Use Connection Count | measurement | the number of connections that are currently in use | inUseConnectionCount |
| Local Transaction | trait | Local Transaction | local-transaction |
| Max Connections In Use Count | measurement | the most connections that have been simultaneously in use since this datasource was started | maxConnectionsInUseCount |
| Max Size | measurement | Max Size | maxSize |
| Min Size | measurement | Min Size | minSize |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.116.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| JNDI Name | The global JNDI Name under which to bind the datasource | yes | jndi-name |
| Username | The default username when creating a new connection. | no | user-name |
| Password | The default password when creating a new connection. | no | password |
| Minimum Pool Size | The minimum number of connections the pool should hold. The default is 0. | no | min-pool-size |
| Maximum Pool Size | The maximum number of connections the pool should hold. The default is 10. | no | max-pool-size |
| XA DataSource Class | The fully qualified name of the javax.sql.XADataSource implementation class. | yes | xa-datasource-class |
| XA Datasource Properties | The properties to assign to the XADataSource implementation class. Each 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. | no | xa-datasource-properties |
| XA Resource Timeout | XA transaction timeout, in seconds (passed to XAResource.setTransactionTimeout()) - default is zero which does not invoke the setter. | no | xa-resource-timeout |
| URL Property | For HA XA datasources, specifies the name of an XADataSource property that contains a list of URLs. | no | url-property |
| Allocation Retry | The number of times that allocating a connection should be tried before throwing an exception. The default is 0. | no | allocation-retry |
| Allocation Retry Wait Millis | The time in milliseconds to wait between retrying to allocate a connection. The default is 5000 (5 seconds). | no | allocation-retry-wait-millis |
| Background Validation | Specify if connections should be validated on a background thread versus being validated prior to use. Background validation is meant to reduce the overall load on the RDBMS system when validating a connection. The default is No. | no | background-validation |
| Background Validation Millis | The interval, in milliseconds, at which the ConnectionValidator will run. Set to 0 to disable background validation. The default is 0. | no | background-validation-millis |
| Blocking Timeout in Milliseconds | 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). | no | blocking-timeout-millis |
| Idle Timeout | The maximum time, in minutes, a connection may be idle before being closed. The default is 30. | no | idle-timeout-minutes |
| Is Same RM Override Value | If set, unconditionally sets the boolean return value of javax.transaction.xa.XAResource.isSameRM(XAResource). | no | isSameRM-override-value |
| Jmx Invoker Name | The ObjectName of the JMX Invoker MBean associated with this datasource. | no | jmx-invoker-name |
| Metadata | Metadata properties. | no | metadata |
| No Tx Separate Pools | If true, the datasource cannot reuse a connection outside a transaction once enlisted in a global transaction and vice-versa. The default is Yes. | no | no-tx-separate-pools |
| Prefill | Whether to attempt to prefill the connection pool to the minimum number of connections. NOTE: Only supporting pools (OnePool) support this feature. A warning can be found in the logs if the pool does not support this. The default is No. | no | prefill |
| Security Settings | Security settings for connections in the pool. | no | security-domain |
| Statistics Formatter | The fully qualified class name of the class to use for formatting managed connection pool statistics for this datasource. The class must implement the org.jboss.resource.statistic.formatter.StatisticsFormatter. interface. The default is "org.jboss.resource.statistic.pool.JBossDefaultSubPoolStatisticFormatter". | no | statistics-formatter |
| Type Mapping | The name of the corresponding type-mapping in conf/standardjbosscmp-jdbc.xml. The type mappings provided by default: DB2, InformixDB, MaxDB, mySQL, Oracle9i, PointBase, InterBase, Mimer SQL, McKoi, SapDB, DB2/400, SOLID, Hypersonic SQL, FirstSQL/J, MS SQLSERVER2000, MS SQLSERVER, Cloudscape, Derby, Firebird, PostgreSQL 8.0, PostgreSQL, Sybase, Ingres. Note, there may be custom type mappings defined in addition to these predefined mappings. | no | type-mapping |
| Use Java Context | Indicates whether the JNDI name should be bound under the "java" context, which causes the DataSource to only be accessible from within the JBossAS VM. The default is Yes. | no | use-java-context |
| Use Strict Min | Whether idle connections below the min-pool-size should be closed. The default is No. | no | use-strict-min |
| 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. The default is Yes. | no | validate-on-match |
| Check Valid Connection SQL | The SQL statement to use to check the validity of a pool connection. | no | check-valid-connection-sql |
| Connection Definition | The connection definition inside the RAR deployment uniquely identified by the connection factory interface, e.g. "javax.sql.DataSource". | no | connection-definition |
| Exception Sorter Class Name | The fully qualified name of a Java class implementing the org.jboss.resource.adapter.jdbc.ExceptionSorter interface that should be used to check if a JDBC exception should be broadcast. | no | exception-sorter-class-name |
| New Connection SQL | An SQL statement to execute whenever a new connection is added to the pool; this can be used to set the connection schema, etc. | no | new-connection-sql |
| Prepared Statement Cache Size | The number of prepared statements per connection to be kept open and reused in subsequent requests. They are stored in an LRU cache. Set to 0 to disable the cache. The default is 0. | no | prepared-statement-cache-size |
| Query Timeout | Any configured query timeout in seconds. A value of 0 means no timeout. The default is 0. | no | query-timeout |
| Rar Name | The RAR deployment to associate with the connection manager MBean. e.g. jms-ra.rar or myapplication.ear#my.rar for nested rars. | no | rar-name |
| 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 No. | no | set-tx-query-timeout |
| Share Prepared Statements | Should prepared statements be shared? The default is No. | no | share-prepared-statements |
| Stale Connection Checker Class Name | Fully qualified name of the Java class used to check if a connection has become stale. | no | stale-connection-checker-class-name |
| Track Statements | Whether to check for unclosed Statements and ResultSets when connections are returned to the pool. The default is "yes-no-warnings". | no | track-statements |
| 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 |
| Url Delimiter | Specifies the delimiter for URLs in the value of the connection-url property for HA datasources. The default is "|". | no | url-delimiter |
| Url Selector Strategy Class Name | The fully qualified class name of a Java class implementing the org.jboss.resource.adapter.jdbc.URLSelectorStrategy interface. | no | url-selector-strategy-class-name |
| Use Try Lock | Any configured timeout, in milliseconds, for internal locks on the resource adapter objects. A value of 0 means no timeout. The default is 0. | no | use-try-lock |
| Valid Connection Checker Class Name | The fully qualified name of a Java class implementing the org.jboss.resource.adapter.jdbc.ValidConnectionChecker whose pingDatabase method should be used to check if a connection is still valid before handing it out from the pool. | no | valid-connection-checker-class-name |
| Interleaving | If true, enable transaction interleaving if the DB vendor supports it (most do not). This property supersedes the "track-connection-by-tx" property from earlier versions of JBoss AS. The default is false. | no | interleaving |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.117. Metrics
| Name | Description |
|---|---|
| Flush | Flush the connections in the pool |
| List Formatted Sub Pool Statistics | Obtain a formatted sub pool statistics report |
| List Statistics | Obtain a statistics report |
| Test Connection | Test if a connection can be obtained - returns true if a connection was obtained, or false if not; NOTE: this operation will always return a status of Successful - the results of the operation must be inspected to see whether or not a connection was obtained |
Package Types
none
3.2.1.5. JBossAS5 - No Tx ConnectionFactory Service
Overview
Table 3.118. Overview
| Description: | A ConnectionFactory that does not take part in JTA transactions. |
| Singleton: | no |
| Plugin: | JBossAS5 |
Child Resource Types
none
Connection Properties
Table 3.119.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Custom Properties | Maps a list of custom property names to the the fully qualified class names of the org.rhq.plugins.jbossas5.adapter.api.PropertyAdapter implementations that should be used for those properties. | no | customProperties |
| Component Type | yes | componentType | |
| Component Subtype | yes | componentSubtype | |
| Component Name | yes | componentName | |
| Template Name | yes | templateName | |
| Component Name Property | The name of the Resource configuration property whose value should be used as the underlying ManagedComponent name when creating a new Resource of this type. | yes | componentNameProperty |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.120. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Run State | trait | Run State | runState |
| Connection Available? | trait | could a connection to the underlying data provider be obtained? Please see the documentation before enabling this metric | custom.connectionAvailable |
| Pool JNDI Name | trait | Pool JNDI Name | poolJndiName |
| Available Connection Count | measurement | Number of available connections. | availableConnectionCount |
| Connection Count | measurement | Connection Count | connectionCount |
| Connection Created Count | measurement | Connection Created Count | connectionCreatedCount |
| Connection Destroyed Count | measurement | Connection Destroyed Count | connectionDestroyedCount |
| In Use Connection Count | measurement | Mumber of connections currently in use. | inUseConnectionCount |
| Max Connections In Use Count | measurement | Maximum number of maximum connections that have been in use. | maxConnectionsInUseCount |
| Max Size | measurement | Max Size | maxSize |
| Min Size | measurement | Min Size | minSize |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.121.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| JNDI Name | The global JNDI name to bind the connection factory under. | yes | jndi-name |
| RAR Name | The name of the RAR file that contains the definition for the resource we want to provide. For nested RAR files, the name would look like myapplication.ear#my.rar. | yes | rar-name |
| Connection Definition | The connection factory interface class. It should match the connectionfactory-interface in the ra.xml file. | yes | connection-definition |
| Minimum Pool Size | The minimum number of connections the pool should hold. The default is 0. | no | min-pool-size |
| Maximum Pool Size | The maximum number of connections the pool should hold. The default is 10. | no | max-pool-size |
| Allocation Retry | The number of times that allocating a connection should be tried before throwing an exception. The default is 0. | no | allocation-retry |
| Allocation Retry Wait Millis | The time in milliseconds to wait between retrying to allocate a connection. The default is 5000 (5 seconds). | no | allocation-retry-wait-millis |
| Background Validation | Specify if connections should be validated on a background thread versus being validated prior to use. Background validation is meant to reduce the overall load on the RDBMS system when validating a connection. The default is No. | no | background-validation |
| Background Validation Millis | The interval, in milliseconds, at which the ConnectionValidator will run. Set to 0 to disable background validation. The default is 0. | no | background-validation-millis |
| Blocking Timeout in Milliseconds | 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). | no | blocking-timeout-millis |
| Idle Timeout | The maximum time, in minutes, a connection may be idle before being closed. The default is 30. | no | idle-timeout-minutes |
| Is Same RM Override Value | If set, unconditionally sets the boolean return value of javax.transaction.xa.XAResource.isSameRM(XAResource). | no | isSameRM-override-value |
| Jmx Invoker Name | The ObjectName of the JMX Invoker MBean associated with this datasource. | no | jmx-invoker-name |
| Metadata | Metadata properties. | no | metadata |
| No Tx Separate Pools | If true, the datasource cannot reuse a connection outside a transaction once enlisted in a global transaction and vice-versa. The default is Yes. | no | no-tx-separate-pools |
| Prefill | Whether to attempt to prefill the connection pool to the minimum number of connections. NOTE: Only supporting pools (OnePool) support this feature. A warning can be found in the logs if the pool does not support this. The default is No. | no | prefill |
| Security Settings | Security settings for connections in the pool. | no | security-domain |
| Statistics Formatter | The fully qualified class name of the class to use for formatting managed connection pool statistics for this datasource. The class must implement the org.jboss.resource.statistic.formatter.StatisticsFormatter. interface. The default is "org.jboss.resource.statistic.pool.JBossDefaultSubPoolStatisticFormatter". | no | statistics-formatter |
| Type Mapping | The name of the corresponding type-mapping in conf/standardjbosscmp-jdbc.xml. The type mappings provided by default: DB2, InformixDB, MaxDB, mySQL, Oracle9i, PointBase, InterBase, Mimer SQL, McKoi, SapDB, DB2/400, SOLID, Hypersonic SQL, FirstSQL/J, MS SQLSERVER2000, MS SQLSERVER, Cloudscape, Derby, Firebird, PostgreSQL 8.0, PostgreSQL, Sybase, Ingres. Note, there may be custom type mappings defined in addition to these predefined mappings. | no | type-mapping |
| Use Java Context | Indicates whether the JNDI name should be bound under the "java" context, which causes the DataSource to only be accessible from within the JBossAS VM. The default is Yes. | no | use-java-context |
| Use Strict Min | Whether idle connections below the min-pool-size should be closed. The default is No. | no | use-strict-min |
| 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. The default is Yes. | no | validate-on-match |
| Config Property | Properties to supply to the ManagedConnectionFactory (MCF) MBean service configuration. | no | config-property |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.122. Metrics
| Name | Description |
|---|---|
| Flush | Flush the connections in the pool |
| List Formatted Sub Pool Statistics | Obtain a formatted sub pool statistics report |
| List Statistics | Obtain a statistics report |
| Test Connection | Test if a connection can be obtained - returns true if a connection was obtained, or false if not; NOTE: this operation will always return a status of Successful - the results of the operation must be inspected to see whether or not a connection was obtained |
Package Types
none
3.2.1.6. JBossAS5 - Tx ConnectionFactory Service
Overview
Table 3.123. Overview
| Description: | A ConnectionFactory that takes part in JTA transactions. |
| Singleton: | no |
| Plugin: | JBossAS5 |
Child Resource Types
none
Connection Properties
Table 3.124.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Custom Properties | Maps a list of custom property names to the the fully qualified class names of the org.rhq.plugins.jbossas5.adapter.api.PropertyAdapter implementations that should be used for those properties. | no | customProperties |
| Component Type | yes | componentType | |
| Component Subtype | yes | componentSubtype | |
| Component Name | yes | componentName | |
| Template Name | yes | templateName | |
| Component Name Property | The name of the Resource configuration property whose value should be used as the underlying ManagedComponent name when creating a new Resource of this type. | yes | componentNameProperty |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.125. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Transaction Type | trait | The type of transactions used by this connection factory - Local or XA | custom.transactionType |
| Run State | trait | Run State | runState |
| Connection Available? | trait | could a connection to the underlying data provider be obtained? Please see the documentation before enabling this metric | custom.connectionAvailable |
| Pool JNDI Name | trait | Pool JNDI Name | poolJndiName |
| Available Connection Count | measurement | Number of available connections. | availableConnectionCount |
| Connection Count | measurement | Connection Count | connectionCount |
| Connection Created Count | measurement | Connection Created Count | connectionCreatedCount |
| Connection Destroyed Count | measurement | Connection Destroyed Count | connectionDestroyedCount |
| In Use Connection Count | measurement | Mumber of connections currently in use. | inUseConnectionCount |
| Max Connections In Use Count | measurement | Maximum number of maximum connections that have been in use. | maxConnectionsInUseCount |
| Max Size | measurement | Max Size | maxSize |
| Min Size | measurement | Min Size | minSize |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.126.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| JNDI Name | The global JNDI name to bind the connection factory under. | yes | jndi-name |
| RAR Name | The name of the RAR file that contains the definition for the resource we want to provide. For nested RAR files, the name would look like myapplication.ear#my.rar. | yes | rar-name |
| Connection Definition | The connection factory interface class. It should match the connectionfactory-interface in the ra.xml file. | yes | connection-definition |
| Minimum Pool Size | The minimum number of connections the pool should hold. The default is 0. | no | min-pool-size |
| Maximum Pool Size | The maximum number of connections the pool should hold. The default is 10. | no | max-pool-size |
| XA Transaction | Whether on not to use XA transactions. The default is No. | no | xa-transaction |
| Allocation Retry | The number of times that allocating a connection should be tried before throwing an exception. The default is 0. | no | allocation-retry |
| Allocation Retry Wait Millis | The time in milliseconds to wait between retrying to allocate a connection. The default is 5000 (5 seconds). | no | allocation-retry-wait-millis |
| Background Validation | Specify if connections should be validated on a background thread versus being validated prior to use. Background validation is meant to reduce the overall load on the RDBMS system when validating a connection. The default is No. | no | background-validation |
| Background Validation Millis | The interval, in milliseconds, at which the ConnectionValidator will run. Set to 0 to disable background validation. The default is 0. | no | background-validation-millis |
| Blocking Timeout in Milliseconds | 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). | no | blocking-timeout-millis |
| Idle Timeout | The maximum time, in minutes, a connection may be idle before being closed. The default is 30. | no | idle-timeout-minutes |
| Is Same RM Override Value | If set, unconditionally sets the boolean return value of javax.transaction.xa.XAResource.isSameRM(XAResource). | no | isSameRM-override-value |
| Jmx Invoker Name | The ObjectName of the JMX Invoker MBean associated with this datasource. | no | jmx-invoker-name |
| Metadata | Metadata properties. | no | metadata |
| No Tx Separate Pools | If true, the datasource cannot reuse a connection outside a transaction once enlisted in a global transaction and vice-versa. The default is Yes. | no | no-tx-separate-pools |
| Prefill | Whether to attempt to prefill the connection pool to the minimum number of connections. NOTE: Only supporting pools (OnePool) support this feature. A warning can be found in the logs if the pool does not support this. The default is No. | no | prefill |