Chapter 4. Available JBoss Plug-in Packs

Additional JBoss products can be managed by JBoss ON by installing additional plug-in packs.

4.1. JBoss Service Oriented Architecture Platform (ESB5) Plug-in

Overview

Table 4.1. Overview

Description: Overall metrics for JBoss ESB
Singleton: yes
Plugin: JBossESB5

Child Resource Types

Connection Properties

Table 4.2. 

Name Description Required Internal Name
Naming Provider URL The JNP URL with which to connect to the JBoss Application Server 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 JBossAS is installed (e.g. /opt/jboss-4.2.2.GA). yes jbossHomeDir
Configuration Path The path to the configuration directory under which this instance operates (e.g. /opt/jboss-4.2.2.GA/server/default); if the path is not absolute, then it will be resolved relative to {jbossHomeDir}. yes configurationPath
Configuration Set The name of the server configuration (e.g. minimal, default, or all); if not specified, it will default to the last path component of {configurationPath}. no configurationSet
Object Name yes objectName
Name Template yes nameTemplate
Description Template yes descriptionTemplate

Note

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

Metrics

Table 4.3. Metrics

Name Type Description Internal Name
Message Count (Successful) measurement Overall Successful Message Count SuccessfulMessageCount
Message Count (Total) measurement Total Message Count TotalMessageCount
Message Count (Failed) measurement Failed Message Count FailedMessageCount
Processed Bytes measurement Overall Bytes Processed ProcessedBytes
Last Successful Message Date trait Last Successful Message Date LastSuccessfulMessageDate
Last Failed Message Date trait Last Failed Message Date LastFailedMessageDate

Note

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

Configuration Properties

none

Operations

Table 4.4. Metrics

Name Description
Reset Counts Reset the overall counter

Package Types

Table 4.5. Package Types

Name Category Description
Jar Library Deployable Library Jar files deployed in JBoss AS

4.1.1. JBossESB5 - Deployment Service

Overview

Table 4.6. Overview

Description: Metrics for Deployments
Singleton: no
Plugin: JBossESB5

Child Resource Types

Connection Properties

Table 4.7. 

Name Description Required Internal Name
Extension yes extension
Description Template yes descriptionTemplate
Deployment Type Name yes deploymentTypeName
Object Name yes objectName
Name Template yes nameTemplate
Deployment the deployment name yes deployment

Note

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

Metrics

Table 4.8. Metrics

Name Type Description Internal Name
Deployment Type trait Type of deployment Name

Note

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

Configuration Properties

none

Operations

Table 4.9. Metrics

Name Description
Start deployment Start the deployment
Stop deployment Stop the deployment

Package Types

Table 4.10. Package Types

Name Category Description
ESB Package Deployable

4.1.1.1. JBossESB5 - Services Service

Overview

Table 4.11. Overview

Description: Services
Singleton: no
Plugin: JBossESB5

Note

Services are the services available within a deployment.
Child Resource Types
Connection Properties

Table 4.12. 

Name Description Required Internal Name
Object Name yes objectName
Name Template yes nameTemplate
Description Template yes DescriptionTemplate
Service Name the service name yes serviceName
Category Name the service category name yes categoryName

Note

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

Table 4.13. Metrics

Name Type Description Internal Name
Message Count measurement Message Count overallMessageCount
Message Count (avg) measurement Message Count (avg) overallMessageCountByMinute
Message Count (avg) per Minute measurement Message Count (avg) overallMessageCountByMinute
Overall Bytes measurement Overall Bytes overallBytes
Overall Bytes Processed measurement Overall Bytes Processed bytesProcessed
Overall Bytes Failed measurement Overall Bytes Failed bytesFailed
Overall Service Time Processed measurement Overall Service Time Processed overallTimeProcessed

Note

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

Table 4.14. Metrics

Name Description
Reset the message counter Reset the message counter
Package Types
none
4.1.1.1.1. JBossESB5 - Listeners Service
Overview

Table 4.15. Overview

Description: Listeners
Singleton: no
Plugin: JBossESB5

Note

Listener configuration shows the config of the listener.
Child Resource Types
none
Connection Properties

Table 4.16. 

Name Description Required Internal Name
Object Name yes objectName
Name Template yes nameTemplate
Description Template yes descriptionTemplate
Service Category the service category of the listener yes serviceCategory
Listener Name the name of the Listener yes listenerName
Deployment Name name of deployment yes deploymentName

Note

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

Table 4.17. Metrics

Name Type Description Internal Name
MEP trait Type of deployment mep
Lifecycle State trait Lifecycle State LifeCycleState
Maximum Number of Threads trait Maximum number of threads maxThreads
Start Date trait Start Date StartDate
Service Category trait Service Category service-category
Service Description trait Service Description service-description
Service Name trait Service Name service-name

Note

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

Table 4.18. Metrics

Name Description
Start listener Start the listener.
Stop listener Stop the listener.
Package Types
none
4.1.1.1.2. JBossESB5 - Gateways Service
Overview

Table 4.19. Overview

Description: Gateways
Singleton: no
Plugin: JBossESB5

Note

Gateway configuration shows the config of the listener.
Child Resource Types
none
Connection Properties

Table 4.20. 

Name Description Required Internal Name
Object Name yes objectName
Name Template yes nameTemplate
Description Template yes descriptionTemplate
Service Category the service category of the listener yes serviceCategory
Listener Name the name of the Listener yes listenerName
Deployment Name name of deployment yes deploymentName

Note

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

Table 4.21. Metrics

Name Type Description Internal Name
Lifecycle State trait Lifecycle State LifeCycleState
Maximum Number of Threads trait Maximum number of threads maxThreads
Service Category trait Service Category target-service-category
Service Description trait Service Description target-service-description
Service Name trait Service Name target-service-name

Note

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

Table 4.22. Metrics

Name Description
Start listener Start the listener.
Stop listener Stop the listener.
Package Types
none
4.1.1.1.3. JBossESB5 - Actions Service
Overview

Table 4.23. Overview

Description: Actions
Singleton: no
Plugin: JBossESB5

Note

Actions are the actions executed within a service.
Child Resource Types
none
Connection Properties

Table 4.24. 

Name Description Required Internal Name
Object Name yes objectName
Name Template yes nameTemplate
Description Template yes descriptionTemplate
Action Name the action name yes actionName

Note

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

Table 4.25. Metrics

Name Type Description Internal Name
Message Count measurement Message Count overallMessagesCount
Message Count (avg) measurement Message Count (avg) overallMessagesCountMinute
Message Count (avg) per Minute measurement Message Count (avg) overallMessagesCountMinute
Messages Failed measurement Messages Failed failedProcessedCount
Messages Failed (avg) measurement Messages Failed (avg) failedProcessedCountMinute
Messages Failed (avg) per Minute measurement Messages Failed (avg) failedProcessedCountMinute
Messages Successfully Processed measurement Messages Successfully Processed successProcessedCount
Messages Successfully Processed (avg) measurement Messages Successfully Processed (avg) successProcessedCountMinute
Messages Successfully Processed (avg) per Minute measurement Messages Successfully Processed (avg) successProcessedCountMinute
Overall Bytes measurement Overall Bytes overallBytesProcessed
Overall Bytes Processed measurement Overall Bytes Processed bytesSuccessful
Overall Bytes Failed measurement Overall Bytes Failed overallBytesFailed
Processing Time measurement Processing Time processingTime

Note

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