Software AG Products 10.5 | Using API Gateway | Policies | System-defined Stages and Policies | Routing | JMS/AMQP Policies | Using JMS/AMQP Policy for a REST API
 
Using JMS/AMQP Policy for a REST API
If you are using JMS with Message broker native protocol support ensure that following actions are performed before using the Enable JMS/AMQP policy:
*Create an alias to a JNDI Provider For a detailed procedure, see Creating a JNDI Provider Alias.
*Configure API Gateway to use a JMS connection alias to establish an active connection between API Gateway and the JMS provider. For a detailed procedure, see Creating a JMS Connection Alias.
If you are using JMS with AMQP protocol support, ensure the following before using the Enable JMS/AMQP policy:
*You have configured API Gateway for JMS with AMQP. For details, see Configuring API Gateway for JMS with AMQP Protocol
The table lists the properties that you can specify for this policy:
Parameter
Description
Connection Alias Name
Specifies the name of the connection alias.
Each connection alias contains the configuration information needed to establish a connection to a specific JMS provider.
Destination Name
Specify the destination to which the request message is sent.
Destination Type
Specify the destination type to which the request message is sent.
Reply To Name
Specify the name of the destination to which the response message is sent.
Reply To Type
Specifies the type of destination to which the response message is sent.
Select one of the following source type:
*QUEUE. Indicates that the response message is sent to a particular queue.
*TOPIC. Indicates that the response message is sent to a particular topic.
Time to Live (ms)
Provide a numeric value that specifies the expiration time (in milliseconds) of the JMS or AMQP message. If the time-to-live is specified as zero, expiration is set to zero which indicates the message does not expire.
The default value is 0.
Time to Wait (ms)
Defines the time in milliseconds for which API Gateway listens to the Reply To Queue or Topic for the response message.
Delivery Mode
The message delivery mode for the request message. This is the delivery mode that web service clients must specify in the JMS or AMQP message that serves as the request message for the web service. The available options are:
*Non-persistent. Indicates that the request message is not persistent. The message might be lost if the JMS provider fails.
*Persistent. Indicates that the request message should be persistent. The message is not lost if the JMS provider fails.