solace.md

description
This page contains the technical details of the Solace endpoint plugin

Solace

{% hint style="warning" %} This feature requires Gravitee's Enterprise Edition. {% endhint %}

Overview

Use this endpoint to publish and/or subscribe messages to a Solace broker.

{% hint style="info" %} Only SMF protocol is supported. {% endhint %}

• Compatibility matrix
• Endpoint identifier
• Endpoint configuration

Compatibility matrix

Plugin version	APIM version
1.x and up	4.x or higher

Endpoint identifier

To use this plugin, declare the following solace identifier while configuring your API endpoints.

Endpoint configuration

General configuration

Endpoint-level configuration

Attributes	Default	Mandatory	Description
url	N/A	Yes	Define the URL of the Solace broker. Should begin with either tcp:// or tcps:// for SMF protocol.
vpnName	N/A	Yes	Virtual event broker to target

Shared Configuration

Security

Security options are available under security attribute.

Authentication

Available under security.auth:

Attributes	Default	Mandatory	Description
username	N/A	No	The username to use for the authentication
password	N/A	No	The password to use for the authentication

Consumer configuration

Attributes	Default	Mandatory	Description
enabled	false	No	Enable or disable the consumer capability
topics	N/A	Yes	Refers to a list of UTF-8 strings to subscribe to

Producer configuration

Attributes	Default	Mandatory	Description
enabled	false	No	Enable or disable the producer capability
topics	N/A	Yes	Refers to a list of UTF-8 strings used to publish incoming messages

Examples

The example below shows a full Solace endpoint configuration:

{
    "name": "default",
    "type": "solace",
    "weight": 1,
    "inheritConfiguration": false,
    "configuration": {
        "url": "tcp://localhost:55554",
        "vpnName": "default"
    },
    "sharedConfigurationOverride": {
        "consumer" : {
            "enabled": true,
            "topics": ["topic/subscribe"]
        },
        "producer" : {
            "enabled": true,
            "topics": ["topic/publish"]
        },
        "security" : {
            "auth": {
                "username": "user",
                "password": "password"
            }
        }
    }
}