Viewing the protocols and their allowed actions

System administrators can view the protocols that are on Eclipse Amlen and the actions that are allowed for each of them by using the Eclipse Amlen REST API GET method.

You can view the protocols that are on Eclipse Amlen and the actions that are allowed for them. JMS and MQTT protocols are supplied as protocols on Eclipse Amlen and you can add protocols by creating and updating protocol plug-ins.

You can use the Eclipse Amlen REST API GET method to confirm that any protocols that you create or update are activated on Eclipse Amlen after you have created or updated them and restarted the protocol plug-in server process.

To view the protocols on Eclipse Amlen, use the Eclipse Amlen REST API GET method with the following Eclipse Amlen URI:

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

The following example shows a GET method to view the protocols on Eclipse Amlen by using cURL:

curl -X GET http://127.0.0.1:9089/ima/v1/configuration/Protocol

The following example shows a successful example response to the GET method that was used to view the protocols on Eclipse Amlen. The example shows the JMS and MQTT protocols that Eclipse Amlen supports, as well as a protocol called json_msg that has been created by configuring a protocol plug-in.


{
  "Version":"v1",
  "Protocol": {
    "jms": {
      "UseTopic":true,
      "UseQueue":true,
      "UseShared":true,
      "UseBrowse":true
    },
    "json_msg": {
      "UseBrowse": false,
      "UseQueue": false,
      "UseShared": false,
      "UseTopic": true
    },
    "mqtt": {
      "UseTopic":true,
      "UseQueue":false,
      "UseShared":true,
      "UseBrowse":false
    }
  }
}