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

...

Tip
titleSpecify time in human friendly format

In Camel 2.3 onwards you can specify the time in human friendly syntax.

Options

Div
classconfluenceTableSmall
Wiki Markup
{div:class=confluenceTableSmall} || Name || Default Value || Description || | {{time}} | {{null}} | A {{

Name

Default Value

Description

time

null

A

java.util.Date

}}

the

*

first

*

event

should

be

generated.

If

using

the

URI,

the

pattern

expected

is:

{{

yyyy-MM-dd

HH:mm:ss

}}

or

{{

yyyy-MM-dd'T'HH:mm:ss

}}. | | {{pattern}} | {{null}} | Allows you to specify a custom {{Date}} pattern to use for setting the time option using URI syntax. | | {{period}} | {{1000}} | If greater than 0, generate periodic events every {{period}} milliseconds. | | {{delay}} | {{0}} / {{1000}} | The number of milliseconds to wait before the first event is generated. Should not be used in conjunction with the {{time}} option. The default value has been changed to {{1000}} from *Camel 2.11* onwards. In older releases the default value is {{0}}. | | {{fixedRate}} | {{false}} | Events take place at approximately regular intervals, separated by the specified period. | | {{daemon}} | {{true}} | Specifies whether or not the thread associated with the timer endpoint runs as a daemon. | | {{repeatCount}} | {{0}} | *Camel 2.8:* Specifies a maximum limit of number of fires. So if you set it to 1, the timer 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. | {div}

.

pattern

null

Allows you to specify a custom Date pattern to use for setting the time option using URI syntax.

period

1000

If greater than 0, generate periodic events every period milliseconds.

delay

0 / 1000

The number of milliseconds to wait before the first event is generated. Should not be used in conjunction with the time option. The default value has been changed to 1000 from Camel 2.11 onwards. In older releases the default value is 0.

fixedRate

false

Events take place at approximately regular intervals, separated by the specified period.

daemon

true

Specifies whether or not the thread associated with the timer endpoint runs as a daemon.

repeatCount

0

Camel 2.8: Specifies a maximum limit of number of fires. So if you set it to 1, the timer 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.

Exchange Properties

When the timer is fired, it adds the following information as properties to the Exchange:

Div
classconfluenceTableSmall
Wiki Markup
{div:class=confluenceTableSmall} || Name || Type || Description || | {{

Name

Type

Description

Exchange.TIMER_NAME

}} | {{String}} | The value of the {{name}} option. | | {{

String

The value of the name option.

Exchange.TIMER_TIME

}} | {{Date}} | The value of the {{time}} option. | | {{

Date

The value of the time option.

Exchange.TIMER_PERIOD

}} | {{long}} | The value of the {{period}} option. | | {{

long

The value of the period option.

Exchange.TIMER_FIRED_TIME

}} | {{Date}} | The time when the consumer fired. | | {{

Date

The time when the consumer fired.

Exchange.TIMER_COUNTER

}} | {{Long}} | *Camel

Long

Camel 2.8:

*

The

current

fire

counter.

Starts

from

1.

| {div}

Message Headers

When the timer is fired, it adds the following information as headers to the IN message

Div
classconfluenceTableSmall
Wiki Markup
{div:class=confluenceTableSmall} || Name || Type || Description || | {{

Name

Type

Description

Exchange.TIMER_FIRED_TIME

}} | {{

java.util.Date

}} |

The

time

when

the

consumer

fired

| {div}

Sample

To set up a route that generates an event every 60 seconds:

...