Versions Compared

Old Version 32

changes.mady.by.user Glen Mazza

Saved on

compared with

New Version Current

changes.mady.by.user James Green

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The timer: component is used to generate message exchanges when a timer fires You can only consume events from this endpoint.

URI format

Code Block

timer:name[?options]

Where name is the name of the Timer object, which is created and shared across endpoints. So if you use the same name for all your timer endpoints, only one Timer object and thread will be used.

...

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.
You can also specify time values using units, such as 60s (60 seconds), 5m30s (5 minutes and 30 seconds), and 1h (1 hour).

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.
You can also specify time values using units, such as 60s (60 seconds), 5m30s (5 minutes and 30 seconds), and 1h (1 hour). 
Before Camel 2.11 the default value is 0
From Camel 2.11 the default value is 1000
From Camel 2.17 it is possible to specify a negative delay. In this scenario the timer will generate and fire events as soon as possible.

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:

Code Block
java
java

   from("timer://foo?fixedRate=true&period=60000").to("bean:myBean?method=someMethodName");

...

And the route in Spring DSL:

Code Block
xml
xml

  <route>
    <from uri="timer://foo?fixedRate=true&amp;period=60000"/>
    <to uri="bean:myBean?method=someMethodName"/>
  </route>

Firing as soon as possible

Available as of Camel 2.17

You may want to fire messages in a Camel route as soon as possible you can use a negative delay:

Code Block
xml
xml
  <route>
    <from uri="timer://foo?delay=-1"/>
    <to uri="bean:myBean?method=someMethodName"/>
  </route>

In this way the timer will fire messages immediately.

You can also specify a repeatCount parameter in conjunction with a negative delay to stop firing messages after a fixed number has been reached.

If you don't specify a repeatCount then the timer will continue firing messages until the route will be stopped. 

Firing only once

Available as of Camel 2.8

You may want to fire a message in a Camel route only once, such as when starting the route. To do that you use the repeatCount option as shown:

Code Block
xml
xml

  <route>
    <from uri="timer://foo?repeatCount=1"/>
    <to uri="bean:myBean?method=someMethodName"/>
  </route>

Include Page
Endpoint See Also
Endpoint See Also