Management API Reference for jms-topic

Defines a Jakarta Messaging topic.

Stability Level: default

Attributes (13)

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

Type	INT
Where is the attribute stored?	runtime
Access Type	metric
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The number of messages that this queue is currently delivering to its consumers.", "expressions-allowed" : false, "required" : true, "nillable" : false, "stability" : "default", "access-type" : "metric", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

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

Type	INT
Where is the attribute stored?	runtime
Access Type	metric
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The number of messages for all durable subscribers for this topic.", "expressions-allowed" : false, "required" : true, "nillable" : false, "stability" : "default", "access-type" : "metric", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

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

Type	INT
Where is the attribute stored?	runtime
Access Type	metric
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The number of durable subscribers for this topic.", "expressions-allowed" : false, "required" : true, "nillable" : false, "stability" : "default", "access-type" : "metric", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

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

Type	LIST
Does the attribute allow expression?	true
Where is the attribute stored?	runtime
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "description" : "The jndi names the topic will be bound to.", "expressions-allowed" : true, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" }, "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

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

Type	LIST
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	runtime
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "description" : "The legacy jndi names the topic will be bound to.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" }, "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

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

Type	LONG
Where is the attribute stored?	runtime
Access Type	metric
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "LONG" }, "description" : "The number of messages currently in this queue.", "expressions-allowed" : false, "required" : true, "nillable" : false, "stability" : "default", "access-type" : "metric", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

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

Type	LONG
Where is the attribute stored?	runtime
Access Type	metric
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "LONG" }, "description" : "The number of messages added to this queue since it was created.", "expressions-allowed" : false, "required" : true, "nillable" : false, "stability" : "default", "access-type" : "metric", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

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

Type	INT
Where is the attribute stored?	runtime
Access Type	metric
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The number of messages for all non-durable subscribers for this topic.", "expressions-allowed" : false, "required" : true, "nillable" : false, "stability" : "default", "access-type" : "metric", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

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

Type	INT
Where is the attribute stored?	runtime
Access Type	metric
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The number of non-durable subscribers for this topic.", "expressions-allowed" : false, "required" : true, "nillable" : false, "stability" : "default", "access-type" : "metric", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

paused - The current status of the Topic. A paused Topic won't send messages to its consumers.

Type	BOOLEAN
Where is the attribute stored?	runtime
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "The current status of the Topic. A paused Topic won't send messages to its consumers.", "expressions-allowed" : false, "required" : true, "nillable" : false, "stability" : "default", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

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

Type	INT
Where is the attribute stored?	runtime
Access Type	metric
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The number of (durable and non-durable) subscribers for this topic.", "expressions-allowed" : false, "required" : true, "nillable" : false, "stability" : "default", "access-type" : "metric", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

temporary - Whether the topic is temporary.

Type	BOOLEAN
Where is the attribute stored?	runtime
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Whether the topic is temporary.", "expressions-allowed" : false, "required" : true, "nillable" : false, "stability" : "default", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

topic-address - The address the topic points to.

Type	STRING
Where is the attribute stored?	runtime
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The address the topic points to.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

Operations (14)

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

Raw DMR model


{
    "operation-name" : "count-messages-for-subscription",
    "description" : "Count the number of messages matching the filter for the given subscription.",
    "request-properties" : {
        "client-id" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The client ID.",
            "expressions-allowed" : true,
            "required" : true,
            "nillable" : false,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "subscription-name" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The name of the durable subscription.",
            "expressions-allowed" : false,
            "required" : true,
            "nillable" : false,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "filter" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "=A message filter. An undefined or empty filter will match all messages.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 0,
            "max-length" : 2147483647,
            "stability" : "default"
        }
    },
    "reply-properties" : {"type" : {
        "TYPE_MODEL_VALUE" : "INT"
    }},
    "stability" : "default",
    "read-only" : true,
    "runtime-only" : true
}

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

Raw DMR model


{
    "operation-name" : "drop-all-subscriptions",
    "description" : "Drop all subscriptions from this topic.",
    "request-properties" : {},
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : true
}

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.

Raw DMR model


{
    "operation-name" : "drop-durable-subscription",
    "description" : "Drop a durable subscription",
    "request-properties" : {
        "client-id" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The client ID.",
            "expressions-allowed" : true,
            "required" : true,
            "nillable" : false,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "subscription-name" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The name of the durable subscription.",
            "expressions-allowed" : false,
            "required" : true,
            "nillable" : false,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : true
}

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

Raw DMR model


{
    "operation-name" : "list-all-subscriptions",
    "description" : "List all subscriptions.",
    "request-properties" : {},
    "reply-properties" : {
        "type" : {
            "TYPE_MODEL_VALUE" : "LIST"
        },
        "value-type" : {
            "queueName" : {
                "type" : {
                    "TYPE_MODEL_VALUE" : "STRING"
                },
                "description" : "The full name of the queue.",
                "expressions-allowed" : false,
                "required" : true,
                "nillable" : false,
                "min-length" : 1,
                "max-length" : 2147483647,
                "stability" : "default"
            },
            "clientID" : {
                "type" : {
                    "TYPE_MODEL_VALUE" : "STRING"
                },
                "description" : "The client id.",
                "expressions-allowed" : false,
                "required" : true,
                "nillable" : false,
                "min-length" : 1,
                "max-length" : 2147483647,
                "stability" : "default"
            },
            "selector" : {
                "type" : {
                    "TYPE_MODEL_VALUE" : "STRING"
                },
                "description" : "The queue selector.",
                "expressions-allowed" : false,
                "required" : true,
                "nillable" : false,
                "min-length" : 1,
                "max-length" : 2147483647,
                "stability" : "default"
            },
            "name" : {
                "type" : {
                    "TYPE_MODEL_VALUE" : "STRING"
                },
                "description" : "The name of the queue.",
                "expressions-allowed" : false,
                "required" : true,
                "nillable" : false,
                "min-length" : 1,
                "max-length" : 2147483647,
                "stability" : "default"
            },
            "durable" : {
                "type" : {
                    "TYPE_MODEL_VALUE" : "BOOLEAN"
                },
                "description" : "Whether the queue is durable or not.",
                "expressions-allowed" : false,
                "required" : true,
                "nillable" : false,
                "stability" : "default"
            },
            "messageCount" : {
                "type" : {
                    "TYPE_MODEL_VALUE" : "LONG"
                },
                "description" : "The number of messages currently in this queue.",
                "expressions-allowed" : false,
                "required" : true,
                "nillable" : false,
                "stability" : "default"
            },
            "deliveringCount" : {
                "type" : {
                    "TYPE_MODEL_VALUE" : "INT"
                },
                "description" : "The number of messages that this queue is currently delivering to its consumers.",
                "expressions-allowed" : false,
                "required" : true,
                "nillable" : false,
                "stability" : "default"
            },
            "consumers" : {
                "type" : {
                    "TYPE_MODEL_VALUE" : "LIST"
                },
                "description" : "The queue consumers.",
                "expressions-allowed" : false,
                "required" : true,
                "nillable" : false,
                "min-length" : 0,
                "max-length" : 2147483647,
                "stability" : "default",
                "value-type" : {
                    "consumerID" : {
                        "type" : {
                            "TYPE_MODEL_VALUE" : "STRING"
                        },
                        "description" : "The consumer ID.",
                        "expressions-allowed" : false,
                        "required" : true,
                        "nillable" : false,
                        "min-length" : 1,
                        "max-length" : 2147483647,
                        "stability" : "default"
                    },
                    "connectionID" : {
                        "type" : {
                            "TYPE_MODEL_VALUE" : "STRING"
                        },
                        "description" : "The connection id.",
                        "expressions-allowed" : false,
                        "required" : true,
                        "nillable" : false,
                        "min-length" : 1,
                        "max-length" : 2147483647,
                        "stability" : "default"
                    },
                    "sessionID" : {
                        "type" : {
                            "TYPE_MODEL_VALUE" : "STRING"
                        },
                        "description" : "The consumer's session id.",
                        "expressions-allowed" : false,
                        "required" : true,
                        "nillable" : false,
                        "min-length" : 1,
                        "max-length" : 2147483647,
                        "stability" : "default"
                    },
                    "browseOnly" : {
                        "type" : {
                            "TYPE_MODEL_VALUE" : "BOOLEAN"
                        },
                        "description" : "Whether the consumer is only browsing the queue.",
                        "expressions-allowed" : false,
                        "required" : true,
                        "nillable" : false,
                        "stability" : "default"
                    },
                    "creationTime" : {
                        "type" : {
                            "TYPE_MODEL_VALUE" : "BOOLEAN"
                        },
                        "description" : "Time when the consumer was created, in ms since the epoch.",
                        "expressions-allowed" : false,
                        "required" : true,
                        "nillable" : false,
                        "stability" : "default"
                    }
                }
            }
        },
        "description" : "A list, each of whose elements describes a single subscription."
    },
    "stability" : "default",
    "read-only" : true,
    "runtime-only" : true
}

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

Reply properties

A JSON formatted string.

Type: STRING

Raw DMR model


{
    "operation-name" : "list-all-subscriptions-as-json",
    "description" : "List all subscriptions as a string in JSON format.",
    "request-properties" : {},
    "reply-properties" : {
        "type" : {
            "TYPE_MODEL_VALUE" : "STRING"
        },
        "description" : "A JSON formatted string."
    },
    "stability" : "default",
    "read-only" : true,
    "runtime-only" : true
}

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

Raw DMR model


{
    "operation-name" : "list-durable-subscriptions",
    "description" : "List only the durable subscriptions.",
    "request-properties" : {},
    "reply-properties" : {
        "type" : {
            "TYPE_MODEL_VALUE" : "LIST"
        },
        "value-type" : {
            "queueName" : {
                "type" : {
                    "TYPE_MODEL_VALUE" : "STRING"
                },
                "description" : "The full name of the queue.",
                "expressions-allowed" : false,
                "required" : true,
                "nillable" : false,
                "min-length" : 1,
                "max-length" : 2147483647,
                "stability" : "default"
            },
            "clientID" : {
                "type" : {
                    "TYPE_MODEL_VALUE" : "STRING"
                },
                "description" : "The client id.",
                "expressions-allowed" : false,
                "required" : true,
                "nillable" : false,
                "min-length" : 1,
                "max-length" : 2147483647,
                "stability" : "default"
            },
            "selector" : {
                "type" : {
                    "TYPE_MODEL_VALUE" : "STRING"
                },
                "description" : "The queue selector.",
                "expressions-allowed" : false,
                "required" : true,
                "nillable" : false,
                "min-length" : 1,
                "max-length" : 2147483647,
                "stability" : "default"
            },
            "name" : {
                "type" : {
                    "TYPE_MODEL_VALUE" : "STRING"
                },
                "description" : "The name of the queue.",
                "expressions-allowed" : false,
                "required" : true,
                "nillable" : false,
                "min-length" : 1,
                "max-length" : 2147483647,
                "stability" : "default"
            },
            "durable" : {
                "type" : {
                    "TYPE_MODEL_VALUE" : "BOOLEAN"
                },
                "description" : "Whether the queue is durable or not.",
                "expressions-allowed" : false,
                "required" : true,
                "nillable" : false,
                "stability" : "default"
            },
            "messageCount" : {
                "type" : {
                    "TYPE_MODEL_VALUE" : "LONG"
                },
                "description" : "The number of messages currently in this queue.",
                "expressions-allowed" : false,
                "required" : true,
                "nillable" : false,
                "stability" : "default"
            },
            "deliveringCount" : {
                "type" : {
                    "TYPE_MODEL_VALUE" : "INT"
                },
                "description" : "The number of messages that this queue is currently delivering to its consumers.",
                "expressions-allowed" : false,
                "required" : true,
                "nillable" : false,
                "stability" : "default"
            },
            "consumers" : {
                "type" : {
                    "TYPE_MODEL_VALUE" : "LIST"
                },
                "description" : "The queue consumers.",
                "expressions-allowed" : false,
                "required" : true,
                "nillable" : false,
                "min-length" : 0,
                "max-length" : 2147483647,
                "stability" : "default",
                "value-type" : {
                    "consumerID" : {
                        "type" : {
                            "TYPE_MODEL_VALUE" : "STRING"
                        },
                        "description" : "The consumer ID.",
                        "expressions-allowed" : false,
                        "required" : true,
                        "nillable" : false,
                        "min-length" : 1,
                        "max-length" : 2147483647,
                        "stability" : "default"
                    },
                    "connectionID" : {
                        "type" : {
                            "TYPE_MODEL_VALUE" : "STRING"
                        },
                        "description" : "The connection id.",
                        "expressions-allowed" : false,
                        "required" : true,
                        "nillable" : false,
                        "min-length" : 1,
                        "max-length" : 2147483647,
                        "stability" : "default"
                    },
                    "sessionID" : {
                        "type" : {
                            "TYPE_MODEL_VALUE" : "STRING"
                        },
                        "description" : "The consumer's session id.",
                        "expressions-allowed" : false,
                        "required" : true,
                        "nillable" : false,
                        "min-length" : 1,
                        "max-length" : 2147483647,
                        "stability" : "default"
                    },
                    "browseOnly" : {
                        "type" : {
                            "TYPE_MODEL_VALUE" : "BOOLEAN"
                        },
                        "description" : "Whether the consumer is only browsing the queue.",
                        "expressions-allowed" : false,
                        "required" : true,
                        "nillable" : false,
                        "stability" : "default"
                    },
                    "creationTime" : {
                        "type" : {
                            "TYPE_MODEL_VALUE" : "BOOLEAN"
                        },
                        "description" : "Time when the consumer was created, in ms since the epoch.",
                        "expressions-allowed" : false,
                        "required" : true,
                        "nillable" : false,
                        "stability" : "default"
                    }
                }
            }
        },
        "description" : "A list, each of whose elements describes a single subscription."
    },
    "stability" : "default",
    "read-only" : true,
    "runtime-only" : true
}

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

Reply properties

Type: STRING

Raw DMR model


{
    "operation-name" : "list-durable-subscriptions-as-json",
    "description" : "List only the durable subscriptions, as a string in JSON format.",
    "request-properties" : {},
    "reply-properties" : {"type" : {
        "TYPE_MODEL_VALUE" : "STRING"
    }},
    "stability" : "default",
    "read-only" : true,
    "runtime-only" : true
}

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

Raw DMR model


{
    "operation-name" : "list-messages-for-subscription",
    "description" : "List all the messages for the given subscription.",
    "request-properties" : {"queue-name" : {
        "type" : {
            "TYPE_MODEL_VALUE" : "STRING"
        },
        "description" : "The name of the queue representing a subscription",
        "expressions-allowed" : false,
        "required" : true,
        "nillable" : false,
        "min-length" : 1,
        "max-length" : 2147483647,
        "stability" : "default"
    }},
    "reply-properties" : {
        "type" : {
            "TYPE_MODEL_VALUE" : "LIST"
        },
        "value-type" : {
            "JMSMessageID" : {
                "type" : {
                    "TYPE_MODEL_VALUE" : "STRING"
                },
                "description" : "The message ID.",
                "expressions-allowed" : false,
                "required" : true,
                "nillable" : false,
                "min-length" : 1,
                "max-length" : 2147483647,
                "stability" : "default"
            },
            "JMSPriority" : {
                "type" : {
                    "TYPE_MODEL_VALUE" : "INT"
                },
                "description" : "The message's priority.",
                "expressions-allowed" : false,
                "required" : true,
                "nillable" : false,
                "min" : 0,
                "max" : 9,
                "stability" : "default"
            },
            "JMSTimestamp" : {
                "type" : {
                    "TYPE_MODEL_VALUE" : "LONG"
                },
                "description" : "The message's timestamp, in ms since the epoch.",
                "expressions-allowed" : false,
                "required" : true,
                "nillable" : false,
                "stability" : "default"
            },
            "JMSExpiration" : {
                "type" : {
                    "TYPE_MODEL_VALUE" : "LONG"
                },
                "description" : "The message's expiration time.",
                "expressions-allowed" : false,
                "required" : true,
                "nillable" : false,
                "stability" : "default"
            },
            "JMSDeliveryMode" : {
                "type" : {
                    "TYPE_MODEL_VALUE" : "STRING"
                },
                "description" : "The delivery mode for the message, PERSISTENT or NON_PERSISTENT.",
                "expressions-allowed" : false,
                "required" : true,
                "nillable" : false,
                "min-length" : 1,
                "max-length" : 2147483647,
                "allowed" : [
                    "PERSISTENT",
                    "NON_PERSISTENT"
                ],
                "stability" : "default"
            }
        },
        "description" : "A list where each element is a map of message properties to their value."
    },
    "stability" : "default",
    "read-only" : true,
    "runtime-only" : 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

Type: STRING

Raw DMR model


{
    "operation-name" : "list-messages-for-subscription-as-json",
    "description" : "List all the messages for the given subscription as a string in JSON format.",
    "request-properties" : {"queue-name" : {
        "type" : {
            "TYPE_MODEL_VALUE" : "STRING"
        },
        "description" : "The name of the queue representing a subscription",
        "expressions-allowed" : false,
        "required" : true,
        "nillable" : false,
        "min-length" : 1,
        "max-length" : 2147483647,
        "stability" : "default"
    }},
    "reply-properties" : {"type" : {
        "TYPE_MODEL_VALUE" : "STRING"
    }},
    "stability" : "default",
    "read-only" : true,
    "runtime-only" : true
}

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

Raw DMR model


{
    "operation-name" : "list-non-durable-subscriptions",
    "description" : "List only the non-durable subscriptions.",
    "request-properties" : {},
    "reply-properties" : {
        "type" : {
            "TYPE_MODEL_VALUE" : "LIST"
        },
        "value-type" : {
            "queueName" : {
                "type" : {
                    "TYPE_MODEL_VALUE" : "STRING"
                },
                "description" : "The full name of the queue.",
                "expressions-allowed" : false,
                "required" : true,
                "nillable" : false,
                "min-length" : 1,
                "max-length" : 2147483647,
                "stability" : "default"
            },
            "clientID" : {
                "type" : {
                    "TYPE_MODEL_VALUE" : "STRING"
                },
                "description" : "The client id.",
                "expressions-allowed" : false,
                "required" : true,
                "nillable" : false,
                "min-length" : 1,
                "max-length" : 2147483647,
                "stability" : "default"
            },
            "selector" : {
                "type" : {
                    "TYPE_MODEL_VALUE" : "STRING"
                },
                "description" : "The queue selector.",
                "expressions-allowed" : false,
                "required" : true,
                "nillable" : false,
                "min-length" : 1,
                "max-length" : 2147483647,
                "stability" : "default"
            },
            "name" : {
                "type" : {
                    "TYPE_MODEL_VALUE" : "STRING"
                },
                "description" : "The name of the queue.",
                "expressions-allowed" : false,
                "required" : true,
                "nillable" : false,
                "min-length" : 1,
                "max-length" : 2147483647,
                "stability" : "default"
            },
            "durable" : {
                "type" : {
                    "TYPE_MODEL_VALUE" : "BOOLEAN"
                },
                "description" : "Whether the queue is durable or not.",
                "expressions-allowed" : false,
                "required" : true,
                "nillable" : false,
                "stability" : "default"
            },
            "messageCount" : {
                "type" : {
                    "TYPE_MODEL_VALUE" : "LONG"
                },
                "description" : "The number of messages currently in this queue.",
                "expressions-allowed" : false,
                "required" : true,
                "nillable" : false,
                "stability" : "default"
            },
            "deliveringCount" : {
                "type" : {
                    "TYPE_MODEL_VALUE" : "INT"
                },
                "description" : "The number of messages that this queue is currently delivering to its consumers.",
                "expressions-allowed" : false,
                "required" : true,
                "nillable" : false,
                "stability" : "default"
            },
            "consumers" : {
                "type" : {
                    "TYPE_MODEL_VALUE" : "LIST"
                },
                "description" : "The queue consumers.",
                "expressions-allowed" : false,
                "required" : true,
                "nillable" : false,
                "min-length" : 0,
                "max-length" : 2147483647,
                "stability" : "default",
                "value-type" : {
                    "consumerID" : {
                        "type" : {
                            "TYPE_MODEL_VALUE" : "STRING"
                        },
                        "description" : "The consumer ID.",
                        "expressions-allowed" : false,
                        "required" : true,
                        "nillable" : false,
                        "min-length" : 1,
                        "max-length" : 2147483647,
                        "stability" : "default"
                    },
                    "connectionID" : {
                        "type" : {
                            "TYPE_MODEL_VALUE" : "STRING"
                        },
                        "description" : "The connection id.",
                        "expressions-allowed" : false,
                        "required" : true,
                        "nillable" : false,
                        "min-length" : 1,
                        "max-length" : 2147483647,
                        "stability" : "default"
                    },
                    "sessionID" : {
                        "type" : {
                            "TYPE_MODEL_VALUE" : "STRING"
                        },
                        "description" : "The consumer's session id.",
                        "expressions-allowed" : false,
                        "required" : true,
                        "nillable" : false,
                        "min-length" : 1,
                        "max-length" : 2147483647,
                        "stability" : "default"
                    },
                    "browseOnly" : {
                        "type" : {
                            "TYPE_MODEL_VALUE" : "BOOLEAN"
                        },
                        "description" : "Whether the consumer is only browsing the queue.",
                        "expressions-allowed" : false,
                        "required" : true,
                        "nillable" : false,
                        "stability" : "default"
                    },
                    "creationTime" : {
                        "type" : {
                            "TYPE_MODEL_VALUE" : "BOOLEAN"
                        },
                        "description" : "Time when the consumer was created, in ms since the epoch.",
                        "expressions-allowed" : false,
                        "required" : true,
                        "nillable" : false,
                        "stability" : "default"
                    }
                }
            }
        },
        "description" : "A list, each of whose elements describes a single subscription."
    },
    "stability" : "default",
    "read-only" : true,
    "runtime-only" : true
}

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

Reply properties

Type: STRING

Raw DMR model


{
    "operation-name" : "list-non-durable-subscriptions-as-json",
    "description" : "List only the non-durable subscriptions, as a string in JSON format.",
    "request-properties" : {},
    "reply-properties" : {"type" : {
        "TYPE_MODEL_VALUE" : "STRING"
    }},
    "stability" : "default",
    "read-only" : true,
    "runtime-only" : true
}

pause - Pause the current Topic.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
persist	BOOLEAN	false	false	false	Persist the paused status of this Topic.

Raw DMR model


{
    "operation-name" : "pause",
    "description" : "Pause the current Topic.",
    "request-properties" : {"persist" : {
        "type" : {
            "TYPE_MODEL_VALUE" : "BOOLEAN"
        },
        "description" : "Persist the paused status of this Topic.",
        "expressions-allowed" : false,
        "required" : false,
        "nillable" : true,
        "default" : false,
        "stability" : "default"
    }},
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : true
}

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

Raw DMR model


{
    "operation-name" : "remove-messages",
    "description" : "Remove messages matching the given filter from the topic.",
    "request-properties" : {"filter" : {
        "type" : {
            "TYPE_MODEL_VALUE" : "STRING"
        },
        "description" : "A message filter. An undefined or empty filter will match all messages.",
        "expressions-allowed" : true,
        "required" : false,
        "nillable" : true,
        "min-length" : 0,
        "max-length" : 2147483647,
        "stability" : "default"
    }},
    "reply-properties" : {
        "type" : {
            "TYPE_MODEL_VALUE" : "INT"
        },
        "description" : "The number of removed messages."
    },
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : true
}

resume - Resume the current Topic if it is paused.

Raw DMR model


{
    "operation-name" : "resume",
    "description" : "Resume the current Topic if it is paused.",
    "request-properties" : {},
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : true
}