Camel Component: Timer - 6.3

Talend ESB Mediation Developer Guide

EnrichVersion
6.3
EnrichProdName
Talend Data Fabric
Talend Data Services Platform
Talend ESB
Talend MDM Platform
Talend Open Studio for ESB
Talend Real-Time Big Data Platform
task
Design and Development
EnrichPlatform
Talend ESB

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.

Note

See also the Camel Component: Quartz component that supports much more advanced scheduling.

Note

You can specify the time in human friendly syntax.

Options

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. Starting with Camel 2.11 the default value is 1000, versions prior to that 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.

Exchange Properties

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

Name

Type

Description

org.apache.camel.timer.name

String

The value of the name option.

org.apache.camel.timer.time

Date

The value of the time option.

org.apache.camel.timer.period

long

The value of the period option.

org.apache.camel.timer. firedTime

Date

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

firedTime

java.util.Date

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&amp;period=60000"/>
   <to uri="bean:myBean?method=someMethodName"/>
</route>