| // spring-boot-auto-configure options: START |
| :page-partial: |
| :doctitle: Camel Spring Boot Starter for stomp |
| |
| == Spring Boot Auto-Configuration |
| |
| When using stomp with Spring Boot make sure to use the following Maven dependency to have support for auto configuration: |
| |
| [source,xml] |
| ---- |
| <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. |
| |
| |
| |
| [width="100%",cols="2,5,^1,2",options="header"] |
| |=== |
| | 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 |
| |=== |
| // spring-boot-auto-configure options: END |
