Creating and updating a queue policy by using REST Administration APIs

http://<admin-endpoint-IP:Port>/ima/v1/configuration/

{    
   "QueuePolicy": {
     "<NameOfQueuePolicy>": {
       "Description": "string",
       "Queue": "string",
       "ActionList": "string",
       "MaxMessageTimeToLive": "string",
       "ClientID": "string",
       "UserID": "string",
       "GroupID": "string",
       "CommonNames": "string",
       "ClientAddress": "string",
       "Protocol": "string"             
    }
  }
}

NameOfQueuePolicy

Required.

Specifies the name of the queue policy.

The name must not have leading or trailing spaces and cannot contain control characters, commas, double quotation marks, backslashes, or equal signs. The first character must not be a number or any of the following special characters:

! # $ % & ' ( ) * + - . / : ; < > ? @

After the queue policy is created, you cannot change this name.

Description

Optional.

Specifies a description for the queue policy.

If you do not want a description, omit "Description":"description".

Queue

Required if you are creating a queue policy.

Specifies the queue or queues that the queue policy applies to.

You can use an asterisk (*) as a wildcard. You must take care when you use a wildcard to ensure that you do not grant greater authority to topics than intended. For more information about how wildcard characters can be used, see Wildcards.

The dollar sign ($) and asterisk (*) have special meanings in the queue field. To use these characters as literals, use ${$} for a dollar sign, and use ${*} for an asterisk.

You can use variable substitution in the queue field to ensure that only clients with specific user IDs, group IDs, client IDs, or client certificate common names can access a queue. The variables are:

• ${UserID} for the user ID.
• ${GroupID} for the group ID.
• ${ClientID} for the client ID.
• ${CommonName} for the client certificate common name.

For example, if a queue in a queue policy is ${ClientID}, then a client with an ID of client_a can access queue client_a. A client with an ID of client_b cannot access queue client_a, but can access queue client_b.

ActionList

Required if you are creating a queue policy.

Specifies which messaging actions can be used by clients that connect to endpoints associated with this queue policy.

You can specify the following values for a queue policy. To specify more than one, separate each value with a comma.

• Send

  Allows clients to send messages to the queue that is specified in the queue policy.

• Receive

  Allows clients to receive messages from the queue that is specified in the queue policy.

• Browse

  Allows clients to browse messages on the queue that is specified in the queue policy.

MaxMessageTimeTo Live

Optional.

Specifies the maximum time, in seconds, that a sent message that is associated with the queue policy can exist for in Eclipse Amlen.

The value must be either unlimited or in the range 1-2147483647.

The default value is unlimited and means that messages will not expire unless the publishing application specifies a time for messages to exist for.

This value is applied only when the queue policy includes an action of send.

Ensure that client and server times are synchronized in order to minimize the possibility of expired messages being received.

You can check that the configuration of your policy is as expected by using the Eclipse Amlen REST Administration API GET method. For more information about the GET method, see Viewing configuration details of objects that can be named by using REST Administration APIs.