camel-undertow-kafka-connector source configuration

When using camel-undertow-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-undertow-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.undertow.CamelUndertowSourceConnector

The camel-undertow source connector supports 31 options, which are listed below.

Name	Description	Default	Priority
camel.source.path.httpURI	The url of the HTTP endpoint to use.	null	HIGH
camel.source.endpoint.useStreaming	For HTTP endpoint: if true, text and binary messages will be wrapped as java.io.InputStream before they are passed to an Exchange; otherwise they will be passed as byte. For WebSocket endpoint: if true, text and binary messages will be wrapped as java.io.Reader and java.io.InputStream respectively before they are passed to an Exchange; otherwise they will be passed as String and byte respectively.	false	MEDIUM
camel.source.endpoint.accessLog	Whether or not the consumer should write access log	"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	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.optionsEnabled	Specifies whether to enable HTTP OPTIONS for this Servlet consumer. By default OPTIONS is turned off.	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.handlers	Specifies a comma-delimited set of io.undertow.server.HttpHandler instances to lookup in your Registry. These handlers are added to the Undertow handler chain (for example, to add security). Important: You can not use different handlers with different Undertow endpoints using the same port number. The handlers is associated to the port number. If you need different handlers, then use different port numbers.	null	MEDIUM
camel.source.endpoint.accessLogReceiver	Which Undertow AccessLogReciever should be used Will use JBossLoggingAccessLogReceiver if not specifid	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.undertowHttpBinding	To use a custom UndertowHttpBinding to control the mapping between Camel message and undertow.	null	MEDIUM
camel.source.endpoint.allowedRoles	Configuration used by UndertowSecurityProvider. Comma separated list of allowed roles.	null	MEDIUM
camel.source.endpoint.securityConfiguration	OConfiguration used by UndertowSecurityProvider. Security configuration object for use from UndertowSecurityProvider. Configuration is UndertowSecurityProvider specific. Each provider decides whether accepts configuration.	null	MEDIUM
camel.source.endpoint.securityProvider	Security provider allows plug in the provider, which will be used to secure requests. SPI approach could be used too (endpoint then finds security provider using SPI).	null	MEDIUM
camel.source.endpoint.sslContextParameters	To configure security using SSLContextParameters	null	MEDIUM
camel.source.endpoint.fireWebSocketChannelEvents	if true, the consumer will post notifications to the route when a new WebSocket peer connects, disconnects, etc. See UndertowConstants.EVENT_TYPE and EventType.	false	MEDIUM
camel.component.undertow.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.undertow.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.component.undertow.basicPropertyBinding	Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities	false	MEDIUM
camel.component.undertow.hostOptions	To configure common options, such as thread pools	null	MEDIUM
camel.component.undertow.undertowHttpBinding	To use a custom HttpBinding to control the mapping between Camel message and HttpClient.	null	MEDIUM
camel.component.undertow.allowedRoles	Configuration used by UndertowSecurityProvider. Comma separated list of allowed roles.	null	MEDIUM
camel.component.undertow.securityConfiguration	Configuration used by UndertowSecurityProvider. Security configuration object for use from UndertowSecurityProvider. Configuration is UndertowSecurityProvider specific. Each provider decides, whether it accepts configuration.	null	MEDIUM
camel.component.undertow.securityProvider	Security provider allows plug in the provider, which will be used to secure requests. SPI approach could be used too (component then finds security provider using SPI).	null	MEDIUM
camel.component.undertow.sslContextParameters	To configure security using SSLContextParameters	null	MEDIUM
camel.component.undertow.useGlobalSslContext Parameters	Enable usage of global SSL context parameters.	false	MEDIUM

Name

Description

Default

Priority

camel.source.path.httpURI

The url of the HTTP endpoint to use.

null

HIGH

camel.source.endpoint.useStreaming

For HTTP endpoint: if true, text and binary messages will be wrapped as java.io.InputStream before they are passed to an Exchange; otherwise they will be passed as byte. For WebSocket endpoint: if true, text and binary messages will be wrapped as java.io.Reader and java.io.InputStream respectively before they are passed to an Exchange; otherwise they will be passed as String and byte respectively.

false

MEDIUM

camel.source.endpoint.accessLog

Whether or not the consumer should write access log

"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

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

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

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

Specifies a comma-delimited set of io.undertow.server.HttpHandler instances to lookup in your Registry. These handlers are added to the Undertow handler chain (for example, to add security). Important: You can not use different handlers with different Undertow endpoints using the same port number. The handlers is associated to the port number. If you need different handlers, then use different port numbers.

null

MEDIUM

camel.source.endpoint.accessLogReceiver

Which Undertow AccessLogReciever should be used Will use JBossLoggingAccessLogReceiver if not specifid

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

To use a custom UndertowHttpBinding to control the mapping between Camel message and undertow.

null

MEDIUM

camel.source.endpoint.allowedRoles

Configuration used by UndertowSecurityProvider. Comma separated list of allowed roles.

null

MEDIUM

camel.source.endpoint.securityConfiguration

OConfiguration used by UndertowSecurityProvider. Security configuration object for use from UndertowSecurityProvider. Configuration is UndertowSecurityProvider specific. Each provider decides whether accepts configuration.

null

MEDIUM

camel.source.endpoint.securityProvider

Security provider allows plug in the provider, which will be used to secure requests. SPI approach could be used too (endpoint then finds security provider using SPI).

null

MEDIUM

camel.source.endpoint.sslContextParameters

To configure security using SSLContextParameters

null

MEDIUM

camel.source.endpoint.fireWebSocketChannelEvents

if true, the consumer will post notifications to the route when a new WebSocket peer connects, disconnects, etc. See UndertowConstants.EVENT_TYPE and EventType.

false

MEDIUM

camel.component.undertow.bridgeErrorHandler

false

MEDIUM

camel.component.undertow.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.component.undertow.basicPropertyBinding

Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities

false

MEDIUM

camel.component.undertow.hostOptions

To configure common options, such as thread pools

null

MEDIUM

camel.component.undertow.undertowHttpBinding

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

null

MEDIUM

camel.component.undertow.allowedRoles

Configuration used by UndertowSecurityProvider. Comma separated list of allowed roles.

null

MEDIUM

camel.component.undertow.securityConfiguration

Configuration used by UndertowSecurityProvider. Security configuration object for use from UndertowSecurityProvider. Configuration is UndertowSecurityProvider specific. Each provider decides, whether it accepts configuration.

null

MEDIUM

camel.component.undertow.securityProvider

Security provider allows plug in the provider, which will be used to secure requests. SPI approach could be used too (component then finds security provider using SPI).

null

MEDIUM

camel.component.undertow.sslContextParameters

To configure security using SSLContextParameters

null

MEDIUM

camel.component.undertow.useGlobalSslContext Parameters

Enable usage of global SSL context parameters.

false

MEDIUM