5.5. ESB 5 Service

Overview

Expand

Table 5.33. Overview
Description:	Overall metrics for JBoss ESB 5.
Singleton:	yes
Plugin:	JBossESB5

Parent Resource Types

Section 2.2, “JBossAS 5.x Server and JBoss EAP 5.x”

Child Resource Types

Connection Properties

Expand

Table 5.34.
Name	Description	Required	Internal Name
Object Name		yes	objectName
Name Template		yes	nameTemplate
Description Template		yes	descriptionTemplate
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

Metrics

Expand

Table 5.35. Metrics
Name	Type	Description	Internal Name
Message Count (Successful)	measurement	Overall Successful Message Count.	SuccessfulMessageCount
Message Count (Total)	measurement	Total Message Count.	TotalMessageCount
Message Counts (Failed)	measurement	Failed Message Count.	FailedMessageCount
Processed Bytes	measurement	Overall Bytes Processed.	ProcessedBytes
LastSuccessfulMessageDate	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

Expand

Table 5.36. Metrics
Name	Description
Reset Counts	Reset the overall counter.

Expand

Table 5.37. Package Types
Name	Category	Description
Jar Library	Deployable	Library Jar files deployed in JBoss AS.

5.5.1. Deployment
Copy link

Overview

Expand

Table 5.38. Overview
Description:	Metrics for Deployments.
Singleton:	no
Plugin:	JBossESB5

Parent Resource Types

Section 5.5, “ESB 5 Service”

Child Resource Types

none

Connection Properties

Expand

Table 5.39.
Name	Description	Required	Internal Name
Object Name		yes	objectName
Name Template		yes	nameTemplate
Description Template		yes	descriptionTemplate
Deployment	The deployment name.	yes	deployment
Extension		yes	extension

Metrics

Expand

Table 5.40. Metrics
Name	Type	Description	Internal Name
Deployment Type	trait	Type of deployment.	Name
.esb State String	trait	Current state of the ESB.	StateString
.esb State	trait	Numeric value of the state of the ESB 5 deployment.	State

Note

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

Configuration Properties

none

Operations

Expand

Table 5.41. Operations
Name	Description
Start deployment	Start the deployment.
Stop deployment	Stop the deployment.

Expand

Table 5.42. Package Types
Name	Category	Description
ESB Package	Deployable

5.5.2. Services
Copy link

Overview

Expand

Table 5.43. Overview
Description:	Services.
Singleton:	no
Plugin:	JBossESB5

Note

Services are the services available within a deployment.

Parent Resource Types

Section 5.5, “ESB 5 Service”

Child Resource Types

none

Connection Properties

Expand

Table 5.44.
Name	Description	Required	Internal Name
Object Name		yes	objectName
Name Template		yes	nameTemplate
Description Template		yes	descriptionTemplate
Deployment	The deployment name.	yes	deployment
Service Name	The service name.	yes	serviceName
Category Name	The service category name.	yes	categoryName

Metrics

Expand

Table 5.45. Metrics
Name	Type	Description	Internal Name
Message Count	trait	Type of deployment.	Name
Message Count (avg)	trait	Current state of the ESB.	StateString
Overall Bytes	trait	Numeric value of the state of the ESB 5 deployment.	State
Overall Bytes Processed	trait	Numeric value of the state of the ESB 5 deployment.	State
Overall Bytes Failed	trait	Numeric value of the state of the ESB 5 deployment.	State
Overall Service Time Processed	trait	Numeric value of the state of the ESB 5 deployment.	State

Note

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

Configuration Properties

none

Operations

Expand

Table 5.46. Operations
Name	Description
Reset the message counter	Reset the message counter.

Package Types

none

5.5.3. Gateways
Copy link

Overview

Expand

Table 5.47. Overview
Description:	Gateways.
Singleton:	no
Plugin:	JBossESB5

Note

Gateway configuration shows the config of the listener.

Parent Resource Types

Section 5.5, “ESB 5 Service”

Child Resource Types

none

Connection Properties

Expand

Table 5.48.
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	The name of deployment.	yes	deploymentName

Metrics

Expand

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

Expand

Table 5.50. Operations
Name	Description
Start listener	Start the listener.
Stop listener	Stop the listener.

Expand

Table 5.51. Package Types
Name	Category	Description
ESB Package	Deployable

5.5.4. Listeners
Copy link

Overview

Expand

Table 5.52. Overview
Description:	Listeners.
Singleton:	no
Plugin:	JBossESB5

Note

Listener configuration shows the config of the listener.

Parent Resource Types

Section 5.5, “ESB 5 Service”

Child Resource Types

none

Connection Properties

Expand

Table 5.53.
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	The name of deployment.	yes	deploymentName

Metrics

Expand

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

Expand

Table 5.55. Operations
Name	Description
Start listener	Start the listener.
Stop listener	Stop the listener.

Package Types

none

5.5.5. Actions
Copy link

Overview

Expand

Table 5.56. Overview
Description:	Actions.
Singleton:	no
Plugin:	JBossESB5

Note

Actions are the actions executed within a service.

Parent Resource Types

Section 5.5, “ESB 5 Service”

Child Resource Types

none

Connection Properties

Expand

Table 5.57.
Name	Description	Required	Internal Name
Object Name		yes	objectName
Name Template		yes	nameTemplate
Description Template		yes	descriptionTemplate
Action Name	The action name.	yes	actionName

Metrics

Expand

Table 5.58. Metrics
Name	Type	Internal Name
Message Count	measurement	overallMessagesCount
Message Count (avg)	measurement	overallMessagesCountMinute
Messages Failed	measurement	failedProcessedCount
Messages Failed (avg)	measurement	failedProcessedCountMinute
Messages Successfully Processed	measurement	successProcessedCount
Messages Successfully Processed (avg)	measurement	successProcessedCountMinute
Overall Bytes	measurement	overallBytesProcessed
Overall Bytes Processed	measurement	bytesSuccessful
Overall Bytes Failed	measurement	overallBytesFailed
Processing Time	measurement	processingTime

Note

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

Configuration Properties

none

Operations

none

Package Types

none

5.5. ESB 5 Service

Overview

Parent Resource Types

Child Resource Types

Connection Properties

Metrics

Configuration Properties

Operations

5.5.1. DeploymentCopy linkLink copied to clipboard!

Overview

Parent Resource Types

Child Resource Types

Connection Properties

Metrics

Configuration Properties

Operations

5.5.2. ServicesCopy linkLink copied to clipboard!

Overview

Parent Resource Types

Child Resource Types

Connection Properties

Metrics

Configuration Properties

Operations

Package Types

5.5.3. GatewaysCopy linkLink copied to clipboard!

Overview

Parent Resource Types

Child Resource Types

Connection Properties

Metrics

Configuration Properties

Operations

5.5.4. ListenersCopy linkLink copied to clipboard!

Overview

Parent Resource Types

Child Resource Types

Connection Properties

Metrics

Configuration Properties

Operations

Package Types

5.5.5. ActionsCopy linkLink copied to clipboard!

Overview

Parent Resource Types

Child Resource Types

Connection Properties

Metrics

Configuration Properties

Operations

Package Types

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

Making open source more inclusive

About Red Hat

Theme

Red Hat legal and privacy links

Red Hat legal and privacy links

5.5.1. Deployment
Copy link

5.5.2. Services
Copy link

5.5.3. Gateways
Copy link

5.5.4. Listeners
Copy link

5.5.5. Actions
Copy link