Chapter 8. Queue Service

Overview

Description: ActiveMQ Queue
Singleton: no
Plugin: ActiveMQ

Parent Resource Types

Child Resource Types

none

Connection Properties

Table 8.1. Connection Properties

NameRequiredDescriptionInternal Name
Object Name yes  objectName
Name Template yes  nameTemplate
Description Template yes  descriptionTemplate
Destination yes  destination
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Metrics

Table 8.2. Metrics

NameTypeDescriptionInternal Name
Enqueue CountmeasurementNumber of messages that have been sent to the destinationEnqueueCount
Enqueue Count per MinutemeasurementNumber of messages per minute that have been sent to the destinationEnqueueCount
Dequeue CountmeasurementNumber of messages that have been acknowledged (and removed) from the destination.DequeueCount
Dequeue Count per MinutemeasurementNumber of messages per minute that have been acknowledged (and removed) from the destination.DequeueCount
Forward CountmeasurementNumber of messages forwarded from the destination to a networked broker.ForwardCount
Forward Count per MinutemeasurementNumber of messages forwarded per minute from the destination to a networked broker.ForwardCount
Consumer CountmeasurementNumber of consumers subscribed to this destinationConsumerCount
Queue SizemeasurementNumber of messages in the destination yet to be consumed. Potentially dispatched but unacknowledged.QueueSize
Memory Percent UsagemeasurementThe percentage of the memory limit usedMemoryPercentUsage
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

none

Operations

Table 8.3. Operations

NameDescription
PurgeRemoves all of the messages in the queue
Remove MessageRemove a message from the destination by JMS message ID. If the message has been dispatched, it cannot be deleted and false is returned.
Remove Matching MessagesRemoves up to a specified number of messages from the destination based on an SQL-92 selection on the message headers or XPATH on the body.
Copy Message ToCopies a message with the given JMS message ID into the specified destination.
Copy Matching Messages ToCopies up to a specified number of messages based on an SQL-92 selecton on the message headers or XPATH on the body into the specified destination.
Move Message ToMoves a message with the given JMS message ID into the specified destination.
Move Matching Messages ToMoves up to a specified number of messages based on an SQL-92 selecton on the message headers or XPATH on the body into the specified destination.
Retry MessageMoves a message with the given JMS message back to its original destination
Does Cursor Have SpaceMessage cursor has memory space available
Does Cursor Have Messages BufferedMessage cursor has buffered messages to deliver
Cursor SizeNumber of messages available to be paged in by the cursor.
Reset StatisticsResets statistics
Send Text MessageSends a text message to this destination
BrowseBrowse messages sent to this destination

Package Types

none