Red Hat Training

A Red Hat training course is available for Red Hat JBoss Operations Network

3.10. HornetQ - JMS Manager Service

Overview

Table 3.2021. Overview

Description:
Singleton: yes
Plugin: HornetQ

Child Resource Types

Connection Properties

none

Metrics

Table 3.2022. Metrics

Name Type Description Internal Name
Provider Name trait The JMS Provider provider
Is Started trait The HornetQ version started

Note

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

Configuration Properties

none

Operations

Table 3.2023. Metrics

Name Description
List Remote Addresses List all remote addresses connected to HornetQ.
List Remote Addresses List all remote addresses connected to HornetQ that match an ip address.
Close Connection Closes all the connections for the given IP Address.
List connections List all the connection IDs.
List sessions List the sessions for the given connectionID.
Enable Message Counters Enable Message Counters.
Disable Message Counters Disable Message Counters.
Reset All MessageCounters Reset All MessageCounters.
Reset All Message Counter Histories Reset All Message Counter Histories.

Package Types

none

3.10.1. HornetQ - JMS Queue Service

Overview

Table 3.2024. Overview

Description:
Singleton: no
Plugin: HornetQ

Child Resource Types

none

Connection Properties

none

Metrics

Table 3.2025. Metrics

Name Type Description Internal Name
Name trait name of this destination getName
JNDI Binding trait JNDI Binding of this destination getJNDIBindings
Address trait Address of this destination getAddress
Temporary trait If this destination is temporary isTemporary
Message Count measurement number of messages currently held in this queue awaiting delivery getMessageCount
Scheduled Message Count measurement number of scheduled messages in this queue awaiting scheduled delivery getScheduledCount
Consumer Count measurement number of consumers currently consuming messages from this queue getConsumerCount
Delivering Count measurement number of messages that this queue is currently delivering to its consumers that have not been acknowledged getDeliveringCount
Messages Added measurement number of messages added to this queue since it was initially created getMessagesAdded
Paused trait Is the queue currently paused isPaused

Note

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

Configuration Properties

Table 3.2026. 

Name Description Required Internal Name
Name The name of the queue yes name
JNDI Name comma-separated list of JNDI bindings (use ',' if u need to use commas in your jndi name) yes jndiBindings
Dead Letter Address The address to route messages to once the message has been delivered more than the configured number of times. This is specified by 'Max Delivery Attempts'. Default is no dead letter address no dla
Expiry Address The Address to route messages to once they have expired. Default is no Expiry Address no expiryAddress
Max Size of Address The maximum size in bytes of messages that can be delivered to this queue. -1 means no limit, if limit is set then 'Address Full Message Policy' specifies what should happen yes maxSize
Page Size The size in bytes that an address can reach before paging starts. -1 means no limit. yes pageSize
Page Cache Max Size The max number of pages in the soft memory cache. yes pageMaxCacheSize
Max Delivery Attempts The maximum time to attempt delivery of a message to a consumer, once hit the message is routed to which ever address is specified by 'Dead Letter Address' yes maxDeliveryAttempts
Redelivery Delay The delay (in milli seconds) before re routing a message to this Address after an unsuccessful delivery attempt has occurred. default 0 means no delay yes redeliveryDelay
Last Value Queue Is this queue a last value queue. A last value queue can only ever contain a single message for each value for the message property '_HQ_LVQ_NAME'. yes lastValueQueue
Redistribution Delay How long to wait (in milli seconds) before redistributing messages to another node when clustered when a queue has no consumers. Default -1 means do not re distribute. yes redistributionDelay
Send To dead letter address on no route Whether or not messages routed to this address gets sent to dead letter address when no consumers are available yes sendToDLAOnNoRoute
Address Full Message Policy The policy to use when this Address is full. PAGE means that the message will be paged, DROP means that messages are just dropped and BLOCK means that the client will block on send until the queue clears some messages yes addressFullMessagePolicy
Roles These are the roles for this queue. The 'name' of the role, 'send' allows a producer to send a message, 'consume' allows a consumer to receive a message. yes roles

Note

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

Operations

Table 3.2027. Metrics

Name Description
Remove Messages Remove all the messages from this queue.
List Messages list all the messages currently in this queue.
Count Messages Returns the number of the messages in the queue.
Remove Message Remove the message corresponding to the given messageID.
Expire Messages Expires messages.
Expire Message Expire the message corresponding to the given messageID.
Send Message to dead letter address Send the message corresponding to the given messageID to this queue's Dead Letter Address.
Send Messages to dead letter address Send the messages corresponding to the given filter to this queue's Dead Letter Address.
Change Message Priority Change the priority of the message corresponding to the given messageID.
Change Messages Priority Change the priority of the messages corresponding to the given filter.
Move Message Move the message corresponding to the given messageID to another queue.
Move Messages Move the messages corresponding to the given filter.
List Message Counter List the message counters for this queue. This will show statistics for the queue
Reset Message Counter Reset the message counters.
List Message Counter in HTML List the message counters in HTML.
List Message Counter History List the message counters history.
List Message Counter History in HTML List the message counters history in HTML.
Pause the Queue Pause the Queue. If the queue is paused no messages can be routed to it or consumed from it.
Restart the Queue Restart the Queue from its paused state.

Package Types

none