Forwards STOMP requests to a STOMP broker and then tunnels the connection between client and broker. A request without STOMP credentials (login and passcode, or host and accept-version headers) gets 400. If the broker cannot be reached or the connection fails, the response is a 502 gateway problem detail.

Example Configuration

api:
   port: 61614
   flow:
     - stompClient:
         host: broker.example.com
         port: 61613

api:
   port: 61614
   flow:
     - stompClient:
         host: broker.example.com
         port: 61613

Syntax

stompClient:
  host: <string> # required
  '$ref': <string>
  connection: {}
  port: <int>
  ssl: {}

stompClient:
  host: <string> # required
  '$ref': <string>
  connection: {}
  port: <int>
  ssl: {}

Attributes

Name	Required	Default	Description	Examples
$ref	false	-	Reference a component defined under components.	-
host	true	-	The host (name or IP) to connect to.	-
port	false	61613	The port to connect to.	-

Child Structure

Element	Cardinality	Description
connection	0..1	Socket level settings for connections to a backend: how long the client waits while connecting and while reading, how long an idle connection is kept in the pool, and which local network interface it binds to.
ssl	0..1	Configures a TLS context: the identity (key and certificate) presented to the peer, the certificates trusted from it, and handshake parameters such as protocol, ciphers, and client-certificate policy. Attach it to a `serviceProxy`/`api` to terminate inbound TLS, or to a `target` to make an outbound connection over TLS; most attributes and child elements apply to both directions, but a few - such as `clientAuth` and `useAsDefault` - only take effect on an inbound context. See `tutorials/ssl-tls/10-TLS-Termination.yaml` for inbound termination and `tutorials/ssl-tls/20-Central-SSL-Config.yaml` for sharing one `ssl` across several APIs via `$ref`.

Can be used in

abort api case chain components for global if interceptor internal operationSettings otherwise proxy registration request response serviceProxy soapProxy stompProxy time transport wsStompReassembler