Scheduler

Scheduler Component

Available as of Camel 2.15

The scheduler: component is used to generate message exchanges when a scheduler fires. This component is similar to the Timer component, but it offers more functionality in terms of scheduling. Also this component uses JDK ScheduledExecutorService. Where as the timer uses a JDK Timer.

You can only consume events from this endpoint.

URI format

scheduler:name[?options]

Where name is the name of the scheduler, which is created and shared across endpoints. So if you use the same name for all your timer endpoints, only one scheduler thread pool and thread will be used - but you can configure the thread pool to allow more concurrent threads.

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
initialDelay	1000	Milliseconds before the first poll starts
`period`	`1000`	If greater than 0, generate periodic events every `period` milliseconds.
`delay`	`500`	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.

Exchange Properties

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

Name	Type	Description
`Exchange.TIMER_NAME`	`String`	The value of the `name` option.
`Exchange.TIMER_TIME`	`Date`	The value of the `time` option.
`Exchange.TIMER_PERIOD`	`long`	The value of the `period` option.
`Exchange.TIMER_FIRED_TIME`	`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
`Exchange.TIMER_FIRED_TIME`	`java.util.Date`	The time when the consumer fired

Sample

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

   from("scheduler://foo?period=60s").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="scheduler://foo?period=60s"/>
    <to uri="bean:myBean?method=someMethodName"/>
  </route>

Child pages