Timer Component
The timer: component is used to generate message exchanges when a timer fires You can only consume events from this endpoint.
URI format
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.
You can append query options to the URI in the following format, ?option=value&option=value&...
Note: The IN body of the generated exchange is null
. So exchange.getIn().getBody()
returns null
.
Advanced Scheduler
See also the Quartz component that supports much more advanced scheduling.
Options
Name |
Default Value |
Description |
---|---|---|
|
|
A |
|
|
Camel 1.6.2/2.0: Allows you to specify a custom |
|
|
If greater than 0, generate periodic events every |
|
|
The number of milliseconds to wait before the first event is generated. Should not be used in conjunction with the |
|
|
Events take place at approximately regular intervals, separated by the specified period. |
|
|
Specifies whether or not the thread associated with the timer endpoint runs as a daemon. |
Exchange Properties
When the timer is fired, it adds the following information as properties to the Exchange
:
Name |
Type |
Description |
---|---|---|
|
|
The value of the |
|
|
The value of the |
|
|
The value of the |
|
|
Camel 1.5: The time when the consumer fired. |
Message Headers
When the timer is fired, it adds the following information as headers to the IN message
Name |
Type |
Description |
---|---|---|
|
|
Camel 1.5: The time when the consumer fired |
Sample
To set up a route that generates an event every 60 seconds:
from("timer://foo?fixedRate=true&period=60000").to("bean:myBean?method=someMethodName");
The above route will generate an event and then invoke the someMethodName
method on the bean called myBean
in the Registry such as JNDI or Spring.
And the route in Spring DSL:
<route> <from uri="timer://foo?fixedRate=true&period=60000"/> <to uri="bean:myBean?method=someMethodName"/> </route>