JBoss Community Archive (Read Only)

RHQ 4.9

JBossAS5 - Topic Service

Overview

Internal Name:

Topic

Description:

a JMS topic

Singleton:

no

Plugin:

JBossAS5

Managed Resource Configuration

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

Connection Settings

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

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

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

Clustered

trait

True if this topic is clustered, false otherwise

clustered

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

Configuration Properties

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

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

Operations

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

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