Stomp
Since Camel 2.12
Both producer and consumer are supported
The Stomp component is used for communicating with Stomp compliant message brokers, like Apache ActiveMQ or ActiveMQ Apollo
Note: Since STOMP specification is not actively maintained, please note STOMP JMS client is not as well actively maintained. However, we hope for the community to step up to help on maintaining the STOMP JMS project in the near future.
Maven users will need to add the following dependency to their pom.xml
for this component:
<dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-stomp</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel core version -->
</dependency>Options
The Stomp component supports 13 options, which are listed below.
| Name | Description | Default | Type |
|---|---|---|---|
brokerURL (common) |
Required The URI of the Stomp broker to connect to |
tcp://localhost:61613 |
String |
customHeaders (common) |
To set custom headers |
Properties |
|
host (common) |
The virtual host name |
String |
|
version (common) |
The stomp version (1.1, or 1.2) |
String |
|
bridgeErrorHandler (consumer) |
Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. |
false |
boolean |
lazyStartProducer (producer) |
Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. |
false |
boolean |
basicPropertyBinding (advanced) |
Deprecated Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities |
false |
boolean |
configuration (advanced) |
Component configuration. |
StompConfiguration |
|
headerFilterStrategy (filter) |
To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message. |
HeaderFilterStrategy |
|
login (security) |
The username |
String |
|
passcode (security) |
The password |
String |
|
sslContextParameters (security) |
To configure security using SSLContextParameters |
SSLContextParameters |
|
useGlobalSslContextParameters (security) |
Enable usage of global SSL context parameters. |
false |
boolean |
The Stomp endpoint is configured using URI syntax:
stomp:destination
with the following path and query parameters:
Path Parameters (1 parameters):
| Name | Description | Default | Type |
|---|---|---|---|
destination |
Required Name of the queue |
String |
Query Parameters (14 parameters):
| Name | Description | Default | Type |
|---|---|---|---|
brokerURL (common) |
Required The URI of the Stomp broker to connect to |
tcp://localhost:61613 |
String |
customHeaders (common) |
To set custom headers |
Properties |
|
host (common) |
The virtual host name |
String |
|
version (common) |
The stomp version (1.1, or 1.2) |
String |
|
bridgeErrorHandler (consumer) |
Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. |
false |
boolean |
exceptionHandler (consumer) |
To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. |
ExceptionHandler |
|
exchangePattern (consumer) |
Sets the exchange pattern when the consumer creates an exchange. There are 3 enums and the value can be one of: InOnly, InOut, InOptionalOut |
ExchangePattern |
|
lazyStartProducer (producer) |
Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. |
false |
boolean |
basicPropertyBinding (advanced) |
Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities |
false |
boolean |
headerFilterStrategy (advanced) |
To use a custom HeaderFilterStrategy to filter header to and from Camel message. |
HeaderFilterStrategy |
|
synchronous (advanced) |
Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). |
false |
boolean |
login (security) |
The username |
String |
|
passcode (security) |
The password |
String |
|
sslContextParameters (security) |
To configure security using SSLContextParameters |
SSLContextParameters |
You can append query options to the URI in the following format,
?option=value&option=value&…
Samples
Sending messages:
from("direct:foo").to("stomp:queue:test");Consuming messages:
from("stomp:queue:test").transform(body().convertToString()).to("mock:result")Endpoints
Camel supports the Message Endpoint pattern using the Endpoint interface. Endpoints are usually created by a Component and Endpoints are usually referred to in the DSL via their URIs.
From an Endpoint you can use the following methods
* createProducer() will create a Producer for sending message exchanges to the endpoint * createConsumer() implements the Event Driven Consumer pattern for consuming message exchanges from the endpoint via a Processor when creating a Consumer * createPollingConsumer() implements the Polling Consumer pattern for consuming message exchanges from the endpoint via a PollingConsumer
Spring Boot Auto-Configuration
When using stomp with Spring Boot make sure to use the following Maven dependency to have support for auto configuration:
<dependency>
<groupId>org.apache.camel.springboot</groupId>
<artifactId>camel-stomp-starter</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel core version -->
</dependency>The component supports 14 options, which are listed below.
| Name | Description | Default | Type |
|---|---|---|---|
camel.component.stomp.autowired-enabled |
Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. |
true |
Boolean |
camel.component.stomp.bridge-error-handler |
Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. |
false |
Boolean |
camel.component.stomp.broker-url |
The URI of the Stomp broker to connect to |
tcp://localhost:61613 |
String |
camel.component.stomp.configuration |
Component configuration. The option is a org.apache.camel.component.stomp.StompConfiguration type. |
StompConfiguration |
|
camel.component.stomp.custom-headers |
To set custom headers. The option is a java.util.Properties type. |
Properties |
|
camel.component.stomp.enabled |
Whether to enable auto configuration of the stomp component. This is enabled by default. |
Boolean |
|
camel.component.stomp.header-filter-strategy |
To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message. The option is a org.apache.camel.spi.HeaderFilterStrategy type. |
HeaderFilterStrategy |
|
camel.component.stomp.host |
The virtual host name |
String |
|
camel.component.stomp.lazy-start-producer |
Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. |
false |
Boolean |
camel.component.stomp.login |
The username |
String |
|
camel.component.stomp.passcode |
The password |
String |
|
camel.component.stomp.ssl-context-parameters |
To configure security using SSLContextParameters. The option is a org.apache.camel.support.jsse.SSLContextParameters type. |
SSLContextParameters |
|
camel.component.stomp.use-global-ssl-context-parameters |
Enable usage of global SSL context parameters. |
false |
Boolean |
camel.component.stomp.version |
The stomp version (1.1, or 1.2) |
String |