WildFly 14.0 Model Reference

A Queue.

Runtime only resource This resource is runtime only and doesn't have any persistent configuration.

Attributes (13)

consumer-count The number of consumers consuming messages from this queue.

Attribute	Value
Type	INT
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	metric

dead-letter-address The address to send the queue's dead messages to.

Attribute	Value
Type	STRING
Nillable	true
Expressions Allowed	true
Storage	runtime
Access Type	read-only

delivering-count The number of messages that this queue is currently delivering to its consumers.

Attribute	Value
Type	INT
Nillable	false
Expressions Allowed	false
Storage	runtime
Access Type	metric

durable Defines whether the queue is durable.

Attribute	Value
Default Value	true
Type	BOOLEAN
Nillable	true
Expressions Allowed	true
Storage	runtime
Access Type	read-only

expiry-address The address to send the queue's expired messages to.

Attribute	Value
Type	STRING
Nillable	true
Expressions Allowed	true
Storage	runtime
Access Type	read-only

filter A queue message filter definition. An undefined or empty filter will match all messages.

id The id of the queue.

Attribute	Value
Type	LONG
Nillable	false
Expressions Allowed	false
Storage	runtime
Access Type	read-only

message-count The number of messages currently in this queue.

Attribute	Value
Type	LONG
Nillable	false
Expressions Allowed	false
Storage	runtime
Access Type	metric

messages-added The number of messages added to this queue since it was created.

Attribute	Value
Type	LONG
Nillable	false
Expressions Allowed	false
Storage	runtime
Access Type	metric

paused Whether the queue is paused.

Attribute	Value
Type	BOOLEAN
Nillable	false
Expressions Allowed	false
Storage	runtime
Access Type	read-only

queue-address The queue address defines what address is used for routing messages.

Attribute	Value
Type	STRING
Nillable	false
Expressions Allowed	true
Storage	runtime
Access Type	read-only

scheduled-count The number of scheduled messages in this queue.

Attribute	Value
Type	LONG
Nillable	false
Expressions Allowed	false
Storage	runtime
Access Type	metric

temporary Whether the queue is temporary.

Attribute	Value
Type	BOOLEAN
Nillable	false
Expressions Allowed	false
Storage	runtime
Access Type	read-only

Operations (25)

change-message-priority Change the priority of the message corresponding to the given message-id.

Request Parameter Type Required Expressions Allowed Default value Description

message-id LONG true false The message ID.

new-priority INT true false The new priority (between 0 and 9).

Reply properties

True if the message priority was changed, false otherwise.

type

BOOLEAN

change-messages-priority Change the priority of the messages corresponding to the given filter.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
filter	STRING	false	true		A message filter. An undefined or empty filter will match all messages.
new-priority	INT	true	false		The new priority (between 0 and 9).

Reply properties

The number of changed messages.

type: INT

count-messages Returns the number of the messages in the queue matching the given filter.

Request Parameter Type Required Expressions Allowed Default value Description

filter STRING false true A message filter. An undefined or empty filter will match all messages.

Reply properties

type

LONG
expire-message Expire the message corresponding to the given message-id.

Request Parameter Type Required Expressions Allowed Default value Description

message-id LONG true false The message ID.

Reply properties

True if the message was expired, false otherwise.

type

BOOLEAN
expire-messages Expire the messages matching the given filter.

Request Parameter Type Required Expressions Allowed Default value Description

filter STRING false true A message filter. An undefined or empty filter will match all messages.

Reply properties

The number of expired messages.

type

INT
list-consumers-as-json List all the existing consumers on the queue as a string in JSON format.

Reply properties

A string in JSON format with the list of all consumers

type

STRING

list-delivering-messages List the messages are currently being delivered.

Reply properties

A list where each element is a map of message properties to their value.

type

LIST

Value Type

{
    "consumerName" => {
        "type" => STRING,
        "description" => "The name of the consumer that the messages are delivered to.",
        "expressions-allowed" => false,
        "required" => true,
        "nillable" => false,
        "min-length" => 1L,
        "max-length" => 2147483647L
    },
    "elements" => {
        "type" => LIST,
        "description" => "The delivering messages.",
        "expressions-allowed" => false,
        "required" => false,
        "nillable" => true,
        "min-length" => 0L,
        "max-length" => 2147483647L,
        "value-type" => {
            "messageID" => {
                "type" => STRING,
                "description" => "The message ID.",
                "expressions-allowed" => false,
                "required" => true,
                "nillable" => false,
                "min-length" => 1L,
                "max-length" => 2147483647L
            },
            "userID" => {
                "type" => STRING,
                "description" => "The userID - this is an optional user specified UUID that can be set to identify the message.",
                "expressions-allowed" => false,
                "required" => true,
                "nillable" => false,
                "min-length" => 1L,
                "max-length" => 2147483647L
            },
            "address" => {
                "type" => STRING,
                "description" => "Te address this message is sent to.",
                "expressions-allowed" => false,
                "required" => true,
                "nillable" => false,
                "min-length" => 1L,
                "max-length" => 2147483647L
            },
            "type" => {
                "type" => INT,
                "description" => "The message type. 0 = Default; 2 = Object; 3 = Text; 4 = Bytes; 5 = Map; 6 = Stream",
                "expressions-allowed" => false,
                "required" => true,
                "nillable" => false,
                "allowed" => [
                    0,
                    2,
                    3,
                    4,
                    5,
                    6
                ]
            },
            "durable" => {
                "type" => INT,
                "description" => "Whether this message is durable or not.",
                "expressions-allowed" => false,
                "required" => true,
                "nillable" => false
            },
            "expiration" => {
                "type" => LONG,
                "description" => "The expiration time of this message.",
                "expressions-allowed" => false,
                "required" => true,
                "nillable" => false
            },
            "priority" => {
                "type" => INT,
                "description" => "The message priority. Values range from 0 (less priority) to 9 (more priority) inclusive.",
                "expressions-allowed" => false,
                "required" => true,
                "nillable" => false,
                "min" => 0L,
                "max" => 9L
            }
        }
    }
}

list-delivering-messages-as-json List the messages are currently being delivered as a string in JSON format

Reply properties

A string in JSON format representing a list where each element is a map of message properties to their value.

type

STRING
list-message-counter-as-html List the message counter as a string in HTML format.

Reply properties

A string in HTML format.

type

STRING
list-message-counter-as-json List the message counter as a string in JSON format.

Reply properties

A string in JSON format.

type

STRING
list-message-counter-history-as-html List the message counter history.

Reply properties

A string in HTML format as a string in HTML format.

type

STRING
list-message-counter-history-as-json List the message counter history as a string in JSON format.

Reply properties

A string in JSON format

type

STRING

list-messages List all messages in the queue that match the filter

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
filter	STRING	false	true		A message filter. An undefined or empty filter will match all messages.

Reply properties

A list where each element is a map of message properties to their value.

type

LIST

Value Type

{
    "messageID" => {
        "type" => STRING,
        "description" => "The message ID.",
        "expressions-allowed" => false,
        "required" => true,
        "nillable" => false,
        "min-length" => 1L,
        "max-length" => 2147483647L
    },
    "userID" => {
        "type" => STRING,
        "description" => "The userID - this is an optional user specified UUID that can be set to identify the message.",
        "expressions-allowed" => false,
        "required" => true,
        "nillable" => false,
        "min-length" => 1L,
        "max-length" => 2147483647L
    },
    "address" => {
        "type" => STRING,
        "description" => "Te address this message is sent to.",
        "expressions-allowed" => false,
        "required" => true,
        "nillable" => false,
        "min-length" => 1L,
        "max-length" => 2147483647L
    },
    "type" => {
        "type" => INT,
        "description" => "The message type. 0 = Default; 2 = Object; 3 = Text; 4 = Bytes; 5 = Map; 6 = Stream",
        "expressions-allowed" => false,
        "required" => true,
        "nillable" => false,
        "allowed" => [
            0,
            2,
            3,
            4,
            5,
            6
        ]
    },
    "durable" => {
        "type" => INT,
        "description" => "Whether this message is durable or not.",
        "expressions-allowed" => false,
        "required" => true,
        "nillable" => false
    },
    "expiration" => {
        "type" => LONG,
        "description" => "The expiration time of this message.",
        "expressions-allowed" => false,
        "required" => true,
        "nillable" => false
    },
    "priority" => {
        "type" => INT,
        "description" => "The message priority. Values range from 0 (less priority) to 9 (more priority) inclusive.",
        "expressions-allowed" => false,
        "required" => true,
        "nillable" => false,
        "min" => 0L,
        "max" => 9L
    }
}

list-messages-as-json List all messages in the queue that match the filter and return them as a string in JSON format.

Request Parameter Type Required Expressions Allowed Default value Description

filter STRING false true A message filter. An undefined or empty filter will match all messages.

Reply properties

A JSON string containing all the messages matching the filter.

type

STRING

list-scheduled-messages List the messages scheduled for delivery.

Reply properties

A list where each element is a map of message properties to their value.

type

LIST

Value Type

{
    "messageID" => {
        "type" => STRING,
        "description" => "The message ID.",
        "expressions-allowed" => false,
        "required" => true,
        "nillable" => false,
        "min-length" => 1L,
        "max-length" => 2147483647L
    },
    "userID" => {
        "type" => STRING,
        "description" => "The userID - this is an optional user specified UUID that can be set to identify the message.",
        "expressions-allowed" => false,
        "required" => true,
        "nillable" => false,
        "min-length" => 1L,
        "max-length" => 2147483647L
    },
    "address" => {
        "type" => STRING,
        "description" => "Te address this message is sent to.",
        "expressions-allowed" => false,
        "required" => true,
        "nillable" => false,
        "min-length" => 1L,
        "max-length" => 2147483647L
    },
    "type" => {
        "type" => INT,
        "description" => "The message type. 0 = Default; 2 = Object; 3 = Text; 4 = Bytes; 5 = Map; 6 = Stream",
        "expressions-allowed" => false,
        "required" => true,
        "nillable" => false,
        "allowed" => [
            0,
            2,
            3,
            4,
            5,
            6
        ]
    },
    "durable" => {
        "type" => INT,
        "description" => "Whether this message is durable or not.",
        "expressions-allowed" => false,
        "required" => true,
        "nillable" => false
    },
    "expiration" => {
        "type" => LONG,
        "description" => "The expiration time of this message.",
        "expressions-allowed" => false,
        "required" => true,
        "nillable" => false
    },
    "priority" => {
        "type" => INT,
        "description" => "The message priority. Values range from 0 (less priority) to 9 (more priority) inclusive.",
        "expressions-allowed" => false,
        "required" => true,
        "nillable" => false,
        "min" => 0L,
        "max" => 9L
    }
}

list-scheduled-messages-as-json List the messages scheduled for delivery as a string in JSON format.

Reply properties

A string in JSON format representing a list where each element is a map of message properties to their value.

type

STRING

move-message Move the message corresponding to the given message-id to another queue

Request Parameter	Type	Required	Expressions Allowed	Description
message-id	LONG	true	false	The message ID.
other-queue-name	STRING	true	false	The name of the queue to move the message to.
reject-duplicates	BOOLEAN	false	false	Whether to reject messages identified as duplicate.

Reply properties

True if the message was moved, false otherwise

type: INT

move-messages Move the messages corresponding to the given filter to another queue.

Request Parameter	Type	Required	Expressions Allowed	Description
filter	STRING	false	true	A message filter. An undefined or empty filter will match all messages.
other-queue-name	STRING	true	false	The name of the queue to move the message to.
reject-duplicates	BOOLEAN	false	false	Whether to reject messages identified as duplicate.

Reply properties

The number of moved messages.

type: INT

pause Pause the queue.
remove-message Remove the message corresponding to the given message-id.

Request Parameter Type Required Expressions Allowed Default value Description

message-id LONG true false The message ID.

Reply properties

True if the message was removed, false otherwise.

type

BOOLEAN
remove-messages Remove messages matching the given filter from the queue.

Request Parameter Type Required Expressions Allowed Default value Description

filter STRING false true A message filter. An undefined or empty filter will match all messages.

Reply properties

The number of removed messages.

type

INT
reset-message-counter Reset the message counters.
resume Resume the queue.
send-message-to-dead-letter-address Send the message corresponding to the given message-id to this queue's Dead Letter Address.

Request Parameter Type Required Expressions Allowed Default value Description

message-id LONG true false The message ID.

Reply properties

True if the message was sent to the dead letter address, false otherwise.

type

BOOLEAN
send-messages-to-dead-letter-address Send the messages corresponding to the given filter to this queue's Dead Letter Address.

Request Parameter Type Required Expressions Allowed Default value Description

filter STRING false true A message filter. An undefined or empty filter will match all messages.

Reply properties

The number of sent messages.

type

INT