Require JMS

Require JMS

The Require JMS policy is applicable only for SOAP APIs.

The following are not supported if the Require JMS policy is added:

Threat protection policies

API Gateway SOAP to REST transformation feature

Require JMS policy is used when you have a native API that requires clients to communicate with the server using the Java Message Service (JMS) protocol. This action allows you to bridge protocols between the client and the native API.

When this action is configured for a proxy API, you can intentionally expose an API over a JMS protocol. For example, if you have a native API that is exposed over HTTP, you might expose the API over JMS simply to gain the asynchronous-messaging and guaranteed-delivery benefits that one gains by using JMS as the message transport.

Complete the following before using the Require JMS action:

Create an alias to a JNDI Provider (in the Integration Server Administrator, go to Settings > Messaging > JNDI Settings).

To establish an active connection between Integration Server and the JMS provider, you must configure Integration Server to use a JMS connection alias (in the Integration Server Administrator, go to Settings > Messaging > JMS Settings).

Create a WS (Web Service) JMS Provider endpoint alias. In the Integration Server Administrator, navigate to Settings > Web Services > Create Web Service Endpoint Alias and configure the Alias, Description, Type (Provider), Transport Type (JMS) fields and JMS Transport Properties.

Configure a WS (Web Service) endpoint trigger (in the Integration Server Administrator, go to Settings > Messaging > JMS Trigger Management).

Additionally, ensure that you delete the predefined Require HTTP / HTTPS Protocol action from the Transport stage. This is because, these actions are mutually exclusive.

For detailed procedures, see webMethods Integration Server Administrator’s Guide.

The table lists the properties that you can specify for this policy:

Parameter	Description
JMS Provider Endpoint Alias	Specifies the name of Integration Server's JMS provider endpoint alias.
SOAP Version	For SOAP-based APIs. Specifies the SOAP version of the requests which the API Gateway accepts from the client. Select one of the following: SOAP 1.1. This is selected by default. API Gateway accepts requests that are in the SOAP 1.1 format. SOAP 1.2. API Gateway accepts requests that are in the SOAP 1.2 format.