| // kafka-connector options: START |
| [[camel-cometds-kafka-connector-sink]] |
| = camel-cometds-kafka-connector sink configuration |
| |
| When using camel-cometds-kafka-connector as sink 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-cometds-kafka-connector</artifactId> |
| <version>x.x.x</version> |
| <!-- use the same version as your Camel Kafka connector version --> |
| </dependency> |
| ---- |
| |
| |
| The camel-cometds sink connector supports 26 options, which are listed below. |
| |
| |
| |
| [width="100%",cols="2,5,^1,2",options="header"] |
| |=== |
| | Name | Description | Default | Priority |
| | *camel.sink.path.host* | Hostname | null | HIGH |
| | *camel.sink.path.port* | Host port number | null | HIGH |
| | *camel.sink.path.channelName* | The channelName represents a topic that can be subscribed to by the Camel endpoints. | null | HIGH |
| | *camel.sink.endpoint.allowedOrigins* | The origins domain that support to cross, if the crosssOriginFilterOn is true | "*" | MEDIUM |
| | *camel.sink.endpoint.baseResource* | The root directory for the web resources or classpath. Use the protocol file: or classpath: depending if you want that the component loads the resource from file system or classpath. Classpath is required for OSGI deployment where the resources are packaged in the jar | null | MEDIUM |
| | *camel.sink.endpoint.crossOriginFilterOn* | If true, the server will support for cross-domain filtering | false | MEDIUM |
| | *camel.sink.endpoint.filterPath* | The filterPath will be used by the CrossOriginFilter, if the crosssOriginFilterOn is true | null | MEDIUM |
| | *camel.sink.endpoint.interval* | The client side poll timeout in milliseconds. How long a client will wait between reconnects | null | MEDIUM |
| | *camel.sink.endpoint.jsonCommented* | If true, the server will accept JSON wrapped in a comment and will generate JSON wrapped in a comment. This is a defence against Ajax Hijacking. | true | MEDIUM |
| | *camel.sink.endpoint.logLevel* | Logging level. 0=none, 1=info, 2=debug. One of: [0] [1] [2] | 1 | MEDIUM |
| | *camel.sink.endpoint.maxInterval* | The max client side poll timeout in milliseconds. A client will be removed if a connection is not received in this time. | 30000 | MEDIUM |
| | *camel.sink.endpoint.multiFrameInterval* | The client side poll timeout, if multiple connections are detected from the same browser. | 1500 | MEDIUM |
| | *camel.sink.endpoint.timeout* | The server side poll timeout in milliseconds. This is how long the server will hold a reconnect request before responding. | 240000 | MEDIUM |
| | *camel.sink.endpoint.disconnectLocalSession* | Whether to disconnect local sessions after publishing a message to its channel. Disconnecting local session is needed as they are not swept by default by CometD, and therefore you can run out of memory. | false | MEDIUM |
| | *camel.sink.endpoint.lazyStartProducer* | 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 | MEDIUM |
| | *camel.sink.endpoint.basicPropertyBinding* | Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | MEDIUM |
| | *camel.sink.endpoint.synchronous* | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | MEDIUM |
| | *camel.component.cometds.extensions* | To use a list of custom BayeuxServer.Extension that allows modifying incoming and outgoing requests. | null | MEDIUM |
| | *camel.component.cometds.lazyStartProducer* | 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 | MEDIUM |
| | *camel.component.cometds.basicPropertyBinding* | Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | MEDIUM |
| | *camel.component.cometds.securityPolicy* | To use a custom configured SecurityPolicy to control authorization | null | MEDIUM |
| | *camel.component.cometds.sslContextParameters* | To configure security using SSLContextParameters | null | MEDIUM |
| | *camel.component.cometds.sslKeyPassword* | The password for the keystore when using SSL. | null | MEDIUM |
| | *camel.component.cometds.sslKeystore* | The path to the keystore. | null | MEDIUM |
| | *camel.component.cometds.sslPassword* | The password when using SSL. | null | MEDIUM |
| | *camel.component.cometds.useGlobalSslContext Parameters* | Enable usage of global SSL context parameters. | false | MEDIUM |
| |=== |
| // kafka-connector options: END |
