JBoss EAP 6.3 Model Reference

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

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.

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

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	false	false	The client ID.
subscription-name	STRING	false	false	The name of the durable subscription.
filter	STRING	false	false	A JMS message filter.

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	false	false		The client ID.
subscription-name	STRING	false	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" => {
        "description" => "The full name of the queue.",
        "type" => STRING,
        "nillable" => false
    },
    "clientID" => {
        "description" => "The client id.",
        "type" => STRING,
        "nillable" => false
    },
    "selector" => {
        "description" => "The queue selector.",
        "type" => STRING,
        "nillable" => true
    },
    "name" => {
        "description" => "The name of the queue.",
        "type" => STRING,
        "nillable" => false
    },
    "durable" => {
        "description" => "Whether the queue is durable or not.",
        "type" => BOOLEAN,
        "nillable" => false
    },
    "messageCount" => {
        "description" => "The number of messages currently in this queue.",
        "type" => LONG,
        "nillable" => false,
        "unit" => "NONE"
    },
    "deliveringCount" => {
        "description" => "The number of messages that this queue is currently delivering to its consumers.",
        "type" => INT,
        "nillable" => false,
        "unit" => "NONE"
    },
    "consumers" => {
        "description" => "The queue consumers.",
        "type" => LIST,
        "nillable" => false,
        "min-length" => 0,
        "value-type" => {
            "consumerID" => {
                "description" => "The id of the consumer.",
                "type" => LONG,
                "nillable" => false
            },
            "connectionID" => {
                "description" => "The connection id.",
                "type" => STRING,
                "nillable" => false
            },
            "sessionID" => {
                "description" => "The consumer's session id.",
                "type" => STRING,
                "nillable" => true
            },
            "browseOnly" => {
                "description" => "Whether the consumer is only browsing the queue.",
                "type" => BOOLEAN,
                "nillable" => false
            },
            "creationTime" => {
                "description" => "Time when the consumer was created, in ms since the epoch.",
                "type" => LONG,
                "nillable" => false
            }
        }
    }
}

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

Reply properties

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" => {
        "description" => "The full name of the queue.",
        "type" => STRING,
        "nillable" => false
    },
    "clientID" => {
        "description" => "The client id.",
        "type" => STRING,
        "nillable" => false
    },
    "selector" => {
        "description" => "The queue selector.",
        "type" => STRING,
        "nillable" => true
    },
    "name" => {
        "description" => "The name of the queue.",
        "type" => STRING,
        "nillable" => false
    },
    "durable" => {
        "description" => "Whether the queue is durable or not.",
        "type" => BOOLEAN,
        "nillable" => false
    },
    "messageCount" => {
        "description" => "The number of messages currently in this queue.",
        "type" => LONG,
        "nillable" => false,
        "unit" => "NONE"
    },
    "deliveringCount" => {
        "description" => "The number of messages that this queue is currently delivering to its consumers.",
        "type" => INT,
        "nillable" => false,
        "unit" => "NONE"
    },
    "consumers" => {
        "description" => "The queue consumers.",
        "type" => LIST,
        "nillable" => false,
        "min-length" => 0,
        "value-type" => {
            "consumerID" => {
                "description" => "The id of the consumer.",
                "type" => LONG,
                "nillable" => false
            },
            "connectionID" => {
                "description" => "The connection id.",
                "type" => STRING,
                "nillable" => false
            },
            "sessionID" => {
                "description" => "The consumer's session id.",
                "type" => STRING,
                "nillable" => true
            },
            "browseOnly" => {
                "description" => "Whether the consumer is only browsing the queue.",
                "type" => BOOLEAN,
                "nillable" => false
            },
            "creationTime" => {
                "description" => "Time when the consumer was created, in ms since the epoch.",
                "type" => LONG,
                "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

{
    "JMSPriority" => {
        "description" => "The message's priority.",
        "type" => INT
    },
    "JMSTimestamp" => {
        "description" => "The message's timestamp, in ms since the epoch.",
        "type" => LONG
    },
    "JMSExpiration" => {
        "description" => "The message's expiration time.",
        "type" => LONG
    },
    "JMSDeliveryMode" => {
        "description" => "The delivery mode for the message, PERSISTENT or NON_PERSISTENT.",
        "type" => STRING,
        "nillable" => false,
        "allowed" => [
            "PERSISTENT",
            "NON_PERSISTENT"
        ]
    },
    "JMSMessageID" => {
        "description" => "The message's id.",
        "type" => STRING,
        "nillable" => true
    }
}

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

jms-topic.list-messages-for-subscription-as-json.reply

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" => {
        "description" => "The full name of the queue.",
        "type" => STRING,
        "nillable" => false
    },
    "clientID" => {
        "description" => "The client id.",
        "type" => STRING,
        "nillable" => false
    },
    "selector" => {
        "description" => "The queue selector.",
        "type" => STRING,
        "nillable" => true
    },
    "name" => {
        "description" => "The name of the queue.",
        "type" => STRING,
        "nillable" => false
    },
    "durable" => {
        "description" => "Whether the queue is durable or not.",
        "type" => BOOLEAN,
        "nillable" => false
    },
    "messageCount" => {
        "description" => "The number of messages currently in this queue.",
        "type" => LONG,
        "nillable" => false,
        "unit" => "NONE"
    },
    "deliveringCount" => {
        "description" => "The number of messages that this queue is currently delivering to its consumers.",
        "type" => INT,
        "nillable" => false,
        "unit" => "NONE"
    },
    "consumers" => {
        "description" => "The queue consumers.",
        "type" => LIST,
        "nillable" => false,
        "min-length" => 0,
        "value-type" => {
            "consumerID" => {
                "description" => "The id of the consumer.",
                "type" => LONG,
                "nillable" => false
            },
            "connectionID" => {
                "description" => "The connection id.",
                "type" => STRING,
                "nillable" => false
            },
            "sessionID" => {
                "description" => "The consumer's session id.",
                "type" => STRING,
                "nillable" => true
            },
            "browseOnly" => {
                "description" => "Whether the consumer is only browsing the queue.",
                "type" => BOOLEAN,
                "nillable" => false
            },
            "creationTime" => {
                "description" => "Time when the consumer was created, in ms since the epoch.",
                "type" => LONG,
                "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-messages Remove messages matching the given filter from the destination.

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

Reply properties

The number of removed messages.

type: INT