Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin

...

The EventDrivePollingConsumer (the default implementation) supports the following options:

Div
classconfluenceTableSmall

Option

Default

Description

pollingConsumerQueueSize

1000

Camel

Wiki Markup
{div:class=confluenceTableSmall} || Option || Default || Description || | {{pollingConsumerQueueSize}} | {{1000}} | *Camel

2.14/2.13.1/2.12.4:

*

The

queue

size

for

the

internal

handoff

queue

between

the

polling

consumer,

and

producers

sending

data

into

the

queue.

| | {{pollingConsumerBlockWhenFull}} | {{true}} | *Camel

pollingConsumerBlockWhenFull

true

Camel 2.14/2.13.1/2.12/4:

*

Whether

to

block

any

producer

if

the

internal

queue

is

full.

| {div}

Notice that some Camel Components has their own implementation of PollingConsumer and therefore do not support the options above.

...

The ScheduledPollConsumer supports the following options:

Div
classconfluenceTableSmall
Wiki Markup
{div:class=confluenceTableSmall} || Option || Default || Description || | {{pollStrategy}} | - | A pluggable {{

Option

Default

Description

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

    []

    have

    been

    created

    and

    being

    routed

    in

    Camel.

    In

    other

    words

    the

    error

    occurred

    while

    the

    polling

    was

    gathering

    information,

    for

    instance

    access

    to

    a

    file

    network

    failed

    so

    Camel

    cannot

    access

    it

    to

    scan

    for

    files.

    The

    default

    implementation

    will

    log

    the

    caused

    exception

    at

    {{

    WARN

    }}

    level

    and

    ignore

    it.

    | | {{sendEmptyMessageWhenIdle}} | {{false}} | *Camel

    sendEmptyMessageWhenIdle

    false

    Camel 2.9:

    *

    If

    the

    polling

    consumer

    did

    not

    poll

    any

    files,

    you

    can

    enable

    this

    option

    to

    send

    an

    empty

    message

    (no

    body)

    instead.

    | | {{startScheduler}} | {{true}} | Whether the scheduler should be auto started. | | {{initialDelay}} | {{1000}} | Milliseconds before the first poll starts. | | {{delay}} | {{500}} | Milliseconds before the next poll. | | {{useFixedDelay}} | | Controls if fixed delay or fixed rate is used. See [ScheduledExecutorService|http://java.sun.com/j2se/1.5.0/docs/api/java/util/concurrent/ScheduledExecutorService.html] in JDK for details. In *Camel 2.7.x* or older the default value is {{false}}. From *Camel 2.8* onwards the default value is {{true}}. | | {{timeUnit}} | {{TimeUnit.MILLISECONDS}} | time unit for {{initialDelay}} and {{delay}} options. | | {{runLoggingLevel}} | {{TRACE}} | *Camel 2.8:* The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. | | {{scheduledExecutorService}} | {{null}} | *Camel 2.10:* Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. This option allows you to share a thread pool among multiple consumers. | | {{greedy}} | {{false}} | *Camel

    startScheduler

    true

    Whether the scheduler should be auto started.

    initialDelay

    1000

    Milliseconds before the first poll starts.

    delay

    500

    Milliseconds before the next poll.

    useFixedDelay

     

    Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. In Camel 2.7.x or older the default value is false. From Camel 2.8 onwards the default value is true.

    timeUnit

    TimeUnit.MILLISECONDS

    time unit for initialDelay and delay options.

    runLoggingLevel

    TRACE

    Camel 2.8: The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that.

    scheduledExecutorService

    null

    Camel 2.10: Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. This option allows you to share a thread pool among multiple consumers.

    greedy

    false

    Camel 2.10.6/2.11.1:

    *

    If

    greedy

    is

    enabled,

    then

    the

    ScheduledPollConsumer

    will

    run

    immediately

    again,

    if

    the

    previous

    run

    polled

    1

    or

    more

    messages.

    | | {{scheduler}} | {{null}} | *Camel

    scheduler

    null

    Camel 2.12:

    *

    Allow

    to

    plugin

    a

    custom

    {{

    org.apache.camel.spi.ScheduledPollConsumerScheduler

    }}

    to

    use

    as

    the

    scheduler

    for

    firing

    when

    the

    polling

    consumer

    runs.

    The

    default

    implementation

    uses

    the

    {{

    ScheduledExecutorService

    }}

    and

    there

    is

    a

    []

    ,

    and

    []

    based

    which

    supports

    CRON

    expressions.

    *

    Notice:

    *

    If

    using

    a

    custom

    scheduler

    then

    the

    options

    for

    {{

    initialDelay

    }}

    ,

    {{

    useFixedDelay

    }}

    ,

    {{

    timeUnit

    }}

    ,

    and

    {{

    scheduledExecutorService

    }}

    may

    not

    be

    in

    use.

    Use

    the

    text {{quartz2}} to refer to use the [Quartz2] scheduler; and use the text {{spring}} to use the [Spring] based; and use the text {{#myScheduler}} to refer to a custom scheduler by its id in the [Registry]. See [Quartz2] page for an example. | | {{scheduler.xxx}} | {{null}} | *Camel 2.12:* To configure additional properties when using a custom {{scheduler}} or any of the [Quartz2], [Spring] based scheduler. | | {{backoffMultiplier}} | {{0}} | *Camel 2.12:* 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. | | {{backoffIdleThreshold}} | {{0}} | *Camel 2.12:* The number of subsequent idle polls that should happen before the {{backoffMultipler}} should kick-in. | | {{backoffErrorThreshold}} | {{0}} | *Camel 2.12:* The number of subsequent error polls (failed due some error) that should happen before the {{backoffMultipler}} should kick-in. | {div}

    text quartz2 to refer to use the Quartz2 scheduler; and use the text spring to use the Spring based; and use the text #myScheduler to refer to a custom scheduler by its id in the Registry. See Quartz2 page for an example.

    scheduler.xxx

    null

    Camel 2.12: To configure additional properties when using a custom scheduler or any of the Quartz2, Spring based scheduler.

    backoffMultiplier

    0

    Camel 2.12: 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.

    backoffIdleThreshold

    0

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

    backoffErrorThreshold

    0

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

    Using backoff to let the scheduler be less aggressive

    ...