WildFly 10.1 Model Reference

Defines a JMS topic.

Attributes (12)

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-message-count The number of messages for all durable subscribers for this topic.

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

durable-subscription-count The number of durable subscribers for this topic.

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

entries The jndi names the topic will be bound to.

Attribute	Value
Type	LIST
Nillable	false
Expressions Allowed	true
Storage	configuration
Access Type	read-write
Restart Required	all-services

legacy-entries The legacy jndi names the topic will be bound to.

Attribute	Value
Type	LIST
Nillable	true
Expressions Allowed	true
Storage	configuration
Access Type	read-write
Restart Required	all-services

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

non-durable-message-count The number of messages for all non-durable subscribers for this topic.

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

non-durable-subscription-count The number of non-durable subscribers for this topic.

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

subscription-count The number of (durable and non-durable) subscribers for this topic.

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

temporary Whether the topic is temporary.

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

topic-address The address the topic points to.

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

Operations (16)

add Add a JMS topic.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
entries	LIST	true	true		The jndi names the topic will be bound to.
legacy-entries	LIST	false	true		The legacy jndi names the topic will be bound to.

add-jndi Adds the queue to another JNDI binding

Request Parameter Type Required Expressions Allowed Default value Description

jndi-binding STRING true false Jndi binding

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
jndi-binding	STRING	true	false		Jndi binding

count-messages-for-subscription Count the number of messages matching the filter for the given subscription.

Request Parameter	Type	Required	Expressions Allowed	Description
client-id	STRING	true	true	The client ID.
subscription-name	STRING	true	false	The name of the durable subscription.
filter	STRING	false	true	=A message filter. An undefined or empty filter will match all messages.

Reply properties

type: INT

drop-all-subscriptions Drop all subscriptions from this topic.

drop-durable-subscription Drop a durable subscription

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
client-id	STRING	true	true		The client ID.
subscription-name	STRING	true	false		The name of the durable subscription.

list-all-subscriptions List all subscriptions.

Reply properties

A list, each of whose elements describes a single subscription.

type

LIST

Value Type

{
    "queueName" => {
        "type" => STRING,
        "description" => "The full name of the queue.",
        "expressions-allowed" => false,
        "required" => true,
        "nillable" => false,
        "min-length" => 1L,
        "max-length" => 2147483647L
    },
    "clientID" => {
        "type" => STRING,
        "description" => "The client id.",
        "expressions-allowed" => false,
        "required" => true,
        "nillable" => false,
        "min-length" => 1L,
        "max-length" => 2147483647L
    },
    "selector" => {
        "type" => STRING,
        "description" => "The queue selector.",
        "expressions-allowed" => false,
        "required" => true,
        "nillable" => false,
        "min-length" => 1L,
        "max-length" => 2147483647L
    },
    "name" => {
        "type" => STRING,
        "description" => "The name of the queue.",
        "expressions-allowed" => false,
        "required" => true,
        "nillable" => false,
        "min-length" => 1L,
        "max-length" => 2147483647L
    },
    "durable" => {
        "type" => BOOLEAN,
        "description" => "Whether the queue is durable or not.",
        "expressions-allowed" => false,
        "required" => true,
        "nillable" => false
    },
    "messageCount" => {
        "type" => LONG,
        "description" => "The number of messages currently in this queue.",
        "expressions-allowed" => false,
        "required" => true,
        "nillable" => false
    },
    "deliveringCount" => {
        "type" => INT,
        "description" => "The number of messages that this queue is currently delivering to its consumers.",
        "expressions-allowed" => false,
        "required" => true,
        "nillable" => false
    },
    "consumers" => {
        "type" => LIST,
        "description" => "The queue consumers.",
        "expressions-allowed" => false,
        "required" => false,
        "nillable" => false,
        "value-type" => {
            "consumerID" => {
                "type" => STRING,
                "description" => "The consumer ID.",
                "expressions-allowed" => false,
                "nillable" => false,
                "min-length" => 1L,
                "max-length" => 2147483647L
            },
            "connectionID" => {
                "type" => STRING,
                "description" => "The connection id.",
                "expressions-allowed" => false,
                "nillable" => false,
                "min-length" => 1L,
                "max-length" => 2147483647L
            },
            "sessionID" => {
                "type" => STRING,
                "description" => "The consumer's session id.",
                "expressions-allowed" => false,
                "nillable" => false,
                "min-length" => 1L,
                "max-length" => 2147483647L
            },
            "browseOnly" => {
                "type" => BOOLEAN,
                "description" => "Whether the consumer is only browsing the queue.",
                "expressions-allowed" => false,
                "nillable" => false
            },
            "creationTime" => {
                "type" => BOOLEAN,
                "description" => "Time when the consumer was created, in ms since the epoch.",
                "expressions-allowed" => false,
                "nillable" => false
            }
        }
    }
}

list-all-subscriptions-as-json List all subscriptions as a string in JSON format.

Reply properties

A JSON formatted string.

type

STRING

list-durable-subscriptions List only the durable subscriptions.

Reply properties

A list, each of whose elements describes a single subscription.

type

LIST

Value Type

{
    "queueName" => {
        "type" => STRING,
        "description" => "The full name of the queue.",
        "expressions-allowed" => false,
        "required" => true,
        "nillable" => false,
        "min-length" => 1L,
        "max-length" => 2147483647L
    },
    "clientID" => {
        "type" => STRING,
        "description" => "The client id.",
        "expressions-allowed" => false,
        "required" => true,
        "nillable" => false,
        "min-length" => 1L,
        "max-length" => 2147483647L
    },
    "selector" => {
        "type" => STRING,
        "description" => "The queue selector.",
        "expressions-allowed" => false,
        "required" => true,
        "nillable" => false,
        "min-length" => 1L,
        "max-length" => 2147483647L
    },
    "name" => {
        "type" => STRING,
        "description" => "The name of the queue.",
        "expressions-allowed" => false,
        "required" => true,
        "nillable" => false,
        "min-length" => 1L,
        "max-length" => 2147483647L
    },
    "durable" => {
        "type" => BOOLEAN,
        "description" => "Whether the queue is durable or not.",
        "expressions-allowed" => false,
        "required" => true,
        "nillable" => false
    },
    "messageCount" => {
        "type" => LONG,
        "description" => "The number of messages currently in this queue.",
        "expressions-allowed" => false,
        "required" => true,
        "nillable" => false
    },
    "deliveringCount" => {
        "type" => INT,
        "description" => "The number of messages that this queue is currently delivering to its consumers.",
        "expressions-allowed" => false,
        "required" => true,
        "nillable" => false
    },
    "consumers" => {
        "type" => LIST,
        "description" => "The queue consumers.",
        "expressions-allowed" => false,
        "required" => false,
        "nillable" => false,
        "value-type" => {
            "consumerID" => {
                "type" => STRING,
                "description" => "The consumer ID.",
                "expressions-allowed" => false,
                "nillable" => false,
                "min-length" => 1L,
                "max-length" => 2147483647L
            },
            "connectionID" => {
                "type" => STRING,
                "description" => "The connection id.",
                "expressions-allowed" => false,
                "nillable" => false,
                "min-length" => 1L,
                "max-length" => 2147483647L
            },
            "sessionID" => {
                "type" => STRING,
                "description" => "The consumer's session id.",
                "expressions-allowed" => false,
                "nillable" => false,
                "min-length" => 1L,
                "max-length" => 2147483647L
            },
            "browseOnly" => {
                "type" => BOOLEAN,
                "description" => "Whether the consumer is only browsing the queue.",
                "expressions-allowed" => false,
                "nillable" => false
            },
            "creationTime" => {
                "type" => BOOLEAN,
                "description" => "Time when the consumer was created, in ms since the epoch.",
                "expressions-allowed" => false,
                "nillable" => false
            }
        }
    }
}

list-durable-subscriptions-as-json List only the durable subscriptions, as a string in JSON format.

Reply properties

type

STRING

list-messages-for-subscription List all the messages for the given subscription.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
queue-name	STRING	true	false		The name of the queue representing a subscription

Reply properties

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

type

LIST

Value Type

{
    "JMSMessageID" => {
        "type" => STRING,
        "description" => "The message ID.",
        "expressions-allowed" => false,
        "required" => true,
        "nillable" => false,
        "min-length" => 1L,
        "max-length" => 2147483647L
    },
    "JMSPriority" => {
        "type" => INT,
        "description" => "The message's priority.",
        "expressions-allowed" => false,
        "required" => true,
        "nillable" => false,
        "min" => 0L,
        "max" => 9L
    },
    "JMSTimestamp" => {
        "type" => LONG,
        "description" => "The message's timestamp, in ms since the epoch.",
        "expressions-allowed" => false,
        "required" => true,
        "nillable" => false
    },
    "JMSExpiration" => {
        "type" => LONG,
        "description" => "The message's expiration time.",
        "expressions-allowed" => false,
        "required" => true,
        "nillable" => false
    },
    "JMSDeliveryMode" => {
        "type" => STRING,
        "description" => "The delivery mode for the message, PERSISTENT or NON_PERSISTENT.",
        "expressions-allowed" => false,
        "required" => true,
        "nillable" => false,
        "min-length" => 1L,
        "max-length" => 2147483647L,
        "allowed" => [
            "PERSISTENT",
            "NON_PERSISTENT"
        ]
    }
}

list-messages-for-subscription-as-json List all the messages for the given subscription as a string in JSON format.

Request Parameter Type Required Expressions Allowed Default value Description

queue-name STRING true false The name of the queue representing a subscription

Reply properties

type

STRING

list-non-durable-subscriptions List only the non-durable subscriptions.

Reply properties

A list, each of whose elements describes a single subscription.

type

LIST

Value Type

{
    "queueName" => {
        "type" => STRING,
        "description" => "The full name of the queue.",
        "expressions-allowed" => false,
        "required" => true,
        "nillable" => false,
        "min-length" => 1L,
        "max-length" => 2147483647L
    },
    "clientID" => {
        "type" => STRING,
        "description" => "The client id.",
        "expressions-allowed" => false,
        "required" => true,
        "nillable" => false,
        "min-length" => 1L,
        "max-length" => 2147483647L
    },
    "selector" => {
        "type" => STRING,
        "description" => "The queue selector.",
        "expressions-allowed" => false,
        "required" => true,
        "nillable" => false,
        "min-length" => 1L,
        "max-length" => 2147483647L
    },
    "name" => {
        "type" => STRING,
        "description" => "The name of the queue.",
        "expressions-allowed" => false,
        "required" => true,
        "nillable" => false,
        "min-length" => 1L,
        "max-length" => 2147483647L
    },
    "durable" => {
        "type" => BOOLEAN,
        "description" => "Whether the queue is durable or not.",
        "expressions-allowed" => false,
        "required" => true,
        "nillable" => false
    },
    "messageCount" => {
        "type" => LONG,
        "description" => "The number of messages currently in this queue.",
        "expressions-allowed" => false,
        "required" => true,
        "nillable" => false
    },
    "deliveringCount" => {
        "type" => INT,
        "description" => "The number of messages that this queue is currently delivering to its consumers.",
        "expressions-allowed" => false,
        "required" => true,
        "nillable" => false
    },
    "consumers" => {
        "type" => LIST,
        "description" => "The queue consumers.",
        "expressions-allowed" => false,
        "required" => false,
        "nillable" => false,
        "value-type" => {
            "consumerID" => {
                "type" => STRING,
                "description" => "The consumer ID.",
                "expressions-allowed" => false,
                "nillable" => false,
                "min-length" => 1L,
                "max-length" => 2147483647L
            },
            "connectionID" => {
                "type" => STRING,
                "description" => "The connection id.",
                "expressions-allowed" => false,
                "nillable" => false,
                "min-length" => 1L,
                "max-length" => 2147483647L
            },
            "sessionID" => {
                "type" => STRING,
                "description" => "The consumer's session id.",
                "expressions-allowed" => false,
                "nillable" => false,
                "min-length" => 1L,
                "max-length" => 2147483647L
            },
            "browseOnly" => {
                "type" => BOOLEAN,
                "description" => "Whether the consumer is only browsing the queue.",
                "expressions-allowed" => false,
                "nillable" => false
            },
            "creationTime" => {
                "type" => BOOLEAN,
                "description" => "Time when the consumer was created, in ms since the epoch.",
                "expressions-allowed" => false,
                "nillable" => false
            }
        }
    }
}

list-non-durable-subscriptions-as-json List only the non-durable subscriptions, as a string in JSON format.

Reply properties

type

STRING
remove Remove a JMS topic.
remove-jndi Removes the JNDI binding

Request Parameter Type Required Expressions Allowed Default value Description

jndi-binding STRING true false Jndi binding
remove-messages Remove messages matching the given filter from the topic.

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