ApnsEndpointBuilderFactory.ApnsEndpointConsumerBuilder (Camel

All Superinterfaces:

org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver

All Known Subinterfaces:

ApnsEndpointBuilderFactory.ApnsEndpointBuilder

Enclosing interface:

ApnsEndpointBuilderFactory
```
public static interface ApnsEndpointBuilderFactory.ApnsEndpointConsumerBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder
```
Builder for endpoint consumers for the APNS component.

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`default ApnsEndpointBuilderFactory.AdvancedApnsEndpointConsumerBuilder`	`advanced()`
`default ApnsEndpointBuilderFactory.ApnsEndpointConsumerBuilder`	`backoffErrorThreshold(int backoffErrorThreshold)` The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
`default ApnsEndpointBuilderFactory.ApnsEndpointConsumerBuilder`	`backoffErrorThreshold(String backoffErrorThreshold)` The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
`default ApnsEndpointBuilderFactory.ApnsEndpointConsumerBuilder`	`backoffIdleThreshold(int backoffIdleThreshold)` The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
`default ApnsEndpointBuilderFactory.ApnsEndpointConsumerBuilder`	`backoffIdleThreshold(String backoffIdleThreshold)` The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
`default ApnsEndpointBuilderFactory.ApnsEndpointConsumerBuilder`	`backoffMultiplier(int backoffMultiplier)` To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row.
`default ApnsEndpointBuilderFactory.ApnsEndpointConsumerBuilder`	`backoffMultiplier(String backoffMultiplier)` To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row.
`default ApnsEndpointBuilderFactory.ApnsEndpointConsumerBuilder`	`bridgeErrorHandler(boolean 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.
`default ApnsEndpointBuilderFactory.ApnsEndpointConsumerBuilder`	`bridgeErrorHandler(String 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.
`default ApnsEndpointBuilderFactory.ApnsEndpointConsumerBuilder`	`delay(long delay)` Milliseconds before the next poll.
`default ApnsEndpointBuilderFactory.ApnsEndpointConsumerBuilder`	`delay(String delay)` Milliseconds before the next poll.
`default ApnsEndpointBuilderFactory.ApnsEndpointConsumerBuilder`	`greedy(boolean greedy)` If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.
`default ApnsEndpointBuilderFactory.ApnsEndpointConsumerBuilder`	`greedy(String greedy)` If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.
`default ApnsEndpointBuilderFactory.ApnsEndpointConsumerBuilder`	`initialDelay(long initialDelay)` Milliseconds before the first poll starts.
`default ApnsEndpointBuilderFactory.ApnsEndpointConsumerBuilder`	`initialDelay(String initialDelay)` Milliseconds before the first poll starts.
`default ApnsEndpointBuilderFactory.ApnsEndpointConsumerBuilder`	`repeatCount(long repeatCount)` Specifies a maximum limit of number of fires.
`default ApnsEndpointBuilderFactory.ApnsEndpointConsumerBuilder`	`repeatCount(String repeatCount)` Specifies a maximum limit of number of fires.
`default ApnsEndpointBuilderFactory.ApnsEndpointConsumerBuilder`	`runLoggingLevel(org.apache.camel.LoggingLevel runLoggingLevel)` The consumer logs a start/complete log line when it polls.
`default ApnsEndpointBuilderFactory.ApnsEndpointConsumerBuilder`	`runLoggingLevel(String runLoggingLevel)` The consumer logs a start/complete log line when it polls.
`default ApnsEndpointBuilderFactory.ApnsEndpointConsumerBuilder`	`scheduledExecutorService(ScheduledExecutorService scheduledExecutorService)` Allows for configuring a custom/shared thread pool to use for the consumer.
`default ApnsEndpointBuilderFactory.ApnsEndpointConsumerBuilder`	`scheduledExecutorService(String scheduledExecutorService)` Allows for configuring a custom/shared thread pool to use for the consumer.
`default ApnsEndpointBuilderFactory.ApnsEndpointConsumerBuilder`	`scheduler(Object scheduler)` To use a cron scheduler from either camel-spring or camel-quartz component.
`default ApnsEndpointBuilderFactory.ApnsEndpointConsumerBuilder`	`scheduler(String scheduler)` To use a cron scheduler from either camel-spring or camel-quartz component.
`default ApnsEndpointBuilderFactory.ApnsEndpointConsumerBuilder`	`schedulerProperties(Map values)` To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.
`default ApnsEndpointBuilderFactory.ApnsEndpointConsumerBuilder`	`schedulerProperties(String key, Object value)` To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.
`default ApnsEndpointBuilderFactory.ApnsEndpointConsumerBuilder`	`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.
`default ApnsEndpointBuilderFactory.ApnsEndpointConsumerBuilder`	`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.
`default ApnsEndpointBuilderFactory.ApnsEndpointConsumerBuilder`	`startScheduler(boolean startScheduler)` Whether the scheduler should be auto started.
`default ApnsEndpointBuilderFactory.ApnsEndpointConsumerBuilder`	`startScheduler(String startScheduler)` Whether the scheduler should be auto started.
`default ApnsEndpointBuilderFactory.ApnsEndpointConsumerBuilder`	`timeUnit(String timeUnit)` Time unit for initialDelay and delay options.
`default ApnsEndpointBuilderFactory.ApnsEndpointConsumerBuilder`	`timeUnit(TimeUnit timeUnit)` Time unit for initialDelay and delay options.
`default ApnsEndpointBuilderFactory.ApnsEndpointConsumerBuilder`	`tokens(String tokens)` Configure this property in case you want to statically declare tokens related to devices you want to notify.
`default ApnsEndpointBuilderFactory.ApnsEndpointConsumerBuilder`	`useFixedDelay(boolean useFixedDelay)` Controls if fixed delay or fixed rate is used.
`default ApnsEndpointBuilderFactory.ApnsEndpointConsumerBuilder`	`useFixedDelay(String useFixedDelay)` Controls if fixed delay or fixed rate is used.

Methods inherited from interface org.apache.camel.builder.EndpointConsumerBuilder
doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, getUri

Methods inherited from interface org.apache.camel.EndpointConsumerResolver
resolve, resolve

- Method Detail
  - advanced
```
default ApnsEndpointBuilderFactory.AdvancedApnsEndpointConsumerBuilder advanced()
```
  - tokens
```
default ApnsEndpointBuilderFactory.ApnsEndpointConsumerBuilder tokens(String tokens)
```
    Configure this property in case you want to statically declare tokens related to devices you want to notify. Tokens are separated by comma. The option is a: java.lang.String type. Group: common
  - bridgeErrorHandler
```
default ApnsEndpointBuilderFactory.ApnsEndpointConsumerBuilder bridgeErrorHandler(boolean 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. The option is a: boolean type. Default: false Group: consumer
  - bridgeErrorHandler
```
default ApnsEndpointBuilderFactory.ApnsEndpointConsumerBuilder bridgeErrorHandler(String 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. The option will be converted to a boolean type. Default: false Group: consumer
  - sendEmptyMessageWhenIdle
```
default ApnsEndpointBuilderFactory.ApnsEndpointConsumerBuilder 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: boolean type. Default: false Group: consumer
  - sendEmptyMessageWhenIdle
```
default ApnsEndpointBuilderFactory.ApnsEndpointConsumerBuilder 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 boolean type. Default: false Group: consumer
  - backoffErrorThreshold
```
default ApnsEndpointBuilderFactory.ApnsEndpointConsumerBuilder 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: int type. Group: scheduler
  - backoffErrorThreshold
```
default ApnsEndpointBuilderFactory.ApnsEndpointConsumerBuilder 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 int type. Group: scheduler
  - backoffIdleThreshold
```
default ApnsEndpointBuilderFactory.ApnsEndpointConsumerBuilder backoffIdleThreshold(int backoffIdleThreshold)
```
    The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. The option is a: int type. Group: scheduler
  - backoffIdleThreshold
```
default ApnsEndpointBuilderFactory.ApnsEndpointConsumerBuilder 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 int type. Group: scheduler
  - backoffMultiplier
```
default ApnsEndpointBuilderFactory.ApnsEndpointConsumerBuilder 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: int type. Group: scheduler
  - backoffMultiplier
```
default ApnsEndpointBuilderFactory.ApnsEndpointConsumerBuilder 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 int type. Group: scheduler
  - delay
```
default ApnsEndpointBuilderFactory.ApnsEndpointConsumerBuilder delay(long delay)
```
    Milliseconds before the next poll. The option is a: long type. Default: 500 Group: scheduler
  - delay
```
default ApnsEndpointBuilderFactory.ApnsEndpointConsumerBuilder delay(String delay)
```
    Milliseconds before the next poll. The option will be converted to a long type. Default: 500 Group: scheduler
  - greedy
```
default ApnsEndpointBuilderFactory.ApnsEndpointConsumerBuilder greedy(boolean 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: boolean type. Default: false Group: scheduler
  - greedy
```
default ApnsEndpointBuilderFactory.ApnsEndpointConsumerBuilder greedy(String 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 boolean type. Default: false Group: scheduler
  - initialDelay
```
default ApnsEndpointBuilderFactory.ApnsEndpointConsumerBuilder initialDelay(long initialDelay)
```
    Milliseconds before the first poll starts. The option is a: long type. Default: 1000 Group: scheduler
  - initialDelay
```
default ApnsEndpointBuilderFactory.ApnsEndpointConsumerBuilder initialDelay(String initialDelay)
```
    Milliseconds before the first poll starts. The option will be converted to a long type. Default: 1000 Group: scheduler
  - repeatCount
```
default ApnsEndpointBuilderFactory.ApnsEndpointConsumerBuilder repeatCount(long 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: long type. Default: 0 Group: scheduler
  - repeatCount
```
default ApnsEndpointBuilderFactory.ApnsEndpointConsumerBuilder 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 long type. Default: 0 Group: scheduler
  - runLoggingLevel
```
default ApnsEndpointBuilderFactory.ApnsEndpointConsumerBuilder 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: org.apache.camel.LoggingLevel type. Default: TRACE Group: scheduler
  - runLoggingLevel
```
default ApnsEndpointBuilderFactory.ApnsEndpointConsumerBuilder 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 org.apache.camel.LoggingLevel type. Default: TRACE Group: scheduler
  - scheduledExecutorService
```
default ApnsEndpointBuilderFactory.ApnsEndpointConsumerBuilder 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: java.util.concurrent.ScheduledExecutorService type. Group: scheduler
  - scheduledExecutorService
```
default ApnsEndpointBuilderFactory.ApnsEndpointConsumerBuilder 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 java.util.concurrent.ScheduledExecutorService type. Group: scheduler
  - scheduler
```
default ApnsEndpointBuilderFactory.ApnsEndpointConsumerBuilder scheduler(Object 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: java.lang.Object type. Default: none Group: scheduler
  - scheduler
```
default ApnsEndpointBuilderFactory.ApnsEndpointConsumerBuilder scheduler(String 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 java.lang.Object type. Default: none Group: scheduler
  - schedulerProperties
```
default ApnsEndpointBuilderFactory.ApnsEndpointConsumerBuilder 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: java.util.Map<java.lang.String, java.lang.Object> 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
  - schedulerProperties
```
default ApnsEndpointBuilderFactory.ApnsEndpointConsumerBuilder schedulerProperties(Map values)
```
    To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler. The option is a: java.util.Map<java.lang.String, java.lang.Object> 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
  - startScheduler
```
default ApnsEndpointBuilderFactory.ApnsEndpointConsumerBuilder startScheduler(boolean startScheduler)
```
    Whether the scheduler should be auto started. The option is a: boolean type. Default: true Group: scheduler
  - startScheduler
```
default ApnsEndpointBuilderFactory.ApnsEndpointConsumerBuilder startScheduler(String startScheduler)
```
    Whether the scheduler should be auto started. The option will be converted to a boolean type. Default: true Group: scheduler
  - timeUnit
```
default ApnsEndpointBuilderFactory.ApnsEndpointConsumerBuilder timeUnit(TimeUnit timeUnit)
```
    Time unit for initialDelay and delay options. The option is a: java.util.concurrent.TimeUnit type. Default: MILLISECONDS Group: scheduler
  - timeUnit
```
default ApnsEndpointBuilderFactory.ApnsEndpointConsumerBuilder timeUnit(String timeUnit)
```
    Time unit for initialDelay and delay options. The option will be converted to a java.util.concurrent.TimeUnit type. Default: MILLISECONDS Group: scheduler
  - useFixedDelay
```
default ApnsEndpointBuilderFactory.ApnsEndpointConsumerBuilder useFixedDelay(boolean useFixedDelay)
```
    Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. The option is a: boolean type. Default: true Group: scheduler
  - useFixedDelay
```
default ApnsEndpointBuilderFactory.ApnsEndpointConsumerBuilder 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 boolean type. Default: true Group: scheduler

Interface ApnsEndpointBuilderFactory.ApnsEndpointConsumerBuilder

Method Summary

Methods inherited from interface org.apache.camel.builder.EndpointConsumerBuilder

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

Method Detail

advanced

tokens

bridgeErrorHandler

bridgeErrorHandler

sendEmptyMessageWhenIdle

sendEmptyMessageWhenIdle

backoffErrorThreshold

backoffErrorThreshold

backoffIdleThreshold

backoffIdleThreshold

backoffMultiplier

backoffMultiplier

delay

delay

greedy

greedy

initialDelay

initialDelay

repeatCount

repeatCount

runLoggingLevel

runLoggingLevel

scheduledExecutorService

scheduledExecutorService

scheduler

scheduler

schedulerProperties

schedulerProperties

startScheduler

startScheduler

timeUnit

timeUnit

useFixedDelay

useFixedDelay