Interface Jt400EndpointBuilderFactory.Jt400EndpointConsumerBuilder
- All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder
,org.apache.camel.EndpointConsumerResolver
- All Known Subinterfaces:
Jt400EndpointBuilderFactory.Jt400EndpointBuilder
- Enclosing interface:
- Jt400EndpointBuilderFactory
public static interface Jt400EndpointBuilderFactory.Jt400EndpointConsumerBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder
Builder for endpoint consumers for the JT400 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.ccsid
(int ccsid) Sets the CCSID to use for the connection with the IBM i system.Sets the CCSID to use for the connection with the IBM i system.delay
(long delay) Milliseconds before the next poll.Milliseconds before the next poll.Sets the data format for sending messages.format
(org.apache.camel.component.jt400.Jt400Configuration.Format format) Sets the data format for sending messages.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.guiAvailable
(boolean guiAvailable) Sets whether IBM i prompting is enabled in the environment running Camel.guiAvailable
(String guiAvailable) Sets whether IBM i prompting is enabled in the environment running Camel.initialDelay
(long initialDelay) Milliseconds before the first poll starts.initialDelay
(String initialDelay) Milliseconds before the first poll starts.keyed
(boolean keyed) Whether to use keyed or non-keyed data queues.Whether to use keyed or non-keyed data queues.messageAction
(String messageAction) Action to be taken on messages when read from a message queue.messageAction
(org.apache.camel.component.jt400.Jt400Configuration.MessageAction messageAction) Action to be taken on messages when read from a message queue.readTimeout
(int readTimeout) Timeout in millis the consumer will wait while trying to read a new message of the data queue.readTimeout
(String readTimeout) Timeout in millis the consumer will wait while trying to read a new message of the data queue.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.Search key for keyed data queues.searchType
(String searchType) Search type such as EQ for equal etc.searchType
(org.apache.camel.component.jt400.Jt400Configuration.SearchType searchType) Search type such as EQ for equal etc.secured
(boolean secured) Whether connections to IBM i are secured with SSL.Whether connections to IBM i are secured with SSL.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.sendingReply
(boolean sendingReply) If true, the consumer endpoint will set the Jt400Constants.MESSAGE_REPLYTO_KEY header of the camel message for any IBM i inquiry messages received.sendingReply
(String sendingReply) If true, the consumer endpoint will set the Jt400Constants.MESSAGE_REPLYTO_KEY header of the camel message for any IBM i inquiry messages received.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
-
ccsid
Sets the CCSID to use for the connection with the IBM i system. The option is a: <code>int</code> type. Group: common- Parameters:
ccsid
- the value to set- Returns:
- the dsl builder
-
ccsid
Sets the CCSID to use for the connection with the IBM i system. The option will be converted to a <code>int</code> type. Group: common- Parameters:
ccsid
- the value to set- Returns:
- the dsl builder
-
format
default Jt400EndpointBuilderFactory.Jt400EndpointConsumerBuilder format(org.apache.camel.component.jt400.Jt400Configuration.Format format) Sets the data format for sending messages. The option is a: <code>org.apache.camel.component.jt400.Jt400Configuration.Format</code> type. Default: text Group: common- Parameters:
format
- the value to set- Returns:
- the dsl builder
-
format
Sets the data format for sending messages. The option will be converted to a <code>org.apache.camel.component.jt400.Jt400Configuration.Format</code> type. Default: text Group: common- Parameters:
format
- the value to set- Returns:
- the dsl builder
-
guiAvailable
Sets whether IBM i prompting is enabled in the environment running Camel. The option is a: <code>boolean</code> type. Default: false Group: common- Parameters:
guiAvailable
- the value to set- Returns:
- the dsl builder
-
guiAvailable
Sets whether IBM i prompting is enabled in the environment running Camel. The option will be converted to a <code>boolean</code> type. Default: false Group: common- Parameters:
guiAvailable
- the value to set- Returns:
- the dsl builder
-
keyed
Whether to use keyed or non-keyed data queues. The option is a: <code>boolean</code> type. Default: false Group: common- Parameters:
keyed
- the value to set- Returns:
- the dsl builder
-
keyed
Whether to use keyed or non-keyed data queues. The option will be converted to a <code>boolean</code> type. Default: false Group: common- Parameters:
keyed
- the value to set- Returns:
- the dsl builder
-
searchKey
Search key for keyed data queues. The option is a: <code>java.lang.String</code> type. Group: common- Parameters:
searchKey
- the value to set- Returns:
- the dsl builder
-
messageAction
default Jt400EndpointBuilderFactory.Jt400EndpointConsumerBuilder messageAction(org.apache.camel.component.jt400.Jt400Configuration.MessageAction messageAction) Action to be taken on messages when read from a message queue. Messages can be marked as old (OLD), removed from the queue (REMOVE), or neither (SAME). The option is a: <code>org.apache.camel.component.jt400.Jt400Configuration.MessageAction</code> type. Default: OLD Group: consumer- Parameters:
messageAction
- the value to set- Returns:
- the dsl builder
-
messageAction
default Jt400EndpointBuilderFactory.Jt400EndpointConsumerBuilder messageAction(String messageAction) Action to be taken on messages when read from a message queue. Messages can be marked as old (OLD), removed from the queue (REMOVE), or neither (SAME). The option will be converted to a <code>org.apache.camel.component.jt400.Jt400Configuration.MessageAction</code> type. Default: OLD Group: consumer- Parameters:
messageAction
- the value to set- Returns:
- the dsl builder
-
readTimeout
Timeout in millis the consumer will wait while trying to read a new message of the data queue. The option is a: <code>int</code> type. Default: 30000 Group: consumer- Parameters:
readTimeout
- the value to set- Returns:
- the dsl builder
-
readTimeout
Timeout in millis the consumer will wait while trying to read a new message of the data queue. The option will be converted to a <code>int</code> type. Default: 30000 Group: consumer- Parameters:
readTimeout
- the value to set- Returns:
- the dsl builder
-
searchType
default Jt400EndpointBuilderFactory.Jt400EndpointConsumerBuilder searchType(org.apache.camel.component.jt400.Jt400Configuration.SearchType searchType) Search type such as EQ for equal etc. The option is a: <code>org.apache.camel.component.jt400.Jt400Configuration.SearchType</code> type. Default: EQ Group: consumer- Parameters:
searchType
- the value to set- Returns:
- the dsl builder
-
searchType
Search type such as EQ for equal etc. The option will be converted to a <code>org.apache.camel.component.jt400.Jt400Configuration.SearchType</code> type. Default: EQ Group: consumer- Parameters:
searchType
- the value to set- Returns:
- the dsl builder
-
sendEmptyMessageWhenIdle
default Jt400EndpointBuilderFactory.Jt400EndpointConsumerBuilder 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 Jt400EndpointBuilderFactory.Jt400EndpointConsumerBuilder 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
-
sendingReply
If true, the consumer endpoint will set the Jt400Constants.MESSAGE_REPLYTO_KEY header of the camel message for any IBM i inquiry messages received. If that message is then routed to a producer endpoint, the action will not be processed as sending a message to the queue, but rather a reply to the specific inquiry message. The option is a: <code>boolean</code> type. Default: true Group: consumer- Parameters:
sendingReply
- the value to set- Returns:
- the dsl builder
-
sendingReply
If true, the consumer endpoint will set the Jt400Constants.MESSAGE_REPLYTO_KEY header of the camel message for any IBM i inquiry messages received. If that message is then routed to a producer endpoint, the action will not be processed as sending a message to the queue, but rather a reply to the specific inquiry message. The option will be converted to a <code>boolean</code> type. Default: true Group: consumer- Parameters:
sendingReply
- the value to set- Returns:
- the dsl builder
-
backoffErrorThreshold
default Jt400EndpointBuilderFactory.Jt400EndpointConsumerBuilder 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 Jt400EndpointBuilderFactory.Jt400EndpointConsumerBuilder 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 Jt400EndpointBuilderFactory.Jt400EndpointConsumerBuilder 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 Jt400EndpointBuilderFactory.Jt400EndpointConsumerBuilder 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 Jt400EndpointBuilderFactory.Jt400EndpointConsumerBuilder 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 Jt400EndpointBuilderFactory.Jt400EndpointConsumerBuilder 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
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
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
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 Jt400EndpointBuilderFactory.Jt400EndpointConsumerBuilder 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 Jt400EndpointBuilderFactory.Jt400EndpointConsumerBuilder 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 Jt400EndpointBuilderFactory.Jt400EndpointConsumerBuilder 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 Jt400EndpointBuilderFactory.Jt400EndpointConsumerBuilder 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 Jt400EndpointBuilderFactory.Jt400EndpointConsumerBuilder 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
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 Jt400EndpointBuilderFactory.Jt400EndpointConsumerBuilder 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 Jt400EndpointBuilderFactory.Jt400EndpointConsumerBuilder 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 Jt400EndpointBuilderFactory.Jt400EndpointConsumerBuilder 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 Jt400EndpointBuilderFactory.Jt400EndpointConsumerBuilder 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
-
secured
Whether connections to IBM i are secured with SSL. The option is a: <code>boolean</code> type. Default: false Group: security- Parameters:
secured
- the value to set- Returns:
- the dsl builder
-
secured
Whether connections to IBM i are secured with SSL. The option will be converted to a <code>boolean</code> type. Default: false Group: security- Parameters:
secured
- the value to set- Returns:
- the dsl builder
-