...
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 options is a query string that can specify any of the following parameters:
...
Name
...
Default Value
...
Description
...
name
...
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
.
Tip | ||
---|---|---|
| ||
See also the Quartz component that supports much more advanced scheduling. |
Tip | ||
---|---|---|
| ||
In Camel 2.3 onwards you can specify the time |
...
...
The date/time that the (first) event should be generated.
Options
Div | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||
|
...
period
...
-1
...
|
...
delay
|
...
|
...
|
...
|
...
|
Using
|
Exchange Properties
When the timer is fired, it adds the following information as properties to the Exchange
:
Div | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
|
Message Headers
When the timer is fired, it adds the following information as headers to the IN message
Div | ||||||
---|---|---|---|---|---|---|
| ||||||
|
Sample
To set up To setup a route that generates an event every 500 60 seconds:
Code Block | ||||
---|---|---|---|---|
| ||||
from("timer://foo?fixedRate=true&delay=0&period=50060000").to("bean:myBean?methodNamemethod=someMethodName"); |
Tip |
---|
Instead of 60000 you can use period=60s which is more friendly to read. |
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:
Code Block | ||||
---|---|---|---|---|
| ||||
<route>
<from uri="timer://foo?fixedRate=true&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 | ||||
---|---|---|---|---|
| ||||
<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 | ||||
---|---|---|---|---|
| ||||
<route>
<from uri="timer://foo?repeatCount=1"/>
<to uri="bean:myBean?method=someMethodName"/>
</route>
|
...
Include Page | |
---|---|
|
...
|