camel-cometd-kafka-connector sink configuration

When using camel-cometd-kafka-connector as sink make sure to use the following Maven dependency to have support for the connector:

<dependency>
  <groupId>org.apache.camel.kafkaconnector</groupId>
  <artifactId>camel-cometd-kafka-connector</artifactId>
  <version>x.x.x</version>
  <!-- use the same version as your Camel Kafka connector version -->
</dependency>

To use this Sink connector in Kafka connect you’ll need to set the following connector.class

connector.class=org.apache.camel.kafkaconnector.cometd.CamelCometdSinkConnector

The camel-cometd sink connector supports 25 options, which are listed below.

Name	Description	Default	Required	Priority
camel.sink.path.host	Hostname	null	true	HIGH
camel.sink.path.port	Host port number	null	true	HIGH
camel.sink.path.channelName	The channelName represents a topic that can be subscribed to by the Camel endpoints.	null	true	HIGH
camel.sink.endpoint.allowedOrigins	The origins domain that support to cross, if the crosssOriginFilterOn is true	"*"	false	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	false	MEDIUM
camel.sink.endpoint.crossOriginFilterOn	If true, the server will support for cross-domain filtering	false	false	MEDIUM
camel.sink.endpoint.filterPath	The filterPath will be used by the CrossOriginFilter, if the crosssOriginFilterOn is true	null	false	MEDIUM
camel.sink.endpoint.interval	The client side poll timeout in milliseconds. How long a client will wait between reconnects	null	false	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	false	MEDIUM
camel.sink.endpoint.logLevel	Logging level. 0=none, 1=info, 2=debug. One of: [0] [1] [2]	1	false	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	false	MEDIUM
camel.sink.endpoint.multiFrameInterval	The client side poll timeout, if multiple connections are detected from the same browser.	1500	false	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	false	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	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	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	false	MEDIUM
camel.component.cometd.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	false	MEDIUM
camel.component.cometd.autowiredEnabled	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	false	MEDIUM
camel.component.cometd.extensions	To use a list of custom BayeuxServer.Extension that allows modifying incoming and outgoing requests.	null	false	MEDIUM
camel.component.cometd.securityPolicy	To use a custom configured SecurityPolicy to control authorization	null	false	MEDIUM
camel.component.cometd.sslContextParameters	To configure security using SSLContextParameters	null	false	MEDIUM
camel.component.cometd.sslKeyPassword	The password for the keystore when using SSL.	null	false	MEDIUM
camel.component.cometd.sslKeystore	The path to the keystore.	null	false	MEDIUM
camel.component.cometd.sslPassword	The password when using SSL.	null	false	MEDIUM
camel.component.cometd.useGlobalSslContext Parameters	Enable usage of global SSL context parameters.	false	false	MEDIUM

Name

Description

Default

Required

Priority

camel.sink.path.host

Hostname

null

true

HIGH

camel.sink.path.port

Host port number

null

true

HIGH

camel.sink.path.channelName

The channelName represents a topic that can be subscribed to by the Camel endpoints.

null

true

HIGH

camel.sink.endpoint.allowedOrigins

The origins domain that support to cross, if the crosssOriginFilterOn is true

"*"

false

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

false

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

false

MEDIUM

camel.sink.endpoint.interval

The client side poll timeout in milliseconds. How long a client will wait between reconnects

null

false

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

false

MEDIUM

camel.sink.endpoint.logLevel

Logging level. 0=none, 1=info, 2=debug. One of: [0] [1] [2]

false

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

false

MEDIUM

camel.sink.endpoint.multiFrameInterval

The client side poll timeout, if multiple connections are detected from the same browser.

1500

false

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

false

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.synchronous

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

false

MEDIUM

camel.component.cometd.lazyStartProducer

false

MEDIUM

camel.component.cometd.autowiredEnabled

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

false

MEDIUM

camel.component.cometd.extensions

To use a list of custom BayeuxServer.Extension that allows modifying incoming and outgoing requests.

null

false

MEDIUM

camel.component.cometd.securityPolicy

To use a custom configured SecurityPolicy to control authorization

null

false

MEDIUM

camel.component.cometd.sslContextParameters

To configure security using SSLContextParameters

null

false

MEDIUM

camel.component.cometd.sslKeyPassword

The password for the keystore when using SSL.

null

false

MEDIUM

camel.component.cometd.sslKeystore

The path to the keystore.

null

false

MEDIUM

camel.component.cometd.sslPassword

The password when using SSL.

null

false

MEDIUM

camel.component.cometd.useGlobalSslContext Parameters

Enable usage of global SSL context parameters.

false

MEDIUM

The camel-cometd sink connector has no converters out of the box.

The camel-cometd sink connector has no transforms out of the box.

The camel-cometd sink connector has no aggregation strategies out of the box.