Stomp Component

Table of Contents

URI format
Options
Samples
Endpoints
See Also

Available as of Camel 2.12

The stomp: component is used for communicating with Stomp compliant message brokers, like Apache ActiveMQ or ActiveMQ Apollo

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>

URI format

stomp:queue:destination[?options]

Where destination is the name of the queue.

Options

The Stomp component supports 5 options which are listed below.

{% raw %}

NameJava TypeDescription

configuration

StompConfiguration

To use the shared stomp configuration

brokerURL

String

The URI of the Stomp broker to connect to

login

String

The username

passcode

String

The password

host

String

The virtual host

{% endraw %}

The Stomp component supports 10 endpoint options which are listed below:

{% raw %}

NameGroupDefaultJava TypeDescription

destination

common

 

String

Required Name of the queue

brokerURL

common

tcp://localhost:61613

String

Required The URI of the Stomp broker to connect to

host

common

 

String

The virtual host name

bridgeErrorHandler

consumer

false

boolean

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/ERROR level and ignored.

exceptionHandler

consumer (advanced)

 

ExceptionHandler

To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored.

exchangePattern

consumer (advanced)

 

ExchangePattern

Sets the exchange pattern when the consumer creates an exchange.

synchronous

advanced

false

boolean

Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).

login

security

 

String

The username

passcode

security

 

String

The password

sslContextParameters

security

 

SSLContextParameters

To configure security using SSLContextParameters

{% endraw %}

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

See Also