## Attributes (14)

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

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

- dead-letter-address - The address to send dead messages to.

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

- 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 - Whether the queue is durable or not.

  Type | BOOLEAN
  Default Value | true
  Is the attribute nillable? | true
  Does the attribute allow expression? | true
  Where is the attribute stored? | configuration
  Access Type | read-only
  Stability Level | default
  Raw DMR model |
      {
          "type" : {
              "TYPE_MODEL_VALUE" : "BOOLEAN"
          },
          "description" : "Whether the queue is durable or not.",
          "expressions-allowed" : true,
          "required" : false,
          "nillable" : true,
          "default" : true,
          "stability" : "default",
          "access-type" : "read-only",
          "storage" : "configuration",
          "restart-required" : null,
          "capability-reference" : null
      }

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

  Type | LIST
  Does the attribute allow expression? | true
  Where is the attribute stored? | configuration
  Access Type | read-write
  Is restarted required? | all-services
  Stability Level | default
  Raw DMR model |
      {
          "type" : {
              "TYPE_MODEL_VALUE" : "LIST"
          },
          "description" : "The jndi names the queue 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-write",
          "storage" : "configuration",
          "restart-required" : "all-services",
          "capability-reference" : null
      }

- expiry-address - The address to send expired messages to.

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

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

  Type | LIST
  Is the attribute nillable? | true
  Does the attribute allow expression? | true
  Where is the attribute stored? | configuration
  Access Type | read-write
  Is restarted required? | all-services
  Stability Level | default
  Raw DMR model |
      {
          "type" : {
              "TYPE_MODEL_VALUE" : "LIST"
          },
          "description" : "The jndi names the queue 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-write",
          "storage" : "configuration",
          "restart-required" : "all-services",
          "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
      }

- paused - Whether the queue is paused.

  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 queue is paused.",
          "expressions-allowed" : false,
          "required" : true,
          "nillable" : false,
          "stability" : "default",
          "access-type" : "read-only",
          "storage" : "runtime",
          "restart-required" : null,
          "capability-reference" : null
      }

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

  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 queue address defines what address is used for routing messages.",
          "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
      }

- scheduled-count - The number of scheduled messages 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 scheduled messages in this queue.",
          "expressions-allowed" : false,
          "required" : true,
          "nillable" : false,
          "stability" : "default",
          "access-type" : "metric",
          "storage" : "runtime",
          "restart-required" : null,
          "capability-reference" : null
      }

- selector - The queue selector.

  Type | STRING
  Is the attribute nillable? | true
  Does the attribute allow expression? | true
  Where is the attribute stored? | configuration
  Access Type | read-only
  Stability Level | default
  Raw DMR model |
      {
          "type" : {
              "TYPE_MODEL_VALUE" : "STRING"
          },
          "description" : "The queue selector.",
          "expressions-allowed" : true,
          "required" : false,
          "nillable" : true,
          "min-length" : 1,
          "max-length" : 2147483647,
          "stability" : "default",
          "access-type" : "read-only",
          "storage" : "configuration",
          "restart-required" : null,
          "capability-reference" : null
      }

- temporary - Whether the queue 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 queue is temporary.",
          "expressions-allowed" : false,
          "required" : true,
          "nillable" : false,
          "stability" : "default",
          "access-type" : "read-only",
          "storage" : "runtime",
          "restart-required" : null,
          "capability-reference" : null
      }

## Operations (29)

- add - Add a Jakarta Messaging queue.

  Request Parameter | Type | Required | Expressions Allowed | Default value | Description
  --- | --- | --- | --- | --- | ---
  durable | BOOLEAN | false | true | true | Whether the queue is durable or not.
  entries | LIST | true | true |  | The jndi names the queue will be bound to.
  legacy-entries | LIST | false | true |  | The jndi names the queue will be bound to.
  selector | STRING | false | true |  | The queue selector.

  Raw DMR model |
      {
          "operation-name" : "add",
          "description" : "Add a Jakarta Messaging queue.",
          "request-properties" : {
              "durable" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "BOOLEAN"
                  },
                  "description" : "Whether the queue is durable or not.",
                  "expressions-allowed" : true,
                  "required" : false,
                  "nillable" : true,
                  "default" : true,
                  "stability" : "default"
              },
              "entries" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "LIST"
                  },
                  "description" : "The jndi names the queue 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"
                  }
              },
              "legacy-entries" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "LIST"
                  },
                  "description" : "The jndi names the queue 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"
                  }
              },
              "selector" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "STRING"
                  },
                  "description" : "The queue selector.",
                  "expressions-allowed" : true,
                  "required" : false,
                  "nillable" : true,
                  "min-length" : 1,
                  "max-length" : 2147483647,
                  "stability" : "default"
              }
          },
          "reply-properties" : {},
          "stability" : "default",
          "read-only" : false,
          "runtime-only" : false
      }

- 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

  Raw DMR model |
      {
          "operation-name" : "add-jndi",
          "description" : "Adds the queue to another JNDI binding",
          "request-properties" : {"jndi-binding" : {
              "type" : {
                  "TYPE_MODEL_VALUE" : "STRING"
              },
              "description" : "Jndi binding",
              "expressions-allowed" : false,
              "required" : true,
              "nillable" : false,
              "min-length" : 1,
              "max-length" : 2147483647,
              "stability" : "default"
          }},
          "reply-properties" : {},
          "stability" : "default",
          "read-only" : false,
          "runtime-only" : false
      }

- 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 | STRING | 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

  Raw DMR model |
      {
          "operation-name" : "change-message-priority",
          "description" : "Change the priority of the message corresponding to the given message-id.",
          "request-properties" : {
              "message-id" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "STRING"
                  },
                  "description" : "The message ID.",
                  "expressions-allowed" : false,
                  "required" : true,
                  "nillable" : false,
                  "min-length" : 1,
                  "max-length" : 2147483647,
                  "stability" : "default"
              },
              "new-priority" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "INT"
                  },
                  "description" : "The new priority (between 0 and 9).",
                  "expressions-allowed" : false,
                  "required" : true,
                  "nillable" : false,
                  "min" : 0,
                  "max" : 9,
                  "stability" : "default"
              }
          },
          "reply-properties" : {
              "type" : {
                  "TYPE_MODEL_VALUE" : "BOOLEAN"
              },
              "description" : "True if the message priority was changed, false otherwise."
          },
          "stability" : "default",
          "read-only" : false,
          "runtime-only" : true
      }

- 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

  Raw DMR model |
      {
          "operation-name" : "change-messages-priority",
          "description" : "Change the priority of the messages corresponding to the given filter.",
          "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"
              },
              "new-priority" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "INT"
                  },
                  "description" : "The new priority (between 0 and 9).",
                  "expressions-allowed" : false,
                  "required" : true,
                  "nillable" : false,
                  "min" : 0,
                  "max" : 9,
                  "stability" : "default"
              }
          },
          "reply-properties" : {
              "type" : {
                  "TYPE_MODEL_VALUE" : "INT"
              },
              "description" : "The number of changed messages."
          },
          "stability" : "default",
          "read-only" : false,
          "runtime-only" : true
      }

- 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

  Raw DMR model |
      {
          "operation-name" : "count-messages",
          "description" : "Returns the number of the messages in the queue matching the given filter.",
          "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" : "LONG"
          }},
          "stability" : "default",
          "read-only" : true,
          "runtime-only" : true
      }

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

  Request Parameter | Type | Required | Expressions Allowed | Default value | Description
  --- | --- | --- | --- | --- | ---
  message-id | STRING | true | false |  | The message ID.

  ### Reply properties

  True if the message was expired, false otherwise.
  Type
    BOOLEAN

  Raw DMR model |
      {
          "operation-name" : "expire-message",
          "description" : "Expire the message corresponding to the given message-id.",
          "request-properties" : {"message-id" : {
              "type" : {
                  "TYPE_MODEL_VALUE" : "STRING"
              },
              "description" : "The message ID.",
              "expressions-allowed" : false,
              "required" : true,
              "nillable" : false,
              "min-length" : 1,
              "max-length" : 2147483647,
              "stability" : "default"
          }},
          "reply-properties" : {
              "type" : {
                  "TYPE_MODEL_VALUE" : "BOOLEAN"
              },
              "description" : "True if the message was expired, false otherwise."
          },
          "stability" : "default",
          "read-only" : false,
          "runtime-only" : true
      }

- 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

  Raw DMR model |
      {
          "operation-name" : "expire-messages",
          "description" : "Expire the messages matching the given filter.",
          "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 expired messages."
          },
          "stability" : "default",
          "read-only" : false,
          "runtime-only" : true
      }

- 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

  Raw DMR model |
      {
          "operation-name" : "list-consumers-as-json",
          "description" : "List all the existing consumers on the queue as a string in JSON format.",
          "request-properties" : {},
          "reply-properties" : {
              "type" : {
                  "TYPE_MODEL_VALUE" : "STRING"
              },
              "description" : "A string in JSON format with the list of all consumers"
          },
          "stability" : "default",
          "read-only" : true,
          "runtime-only" : true
      }

- 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" => 1,
                "max-length" => 2147483647,
                "stability" => "default"
            },
            "elements" => {
                "type" => LIST,
                "description" => "The delivering messages.",
                "expressions-allowed" => false,
                "required" => true,
                "nillable" => false,
                "min-length" => 0,
                "max-length" => 2147483647,
                "stability" => "default",
                "value-type" => {
                    "JMSMessageID" => {
                        "type" => STRING,
                        "description" => "The message's 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-delivering-messages",
          "description" : "List the messages are currently being delivered.",
          "request-properties" : {},
          "reply-properties" : {
              "type" : {
                  "TYPE_MODEL_VALUE" : "LIST"
              },
              "value-type" : {
                  "consumerName" : {
                      "type" : {
                          "TYPE_MODEL_VALUE" : "STRING"
                      },
                      "description" : "The name of the consumer that the messages are delivered to.",
                      "expressions-allowed" : false,
                      "required" : true,
                      "nillable" : false,
                      "min-length" : 1,
                      "max-length" : 2147483647,
                      "stability" : "default"
                  },
                  "elements" : {
                      "type" : {
                          "TYPE_MODEL_VALUE" : "LIST"
                      },
                      "description" : "The delivering messages.",
                      "expressions-allowed" : false,
                      "required" : true,
                      "nillable" : false,
                      "min-length" : 0,
                      "max-length" : 2147483647,
                      "stability" : "default",
                      "value-type" : {
                          "JMSMessageID" : {
                              "type" : {
                                  "TYPE_MODEL_VALUE" : "STRING"
                              },
                              "description" : "The message's 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-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

  Raw DMR model |
      {
          "operation-name" : "list-delivering-messages-as-json",
          "description" : "List the messages are currently being delivered as a string in JSON format",
          "request-properties" : {},
          "reply-properties" : {
              "type" : {
                  "TYPE_MODEL_VALUE" : "STRING"
              },
              "description" : "A string in JSON format representing a list where each element is a map of message properties to their value."
          },
          "stability" : "default",
          "read-only" : true,
          "runtime-only" : true
      }

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

  ### Reply properties

  A string in HTML format.
  Type
    STRING

  Raw DMR model |
      {
          "operation-name" : "list-message-counter-as-html",
          "description" : "List the message counter as a string in HTML format.",
          "request-properties" : {},
          "reply-properties" : {
              "type" : {
                  "TYPE_MODEL_VALUE" : "STRING"
              },
              "description" : "A string in HTML format."
          },
          "stability" : "default",
          "read-only" : true,
          "runtime-only" : true
      }

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

  ### Reply properties

  A string in JSON format.
  Type
    STRING

  Raw DMR model |
      {
          "operation-name" : "list-message-counter-as-json",
          "description" : "List the message counter as a string in JSON format.",
          "request-properties" : {},
          "reply-properties" : {
              "type" : {
                  "TYPE_MODEL_VALUE" : "STRING"
              },
              "description" : "A string in JSON format."
          },
          "stability" : "default",
          "read-only" : true,
          "runtime-only" : true
      }

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

  ### Reply properties

  A string in HTML format.
  Type
    STRING

  Raw DMR model |
      {
          "operation-name" : "list-message-counter-history-as-html",
          "description" : "List the message counter history.",
          "request-properties" : {},
          "reply-properties" : {
              "type" : {
                  "TYPE_MODEL_VALUE" : "STRING"
              },
              "description" : "A string in HTML format."
          },
          "stability" : "default",
          "read-only" : true,
          "runtime-only" : true
      }

- 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

  Raw DMR model |
      {
          "operation-name" : "list-message-counter-history-as-json",
          "description" : "List the message counter history as a string in JSON format.",
          "request-properties" : {},
          "reply-properties" : {
              "type" : {
                  "TYPE_MODEL_VALUE" : "STRING"
              },
              "description" : "A string in JSON format"
          },
          "stability" : "default",
          "read-only" : true,
          "runtime-only" : true
      }

- 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

  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",
          "description" : "List all messages in the queue that match the filter",
          "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" : "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"
                  }
              }
          },
          "stability" : "default",
          "read-only" : true,
          "runtime-only" : true
      }

- 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

  Raw DMR model |
      {
          "operation-name" : "list-messages-as-json",
          "description" : "List all messages in the queue that match the filter and return them as a string in JSON format.",
          "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" : "STRING"
              },
              "description" : "A JSON string containing all the messages matching the filter."
          },
          "stability" : "default",
          "read-only" : true,
          "runtime-only" : true
      }

- 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

        {
            "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-scheduled-messages",
          "description" : "List the messages scheduled for delivery.",
          "request-properties" : {},
          "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-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

  Raw DMR model |
      {
          "operation-name" : "list-scheduled-messages-as-json",
          "description" : "List the messages scheduled for delivery as a string in JSON format.",
          "request-properties" : {},
          "reply-properties" : {
              "type" : {
                  "TYPE_MODEL_VALUE" : "STRING"
              },
              "description" : "A string in JSON format representing a list where each element is a map of message properties to their value."
          },
          "stability" : "default",
          "read-only" : true,
          "runtime-only" : true
      }

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

  Request Parameter | Type | Required | Expressions Allowed | Default value | Description
  --- | --- | --- | --- | --- | ---
  message-id | STRING | 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

  Raw DMR model |
      {
          "operation-name" : "move-message",
          "description" : "Move the message corresponding to the given message-id to another queue",
          "request-properties" : {
              "message-id" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "STRING"
                  },
                  "description" : "The message ID.",
                  "expressions-allowed" : false,
                  "required" : true,
                  "nillable" : false,
                  "min-length" : 1,
                  "max-length" : 2147483647,
                  "stability" : "default"
              },
              "other-queue-name" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "STRING"
                  },
                  "description" : "The name of the queue to move the message to.",
                  "expressions-allowed" : false,
                  "required" : true,
                  "nillable" : false,
                  "min-length" : 1,
                  "max-length" : 2147483647,
                  "stability" : "default"
              },
              "reject-duplicates" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "BOOLEAN"
                  },
                  "description" : "Whether to reject messages identified as duplicate.",
                  "expressions-allowed" : false,
                  "required" : false,
                  "nillable" : true,
                  "stability" : "default"
              }
          },
          "reply-properties" : {
              "type" : {
                  "TYPE_MODEL_VALUE" : "INT"
              },
              "description" : "True if the message was moved, false otherwise"
          },
          "stability" : "default",
          "read-only" : false,
          "runtime-only" : true
      }

- move-messages - Move the messages corresponding to the given filter to another 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.
  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

  Raw DMR model |
      {
          "operation-name" : "move-messages",
          "description" : "Move the messages corresponding to the given filter to another queue.",
          "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"
              },
              "other-queue-name" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "STRING"
                  },
                  "description" : "The name of the queue to move the message to.",
                  "expressions-allowed" : false,
                  "required" : true,
                  "nillable" : false,
                  "min-length" : 1,
                  "max-length" : 2147483647,
                  "stability" : "default"
              },
              "reject-duplicates" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "BOOLEAN"
                  },
                  "description" : "Whether to reject messages identified as duplicate.",
                  "expressions-allowed" : false,
                  "required" : false,
                  "nillable" : true,
                  "stability" : "default"
              }
          },
          "reply-properties" : {
              "type" : {
                  "TYPE_MODEL_VALUE" : "INT"
              },
              "description" : "The number of moved messages."
          },
          "stability" : "default",
          "read-only" : false,
          "runtime-only" : true
      }

- pause - Pause the queue.

  Raw DMR model |
      {
          "operation-name" : "pause",
          "description" : "Pause the queue.",
          "request-properties" : {},
          "reply-properties" : {},
          "stability" : "default",
          "read-only" : false,
          "runtime-only" : true
      }

- remove - Remove a Jakarta Messaging queue.

  Raw DMR model |
      {
          "operation-name" : "remove",
          "description" : "Remove a Jakarta Messaging queue.",
          "request-properties" : {},
          "reply-properties" : {},
          "stability" : "default",
          "read-only" : false,
          "restart-required" : "resource-services",
          "runtime-only" : false
      }

- remove-jndi - Removes the JNDI binding

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

  Raw DMR model |
      {
          "operation-name" : "remove-jndi",
          "description" : "Removes the JNDI binding",
          "request-properties" : {"jndi-binding" : {
              "type" : {
                  "TYPE_MODEL_VALUE" : "STRING"
              },
              "description" : "Jndi binding",
              "expressions-allowed" : false,
              "required" : true,
              "nillable" : false,
              "min-length" : 1,
              "max-length" : 2147483647,
              "stability" : "default"
          }},
          "reply-properties" : {},
          "stability" : "default",
          "read-only" : false,
          "runtime-only" : false
      }

- remove-message - Remove the message corresponding to the given message-id.

  Request Parameter | Type | Required | Expressions Allowed | Default value | Description
  --- | --- | --- | --- | --- | ---
  message-id | STRING | true | false |  | The message ID.

  ### Reply properties

  True if the message was removed, false otherwise.
  Type
    BOOLEAN

  Raw DMR model |
      {
          "operation-name" : "remove-message",
          "description" : "Remove the message corresponding to the given message-id.",
          "request-properties" : {"message-id" : {
              "type" : {
                  "TYPE_MODEL_VALUE" : "STRING"
              },
              "description" : "The message ID.",
              "expressions-allowed" : false,
              "required" : true,
              "nillable" : false,
              "min-length" : 1,
              "max-length" : 2147483647,
              "stability" : "default"
          }},
          "reply-properties" : {
              "type" : {
                  "TYPE_MODEL_VALUE" : "BOOLEAN"
              },
              "description" : "True if the message was removed, false otherwise."
          },
          "stability" : "default",
          "read-only" : false,
          "runtime-only" : true
      }

- 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

  Raw DMR model |
      {
          "operation-name" : "remove-messages",
          "description" : "Remove messages matching the given filter from the queue.",
          "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
      }

- reset-message-counter - Reset the message counters.

  Raw DMR model |
      {
          "operation-name" : "reset-message-counter",
          "description" : "Reset the message counters.",
          "request-properties" : {},
          "reply-properties" : {},
          "stability" : "default",
          "read-only" : false,
          "runtime-only" : true
      }

- resume - Resume the queue.

  Raw DMR model |
      {
          "operation-name" : "resume",
          "description" : "Resume the queue.",
          "request-properties" : {},
          "reply-properties" : {},
          "stability" : "default",
          "read-only" : false,
          "runtime-only" : true
      }

- 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 | STRING | true | false |  | The message ID.

  ### Reply properties

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

  Raw DMR model |
      {
          "operation-name" : "send-message-to-dead-letter-address",
          "description" : "Send the message corresponding to the given message-id to this queue's Dead Letter Address.",
          "request-properties" : {"message-id" : {
              "type" : {
                  "TYPE_MODEL_VALUE" : "STRING"
              },
              "description" : "The message ID.",
              "expressions-allowed" : false,
              "required" : true,
              "nillable" : false,
              "min-length" : 1,
              "max-length" : 2147483647,
              "stability" : "default"
          }},
          "reply-properties" : {
              "type" : {
                  "TYPE_MODEL_VALUE" : "BOOLEAN"
              },
              "description" : "True if the message was sent to the dead letter address, false otherwise."
          },
          "stability" : "default",
          "read-only" : false,
          "runtime-only" : true
      }

- 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

  Raw DMR model |
      {
          "operation-name" : "send-messages-to-dead-letter-address",
          "description" : "Send the messages corresponding to the given filter to this queue's Dead Letter Address.",
          "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 sent messages."
          },
          "stability" : "default",
          "read-only" : false,
          "runtime-only" : true
      }

## Galleon Features

Galleon features are to be used when creating Galleon feature-packs.

- subsystem.messaging-activemq.server.jms-queue

      <feature spec="subsystem.messaging-activemq.server.jms-queue">
        <param name="jms-queue" value="{resource name}"/>
        <param name="server" value="{resource name}"/>
        <param name="durable" value="{value}"/>
        <param name="entries" value="{value}"/>
        <param name="legacy-entries" value="{value}"/>
        <param name="selector" value="{value}"/>
      <feature/>