Interface Olingo4EndpointBuilderFactory.Olingo4EndpointConsumerBuilder
- All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder
,org.apache.camel.EndpointConsumerResolver
- All Known Subinterfaces:
Olingo4EndpointBuilderFactory.Olingo4EndpointBuilder
- Enclosing interface:
- Olingo4EndpointBuilderFactory
public static interface Olingo4EndpointBuilderFactory.Olingo4EndpointConsumerBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder
Builder for endpoint consumers for the Olingo4 component.
-
Method Summary
Modifier and TypeMethodDescriptionadvanced()
backoffErrorThreshold
(int backoffErrorThreshold) The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.backoffErrorThreshold
(String backoffErrorThreshold) The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.backoffIdleThreshold
(int backoffIdleThreshold) The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.backoffIdleThreshold
(String backoffIdleThreshold) The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.backoffMultiplier
(int backoffMultiplier) To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row.backoffMultiplier
(String backoffMultiplier) To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row.connectTimeout
(int connectTimeout) HTTP connection creation timeout in milliseconds, defaults to 30,000 (30 seconds).connectTimeout
(String connectTimeout) HTTP connection creation timeout in milliseconds, defaults to 30,000 (30 seconds).contentType
(String contentType) Content-Type header value can be used to specify JSON or XML message format, defaults to application/json;charset=utf-8.delay
(long delay) Milliseconds before the next poll.Milliseconds before the next poll.filterAlreadySeen
(boolean filterAlreadySeen) Set this to true to filter out results that have already been communicated by this component.filterAlreadySeen
(String filterAlreadySeen) Set this to true to filter out results that have already been communicated by this component.greedy
(boolean greedy) If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.httpHeaders
(String httpHeaders) Custom HTTP headers to inject into every request, this could include OAuth tokens, etc.httpHeaders
(Map<String, String> httpHeaders) Custom HTTP headers to inject into every request, this could include OAuth tokens, etc.Sets the name of a parameter to be passed in the exchange In Body.initialDelay
(long initialDelay) Milliseconds before the first poll starts.initialDelay
(String initialDelay) Milliseconds before the first poll starts.HTTP proxy server configuration.proxy
(org.apache.http.HttpHost proxy) HTTP proxy server configuration.repeatCount
(long repeatCount) Specifies a maximum limit of number of fires.repeatCount
(String repeatCount) Specifies a maximum limit of number of fires.runLoggingLevel
(String runLoggingLevel) The consumer logs a start/complete log line when it polls.runLoggingLevel
(org.apache.camel.LoggingLevel runLoggingLevel) The consumer logs a start/complete log line when it polls.scheduledExecutorService
(String scheduledExecutorService) Allows for configuring a custom/shared thread pool to use for the consumer.scheduledExecutorService
(ScheduledExecutorService scheduledExecutorService) Allows for configuring a custom/shared thread pool to use for the consumer.To use a cron scheduler from either camel-spring or camel-quartz component.To use a cron scheduler from either camel-spring or camel-quartz component.schedulerProperties
(String key, Object value) To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.schedulerProperties
(Map values) To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.sendEmptyMessageWhenIdle
(boolean sendEmptyMessageWhenIdle) If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead.sendEmptyMessageWhenIdle
(String sendEmptyMessageWhenIdle) If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead.serviceUri
(String serviceUri) Target OData service base URI, e.g.socketTimeout
(int socketTimeout) HTTP request timeout in milliseconds, defaults to 30,000 (30 seconds).socketTimeout
(String socketTimeout) HTTP request timeout in milliseconds, defaults to 30,000 (30 seconds).splitResult
(boolean 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.splitResult
(String 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.sslContextParameters
(String sslContextParameters) To configure security using SSLContextParameters.sslContextParameters
(org.apache.camel.support.jsse.SSLContextParameters sslContextParameters) To configure security using SSLContextParameters.startScheduler
(boolean startScheduler) Whether the scheduler should be auto started.startScheduler
(String startScheduler) Whether the scheduler should be auto started.Time unit for initialDelay and delay options.Time unit for initialDelay and delay options.useFixedDelay
(boolean useFixedDelay) Controls if fixed delay or fixed rate is used.useFixedDelay
(String useFixedDelay) Controls if fixed delay or fixed rate is used.Methods inherited from interface org.apache.camel.builder.EndpointConsumerBuilder
doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUri, getUri
Methods inherited from interface org.apache.camel.EndpointConsumerResolver
resolve, resolve
-
Method Details
-
advanced
-
connectTimeout
default Olingo4EndpointBuilderFactory.Olingo4EndpointConsumerBuilder connectTimeout(int connectTimeout) HTTP connection creation timeout in milliseconds, defaults to 30,000 (30 seconds). The option is a: <code>int</code> type. Default: 30000 Group: common- Parameters:
connectTimeout
- the value to set- Returns:
- the dsl builder
-
connectTimeout
default Olingo4EndpointBuilderFactory.Olingo4EndpointConsumerBuilder connectTimeout(String connectTimeout) HTTP connection creation timeout in milliseconds, defaults to 30,000 (30 seconds). The option will be converted to a <code>int</code> type. Default: 30000 Group: common- Parameters:
connectTimeout
- the value to set- Returns:
- the dsl builder
-
contentType
default Olingo4EndpointBuilderFactory.Olingo4EndpointConsumerBuilder contentType(String contentType) Content-Type header value can be used to specify JSON or XML message format, defaults to application/json;charset=utf-8. The option is a: <code>java.lang.String</code> type. Default: application/json;charset=utf-8 Group: common- Parameters:
contentType
- the value to set- Returns:
- the dsl builder
-
filterAlreadySeen
default Olingo4EndpointBuilderFactory.Olingo4EndpointConsumerBuilder filterAlreadySeen(boolean filterAlreadySeen) Set this to true to filter out results that have already been communicated by this component. The option is a: <code>boolean</code> type. Default: false Group: common- Parameters:
filterAlreadySeen
- the value to set- Returns:
- the dsl builder
-
filterAlreadySeen
default Olingo4EndpointBuilderFactory.Olingo4EndpointConsumerBuilder filterAlreadySeen(String filterAlreadySeen) Set this to true to filter out results that have already been communicated by this component. The option will be converted to a <code>boolean</code> type. Default: false Group: common- Parameters:
filterAlreadySeen
- the value to set- Returns:
- the dsl builder
-
httpHeaders
default Olingo4EndpointBuilderFactory.Olingo4EndpointConsumerBuilder httpHeaders(Map<String, String> httpHeaders) Custom HTTP headers to inject into every request, this could include OAuth tokens, etc. The option is a: <code>java.util.Map<java.lang.String, java.lang.String></code> type. Group: common- Parameters:
httpHeaders
- the value to set- Returns:
- the dsl builder
-
httpHeaders
default Olingo4EndpointBuilderFactory.Olingo4EndpointConsumerBuilder httpHeaders(String httpHeaders) Custom HTTP headers to inject into every request, this could include OAuth tokens, etc. The option will be converted to a <code>java.util.Map<java.lang.String, java.lang.String></code> type. Group: common- Parameters:
httpHeaders
- the value to set- Returns:
- the dsl builder
-
inBody
Sets the name of a parameter to be passed in the exchange In Body. The option is a: <code>java.lang.String</code> type. Group: common- Parameters:
inBody
- the value to set- Returns:
- the dsl builder
-
proxy
default Olingo4EndpointBuilderFactory.Olingo4EndpointConsumerBuilder proxy(org.apache.http.HttpHost proxy) HTTP proxy server configuration. The option is a: <code>org.apache.http.HttpHost</code> type. Group: common- Parameters:
proxy
- the value to set- Returns:
- the dsl builder
-
proxy
HTTP proxy server configuration. The option will be converted to a <code>org.apache.http.HttpHost</code> type. Group: common- Parameters:
proxy
- the value to set- Returns:
- the dsl builder
-
serviceUri
Target OData service base URI, e.g. http://services.odata.org/OData/OData.svc. The option is a: <code>java.lang.String</code> type. Group: common- Parameters:
serviceUri
- the value to set- Returns:
- the dsl builder
-
socketTimeout
default Olingo4EndpointBuilderFactory.Olingo4EndpointConsumerBuilder socketTimeout(int socketTimeout) HTTP request timeout in milliseconds, defaults to 30,000 (30 seconds). The option is a: <code>int</code> type. Default: 30000 Group: common- Parameters:
socketTimeout
- the value to set- Returns:
- the dsl builder
-
socketTimeout
default Olingo4EndpointBuilderFactory.Olingo4EndpointConsumerBuilder socketTimeout(String socketTimeout) HTTP request timeout in milliseconds, defaults to 30,000 (30 seconds). The option will be converted to a <code>int</code> type. Default: 30000 Group: common- Parameters:
socketTimeout
- the value to set- Returns:
- the dsl builder
-
sendEmptyMessageWhenIdle
default Olingo4EndpointBuilderFactory.Olingo4EndpointConsumerBuilder sendEmptyMessageWhenIdle(boolean sendEmptyMessageWhenIdle) If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead. The option is a: <code>boolean</code> type. Default: false Group: consumer- Parameters:
sendEmptyMessageWhenIdle
- the value to set- Returns:
- the dsl builder
-
sendEmptyMessageWhenIdle
default Olingo4EndpointBuilderFactory.Olingo4EndpointConsumerBuilder sendEmptyMessageWhenIdle(String sendEmptyMessageWhenIdle) If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer- Parameters:
sendEmptyMessageWhenIdle
- the value to set- Returns:
- the dsl builder
-
splitResult
default Olingo4EndpointBuilderFactory.Olingo4EndpointConsumerBuilder splitResult(boolean 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. The option is a: <code>boolean</code> type. Default: true Group: consumer- Parameters:
splitResult
- the value to set- Returns:
- the dsl builder
-
splitResult
default Olingo4EndpointBuilderFactory.Olingo4EndpointConsumerBuilder splitResult(String 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. The option will be converted to a <code>boolean</code> type. Default: true Group: consumer- Parameters:
splitResult
- the value to set- Returns:
- the dsl builder
-
backoffErrorThreshold
default Olingo4EndpointBuilderFactory.Olingo4EndpointConsumerBuilder backoffErrorThreshold(int backoffErrorThreshold) The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. The option is a: <code>int</code> type. Group: scheduler- Parameters:
backoffErrorThreshold
- the value to set- Returns:
- the dsl builder
-
backoffErrorThreshold
default Olingo4EndpointBuilderFactory.Olingo4EndpointConsumerBuilder backoffErrorThreshold(String backoffErrorThreshold) The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. The option will be converted to a <code>int</code> type. Group: scheduler- Parameters:
backoffErrorThreshold
- the value to set- Returns:
- the dsl builder
-
backoffIdleThreshold
default Olingo4EndpointBuilderFactory.Olingo4EndpointConsumerBuilder backoffIdleThreshold(int backoffIdleThreshold) The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. The option is a: <code>int</code> type. Group: scheduler- Parameters:
backoffIdleThreshold
- the value to set- Returns:
- the dsl builder
-
backoffIdleThreshold
default Olingo4EndpointBuilderFactory.Olingo4EndpointConsumerBuilder backoffIdleThreshold(String backoffIdleThreshold) The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. The option will be converted to a <code>int</code> type. Group: scheduler- Parameters:
backoffIdleThreshold
- the value to set- Returns:
- the dsl builder
-
backoffMultiplier
default Olingo4EndpointBuilderFactory.Olingo4EndpointConsumerBuilder backoffMultiplier(int 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. The option is a: <code>int</code> type. Group: scheduler- Parameters:
backoffMultiplier
- the value to set- Returns:
- the dsl builder
-
backoffMultiplier
default Olingo4EndpointBuilderFactory.Olingo4EndpointConsumerBuilder backoffMultiplier(String 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. The option will be converted to a <code>int</code> type. Group: scheduler- Parameters:
backoffMultiplier
- the value to set- Returns:
- the dsl builder
-
delay
Milliseconds before the next poll. The option is a: <code>long</code> type. Default: 500 Group: scheduler- Parameters:
delay
- the value to set- Returns:
- the dsl builder
-
delay
Milliseconds before the next poll. The option will be converted to a <code>long</code> type. Default: 500 Group: scheduler- Parameters:
delay
- the value to set- Returns:
- the dsl builder
-
greedy
If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages. The option is a: <code>boolean</code> type. Default: false Group: scheduler- Parameters:
greedy
- the value to set- Returns:
- the dsl builder
-
greedy
If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages. The option will be converted to a <code>boolean</code> type. Default: false Group: scheduler- Parameters:
greedy
- the value to set- Returns:
- the dsl builder
-
initialDelay
default Olingo4EndpointBuilderFactory.Olingo4EndpointConsumerBuilder initialDelay(long initialDelay) Milliseconds before the first poll starts. The option is a: <code>long</code> type. Default: 1000 Group: scheduler- Parameters:
initialDelay
- the value to set- Returns:
- the dsl builder
-
initialDelay
default Olingo4EndpointBuilderFactory.Olingo4EndpointConsumerBuilder initialDelay(String initialDelay) Milliseconds before the first poll starts. The option will be converted to a <code>long</code> type. Default: 1000 Group: scheduler- Parameters:
initialDelay
- the value to set- Returns:
- the dsl builder
-
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. The option is a: <code>long</code> type. Default: 0 Group: scheduler- Parameters:
repeatCount
- the value to set- Returns:
- the dsl builder
-
repeatCount
default Olingo4EndpointBuilderFactory.Olingo4EndpointConsumerBuilder repeatCount(String 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. The option will be converted to a <code>long</code> type. Default: 0 Group: scheduler- Parameters:
repeatCount
- the value to set- Returns:
- the dsl builder
-
runLoggingLevel
default Olingo4EndpointBuilderFactory.Olingo4EndpointConsumerBuilder runLoggingLevel(org.apache.camel.LoggingLevel runLoggingLevel) The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. The option is a: <code>org.apache.camel.LoggingLevel</code> type. Default: TRACE Group: scheduler- Parameters:
runLoggingLevel
- the value to set- Returns:
- the dsl builder
-
runLoggingLevel
default Olingo4EndpointBuilderFactory.Olingo4EndpointConsumerBuilder runLoggingLevel(String runLoggingLevel) The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. The option will be converted to a <code>org.apache.camel.LoggingLevel</code> type. Default: TRACE Group: scheduler- Parameters:
runLoggingLevel
- the value to set- Returns:
- the dsl builder
-
scheduledExecutorService
default Olingo4EndpointBuilderFactory.Olingo4EndpointConsumerBuilder scheduledExecutorService(ScheduledExecutorService 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. The option is a: <code>java.util.concurrent.ScheduledExecutorService</code> type. Group: scheduler- Parameters:
scheduledExecutorService
- the value to set- Returns:
- the dsl builder
-
scheduledExecutorService
default Olingo4EndpointBuilderFactory.Olingo4EndpointConsumerBuilder scheduledExecutorService(String 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. The option will be converted to a <code>java.util.concurrent.ScheduledExecutorService</code> type. Group: scheduler- Parameters:
scheduledExecutorService
- the value to set- Returns:
- the dsl builder
-
scheduler
To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler. The option is a: <code>java.lang.Object</code> type. Default: none Group: scheduler- Parameters:
scheduler
- the value to set- Returns:
- the dsl builder
-
scheduler
To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler. The option will be converted to a <code>java.lang.Object</code> type. Default: none Group: scheduler- Parameters:
scheduler
- the value to set- Returns:
- the dsl builder
-
schedulerProperties
default Olingo4EndpointBuilderFactory.Olingo4EndpointConsumerBuilder schedulerProperties(String key, Object value) To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler. The option is a: <code>java.util.Map<java.lang.String, java.lang.Object></code> type. The option is multivalued, and you can use the schedulerProperties(String, Object) method to add a value (call the method multiple times to set more values). Group: scheduler- Parameters:
key
- the option keyvalue
- the option value- Returns:
- the dsl builder
-
schedulerProperties
default Olingo4EndpointBuilderFactory.Olingo4EndpointConsumerBuilder schedulerProperties(Map values) To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler. The option is a: <code>java.util.Map<java.lang.String, java.lang.Object></code> type. The option is multivalued, and you can use the schedulerProperties(String, Object) method to add a value (call the method multiple times to set more values). Group: scheduler- Parameters:
values
- the values- Returns:
- the dsl builder
-
startScheduler
default Olingo4EndpointBuilderFactory.Olingo4EndpointConsumerBuilder startScheduler(boolean startScheduler) Whether the scheduler should be auto started. The option is a: <code>boolean</code> type. Default: true Group: scheduler- Parameters:
startScheduler
- the value to set- Returns:
- the dsl builder
-
startScheduler
default Olingo4EndpointBuilderFactory.Olingo4EndpointConsumerBuilder startScheduler(String startScheduler) Whether the scheduler should be auto started. The option will be converted to a <code>boolean</code> type. Default: true Group: scheduler- Parameters:
startScheduler
- the value to set- Returns:
- the dsl builder
-
timeUnit
Time unit for initialDelay and delay options. The option is a: <code>java.util.concurrent.TimeUnit</code> type. Default: MILLISECONDS Group: scheduler- Parameters:
timeUnit
- the value to set- Returns:
- the dsl builder
-
timeUnit
Time unit for initialDelay and delay options. The option will be converted to a <code>java.util.concurrent.TimeUnit</code> type. Default: MILLISECONDS Group: scheduler- Parameters:
timeUnit
- the value to set- Returns:
- the dsl builder
-
useFixedDelay
default Olingo4EndpointBuilderFactory.Olingo4EndpointConsumerBuilder useFixedDelay(boolean useFixedDelay) Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. The option is a: <code>boolean</code> type. Default: true Group: scheduler- Parameters:
useFixedDelay
- the value to set- Returns:
- the dsl builder
-
useFixedDelay
default Olingo4EndpointBuilderFactory.Olingo4EndpointConsumerBuilder useFixedDelay(String useFixedDelay) Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. The option will be converted to a <code>boolean</code> type. Default: true Group: scheduler- Parameters:
useFixedDelay
- the value to set- Returns:
- the dsl builder
-
sslContextParameters
default Olingo4EndpointBuilderFactory.Olingo4EndpointConsumerBuilder sslContextParameters(org.apache.camel.support.jsse.SSLContextParameters sslContextParameters) To configure security using SSLContextParameters. The option is a: <code>org.apache.camel.support.jsse.SSLContextParameters</code> type. Group: security- Parameters:
sslContextParameters
- the value to set- Returns:
- the dsl builder
-
sslContextParameters
default Olingo4EndpointBuilderFactory.Olingo4EndpointConsumerBuilder sslContextParameters(String sslContextParameters) To configure security using SSLContextParameters. The option will be converted to a <code>org.apache.camel.support.jsse.SSLContextParameters</code> type. Group: security- Parameters:
sslContextParameters
- the value to set- Returns:
- the dsl builder
-