camel-atmosphere-websocket-kafka-connector source configuration

When using camel-atmosphere-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-atmosphere-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.atmospherewebsocket.CamelAtmospherewebsocketSourceConnector

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

Name	Description	Default	Required	Priority
camel.source.path.servicePath	Name of websocket endpoint	null	true	HIGH
camel.source.endpoint.chunked	If this option is false the Servlet will disable the HTTP streaming and set the content-length header on the response	true	false	MEDIUM
camel.source.endpoint.disableStreamCache	Determines whether or not the raw input stream from Servlet is cached or not (Camel will read the stream into a in memory/overflow to file, Stream caching) cache. By default Camel will cache the Servlet input stream to support reading it multiple times to ensure it Camel can retrieve all data from the stream. However you can set this option to true when you for example need to access the raw stream, such as streaming it directly to a file or other persistent store. DefaultHttpBinding will copy the request input stream into a stream cache and put it into message body if this option is false to support reading the stream multiple times. If you use Servlet to bridge/proxy an endpoint then consider enabling this option to improve performance, in case you do not need to read the message payload multiple times. The http producer will by default cache the response body stream. If setting this option to true, then the producers will not cache the response body stream but use the response stream as-is as the message body.	false	false	MEDIUM
camel.source.endpoint.headerFilterStrategy	To use a custom HeaderFilterStrategy to filter header to and from Camel message.	null	false	MEDIUM
camel.source.endpoint.sendToAll	Whether to send to all (broadcast) or send to a single receiver.	false	false	MEDIUM
camel.source.endpoint.transferException	If enabled and an Exchange failed processing on the consumer side, and if the caused Exception was send back serialized in the response as a application/x-java-serialized-object content type. On the producer side the exception will be deserialized and thrown as is, instead of the HttpOperationFailedException. The caused exception is required to be serialized. This is by default turned off. If you enable this then be aware that Java will deserialize the incoming data from the request to Java and that can be a potential security risk.	false	false	MEDIUM
camel.source.endpoint.useStreaming	To enable streaming to send data as multiple text fragments.	false	false	MEDIUM
camel.source.endpoint.httpBinding	To use a custom HttpBinding to control the mapping between Camel message and HttpClient.	null	false	MEDIUM
camel.source.endpoint.async	Configure the consumer to work in async mode	false	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.httpMethodRestrict	Used to only allow consuming if the HttpMethod matches, such as GET/POST/PUT etc. Multiple methods can be specified separated by comma.	null	false	MEDIUM
camel.source.endpoint.matchOnUriPrefix	Whether or not the consumer should try to find a target consumer by matching the URI prefix if no exact match is found.	false	false	MEDIUM
camel.source.endpoint.muteException	If enabled and an Exchange failed processing on the consumer side the response’s body won’t contain the exception’s stack trace.	false	false	MEDIUM
camel.source.endpoint.responseBufferSize	To use a custom buffer size on the javax.servlet.ServletResponse.	null	false	MEDIUM
camel.source.endpoint.servletName	Name of the servlet to use	"CamelServlet"	false	MEDIUM
camel.source.endpoint.attachmentMultipartBinding	Whether to automatic bind multipart/form-data as attachments on the Camel Exchange. The options attachmentMultipartBinding=true and disableStreamCache=false cannot work together. Remove disableStreamCache to use AttachmentMultipartBinding. This is turn off by default as this may require servlet specific configuration to enable this when using Servlet’s.	false	false	MEDIUM
camel.source.endpoint.eagerCheckContentAvailable	Whether to eager check whether the HTTP requests has content if the content-length header is 0 or not present. This can be turned on in case HTTP clients do not send streamed data.	false	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.fileNameExtWhitelist	Whitelist of accepted filename extensions for accepting uploaded files. Multiple extensions can be separated by comma, such as txt,xml.	null	false	MEDIUM
camel.source.endpoint.optionsEnabled	Specifies whether to enable HTTP OPTIONS for this Servlet consumer. By default OPTIONS is turned off.	false	false	MEDIUM
camel.source.endpoint.traceEnabled	Specifies whether to enable HTTP TRACE for this Servlet consumer. By default TRACE is turned off.	false	false	MEDIUM
camel.source.endpoint.mapHttpMessageBody	If this option is true then IN exchange Body of the exchange will be mapped to HTTP body. Setting this to false will avoid the HTTP mapping.	true	false	MEDIUM
camel.source.endpoint.mapHttpMessageFormUrlEncoded Body	If this option is true then IN exchange Form Encoded body of the exchange will be mapped to HTTP. Setting this to false will avoid the HTTP Form Encoded body mapping.	true	false	MEDIUM
camel.source.endpoint.mapHttpMessageHeaders	If this option is true then IN exchange Headers of the exchange will be mapped to HTTP headers. Setting this to false will avoid the HTTP Headers mapping.	true	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.component.atmosphere-websocket.bridgeError 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	false	MEDIUM
camel.component.atmosphere-websocket.servletName	Default name of servlet to use. The default name is CamelServlet.	"CamelServlet"	false	MEDIUM
camel.component.atmosphere-websocket.attachment MultipartBinding	Whether to automatic bind multipart/form-data as attachments on the Camel Exchange. The options attachmentMultipartBinding=true and disableStreamCache=false cannot work together. Remove disableStreamCache to use AttachmentMultipartBinding. This is turn off by default as this may require servlet specific configuration to enable this when using Servlet’s.	false	false	MEDIUM
camel.component.atmosphere-websocket.fileNameExt Whitelist	Whitelist of accepted filename extensions for accepting uploaded files. Multiple extensions can be separated by comma, such as txt,xml.	null	false	MEDIUM
camel.component.atmosphere-websocket.httpRegistry	To use a custom org.apache.camel.component.servlet.HttpRegistry.	null	false	MEDIUM
camel.component.atmosphere-websocket.allowJava SerializedObject	Whether to allow java serialization when a request uses context-type=application/x-java-serialized-object. This is by default turned off. If you enable this then be aware that Java will deserialize the incoming data from the request to Java and that can be a potential security risk.	false	false	MEDIUM
camel.component.atmosphere-websocket.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	false	MEDIUM
camel.component.atmosphere-websocket.httpBinding	To use a custom HttpBinding to control the mapping between Camel message and HttpClient.	null	false	MEDIUM
camel.component.atmosphere-websocket.http Configuration	To use the shared HttpConfiguration as base configuration.	null	false	MEDIUM
camel.component.atmosphere-websocket.headerFilter Strategy	To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message.	null	false	MEDIUM

Name

Description

Default

Required

Priority

camel.source.path.servicePath

Name of websocket endpoint

null

true

HIGH

camel.source.endpoint.chunked

If this option is false the Servlet will disable the HTTP streaming and set the content-length header on the response

true

false

MEDIUM

camel.source.endpoint.disableStreamCache

Determines whether or not the raw input stream from Servlet is cached or not (Camel will read the stream into a in memory/overflow to file, Stream caching) cache. By default Camel will cache the Servlet input stream to support reading it multiple times to ensure it Camel can retrieve all data from the stream. However you can set this option to true when you for example need to access the raw stream, such as streaming it directly to a file or other persistent store. DefaultHttpBinding will copy the request input stream into a stream cache and put it into message body if this option is false to support reading the stream multiple times. If you use Servlet to bridge/proxy an endpoint then consider enabling this option to improve performance, in case you do not need to read the message payload multiple times. The http producer will by default cache the response body stream. If setting this option to true, then the producers will not cache the response body stream but use the response stream as-is as the message body.

false

MEDIUM

camel.source.endpoint.headerFilterStrategy

To use a custom HeaderFilterStrategy to filter header to and from Camel message.

null

false

MEDIUM

camel.source.endpoint.sendToAll

Whether to send to all (broadcast) or send to a single receiver.

false

MEDIUM

camel.source.endpoint.transferException

If enabled and an Exchange failed processing on the consumer side, and if the caused Exception was send back serialized in the response as a application/x-java-serialized-object content type. On the producer side the exception will be deserialized and thrown as is, instead of the HttpOperationFailedException. The caused exception is required to be serialized. This is by default turned off. If you enable this then be aware that Java will deserialize the incoming data from the request to Java and that can be a potential security risk.

false

MEDIUM

camel.source.endpoint.useStreaming

To enable streaming to send data as multiple text fragments.

false

MEDIUM

camel.source.endpoint.httpBinding

To use a custom HttpBinding to control the mapping between Camel message and HttpClient.

null

false

MEDIUM

camel.source.endpoint.async

Configure the consumer to work in async mode

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

Used to only allow consuming if the HttpMethod matches, such as GET/POST/PUT etc. Multiple methods can be specified separated by comma.

null

false

MEDIUM

camel.source.endpoint.matchOnUriPrefix

Whether or not the consumer should try to find a target consumer by matching the URI prefix if no exact match is found.

false

MEDIUM

camel.source.endpoint.muteException

If enabled and an Exchange failed processing on the consumer side the response’s body won’t contain the exception’s stack trace.

false

MEDIUM

camel.source.endpoint.responseBufferSize

To use a custom buffer size on the javax.servlet.ServletResponse.

null

false

MEDIUM

camel.source.endpoint.servletName

Name of the servlet to use

"CamelServlet"

false

MEDIUM

camel.source.endpoint.attachmentMultipartBinding

Whether to automatic bind multipart/form-data as attachments on the Camel Exchange. The options attachmentMultipartBinding=true and disableStreamCache=false cannot work together. Remove disableStreamCache to use AttachmentMultipartBinding. This is turn off by default as this may require servlet specific configuration to enable this when using Servlet’s.

false

MEDIUM

camel.source.endpoint.eagerCheckContentAvailable

Whether to eager check whether the HTTP requests has content if the content-length header is 0 or not present. This can be turned on in case HTTP clients do not send streamed data.

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

Whitelist of accepted filename extensions for accepting uploaded files. Multiple extensions can be separated by comma, such as txt,xml.

null

false

MEDIUM

camel.source.endpoint.optionsEnabled

Specifies whether to enable HTTP OPTIONS for this Servlet consumer. By default OPTIONS is turned off.

false

MEDIUM

camel.source.endpoint.traceEnabled

Specifies whether to enable HTTP TRACE for this Servlet consumer. By default TRACE is turned off.

false

MEDIUM

camel.source.endpoint.mapHttpMessageBody

If this option is true then IN exchange Body of the exchange will be mapped to HTTP body. Setting this to false will avoid the HTTP mapping.

true

false

MEDIUM

camel.source.endpoint.mapHttpMessageFormUrlEncoded Body

If this option is true then IN exchange Form Encoded body of the exchange will be mapped to HTTP. Setting this to false will avoid the HTTP Form Encoded body mapping.

true

false

MEDIUM

camel.source.endpoint.mapHttpMessageHeaders

If this option is true then IN exchange Headers of the exchange will be mapped to HTTP headers. Setting this to false will avoid the HTTP Headers mapping.

true

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.component.atmosphere-websocket.bridgeError Handler

false

MEDIUM

camel.component.atmosphere-websocket.servletName

Default name of servlet to use. The default name is CamelServlet.

"CamelServlet"

false

MEDIUM

camel.component.atmosphere-websocket.attachment MultipartBinding

false

MEDIUM

camel.component.atmosphere-websocket.fileNameExt Whitelist

Whitelist of accepted filename extensions for accepting uploaded files. Multiple extensions can be separated by comma, such as txt,xml.

null

false

MEDIUM

camel.component.atmosphere-websocket.httpRegistry

To use a custom org.apache.camel.component.servlet.HttpRegistry.

null

false

MEDIUM

camel.component.atmosphere-websocket.allowJava SerializedObject

Whether to allow java serialization when a request uses context-type=application/x-java-serialized-object. This is by default turned off. If you enable this then be aware that Java will deserialize the incoming data from the request to Java and that can be a potential security risk.

false

MEDIUM

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

false

MEDIUM

camel.component.atmosphere-websocket.httpBinding

To use a custom HttpBinding to control the mapping between Camel message and HttpClient.

null

false

MEDIUM

camel.component.atmosphere-websocket.http Configuration

To use the shared HttpConfiguration as base configuration.

null

false

MEDIUM

camel.component.atmosphere-websocket.headerFilter Strategy

To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message.

null

false

MEDIUM

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

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

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