blob: e762c69eb348b584f28c1d2aebac2aeac56930fe [file] [log] [blame]
// kafka-connector options: START
[[camel-stomp-kafka-connector-source]]
= camel-stomp-kafka-connector source configuration
When using camel-stomp-kafka-connector as source make sure to use the following Maven dependency to have support for the connector:
[source,xml]
----
<dependency>
<groupId>org.apache.camel.kafkaconnector</groupId>
<artifactId>camel-stomp-kafka-connector</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel Kafka connector version -->
</dependency>
----
The camel-stomp source connector supports 23 options, which are listed below.
[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Priority
| *camel.source.path.destination* | Name of the queue | null | HIGH
| *camel.source.endpoint.brokerURL* | The URI of the Stomp broker to connect to | "tcp://localhost:61613" | HIGH
| *camel.source.endpoint.customHeaders* | To set custom headers | null | MEDIUM
| *camel.source.endpoint.host* | The virtual host name | null | MEDIUM
| *camel.source.endpoint.version* | The stomp version (1.1, or 1.2) | null | MEDIUM
| *camel.source.endpoint.bridgeErrorHandler* | 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 | MEDIUM
| *camel.source.endpoint.exceptionHandler* | 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. | null | MEDIUM
| *camel.source.endpoint.exchangePattern* | Sets the exchange pattern when the consumer creates an exchange. One of: [InOnly] [InOut] [InOptionalOut] | null | MEDIUM
| *camel.source.endpoint.basicPropertyBinding* | Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | MEDIUM
| *camel.source.endpoint.headerFilterStrategy* | To use a custom HeaderFilterStrategy to filter header to and from Camel message. | null | MEDIUM
| *camel.source.endpoint.synchronous* | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | MEDIUM
| *camel.source.endpoint.login* | The username | null | MEDIUM
| *camel.source.endpoint.passcode* | The password | null | MEDIUM
| *camel.source.endpoint.sslContextParameters* | To configure security using SSLContextParameters | null | MEDIUM
| *camel.component.stomp.brokerURL* | The URI of the Stomp broker to connect to | null | MEDIUM
| *camel.component.stomp.host* | The virtual host | null | MEDIUM
| *camel.component.stomp.bridgeErrorHandler* | 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 | MEDIUM
| *camel.component.stomp.basicPropertyBinding* | Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | MEDIUM
| *camel.component.stomp.configuration* | To use the shared stomp configuration | null | MEDIUM
| *camel.component.stomp.headerFilterStrategy* | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message. | null | MEDIUM
| *camel.component.stomp.login* | The username | null | MEDIUM
| *camel.component.stomp.passcode* | The password | null | MEDIUM
| *camel.component.stomp.useGlobalSslContext Parameters* | Enable usage of global SSL context parameters. | false | MEDIUM
|===
// kafka-connector options: END