camel-olingo2-kafka-connector source configuration

When using camel-olingo2-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-olingo2-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.olingo2.CamelOlingo2SourceConnector

The camel-olingo2 source connector supports 54 options, which are listed below.

Name	Description	Default	Required	Priority
camel.source.path.apiName	What kind of operation to perform One of: [DEFAULT]	null	true	HIGH
camel.source.path.methodName	What sub operation to use for the selected operation	null	true	HIGH
camel.source.endpoint.connectTimeout	HTTP connection creation timeout in milliseconds, defaults to 30,000 (30 seconds)	30000	false	MEDIUM
camel.source.endpoint.contentType	Content-Type header value can be used to specify JSON or XML message format, defaults to application/json;charset=utf-8	"application/json;charset=utf-8"	false	MEDIUM
camel.source.endpoint.entityProviderReadProperties	Custom entity provider read properties applied to all read operations.	null	false	MEDIUM
camel.source.endpoint.entityProviderWrite Properties	Custom entity provider write properties applied to create, update, patch, batch and merge operations. For instance users can skip the Json object wrapper or enable content only mode when sending request data. A service URI set in the properties will always be overwritten by the serviceUri configuration parameter. Please consider to using the serviceUri configuration parameter instead of setting the respective write property here.	null	false	MEDIUM
camel.source.endpoint.filterAlreadySeen	Set this to true to filter out results that have already been communicated by this component.	false	false	MEDIUM
camel.source.endpoint.httpHeaders	Custom HTTP headers to inject into every request, this could include OAuth tokens, etc.	null	false	MEDIUM
camel.source.endpoint.inBody	Sets the name of a parameter to be passed in the exchange In Body	null	false	MEDIUM
camel.source.endpoint.proxy	HTTP proxy server configuration	null	false	MEDIUM
camel.source.endpoint.serviceUri	Target OData service base URI, e.g. http://services.odata.org/OData/OData.svc	null	false	MEDIUM
camel.source.endpoint.socketTimeout	HTTP request timeout in milliseconds, defaults to 30,000 (30 seconds)	30000	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.sendEmptyMessageWhenIdle	If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead.	false	false	MEDIUM
camel.source.endpoint.splitResult	For endpoints that return an array or collection, a consumer endpoint will map every element to distinct messages, unless splitResult is set to false.	true	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.pollStrategy	A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel.	null	false	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	false	MEDIUM
camel.source.endpoint.httpAsyncClientBuilder	Custom HTTP async client builder for more complex HTTP client configuration, overrides connectionTimeout, socketTimeout, proxy and sslContext. Note that a socketTimeout MUST be specified in the builder, otherwise OData requests could block indefinitely	null	false	MEDIUM
camel.source.endpoint.httpClientBuilder	Custom HTTP client builder for more complex HTTP client configuration, overrides connectionTimeout, socketTimeout, proxy and sslContext. Note that a socketTimeout MUST be specified in the builder, otherwise OData requests could block indefinitely	null	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.backoffErrorThreshold	The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.	null	false	MEDIUM
camel.source.endpoint.backoffIdleThreshold	The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.	null	false	MEDIUM
camel.source.endpoint.backoffMultiplier	To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured.	null	false	MEDIUM
camel.source.endpoint.delay	Milliseconds before the next poll.	500L	false	MEDIUM
camel.source.endpoint.greedy	If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.	false	false	MEDIUM
camel.source.endpoint.initialDelay	Milliseconds before the first poll starts.	1000L	false	MEDIUM
camel.source.endpoint.repeatCount	Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever.	0L	false	MEDIUM
camel.source.endpoint.runLoggingLevel	The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. One of: [TRACE] [DEBUG] [INFO] [WARN] [ERROR] [OFF]	"TRACE"	false	MEDIUM
camel.source.endpoint.scheduledExecutorService	Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool.	null	false	MEDIUM
camel.source.endpoint.scheduler	To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler	"none"	false	MEDIUM
camel.source.endpoint.schedulerProperties	To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.	null	false	MEDIUM
camel.source.endpoint.startScheduler	Whether the scheduler should be auto started.	true	false	MEDIUM
camel.source.endpoint.timeUnit	Time unit for initialDelay and delay options. One of: [NANOSECONDS] [MICROSECONDS] [MILLISECONDS] [SECONDS] [MINUTES] [HOURS] [DAYS]	"MILLISECONDS"	false	MEDIUM
camel.source.endpoint.useFixedDelay	Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details.	true	false	MEDIUM
camel.source.endpoint.sslContextParameters	To configure security using SSLContextParameters	null	false	MEDIUM
camel.component.olingo2.configuration	To use the shared configuration	null	false	MEDIUM
camel.component.olingo2.connectTimeout	HTTP connection creation timeout in milliseconds, defaults to 30,000 (30 seconds)	30000	false	MEDIUM
camel.component.olingo2.contentType	Content-Type header value can be used to specify JSON or XML message format, defaults to application/json;charset=utf-8	"application/json;charset=utf-8"	false	MEDIUM
camel.component.olingo2.entityProviderRead Properties	Custom entity provider read properties applied to all read operations.	null	false	MEDIUM
camel.component.olingo2.entityProviderWrite Properties	Custom entity provider write properties applied to create, update, patch, batch and merge operations. For instance users can skip the Json object wrapper or enable content only mode when sending request data. A service URI set in the properties will always be overwritten by the serviceUri configuration parameter. Please consider to using the serviceUri configuration parameter instead of setting the respective write property here.	null	false	MEDIUM
camel.component.olingo2.filterAlreadySeen	Set this to true to filter out results that have already been communicated by this component.	false	false	MEDIUM
camel.component.olingo2.httpHeaders	Custom HTTP headers to inject into every request, this could include OAuth tokens, etc.	null	false	MEDIUM
camel.component.olingo2.proxy	HTTP proxy server configuration	null	false	MEDIUM
camel.component.olingo2.serviceUri	Target OData service base URI, e.g. http://services.odata.org/OData/OData.svc	null	false	MEDIUM
camel.component.olingo2.socketTimeout	HTTP request timeout in milliseconds, defaults to 30,000 (30 seconds)	30000	false	MEDIUM
camel.component.olingo2.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.olingo2.splitResult	For endpoints that return an array or collection, a consumer endpoint will map every element to distinct messages, unless splitResult is set to false.	true	false	MEDIUM
camel.component.olingo2.basicPropertyBinding	Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities	false	false	LOW
camel.component.olingo2.httpAsyncClientBuilder	Custom HTTP async client builder for more complex HTTP client configuration, overrides connectionTimeout, socketTimeout, proxy and sslContext. Note that a socketTimeout MUST be specified in the builder, otherwise OData requests could block indefinitely	null	false	MEDIUM
camel.component.olingo2.httpClientBuilder	Custom HTTP client builder for more complex HTTP client configuration, overrides connectionTimeout, socketTimeout, proxy and sslContext. Note that a socketTimeout MUST be specified in the builder, otherwise OData requests could block indefinitely	null	false	MEDIUM
camel.component.olingo2.sslContextParameters	To configure security using SSLContextParameters	null	false	MEDIUM
camel.component.olingo2.useGlobalSslContext Parameters	Enable usage of global SSL context parameters.	false	false	MEDIUM

Name

Description

Default

Required

Priority

camel.source.path.apiName

What kind of operation to perform One of: [DEFAULT]

null

true

HIGH

camel.source.path.methodName

What sub operation to use for the selected operation

null

true

HIGH

camel.source.endpoint.connectTimeout

HTTP connection creation timeout in milliseconds, defaults to 30,000 (30 seconds)

30000

false

MEDIUM

camel.source.endpoint.contentType

Content-Type header value can be used to specify JSON or XML message format, defaults to application/json;charset=utf-8

"application/json;charset=utf-8"

false

MEDIUM

camel.source.endpoint.entityProviderReadProperties

Custom entity provider read properties applied to all read operations.

null

false

MEDIUM

camel.source.endpoint.entityProviderWrite Properties

Custom entity provider write properties applied to create, update, patch, batch and merge operations. For instance users can skip the Json object wrapper or enable content only mode when sending request data. A service URI set in the properties will always be overwritten by the serviceUri configuration parameter. Please consider to using the serviceUri configuration parameter instead of setting the respective write property here.

null

false

MEDIUM

camel.source.endpoint.filterAlreadySeen

Set this to true to filter out results that have already been communicated by this component.

false

MEDIUM

camel.source.endpoint.httpHeaders

Custom HTTP headers to inject into every request, this could include OAuth tokens, etc.

null

false

MEDIUM

camel.source.endpoint.inBody

Sets the name of a parameter to be passed in the exchange In Body

null

false

MEDIUM

camel.source.endpoint.proxy

HTTP proxy server configuration

null

false

MEDIUM

camel.source.endpoint.serviceUri

Target OData service base URI, e.g. http://services.odata.org/OData/OData.svc

null

false

MEDIUM

camel.source.endpoint.socketTimeout

HTTP request timeout in milliseconds, defaults to 30,000 (30 seconds)

30000

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

If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead.

false

MEDIUM

camel.source.endpoint.splitResult

For endpoints that return an array or collection, a consumer endpoint will map every element to distinct messages, unless splitResult is set to false.

true

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

A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel.

null

false

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

Custom HTTP async client builder for more complex HTTP client configuration, overrides connectionTimeout, socketTimeout, proxy and sslContext. Note that a socketTimeout MUST be specified in the builder, otherwise OData requests could block indefinitely

null

false

MEDIUM

camel.source.endpoint.httpClientBuilder

Custom HTTP client builder for more complex HTTP client configuration, overrides connectionTimeout, socketTimeout, proxy and sslContext. Note that a socketTimeout MUST be specified in the builder, otherwise OData requests could block indefinitely

null

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

The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.

null

false

MEDIUM

camel.source.endpoint.backoffIdleThreshold

The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.

null

false

MEDIUM

camel.source.endpoint.backoffMultiplier

To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured.

null

false

MEDIUM

camel.source.endpoint.delay

Milliseconds before the next poll.

500L

false

MEDIUM

camel.source.endpoint.greedy

If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.

false

MEDIUM

camel.source.endpoint.initialDelay

Milliseconds before the first poll starts.

1000L

false

MEDIUM

camel.source.endpoint.repeatCount

Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever.

false

MEDIUM

camel.source.endpoint.runLoggingLevel

The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. One of: [TRACE] [DEBUG] [INFO] [WARN] [ERROR] [OFF]

"TRACE"

false

MEDIUM

camel.source.endpoint.scheduledExecutorService

Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool.

null

false

MEDIUM

camel.source.endpoint.scheduler

To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler

"none"

false

MEDIUM

camel.source.endpoint.schedulerProperties

To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.

null

false

MEDIUM

camel.source.endpoint.startScheduler

Whether the scheduler should be auto started.

true

false

MEDIUM

camel.source.endpoint.timeUnit

Time unit for initialDelay and delay options. One of: [NANOSECONDS] [MICROSECONDS] [MILLISECONDS] [SECONDS] [MINUTES] [HOURS] [DAYS]

"MILLISECONDS"

false

MEDIUM

camel.source.endpoint.useFixedDelay

Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details.

true

false

MEDIUM

camel.source.endpoint.sslContextParameters

To configure security using SSLContextParameters

null

false

MEDIUM

camel.component.olingo2.configuration

To use the shared configuration

null

false

MEDIUM

camel.component.olingo2.connectTimeout

HTTP connection creation timeout in milliseconds, defaults to 30,000 (30 seconds)

30000

false

MEDIUM

camel.component.olingo2.contentType

Content-Type header value can be used to specify JSON or XML message format, defaults to application/json;charset=utf-8

"application/json;charset=utf-8"

false

MEDIUM

camel.component.olingo2.entityProviderRead Properties

Custom entity provider read properties applied to all read operations.

null

false

MEDIUM

camel.component.olingo2.entityProviderWrite Properties

null

false

MEDIUM

camel.component.olingo2.filterAlreadySeen

Set this to true to filter out results that have already been communicated by this component.

false

MEDIUM

camel.component.olingo2.httpHeaders

Custom HTTP headers to inject into every request, this could include OAuth tokens, etc.

null

false

MEDIUM

camel.component.olingo2.proxy

HTTP proxy server configuration

null

false

MEDIUM

camel.component.olingo2.serviceUri

Target OData service base URI, e.g. http://services.odata.org/OData/OData.svc

null

false

MEDIUM

camel.component.olingo2.socketTimeout

HTTP request timeout in milliseconds, defaults to 30,000 (30 seconds)

30000

false

MEDIUM

camel.component.olingo2.bridgeErrorHandler

false

MEDIUM

camel.component.olingo2.splitResult

For endpoints that return an array or collection, a consumer endpoint will map every element to distinct messages, unless splitResult is set to false.

true

false

MEDIUM

camel.component.olingo2.basicPropertyBinding

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

false

LOW

camel.component.olingo2.httpAsyncClientBuilder

null

false

MEDIUM

camel.component.olingo2.httpClientBuilder

null

false

MEDIUM

camel.component.olingo2.sslContextParameters

To configure security using SSLContextParameters

null

false

MEDIUM

camel.component.olingo2.useGlobalSslContext Parameters

Enable usage of global SSL context parameters.

false

MEDIUM

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

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

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