Chapter 6. Queue Service

Overview
Copy link

Expand

Description:	ActiveMQ Queue
Singleton:	no
Plugin:	ActiveMQ

Parent Resource Types
Copy link

Chapter 2, Broker Service

Child Resource Types
Copy link

none

Connection Properties
Copy link

Expand

Table 6.1. Connection Properties
Name	Required	Description	Internal Name
Object Name	yes		`objectName`
Object Name 1	yes		`objectName1`
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
Copy link

Expand

Table 6.2. Metrics
Name	Type	Description	Internal Name
Enqueue Count	measurement	Number of messages that have been sent to the destination	`EnqueueCount`
Enqueue Count per Minute	measurement	Number of messages that have been sent to the destination	`EnqueueCount`
Dequeue Count	measurement	Number of messages that have been acknowledged (and removed from) from the destination.	`DequeueCount`
Dequeue Count per Minute	measurement	Number of messages that have been acknowledged (and removed from) from the destination.	`DequeueCount`
Consumer Count	measurement	Number of consumers subscribed to this destination	`ConsumerCount`
Queue Size	measurement	Number of messages in the destination which are yet to be consumed. Potentially dispatched but unacknowledged.	`QueueSize`
Memory Percent Usage	measurement	The percentage of the memory limit used	`MemoryPercentUsage`

Note

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

Configuration Properties
Copy link

none

Operations
Copy link

Expand

Table 6.3. Operations
Name	Description
Purge	Removes all of the messages in the queue
Remove Message	Remove 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 Messages	Removes 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 To	Copies a message with the given JMS message ID into the specified destination.
Copy Matching Messages To	Copies 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 To	Moves a message with the given JMS message ID into the specified destination.
Move Matching Messages To	Moves 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 Message	Moves a message with the given JMS message back to its original destination
Does Cursor Have Space	Message cursor has memory space available
Does Cursor Have Messages Buffered	Message cursor has buffered messages to deliver
Cursor Size	Number of messages available to be paged in by the cursor.
Reset Statistics	Resets statistics
Send Text Message	Sends a text message to this destination

Package Types
Copy link

none

Back to top

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust. Explore our recent updates.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

Theme

© 2025 Red Hat