Event Broker Prerequisites

Before you configure a Micro-Integration's connection to the event broker, make sure the items in the following list are in place:

Event Broker

The Micro-Integration requires a running Solace event broker to connect to.

A Micro-Integration connects to the event broker as a standard client over SMF, so any deployment type works: an event broker service, a software event broker, or an appliance event broker.

Deploy your Micro-Integration as close as possible to the event broker to minimize latency, regardless of the broker's deployment type. Where possible, also deploy both as close as possible to the external vendor system.

Client Credentials

You must supply the client credentials the Micro-Integration will use to connect to the event broker: a host URL, a VPN name, and either a client username and password or, if your broker is configured for OAuth2 authentication, an OAuth token.

The Micro-Integration always connects over SMF; the host URL's scheme (tcp://, tcps:// for TLS, ws://, or wss:// for TLS) and port depend on your event broker's configuration. For more information, see Session Properties Required to Establish a Connection in the Solace JCSMP API.

For OAuth2 setup information, see JCSMP Spring Boot: Using OAuth2 Authentication Scheme. For the full set of connection properties, see Step 1: Connecting to Your Event Broker .

Source Workflow Queues

If your Micro-Integration has a source workflow, provide one or more queues on the event broker for it to consume from. Either:

  • Leave queue auto-provisioning enabled (the binder's default behavior) and grant the client username the Allow Client to Create Endpoints permission, so the Micro-Integration creates the queue itself, or

  • Provision the queue yourself and grant the client username permission to consume from it.

For the difference between exclusive and non-exclusive queues, see Queue Access Types.

Network Access

Confirm that the Micro-Integration host can reach the event broker host over the network, on the port for your connection scheme:

  • tcp:// (port 55555 by default; 55003 if compression is enabled)

  • tcps:// (port 55443 by default)

  • ws:// or wss://

For the default ports for WebSockets, see Session Properties Required to Establish a Connection in the Solace JCSMP API.

Next Steps

After these prerequisites are in place, see Step 1: Connecting to Your Event Broker for the steps to configure the event broker connection, and Step 2: Configuring the Spring Cloud Stream Binder for details about tuning the behavior of the Solace binder.

These prerequisites apply to every self-managed Micro-Integration. Your vendor system may have its own prerequisites, such as system configuration or authentication keys. For more information, see Step 3: Vendor-Specific Configuration for Self-Managed Micro-Integrations.