2.8. JBoss AS 5.x

Overview

Table 2.171. Overview

Description: JBoss Application Server (AS), Enterprise Application Platform (EAP), Enterprise SOA Platform (SOA-P), or Enterprise Web Platform (EWP) 5.x instance
Singleton: no
Plugin: JBossAS5

Parent Resource Types

Child Resource Types

Autodiscovery Process Scans

Table 2.172. Metrics

Name Query
jbossas process|basename|match=^java.*,arg|org.jboss.Main|match=.*

Connection Properties

Table 2.173. 

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}. no serverName
Script Prefix A prefix applied to script execution commands. Typically a sudo for applicable platforms. The prefix is applied verbatim. As such, a sudo user must be configured appropriately. 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
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'. 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'. no bindAddress
Java Home The absolute path to a JRE or JDK installation directory containing the JVM that should be used to start and shutdown this JBoss AS server; this property must be set in order for the Start operation to work, or for the Shutdown operation to work when the shutdown method is set to 'shutdown script'. no javaHome
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
Availability Check Period The amount of time, in seconds, that must elapse between availability checks to see if the server is up. If set, the availability checks will be performed asynchronously thus allowing slow-responding servers to avoid being falsely reported as down. no availabilityCheckPeriod
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 2.174. 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 the this app server instance's major version (AS 5.0 = Morpheus, AS 5.1 = The Oracle, AS 6.0 = 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 2.175. 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 2.176. Package Types

Name Category Description
Cumulative Patch Deployable Automatically installable application server patches
JAR Library Deployable Library Jar files deployed in JBoss AS

2.8.1. EJB2 JAR Service

Overview

Table 2.177. Overview

Description: a standalone EJB 2.x application
Singleton: no
Plugin: JBossAS5

Parent Resource Types

Child Resource Types

Connection Properties

Table 2.178. 

Name Description Required Internal Name
Deployment Name the name of this EJB JAR yes deploymentName
Filename yes filename
Extension yes extension
Description Template yes descriptionTemplate
Deployment Type Name The name of the item from the org.jboss.deployers.spi.management.KnownDeploymentTypes enum corresponding to this deployment's type. yes deploymentTypeName

Note

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

Metrics

Table 2.179. Metrics

Name Type Description Internal Name
Path trait the absolute path of this EJB JAR file or directory custom.path
Exploded? trait whether this EJB JAR is deployed exploded (i.e. as a directory) custom.exploded

Note

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

Configuration Properties

none

Operations

Table 2.180. Metrics

Name Description
Start starts this EJB JAR
Stop stops this EJB JAR
Restart stops and then restarts this EJB JAR

Package Types

Table 2.181. Package Types

Name Category Description
EJB JAR File Deployable

2.8.1.1. EJB2 Entity Bean Service

Overview

Table 2.182. Overview

Description: An EJB2 Entity Bean
Singleton: no
Plugin: JBossAS5

Parent Resource Types
Child Resource Types
none
Connection Properties

Table 2.183. 

Name Description Required Internal Name
Component Type yes componentType
Component Subtype yes componentSubtype
Component Name yes componentName

Note

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

Table 2.184. Metrics

Name Type Description Internal Name
Create Count measurement The number of instances of this EJB2 Session Bean that have been created. since server start. CreateCount
Create Count per Minute measurement The number of instances of this EJB2 Session Bean that have been created. since server start. CreateCount
Remove Count measurement The number of instances of this EJB2 Session Bean that have been removed since server start. RemoveCount
Remove Count per Minute measurement The number of instances of this EJB2 Session Bean that have been removed since server start. RemoveCount
Current Pool Size measurement The number of beans in the pool. CurrentPoolSize
Max Pool Size measurement The maximum pool size. MaxPoolSize
Cache Size measurement Cache Size CacheSize

Note

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

2.8.1.2. EJB2 Message-Driven Bean Service

Overview

Table 2.185. Overview

Description: An EJB2 Message Driven Bean
Singleton: no
Plugin: JBossAS5

Parent Resource Types
Child Resource Types
none
Connection Properties

Table 2.186. 

Name Description Required Internal Name
Component Type yes componentType
Component Subtype yes componentSubtype
Component Name yes componentName

Note

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

Table 2.187. Metrics

Name Type Description Internal Name
Current Pool Size measurement The number of beans in the pool. CurrentPoolSize
Max Pool Size measurement The maximum pool size. MaxPoolSize
Message Count measurement The number of messages sent/received MessageCount
Message Count per Minute measurement The number of messages sent/received MessageCount

Note

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

2.8.1.3. EJB2 Stateful Session Bean Service

Overview

Table 2.188. Overview

Description: An EJB2 Stateful Session Bean
Singleton: no
Plugin: JBossAS5

Parent Resource Types
Child Resource Types
none
Connection Properties

Table 2.189. 

Name Description Required Internal Name
Component Type yes componentType
Component Subtype yes componentSubtype
Component Name yes componentName
Invocation Stats Property Name yes invocationStatsPropertyName

Note

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

Table 2.190. Metrics

Name Type Description Internal Name
Create Count measurement The number of instances of this EJB2 Session Bean that have been created. since server start. CreateCount
Create Count per Minute measurement The number of instances of this EJB2 Session Bean that have been created. since server start. CreateCount
Remove Count measurement The number of instances of this EJB2 Session Bean that have been removed since server start. RemoveCount
Remove Count per Minute measurement The number of instances of this EJB2 Session Bean that have been removed since server start. RemoveCount
Current Pool Size measurement The number of beans in the pool. CurrentPoolSize
Max Pool Size measurement The maximum pool size. MaxPoolSize
Method Invocation Time calltime The minimum, maximum, and average invocation times for each of the methods exposed by this EJB methodInvocationTime
Passive Beans measurement The count of beans in the passivated state PassivatedCount

Note

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

Table 2.191. Metrics

Name Description
View Method Statistics Display detailed method invocation statistics.

Package Types
none

2.8.1.4. EJB2 Stateless Session Bean Service

Overview

Table 2.192. Overview

Description: An EJB2 Stateless Session Bean
Singleton: no
Plugin: JBossAS5

Parent Resource Types
Child Resource Types
none
Connection Properties

Table 2.193. 

Name Description Required Internal Name
Component Type yes componentType
Component Subtype yes componentSubtype
Component Name yes componentName
Invocation Stats Property Name yes invocationStatsPropertyName

Note

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

Table 2.194. Metrics

Name Type Description Internal Name
Create Count measurement The number of instances of this EJB2 Session Bean that have been created. since server start. CreateCount
Create Count per Minute measurement The number of instances of this EJB2 Session Bean that have been created. since server start. CreateCount
Remove Count measurement The number of instances of this EJB2 Session Bean that have been removed since server start. RemoveCount
Remove Count per Minute measurement The number of instances of this EJB2 Session Bean that have been removed since server start. RemoveCount
Current Pool Size measurement The number of beans in the pool. CurrentPoolSize
Max Pool Size measurement The maximum pool size. MaxPoolSize
Method Invocation Time calltime The minimum, maximum, and average invocation times for each of the methods exposed by this EJB methodInvocationTime

Note

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

Table 2.195. Metrics

Name Description
View Method Statistics Display detailed method invocation statistics.

Package Types
none

2.8.2. EJB2 Entity Bean (Embedded) Service

Overview

Table 2.196. Overview

Description: An EJB2 Entity Bean
Singleton: no
Plugin: JBossAS5

Parent Resource Types

Child Resource Types

none

Connection Properties

Table 2.197. 

Name Description Required Internal Name
Component Type yes componentType
Component Subtype yes componentSubtype
Component Name yes componentName

Note

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

Metrics

Table 2.198. Metrics

Name Type Description Internal Name
Create Count measurement The number of instances of this EJB2 Session Bean that have been created. since server start. CreateCount
Create Count per Minute measurement The number of instances of this EJB2 Session Bean that have been created. since server start. CreateCount
Remove Count measurement The number of instances of this EJB2 Session Bean that have been removed since server start. RemoveCount
Remove Count per Minute measurement The number of instances of this EJB2 Session Bean that have been removed since server start. RemoveCount
Current Pool Size measurement The number of beans in the pool. CurrentPoolSize
Max Pool Size measurement The maximum pool size. MaxPoolSize
Cache Size measurement Cache Size CacheSize

Note

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

Configuration Properties

none

Operations

none

Package Types

none

2.8.3. EJB2 Message-Driven Bean (Embedded) Service

Overview

Table 2.199. Overview

Description: An EJB2 Message Driven Bean
Singleton: no
Plugin: JBossAS5

Parent Resource Types

Child Resource Types

none

Connection Properties

Table 2.200. 

Name Description Required Internal Name
Component Type yes componentType
Component Subtype yes componentSubtype
Component Name yes componentName

Note

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

Metrics

Table 2.201. Metrics

Name Type Description Internal Name
Current Pool Size measurement The number of beans in the pool. CurrentPoolSize
Max Pool Size measurement The maximum pool size. MaxPoolSize
Message Count measurement The number of messages sent/received MessageCount
Message Count per Minute measurement The number of messages sent/received MessageCount

Note

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

Configuration Properties

none

Operations

none

Package Types

none

2.8.4. EJB2 Stateful Session Bean (Embedded) Service

Overview

Table 2.202. Overview

Description: An EJB2 Stateful Session Bean
Singleton: no
Plugin: JBossAS5

Parent Resource Types

Child Resource Types

none

Connection Properties

Table 2.203. 

Name Description Required Internal Name
Component Type yes componentType
Component Subtype yes componentSubtype
Component Name yes componentName
Invocation Stats Property Name yes invocationStatsPropertyName

Note

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

Metrics

Table 2.204. Metrics

Name Type Description Internal Name
Create Count measurement The number of instances of this EJB2 Session Bean that have been created. since server start. CreateCount
Create Count per Minute measurement The number of instances of this EJB2 Session Bean that have been created. since server start. CreateCount
Remove Count measurement The number of instances of this EJB2 Session Bean that have been removed since server start. RemoveCount
Remove Count per Minute measurement The number of instances of this EJB2 Session Bean that have been removed since server start. RemoveCount
Current Pool Size measurement The number of beans in the pool. CurrentPoolSize
Max Pool Size measurement The maximum pool size. MaxPoolSize
Method Invocation Time calltime The minimum, maximum, and average invocation times for each of the methods exposed by this EJB methodInvocationTime
Passive Beans measurement The count of beans in the passivated state PassivatedCount

Note

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

Configuration Properties

none

Operations

Table 2.205. Metrics

Name Description
View Method Statistics Display detailed method invocation statistics.

Package Types

none

2.8.5. EJB2 Stateless Session Bean (Embedded) Service

Overview

Table 2.206. Overview

Description: An EJB2 Stateless Session Bean
Singleton: no
Plugin: JBossAS5

Parent Resource Types

Child Resource Types

none

Connection Properties

Table 2.207. 

Name Description Required Internal Name
Component Type yes componentType
Component Subtype yes componentSubtype
Component Name yes componentName
Invocation Stats Property Name yes invocationStatsPropertyName

Note

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

Metrics

Table 2.208. Metrics

Name Type Description Internal Name
Create Count measurement The number of instances of this EJB2 Session Bean that have been created. since server start. CreateCount
Create Count per Minute measurement The number of instances of this EJB2 Session Bean that have been created. since server start. CreateCount
Remove Count measurement The number of instances of this EJB2 Session Bean that have been removed since server start. RemoveCount
Remove Count per Minute measurement The number of instances of this EJB2 Session Bean that have been removed since server start. RemoveCount
Current Pool Size measurement The number of beans in the pool. CurrentPoolSize
Max Pool Size measurement The maximum pool size. MaxPoolSize
Method Invocation Time calltime The minimum, maximum, and average invocation times for each of the methods exposed by this EJB methodInvocationTime

Note

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

Configuration Properties

none

Operations

Table 2.209. Metrics

Name Description
View Method Statistics Display detailed method invocation statistics.

Package Types

none

2.8.6. EJB3 JAR Service

Overview

Table 2.210. Overview

Description: a standalone EJB 3.x application
Singleton: no
Plugin: JBossAS5

Parent Resource Types

Child Resource Types

Connection Properties

Table 2.211. 

Name Description Required Internal Name
Deployment Name the name of this EJB JAR yes deploymentName
Filename yes filename
Extension yes extension
Description Template yes descriptionTemplate
Deployment Type Name The name of the item from the org.jboss.deployers.spi.management.KnownDeploymentTypes enum corresponding to this deployment's type. yes deploymentTypeName

Note

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

Metrics

Table 2.212. Metrics

Name Type Description Internal Name
Path trait the absolute path of this EJB JAR file or directory custom.path
Exploded? trait whether this EJB JAR is deployed exploded (i.e. as a directory) custom.exploded

Note

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

Configuration Properties

none

Operations

Table 2.213. Metrics

Name Description
Start starts this EJB JAR
Stop stops this EJB JAR
Restart stops and then restarts this EJB JAR

Package Types

Table 2.214. Package Types

Name Category Description
EJB JAR File Deployable

2.8.6.1. EJB3 Message-Driven Bean Service

Overview

Table 2.215. Overview

Description: An EJB3 Message-Driven Bean (MDB)
Singleton: no
Plugin: JBossAS5

Parent Resource Types
Child Resource Types
none
Connection Properties

Table 2.216. 

Name Description Required Internal Name
Component Type yes componentType
Component Subtype yes componentSubtype
Component Name yes componentName
Invocation Stats Property Name yes invocationStatsPropertyName

Note

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

Table 2.217. Metrics

Name Type Description Internal Name
EJB Name trait the name of this EJB name
Minimum Pool Size measurement Minimum Pool Size minPoolSize
Maximum Pool Size measurement Maximum Pool Size maxPoolSize
Maximum number of Messages measurement Maximum number of Messages maxMessages

Note

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

Table 2.218. Metrics

Name Description
View Method Statistics Display detailed method invocation statistics.

Package Types
none

2.8.6.2. EJB3 Stateful Session Bean Service

Overview

Table 2.219. Overview

Description: An EJB3 Stateful Session Bean (SFSB)
Singleton: no
Plugin: JBossAS5

Parent Resource Types
Child Resource Types
none
Connection Properties

Table 2.220. 

Name Description Required Internal Name
Component Type yes componentType
Component Subtype yes componentSubtype
Component Name yes componentName
Invocation Stats Property Name yes invocationStatsPropertyName

Note

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

Table 2.221. Metrics

Name Type Description Internal Name
EJB Name trait the name of this EJB name
Available Count measurement The number of pooled instances of this EJB3 Session Bean in the method-ready state availableCount
Create Count measurement The number of instances of this EJB3 Session Bean that have been created since server start createCount
Create Count per Minute measurement The number of instances of this EJB3 Session Bean that have been created since server start createCount
Current Count measurement The total number of currently pooled instances of this EJB3 Session Bean currentSize
Max Size measurement The maximum number of instances that are allowed to be pooled maxSize
Remove Count measurement The number of instances of this EJB3 Session Bean that have been removed since server start removeCount
Remove Count per Minute measurement The number of instances of this EJB3 Session Bean that have been removed since server start removeCount
Method Invocation Time calltime The minimum, maximum, and average invocation times for each of the methods exposed by this EJB methodInvocationTime
Cache Size measurement Cache Size cacheSize
Passivated Count measurement Passivated Count passivatedCount
Total Size measurement Total Size totalSize

Note

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

Table 2.222. Metrics

Name Description
View Method Statistics Display detailed method invocation statistics.

Package Types
none

2.8.6.3. EJB3 Stateless Session Bean Service

Overview

Table 2.223. Overview

Description: An EJB3 Stateless Session Bean (SLSB)
Singleton: no
Plugin: JBossAS5

Parent Resource Types
Child Resource Types
none
Connection Properties

Table 2.224. 

Name Description Required Internal Name
Component Type yes componentType
Component Subtype yes componentSubtype
Component Name yes componentName
Invocation Stats Property Name yes invocationStatsPropertyName

Note

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

Table 2.225. Metrics

Name Type Description Internal Name
EJB Name trait the name of this EJB name
Available Count measurement The number of pooled instances of this EJB3 Session Bean in the method-ready state availableCount
Create Count measurement The number of instances of this EJB3 Session Bean that have been created since server start createCount
Create Count per Minute measurement The number of instances of this EJB3 Session Bean that have been created since server start createCount
Current Count measurement The total number of currently pooled instances of this EJB3 Session Bean currentSize
Max Size measurement The maximum number of instances that are allowed to be pooled maxSize
Remove Count measurement The number of instances of this EJB3 Session Bean that have been removed since server start removeCount
Remove Count per Minute measurement The number of instances of this EJB3 Session Bean that have been removed since server start removeCount
Method Invocation Time calltime The minimum, maximum, and average invocation times for each of the methods exposed by this EJB methodInvocationTime

Note

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

Table 2.226. Metrics

Name Description
View Method Statistics Display detailed method invocation statistics.

Package Types
none

2.8.7. EJB3 Message-Driven Bean (Embedded) Service

Overview

Table 2.227. Overview

Description: An EJB3 Message-Driven Bean (MDB)
Singleton: no
Plugin: JBossAS5

Parent Resource Types

Child Resource Types

none

Connection Properties

Table 2.228. 

Name Description Required Internal Name
Component Type yes componentType
Component Subtype yes componentSubtype
Component Name yes componentName
Invocation Stats Property Name yes invocationStatsPropertyName

Note

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

Metrics

Table 2.229. Metrics

Name Type Description Internal Name
EJB Name trait the name of this EJB name
Minimum Pool Size measurement Minimum Pool Size minPoolSize
Maximum Pool Size measurement Maximum Pool Size maxPoolSize
Maximum number of Messages measurement Maximum number of Messages maxMessages

Note

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

Configuration Properties

none

Operations

Table 2.230. Metrics

Name Description
View Method Statistics Display detailed method invocation statistics.

Package Types

none

2.8.8. EJB3 Stateful Session Bean (Embedded) Service

Overview

Table 2.231. Overview

Description: An EJB3 Stateful Session Bean (SFSB)
Singleton: no
Plugin: JBossAS5

Parent Resource Types

Child Resource Types

none

Connection Properties

Table 2.232. 

Name Description Required Internal Name
Component Type yes componentType
Component Subtype yes componentSubtype
Component Name yes componentName
Invocation Stats Property Name yes invocationStatsPropertyName

Note

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

Metrics

Table 2.233. Metrics

Name Type Description Internal Name
EJB Name trait the name of this EJB name
Available Count measurement The number of pooled instances of this EJB3 Session Bean in the method-ready state availableCount
Create Count measurement The number of instances of this EJB3 Session Bean that have been created since server start createCount
Create Count per Minute measurement The number of instances of this EJB3 Session Bean that have been created since server start createCount
Current Count measurement The total number of currently pooled instances of this EJB3 Session Bean currentSize
Max Size measurement The maximum number of instances that are allowed to be pooled maxSize
Remove Count measurement The number of instances of this EJB3 Session Bean that have been removed since server start removeCount
Remove Count per Minute measurement The number of instances of this EJB3 Session Bean that have been removed since server start removeCount
Method Invocation Time calltime The minimum, maximum, and average invocation times for each of the methods exposed by this EJB methodInvocationTime
Cache Size measurement Cache Size cacheSize
Passivated Count measurement Passivated Count passivatedCount
Total Size measurement Total Size totalSize

Note

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

Configuration Properties

none

Operations

Table 2.234. Metrics

Name Description
View Method Statistics Display detailed method invocation statistics.

Package Types

none

2.8.9. EJB3 Stateless Session Bean (Embedded) Service

Overview

Table 2.235. Overview

Description: An EJB3 Stateless Session Bean (SLSB)
Singleton: no
Plugin: JBossAS5

Parent Resource Types

Child Resource Types

none

Connection Properties

Table 2.236. 

Name Description Required Internal Name
Component Type yes componentType
Component Subtype yes componentSubtype
Component Name yes componentName
Invocation Stats Property Name yes invocationStatsPropertyName

Note

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

Metrics

Table 2.237. Metrics

Name Type Description Internal Name
EJB Name trait the name of this EJB name
Available Count measurement The number of pooled instances of this EJB3 Session Bean in the method-ready state availableCount
Create Count measurement The number of instances of this EJB3 Session Bean that have been created since server start createCount
Create Count per Minute measurement The number of instances of this EJB3 Session Bean that have been created since server start createCount
Current Count measurement The total number of currently pooled instances of this EJB3 Session Bean currentSize
Max Size measurement The maximum number of instances that are allowed to be pooled maxSize
Remove Count measurement The number of instances of this EJB3 Session Bean that have been removed since server start removeCount
Remove Count per Minute measurement The number of instances of this EJB3 Session Bean that have been removed since server start removeCount
Method Invocation Time calltime The minimum, maximum, and average invocation times for each of the methods exposed by this EJB methodInvocationTime

Note

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

Configuration Properties

none

Operations

Table 2.238. Metrics

Name Description
View Method Statistics Display detailed method invocation statistics.

Package Types

none

2.8.10. Embedded EJB2 JAR Service

Overview

Table 2.239. Overview

Description: an embedded EJB 2.x application
Singleton: no
Plugin: JBossAS5

Parent Resource Types

Child Resource Types

Connection Properties

Table 2.240. 

Name Description Required Internal Name
Deployment Name the name of this EJB JAR yes deploymentName
Filename yes filename
Extension yes extension
Description Template yes descriptionTemplate
Deployment Type Name The name of the item from the org.jboss.deployers.spi.management.KnownDeploymentTypes enum corresponding to this deployment's type. yes deploymentTypeName

Note

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

Metrics

Table 2.241. Metrics

Name Type Description Internal Name
Parent trait the name of this EJB JAR's parent deployment custom.parent

Note

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

Configuration Properties

none

Operations

none

Package Types

none

2.8.11. Embedded EJB3 JAR Service

Overview

Table 2.242. Overview

Description: an embedded EJB 3.x application
Singleton: no
Plugin: JBossAS5

Parent Resource Types

Child Resource Types

Connection Properties

Table 2.243. 

Name Description Required Internal Name
Deployment Name the name of this EJB JAR yes deploymentName
Filename yes filename
Extension yes extension
Description Template yes descriptionTemplate
Deployment Type Name The name of the item from the org.jboss.deployers.spi.management.KnownDeploymentTypes enum corresponding to this deployment's type. yes deploymentTypeName

Note

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

Metrics

Table 2.244. Metrics

Name Type Description Internal Name
Parent trait the name of this EJB JAR's parent deployment custom.parent

Note

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

Configuration Properties

none

Operations

none

Package Types

none

2.8.12. Embedded Resource Adapter Archive (RAR) Service

Overview

Table 2.245. Overview

Description: an embedded JCA resource adapter archive (RAR)
Singleton: no
Plugin: JBossAS5

Parent Resource Types

Child Resource Types

none

Connection Properties

Table 2.246. 

Name Description Required Internal Name
Deployment Name the name of this RAR yes deploymentName
Filename yes filename
Extension yes extension
Description Template yes descriptionTemplate
Deployment Type Name The name of the item from the org.jboss.deployers.spi.management.KnownDeploymentTypes enum corresponding to this deployment's type. yes deploymentTypeName

Note

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

Metrics

Table 2.247. Metrics

Name Type Description Internal Name
Parent trait the name of this RAR's parent deployment custom.parent

Note

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

Configuration Properties

none

Operations

none

Package Types

none

2.8.13. Embedded Web Application (WAR) Service

Overview

Table 2.248. Overview

Description: an embedded web application (WAR)
Singleton: no
Plugin: JBossAS5

Parent Resource Types

Child Resource Types

Connection Properties

Table 2.249. 

Name Description Required Internal Name
Deployment Name the name of this WAR yes deploymentName
Context Path this WAR's context path (e.g. /admin-console yes contextPath
Response Time Log File the full path to the log file containing response-time stats for this webapp no responseTimeLogFile
Response Time Url Excludes a space-delimited list of regular expressions specifying URLs that should be excluded from response-time stats collection no responseTimeUrlExcludes
Response Time Url Transforms a space-delimited list of Perl-style substitution expressions that should be applied to all URLs for which response-time stats are collected (e.g. |^/dept/finance/.*|/dept/finance/*|) no responseTimeUrlTransforms
Extension yes extension
Description Template yes descriptionTemplate
Deployment Type Name The name of the item from the org.jboss.deployers.spi.management.KnownDeploymentTypes enum corresponding to this deployment's type. yes deploymentTypeName
Embedded yes embedded

Note

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

Metrics

Table 2.250. Metrics

Name Type Description Internal Name
Parent trait the name of this WAR's parent deployment custom.parent
Context Root trait this context root of this WAR (e.g. jmx-console) - used as a unique path prefix for URLs corresponding to this WAR contextRoot
Virtual Hosts trait the virtual host(s) to which this WAR is deployed virtualHosts

Note

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

Configuration Properties

none

Operations

none

Package Types

none

2.8.13.1. Embedded Web Application Context Service

Overview

Table 2.251. Overview

Description: a web application context
Singleton: no
Plugin: JBossAS5

Parent Resource Types
Child Resource Types
none
Connection Properties

Table 2.252. 

Name Description Required Internal Name
Component Type yes componentType
Component Subtype yes componentSubtype
Component Name yes componentName
Response Time Log File the full path to the log file containing response-time stats for this webapp no responseTimeLogFile
Response Time Url Excludes a space-delimited list of regular expressions specifying URLs that should be excluded from response-time stats collection no responseTimeUrlExcludes
Response Time Url Transforms a space-delimited list of Perl-style substitution expressions that should be applied to all URLs for which response-time stats are collected (e.g. |^/dept/finance/.*|/dept/finance/*|) no responseTimeUrlTransforms
Virtual Host this WAR's virtual host (e.g. localhost) yes virtualHost

Note

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

Table 2.253. Metrics

Name Type Description Internal Name
Virtual Host trait the virtual host with which this context is associated virtualHost
Response Time calltime the minimum, maximum, and average response times for requests serviced by this webapp responseTime
Currently Active Sessions measurement the number of sessions that are currently active for this WAR activeSessions
Maximum Active Sessions measurement the maximum number of sessions that have been active for this WAR maxActive
Created Sessions measurement the number of sessions created for this WAR sessionCounter
Created Sessions per Minute measurement the number of sessions created for this WAR sessionCounter
Expired Sessions measurement the number of expired sessions for this WAR expiredSessions
Expired Sessions per Minute measurement the number of expired sessions for this WAR expiredSessions
Rejected Sessions measurement the number of sessions rejected for this WAR rejectedSessions
Rejected Sessions per Minute measurement the number of sessions rejected for this WAR rejectedSessions
Average Session Alive Time measurement the average alive time of sessions for this WAR sessionAverageAliveTime
Max Session Alive Time measurement the maximum alive time of sessions for this WAR sessionMaxAliveTime
Minimum Response Time measurement the minimum response time for requests serviced by this WAR Servlet.minimumResponseTime
Average Response Time measurement the average response time for requests serviced by this WAR Servlet.averageResponseTime
Maximum Response Time measurement the maximum response time for requests serviced by this WAR Servlet.maximumResponseTime
Total Response Time measurement the total response time for requests serviced by this WAR Servlet.totalResponseTime
Total Response Time per Minute measurement the total response time for requests serviced by this WAR Servlet.totalResponseTime
Number of Requests Serviced measurement the number of requests serviced by this WAR Servlet.requestCount
Number of Requests Serviced per Minute measurement the number of requests serviced by this WAR Servlet.requestCount
Number of Error Responses measurement the number of error responses sent by this WAR Servlet.errorCount
Number of Error Responses per Minute measurement the number of error responses sent by this WAR Servlet.errorCount

Note

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

2.8.14. Enterprise Application (EAR) Service

Overview

Table 2.254. Overview

Description: JEE enterprise application (EAR)
Singleton: no
Plugin: JBossAS5

Parent Resource Types

Child Resource Types

none

Connection Properties

Table 2.255. 

Name Description Required Internal Name
Deployment Name The name of this EAR yes deploymentName
Filename yes filename
Extension yes extension
Description Template yes descriptionTemplate
Deployment Type Name The name of the item from the org.jboss.deployers.spi.management.KnownDeploymentTypes enum corresponding to this deployment's type. yes deploymentTypeName

Note

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

Metrics

Table 2.256. Metrics

Name Type Description Internal Name
Path trait the absolute path of this EAR file or directory custom.path
Exploded? trait whether this EAR is deployed exploded (i.e. as a directory) custom.exploded

Note

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

Configuration Properties

none

Operations

Table 2.257. Metrics

Name Description
Start starts this EAR
Stop stops this EAR
Restart stops and then restarts this EAR

Package Types

Table 2.258. Package Types

Name Category Description
EAR File Deployable

2.8.15. JBoss Messaging Service

Overview

Table 2.259. Overview

Description: the JBoss Messaging JMS provider
Singleton: yes
Plugin: JBossAS5

Parent Resource Types

Child Resource Types

Connection Properties

Table 2.260. 

Name Description Required Internal Name
Component Type yes componentType
Component Subtype yes componentSubtype
Component Name yes componentName

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

2.8.15.1. Queue Service

Overview

Table 2.261. Overview

Description: a JMS queue
Singleton: no
Plugin: JBossAS5

Note

The message counter metrics will not be collected by default. In order for these metrics to be collected for all Topics and Queues for a given application server instance, go to the instance's JMX Console, and invoke the enableMessageCounters operation on the jboss.messaging:service=ServerPeer MBean. To ensure the message counters are still enabled when the application server is restarted, edit that instance's deploy/messaging/messaging-service.xml file and set the EnableMessageCounters attribute to "true".
Parent Resource Types
Child Resource Types
none
Connection Properties

Table 2.262. 

Name Description Required Internal Name
Jms Type yes jms-type
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 2.263. Metrics

Name Type Description Internal Name
Run State trait Run State runState
Created Programmatically trait Was this queue created programmatically? If Yes, the queue will not survive a restart of the application server. If No, the queue was created via a deployment XML file. createdProgrammatically
Message Counter History Day Limit trait This queue's message counter history day limit - <0: unlimited, =0: history disabled, >0: maximum day count messageCounterHistoryDayLimit
Consumer Count measurement The number of consumers on the queue consumerCount
Delivering Count measurement The number of messages currently being delivered deliveringCount
Message Count measurement The number of messages in the queue messageCount
Scheduled Message Count measurement The number of scheduled messages in the queue scheduledMessageCount
Count measurement The total message count since startup or last counter reset messageStatistics.count
Count Delta measurement The message count delta since last method call messageStatistics.countDelta
Depth measurement The current message count of pending messages within the queue waiting for dispatch messageStatistics.depth
Depth Delta measurement The message count delta of pending messages since last method call messageStatistics.depthDelta
Time Last Update measurement The timestamp of the last message add messageStatistics.timeLastUpdate

Note

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

Table 2.264. 

Name Description Required Internal Name
Name The name of this queue (e.g. 'MyQueue'). yes name
JNDI Name This queue's JNDI name (e.g. '/queue/MyQueue'). yes JNDIName
Clustered Is this queue clustered? For an existing queue, this property is read-only. If not specified when creating a new queue, the default value is false. no clustered
Down Cache Size When paging messages to storage from a subscription, they first go into a "Down Cache" before being written to storage. This enables the write to occur as a single operation, thus aiding performance. This setting determines the maximum number of messages that the Down Cache will hold before they are flushed to storage. Updates to this property will not go into effect until the queue has been restarted. The default value is 2000. no downCacheSize
Full Size The maximum number of messages for the queue held in memory at any one time. The actual queue can hold many more messages than this, but these are paged to and from storage as necessary, as messages are added or consumed. Updates to this property will not go into effect until the queue has been restarted. The default value is 200000. no fullSize
Max Delivery Attempts The number of delivery attempts before a message to a subscriber of this queue is moved to the DLQ. The default value is 10. A value of -1 indicates the default value should be used. no maxDeliveryAttempts
Max Size The maximum number of messages this queue can hold before they are dropped. A value of -1 means there is no maximum. The default value is -1. no maxSize
Page Size When loading messages from a subscription, this is the maximum number of messages to pre-load in one operation. Must be less than Full Size and greater than or equal to Down Cache Size. Updates to this property will not go into effect until the queue has been restarted. The default value is 2000. no pageSize
Redelivery Delay The delay in milliseconds before a rolled back or recovered message is redelivered. Set to 0 to disable redelivery. The default value is 0. A value of -1 indicates the default value should be used. no redeliveryDelay
DLQ The JMX ObjectName of the dead letter queue (DLQ) for this queue (e.g. "jboss.messaging.destination:service=Queue,name=PrivateDLQ") - overrides the default DLQ on the server peer. no DLQ
Expiry Queue The JMX ObjectName of the expiry queue for this queue (e.g. "jboss.messaging.destination:service=Queue,name=PrivateExpiryQueue") - overrides the default expiry queue on the server peer. no expiryQueue
Server Peer The JMX ObjectName of the server peer this queue was deployed on (e.g. "jboss.messaging:service=ServerPeer"). Updates to this property will not go into effect until the queue has been restarted. no serverPeer
Security Configurations This element specifies a XML fragment which describes the access control list to be used by the SecurityManager to authorize client operations against the destination. The content model is the same as for the SecurityManager SecurityConf attribute. yes securityConfig

Note

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

Table 2.265. Metrics

Name Description
Remove All Messages Remove all messages from the destination.
Start Start the destination.
Stop Stop the destination.
List All Messages List all messages for the specified selector
List Durable Messages List all durable messages for the specified selector
List Non Durable Messages List all non durable messages for the specified selector
List Message Counter As HTML Get the message counter as HTML
List Message Counter History As HTML Get the message counter history as HTML
Reset Message Counter Reset the message counter
Reset Message Counter History Reset the message counter history

Package Types
none

2.8.15.2. Topic Service

Overview

Table 2.266. Overview

Description: a JMS topic
Singleton: no
Plugin: JBossAS5

Note

The message counter metrics will not be collected by default. In order for these metrics to be collected for all Topics and Queues for a given application server instance, go to the instance's JMX Console, and invoke the enableMessageCounters operation on the jboss.messaging:service=ServerPeer MBean. To ensure the message counters are still enabled when the application server is restarted, edit that instance's deploy/messaging/messaging-service.xml file and set the EnableMessageCounters attribute to "true".
Parent Resource Types
Child Resource Types
none
Connection Properties

Table 2.267. 

Name Description Required Internal Name
Jms Type yes jms-type
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 2.268. Metrics

Name Type Description Internal Name
Run State trait Run State runState
Created Programmatically trait Was this topic created programmatically? If Yes, the topic will not survive a restart of the application server. If No, the topic was created via a deployment XML file. createdProgrammatically
Message Counter History Day Limit trait This topic's message counter history day limit - <0: unlimited, =0: history disabled, >0: maximum day count messageCounterHistoryDayLimit
All Message Count measurement The count of all messages in all subscriptions to this topic allMessageCount
All Subscriptions Count measurement The count of all subscriptions to this topic allSubscriptionsCount
Durable Message Count measurement The count of all messages for all durable subscriptions to this topic durableMessageCount
Durable Subscriptions Count measurement The count of all durable subscriptions to this topic durableSubscriptionsCount
Non Durable Message Count measurement The count of all messages in all non durable subscriptions to this topic nonDurableMessageCount
Non Durable Subscriptions Count measurement The count of all non durable subscriptions to this topic nonDurableSubscriptionsCount

Note

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

Table 2.269. 

Name Description Required Internal Name
Name The name of this topic (e.g. 'MyTopic'). yes name
JNDI Name This topic's JNDI name (e.g. '/topic/MyTopic') yes JNDIName
Clustered Is this topic clustered? For an existing topic, this property is read-only. If not specified when creating a new topic, the default value is false. no clustered
Down Cache Size When paging messages to storage from a subscription, they first go into a "Down Cache" before being written to storage. This enables the write to occur as a single operation, thus aiding performance. This setting determines the maximum number of messages that the Down Cache will hold before they are flushed to storage. Updates to this property will not go into effect until the topic has been restarted. The default value is 2000. no downCacheSize
Full Size The maximum number of messages held by the topic subscriptions in memory at any one time. The actual subscription can hold many more messages than this, but these are paged to and from storage as necessary, as messages are added or consumed. Updates to this property will not go into effect until the topic has been restarted. The default value is 200000. no fullSize
Max Delivery Attempts The number of delivery attempts before a message to a subscriber of this topic is moved to the DLQ. The default value is 10. A value of -1 indicates the default value should be used. no maxDeliveryAttempts
Max Size The maximum number of messages this topic can hold before they are dropped. A value of -1 means there is no maximum. The default value is -1. no maxSize
Page Size When loading messages from a subscription, this is the maximum number of messages to pre-load in one operation. Must be less than Full Size and greater than or equal to Down Cache Size. Updates to this property will not go into effect until the topic has been restarted. The default value is 2000. no pageSize
Redelivery Delay The delay in milliseconds before a rolled back or recovered message is redelivered. Set to 0 to disable redelivery. The default value is 0. A value of -1 indicates the default value should be used. no redeliveryDelay
DLQ The JMX ObjectName of the dead letter queue (DLQ) for this topic (e.g. "jboss.messaging.destination:service=Queue,name=PrivateDLQ") - overrides the default DLQ on the server peer. no DLQ
Expiry Queue The JMX ObjectName of the expiry queue for this topic (e.g. "jboss.messaging.destination:service=Queue,name=PrivateExpiryQueue") - overrides the default expiry queue on the server peer. no expiryQueue
Server Peer The JMX ObjectName of the server peer this topic was deployed on (e.g. "jboss.messaging:service=ServerPeer"). Updates to this property will not go into effect until the topic has been restarted. no serverPeer
Security Configurations This element specifies a XML fragment which describes the access control list to be used by the SecurityManager to authorize client operations against the destination. The content model is the same as for the SecurityManager SecurityConf attribute. yes securityConfig

Note

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

Table 2.270. Metrics

Name Description
Remove All Messages Remove all messages from the destination.
Start Start the destination.
Stop Stop the destination.
List All Messages List all messages for the specified subscription with the specified selector
List Durable Messages List all durable messages for the specified subscription with the specified selector
List Non Durable Messages List all non durable messages for the specified subscription with the specified selector
List All Subscriptions Return all subscriptions for the topic
List All Subscriptions As HTML Return all subscriptions for the topic as HTML
List Durable Subscriptions Return all durable subscriptions for the topic
List Durable Subscriptions As HTML Return all durable subscriptions for the topic as HTML
List Non-Durable Subscriptions Return all non-durable subscriptions for the topic
List Non-Durable Subscriptions As HTML Return all non-durable subscriptions for the topic as HTML

Package Types
none

2.8.16. JBoss Web Service

Overview

Table 2.271. Overview

Description: JBoss Web Servlet Container
Singleton: yes
Plugin: JBossAS5

Parent Resource Types

Child Resource Types

Connection Properties

none

Metrics

none

Configuration Properties

none

Operations

none

Package Types

none

2.8.16.1. Connector Service

Overview

Table 2.272. Overview

Description: a JBoss Web Connector
Singleton: no
Plugin: JBossAS5

Parent Resource Types
Child Resource Types
none
Connection Properties

Table 2.273. 

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

Note

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

2.8.16.2. Virtual Host Service

Overview

Table 2.275. Overview

Description: a JBoss Web virtual host
Singleton: no
Plugin: JBossAS5

Parent Resource Types
Child Resource Types
none
Connection Properties

Table 2.276. 

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

2.8.17. Local Tx Datasource Service

Overview

Table 2.278. Overview

Description: Local Transaction Datasources deployed in the instance of JBoss AS
Singleton: no
Plugin: JBossAS5

Parent Resource Types

Child Resource Types

none

Connection Properties

Table 2.279. 

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 2.280. Metrics

Name Type Description Internal Name
Run State trait Run State runState
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 2.281. 

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

Package Types

none

2.8.18. No Tx ConnectionFactory Service

Overview

Table 2.283. Overview

Description: A ConnectionFactory that does not take part in JTA transactions.
Singleton: no
Plugin: JBossAS5

Parent Resource Types

Child Resource Types

none

Connection Properties

Table 2.284. 

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 2.285. Metrics

Name Type Description Internal Name
Run State trait Run State runState
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 2.286. 

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

Package Types

none

2.8.19. No Tx Datasource Service

Overview

Table 2.288. Overview

Description: No Transaction Datasources deployed in the instance of JBoss AS
Singleton: no
Plugin: JBossAS5

Parent Resource Types

Child Resource Types

none

Connection Properties

Table 2.289. 

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 2.290. Metrics

Name Type Description Internal Name
Run State trait Run State runState
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 2.291. 

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

Package Types

none

2.8.20. Resource Adapter Archive (RAR) Service

Overview

Table 2.293. Overview

Description: a standalone JCA resource adapter archive (RAR)
Singleton: no
Plugin: JBossAS5

Parent Resource Types

Child Resource Types

none

Connection Properties

Table 2.294. 

Name Description Required Internal Name
Deployment Name the name of this RAR yes deploymentName
Filename yes filename
Extension yes extension
Description Template yes descriptionTemplate
Deployment Type Name The name of the item from the org.jboss.deployers.spi.management.KnownDeploymentTypes enum corresponding to this deployment's type. yes deploymentTypeName

Note

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

Metrics

Table 2.295. Metrics

Name Type Description Internal Name
Path trait the absolute path of this RAR file or directory custom.path
Exploded? trait whether this RAR is deployed exploded (i.e. as a directory) custom.exploded

Note

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

Configuration Properties

none

Operations

Table 2.296. Metrics

Name Description
Start starts this RAR
Stop stops this RAR
Restart stops and then restarts this RAR

Package Types

Table 2.297. Package Types

Name Category Description
RAR File Deployable

2.8.21. Script Service

Overview

Table 2.298. Overview

Description: provides the ability to execute a script that performs some task related to its parent JBossAS server
Singleton: no
Plugin: JBossAS5

Parent Resource Types

Child Resource Types

none

Connection Properties

Table 2.299. 

Name Description Required Internal Name
Path the absolute path to the script file yes path
Environment Variables the environment variables that will be passed to the script; each variable must be on a new line and have the syntax name=value; the variable's value can contain properties with the syntax %propertyName%; the script plugin will interpolate these with the current values of the corresponding properties from the script's parent JBossAS server's connection properties no environmentVariables

Note

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

Metrics

none

Configuration Properties

none

Operations

Table 2.300. Metrics

Name Description
Execute Script execute the script; NOTE: environment variables to be passed to the script can be configured via this Script service's connection properties (under its Inventory tab)

Package Types

none

2.8.22. Service Binding Manager Service

Overview

Table 2.301. Overview

Description: The Service Binding Manager manages the ports of the deployed services
Singleton: yes
Plugin: JBossAS5

Parent Resource Types

Child Resource Types

Connection Properties

Table 2.302. 

Name Description Required Internal Name
Component Type yes componentType
Component Subtype yes componentSubtype
Component Name yes componentName

Note

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

Metrics

Table 2.303. Metrics

Name Type Description Internal Name
Active Binding Set trait The active binding set used to obtain port bindings from. activeBindingSetName

Note

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

Configuration Properties

Table 2.304. 

Name Description Required Internal Name
Active Binding Set Name The name of the binding set the Service Binding Manager should use when resolving bindings. Note to JBoss ON or Jopr users (does not apply to JBoss AS admin console): CHANGING THIS PROPERTY IS POTENTIALLY DANGEROUS because if there are any port conflicts on the machine the Application Server is running on, the server will not start up again and it will not be possible to monitor it. To be able to monitor the server again after the restart you have to update the "Naming Provider Url" in the "Connection" subtab in the "Inventory" of the Application Server to the value of "jboss:service=Naming:Port" binding of the active binding set. I.e. if the "jboss:service=Naming:Port" binding of the active binding set has the port set to 4099 and hostname to 127.0.0.1, you have to set the "Naming Provider Url" to jnp://127.0.0.1:4099. yes activeBindingSetName
Standard Bindings The standard port bindings inherited by the binding sets. yes standardBindings

Note

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

Operations

none

Package Types

none

2.8.22.1. Service Binding Set Service

Overview

Table 2.305. Overview

Description: The Service Binding Set defines all bindings of a profile. It inherits the standard bindings from the Service Binding Manager and defines a port offset and overridden and additional bindings.
Singleton: no
Plugin: JBossAS5

Parent Resource Types
Child Resource Types
none
Connection Properties
none
Metrics

Table 2.306. Metrics

Name Type Description Internal Name
Name trait The name of this binding set. name
Default Host Name trait The default host name of this binding set. defaultHostName
Port Offset trait The port offset of this binding set. portOffset

Note

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

Table 2.307. 

Name Description Required Internal Name
Name The name of this binding set. yes name
Default Host Name The host name that should be used for all bindings whose configuration does not specify "fixed host name". yes defaultHostName
Port Offset A value to add to the port configuration for a standard binding to derive the port to use in this binding set. This doesn't apply to standard bindings defined as 'fixed port'. yes portOffset
Override Bindings The binding configurations that apply only to this binding set, either non-standard bindings or ones that override standard binding configurations. The binding set inherits the standard bindings from the Service Binding Manager, applies the port offset to them (unless the standard binding is defined as "fixed port"), and appends the override bindings. These can either redefine a standard binding or define a brand new binding. The standard bindings and the override bindings then define the full set of the bindings that are defined by the binding set. yes overrideBindings

Note

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

Table 2.308. Metrics

Name Description
Display Bindings Displays the full set of bindings as they would look if this bindings set was active.

Package Types
none

2.8.23. Tx ConnectionFactory Service

Overview

Table 2.309. Overview

Description: A ConnectionFactory that takes part in JTA transactions.
Singleton: no
Plugin: JBossAS5

Parent Resource Types

Child Resource Types

none

Connection Properties

Table 2.310. 

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 2.311. 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
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 2.312. 

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
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. 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
Interleaving If true, enable transaction interleaving if the DB vendor supports it (most do not). Can only be set to true if XA transactions are enabled. This property supersedes the "track-connection-by-tx" property from earlier versions of JBoss AS. The default is false. no interleaving
XA Resource Timeout The maximum time, in minutes, an XA Resource can be idle before it is removed. 0 means no timeout. The default is 0. no xa-resource-timeout

Note

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

Operations

Table 2.313. 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

Package Types

none

2.8.24. Web Application (WAR) Service

Overview

Table 2.314. Overview

Description: a standalone web application (WAR)
Singleton: no
Plugin: JBossAS5

Parent Resource Types

Child Resource Types

Connection Properties

Table 2.315. 

Name Description Required Internal Name
Deployment Name the name of this WAR yes deploymentName
Filename yes filename
Context Path this WAR's context path (e.g. /admin-console) yes contextPath
Extension yes extension
Description Template yes descriptionTemplate
Deployment Type Name The name of the item from the org.jboss.deployers.spi.management.KnownDeploymentTypes enum corresponding to this deployment's type. yes deploymentTypeName

Note

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

Metrics

Table 2.316. Metrics

Name Type Description Internal Name
Path trait the absolute path of this WAR file or directory custom.path
Exploded? trait whether this WAR is deployed exploded (i.e. as a directory) custom.exploded
Context Root trait this context root of this WAR (e.g. jmx-console) - used as a unique path prefix for URLs corresponding to this WAR contextRoot
Virtual Hosts trait the virtual host(s) to which this WAR is deployed virtualHosts

Note

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

Configuration Properties

none

Operations

Table 2.317. Metrics

Name Description
Start starts this WAR
Stop stops this WAR
Restart stops and then restarts this WAR

Package Types

Table 2.318. Package Types

Name Category Description
WAR File Deployable

2.8.24.1. Web Application Context Service

Overview

Table 2.319. Overview

Description: a web application context
Singleton: no
Plugin: JBossAS5

Parent Resource Types
Child Resource Types
none
Connection Properties

Table 2.320. 

Name Description Required Internal Name
Component Type yes componentType
Component Subtype yes componentSubtype
Component Name yes componentName
Response Time Log File the full path to the log file containing response-time stats for this webapp no responseTimeLogFile
Response Time Url Excludes a space-delimited list of regular expressions specifying URLs that should be excluded from response-time stats collection no responseTimeUrlExcludes
Response Time Url Transforms a space-delimited list of Perl-style substitution expressions that should be applied to all URLs for which response-time stats are collected (e.g. |^/dept/finance/.*|/dept/finance/*|) no responseTimeUrlTransforms
Virtual Host this WAR's virtual host (e.g. localhost) yes virtualHost

Note

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

Table 2.321. Metrics

Name Type Description Internal Name
Virtual Host trait the virtual host with which this context is associated virtualHost
Response Time calltime the minimum, maximum, and average response times for requests serviced by this webapp responseTime
Currently Active Sessions measurement the number of sessions that are currently active for this WAR activeSessions
Maximum Active Sessions measurement the maximum number of sessions that have been active for this WAR maxActive
Created Sessions measurement the number of sessions created for this WAR sessionCounter
Created Sessions per Minute measurement the number of sessions created for this WAR sessionCounter
Expired Sessions measurement the number of expired sessions for this WAR expiredSessions
Expired Sessions per Minute measurement the number of expired sessions for this WAR expiredSessions
Rejected Sessions measurement the number of sessions rejected for this WAR rejectedSessions
Rejected Sessions per Minute measurement the number of sessions rejected for this WAR rejectedSessions
Average Session Alive Time measurement the average alive time of sessions for this WAR sessionAverageAliveTime
Max Session Alive Time measurement the maximum alive time of sessions for this WAR sessionMaxAliveTime
Minimum Response Time measurement the minimum response time for requests serviced by this WAR Servlet.minimumResponseTime
Average Response Time measurement the average response time for requests serviced by this WAR Servlet.averageResponseTime
Maximum Response Time measurement the maximum response time for requests serviced by this WAR Servlet.maximumResponseTime
Total Response Time measurement the total response time for requests serviced by this WAR Servlet.totalResponseTime
Total Response Time per Minute measurement the total response time for requests serviced by this WAR Servlet.totalResponseTime
Number of Requests Serviced measurement the number of requests serviced by this WAR Servlet.requestCount
Number of Requests Serviced per Minute measurement the number of requests serviced by this WAR Servlet.requestCount
Number of Error Responses measurement the number of error responses sent by this WAR Servlet.errorCount
Number of Error Responses per Minute measurement the number of error responses sent by this WAR Servlet.errorCount

Note

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

2.8.25. XA Datasource Service

Overview

Table 2.322. Overview

Description: XA Datasources deployed in the instance of JBoss AS
Singleton: no
Plugin: JBossAS5

Parent Resource Types

Child Resource Types

none

Connection Properties

Table 2.323. 

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 2.324. Metrics

Name Type Description Internal Name
Run State trait Run State runState
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 2.325. 

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

Package Types

none