camel-websocket-kafka-connector source configuration

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

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

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

connector.class=org.apache.camel.kafkaconnector.websocket.CamelWebsocketSourceConnector

The camel-websocket source connector supports 33 options, which are listed below.

Name	Description	Default	Required	Priority
camel.source.path.host	The hostname. The default value is 0.0.0.0. Setting this option on the component will use the component configured value as default.	"0.0.0.0"	false	MEDIUM
camel.source.path.port	The port number. The default value is 9292. Setting this option on the component will use the component configured value as default.	"9292"	false	MEDIUM
camel.source.path.resourceUri	Name of the websocket channel to use	null	true	HIGH
camel.source.endpoint.maxBinaryMessageSize	Can be used to set the size in bytes that the websocket created by the websocketServlet may be accept before closing. (Default is -1 - or unlimited)	"-1"	false	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	false	MEDIUM
camel.source.endpoint.sessionSupport	Whether to enable session support which enables HttpSession for each http request.	false	false	MEDIUM
camel.source.endpoint.staticResources	Set a resource path for static resources (such as .html files etc). The resources can be loaded from classpath, if you prefix with classpath:, otherwise the resources is loaded from file system or from JAR files. For example to load from root classpath use classpath:., or classpath:WEB-INF/static If not configured (eg null) then no static resource is in use.	null	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	false	MEDIUM
camel.source.endpoint.exchangePattern	Sets the exchange pattern when the consumer creates an exchange. One of: [InOnly] [InOut] [InOptionalOut]	null	false	MEDIUM
camel.source.endpoint.bufferSize	Set the buffer size of the websocketServlet, which is also the max frame byte size (default 8192)	"8192"	false	MEDIUM
camel.source.endpoint.maxIdleTime	Set the time in ms that the websocket created by the websocketServlet may be idle before closing. (default is 300000)	"300000"	false	MEDIUM
camel.source.endpoint.maxTextMessageSize	Can be used to set the size in characters that the websocket created by the websocketServlet may be accept before closing.	null	false	MEDIUM
camel.source.endpoint.minVersion	Can be used to set the minimum protocol version accepted for the websocketServlet. (Default 13 - the RFC6455 version)	"13"	false	MEDIUM
camel.source.endpoint.synchronous	Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).	false	false	MEDIUM
camel.source.endpoint.allowedOrigins	The CORS allowed origins. Use to allow all.	null	false	MEDIUM
camel.source.endpoint.crossOriginFilterOn	Whether to enable CORS	false	false	MEDIUM
camel.source.endpoint.filterPath	Context path for filtering CORS	null	false	MEDIUM
camel.source.endpoint.enableJmx	If this option is true, Jetty JMX support will be enabled for this endpoint. See Jetty JMX support for more details.	false	false	MEDIUM
camel.source.endpoint.sslContextParameters	To configure security using SSLContextParameters	null	false	MEDIUM
camel.component.websocket.host	The hostname. The default value is 0.0.0.0	"0.0.0.0"	false	MEDIUM
camel.component.websocket.port	The port number. The default value is 9292	"9292"	false	MEDIUM
camel.component.websocket.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	false	MEDIUM
camel.component.websocket.staticResources	Set a resource path for static resources (such as .html files etc). The resources can be loaded from classpath, if you prefix with classpath:, otherwise the resources is loaded from file system or from JAR files. For example to load from root classpath use classpath:., or classpath:WEB-INF/static If not configured (eg null) then no static resource is in use.	null	false	MEDIUM
camel.component.websocket.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.websocket.enableJmx	If this option is true, Jetty JMX support will be enabled for this endpoint. See Jetty JMX support for more details.	false	false	MEDIUM
camel.component.websocket.maxThreads	To set a value for maximum number of threads in server thread pool. MaxThreads/minThreads or threadPool fields are required due to switch to Jetty9. The default values for maxThreads is 1 2 noCores.	null	false	MEDIUM
camel.component.websocket.minThreads	To set a value for minimum number of threads in server thread pool. MaxThreads/minThreads or threadPool fields are required due to switch to Jetty9. The default values for minThreads is 1.	null	false	MEDIUM
camel.component.websocket.threadPool	To use a custom thread pool for the server. MaxThreads/minThreads or threadPool fields are required due to switch to Jetty9.	null	false	MEDIUM
camel.component.websocket.sslContextParameters	To configure security using SSLContextParameters	null	false	MEDIUM
camel.component.websocket.sslKeyPassword	The password for the keystore when using SSL.	null	false	MEDIUM
camel.component.websocket.sslKeystore	The path to the keystore.	null	false	MEDIUM
camel.component.websocket.sslPassword	The password when using SSL.	null	false	MEDIUM
camel.component.websocket.useGlobalSslContext Parameters	Enable usage of global SSL context parameters.	false	false	MEDIUM

Name

Description

Default

Required

Priority

camel.source.path.host

The hostname. The default value is 0.0.0.0. Setting this option on the component will use the component configured value as default.

"0.0.0.0"

false

MEDIUM

camel.source.path.port

The port number. The default value is 9292. Setting this option on the component will use the component configured value as default.

"9292"

false

MEDIUM

camel.source.path.resourceUri

Name of the websocket channel to use

null

true

HIGH

camel.source.endpoint.maxBinaryMessageSize

Can be used to set the size in bytes that the websocket created by the websocketServlet may be accept before closing. (Default is -1 - or unlimited)

"-1"

false

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

Whether to enable session support which enables HttpSession for each http request.

false

MEDIUM

camel.source.endpoint.staticResources

Set a resource path for static resources (such as .html files etc). The resources can be loaded from classpath, if you prefix with classpath:, otherwise the resources is loaded from file system or from JAR files. For example to load from root classpath use classpath:., or classpath:WEB-INF/static If not configured (eg null) then no static resource is in use.

null

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

false

MEDIUM

camel.source.endpoint.exchangePattern

Sets the exchange pattern when the consumer creates an exchange. One of: [InOnly] [InOut] [InOptionalOut]

null

false

MEDIUM

camel.source.endpoint.bufferSize

Set the buffer size of the websocketServlet, which is also the max frame byte size (default 8192)

"8192"

false

MEDIUM

camel.source.endpoint.maxIdleTime

Set the time in ms that the websocket created by the websocketServlet may be idle before closing. (default is 300000)

"300000"

false

MEDIUM

camel.source.endpoint.maxTextMessageSize

Can be used to set the size in characters that the websocket created by the websocketServlet may be accept before closing.

null

false

MEDIUM

camel.source.endpoint.minVersion

Can be used to set the minimum protocol version accepted for the websocketServlet. (Default 13 - the RFC6455 version)

"13"

false

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

The CORS allowed origins. Use to allow all.

null

false

MEDIUM

camel.source.endpoint.crossOriginFilterOn

Whether to enable CORS

false

MEDIUM

camel.source.endpoint.filterPath

Context path for filtering CORS

null

false

MEDIUM

camel.source.endpoint.enableJmx

If this option is true, Jetty JMX support will be enabled for this endpoint. See Jetty JMX support for more details.

false

MEDIUM

camel.source.endpoint.sslContextParameters

To configure security using SSLContextParameters

null

false

MEDIUM

camel.component.websocket.host

The hostname. The default value is 0.0.0.0

"0.0.0.0"

false

MEDIUM

camel.component.websocket.port

The port number. The default value is 9292

"9292"

false

MEDIUM

camel.component.websocket.bridgeErrorHandler

false

MEDIUM

camel.component.websocket.staticResources

null

false

MEDIUM

camel.component.websocket.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.websocket.enableJmx

If this option is true, Jetty JMX support will be enabled for this endpoint. See Jetty JMX support for more details.

false

MEDIUM

camel.component.websocket.maxThreads

To set a value for maximum number of threads in server thread pool. MaxThreads/minThreads or threadPool fields are required due to switch to Jetty9. The default values for maxThreads is 1 2 noCores.

null

false

MEDIUM

camel.component.websocket.minThreads

To set a value for minimum number of threads in server thread pool. MaxThreads/minThreads or threadPool fields are required due to switch to Jetty9. The default values for minThreads is 1.

null

false

MEDIUM

camel.component.websocket.threadPool

To use a custom thread pool for the server. MaxThreads/minThreads or threadPool fields are required due to switch to Jetty9.

null

false

MEDIUM

camel.component.websocket.sslContextParameters

To configure security using SSLContextParameters

null

false

MEDIUM

camel.component.websocket.sslKeyPassword

The password for the keystore when using SSL.

null

false

MEDIUM

camel.component.websocket.sslKeystore

The path to the keystore.

null

false

MEDIUM

camel.component.websocket.sslPassword

The password when using SSL.

null

false

MEDIUM

camel.component.websocket.useGlobalSslContext Parameters

Enable usage of global SSL context parameters.

false

MEDIUM

The camel-websocket source connector has no converters out of the box.

The camel-websocket source connector has no transforms out of the box.

The camel-websocket source connector has no aggregation strategies out of the box.