Page History

h2. Quartz2 Component

*Available as of Camel 2.12.0*

The *quartz2:* component provides a scheduled delivery of messages using the [Quartz Scheduler 2.x |http://www.quartz-scheduler.org/]. 
Each endpoint represents a different timer (in Quartz terms, a Trigger and JobDetail).

Maven users will need to add the following dependency to their {{pom.xml}} for this component:
{code:xml}
<dependency>
    <groupId>org.apache.camel</groupId>
    <artifactId>camel-quartz2</artifactId>
    <version>x.x.x</version>
    <!-- use the same version as your Camel core version -->
</dependency>
{code}

*NOTE:* Quartz 2.x API is not compatible with Quartz 1.x. If you need to remain on old Quartz 1.x, please
use the old [Quartz] component instead.

h3. URI format

{code}
quartz2://timerName?options
quartz2://groupName/timerName?options
quartz2://groupName/timerName?cron=expression
quartz2://timerName?cron=expression
{code}

The component uses either a {{CronTrigger}} or a {{SimpleTrigger}}. If no cron expression is provided, the component uses a simple trigger. If no {{groupName}} is provided, the quartz component uses the {{Camel}} group name.

You can append query options to the URI in the following format, {{?option=value&option=value&...}}

h3. Options
{div:class=confluenceTableSmall}
|| Parameter || Default || Description ||
| {{cron}} | _None_ | Specifies a {{cron}} expression (not compatible with the {{trigger.\*}} or {{job.\*}} options). |
| {{trigger.repeatCount}} | {{0}} | SimpleTrigger: How many times should the timer repeat? |
| {{trigger.repeatInterval}} | {{0}} | SimpleTrigger: The amount of time in milliseconds between repeated triggers. |
| {{job.name}} | {{null}} | Sets the job name. |
| {{job._XXX_}} | {{null}} | Sets the job option with the {{_XXX_}} setter name. |
| {{trigger._XXX_}} | {{null}} | Sets the trigger option with the {{_XXX_}} setter name. |
| {{stateful}} | {{false}} | Uses a Quartz {{@PersistJobDataAfterExecution}} and {{@DisallowConcurrentExecution}} instead of the default job. |
| {{fireNow}} | {{false}} | If it is true will fire the trigger when the route is start when using SimpleTrigger.|
| {{deleteJob}} | {{true}} | If set to true, then the trigger automatically delete when route stop. Else if set to false, it will remain in scheduler. When set to false, it will also mean user may reuse pre-configured trigger with camel Uri. Just ensure the names match. |
{div}

For example, the following routing rule will fire two timer events to the {{mock:results}} endpoint:

{code}
from("quartz2://myGroup/myTimerName?trigger.repeatInterval=2&trigger.repeatCount=1").routeId("myRoute").to("mock:result");
{code}

When using {{stateful=true}}, the [JobDataMap|http://quartz-scheduler.org/api/2.0.0/org/quartz/JobDataMap.html] is re-persisted after every execution of the job, thus preserving state for the next execution.

{info:title=Running in OSGi and having multiple bundles with quartz routes}
If you run in OSGi such as Apache ServiceMix, or Apache Karaf, and have multiple bundles with Camel routes that start from [Quartz2] endpoints, then make sure if you assign
an {{id}} to the <camelContext> that this id is unique, as this is required by the {{QuartzScheduler}} in the OSGi container. If you do not set any {{id}} on <camelContext> then
a unique id is auto assigned, and there is no problem.
{info}

h3. Configuring quartz.properties file

By default Quartz will look for a {{quartz.properties}} file in the {{org/quartz}} directory of the classpath. If you are using WAR deployments this means just drop the quartz.properties in {{WEB-INF/classes/org/quartz}}.

However the Camel [Quartz2] component also allows you to configure properties:
{div:class=confluenceTableSmall}
|| Parameter || Default || Type || Description ||
| {{properties}} | {{null}} | {{Properties}} | You can configure a {{java.util.Properties}} instance. |
| {{propertiesFile}} | {{null}} | {{String}} | File name of the properties to load from the classpath |
{div}

To do this you can configure this in Spring XML as follows

{code:xml}
<bean id="quartz" class="org.apache.camel.component.quartz2.QuartzComponent">
    <property name="propertiesFile" value="com/mycompany/myquartz.properties"/>
</bean>
{code}


h3. Starting the Quartz scheduler

The [Quartz2] component offers an option to let the Quartz scheduler be started delayed, or not auto started at all.
{div:class=confluenceTableSmall}
|| Parameter || Default || Type || Description ||
| {{startDelayedSeconds}} | {{0}} | {{int}} | Seconds to wait before starting the quartz scheduler. |
| {{autoStartScheduler}} | {{true}} | {{boolean}} | Whether or not the scheduler should be auto started. |
{div}

To do this you can configure this in Spring XML as follows

{code:xml}
<bean id="quartz" class="org.apache.camel.component.quartz2.QuartzComponent">
    <property name="startDelayedSeconds" value="5"/>
</bean>
{code}


h3. Clustering

If you use Quartz in clustered mode, e.g. the {{JobStore}} is clustered. Then the [Quartz2] component will *not* pause/remove triggers when a node is being stopped/shutdown. This allows the trigger to keep running on the other nodes in the cluster.

*Note*: When running in clustered node no checking is done to ensure unique job name/group for endpoints. 


h3. Message Headers
Camel adds the getters from the Quartz Execution Context as header values. The following headers are added:
{{calendar}}, {{fireTime}}, {{jobDetail}}, {{jobInstance}}, {{jobRuntTime}}, {{mergedJobDataMap}}, {{nextFireTime}}, {{previousFireTime}}, {{refireCount}}, {{result}}, {{scheduledFireTime}}, {{scheduler}}, {{trigger}}, {{triggerName}}, {{triggerGroup}}.

The {{fireTime}} header contains the {{java.util.Date}} of when the exchange was fired.

h3. Using Cron Triggers
Quartz supports [Cron-like expressions|http://www.quartz-scheduler.org/documentation/quartz-2.1.x/tutorials/crontrigger] for specifying timers in a handy format. You can use these expressions in the {{cron}} URI parameter; though to preserve valid URI encoding we allow + to be used instead of spaces. Quartz provides a [little tutorial|http://www.quartz-scheduler.org/docs/tutorials/crontrigger.html] on how to use cron expressions.

For example, the following will fire a message every five minutes starting at 12pm (noon) to 6pm on weekdays:
{code}
from("quartz2://myGroup/myTimerName?cron=0+0/5+12-18+?+*+MON-FRI").to("activemq:Totally.Rocks");
{code}

which is equivalent to using the cron expression
{code}
0 0/5 12-18 ? * MON-FRI
{code}

The following table shows the URI character encodings we use to preserve valid URI syntax:
{div:class=confluenceTableSmall}
||URI Character||Cron character||
| {{\+}} | _Space_ |
{div}

h3. Specifying time zone

The Quartz Scheduler allows you to configure time zone per trigger. For example to use a timezone of your country, then you can do as follows:
{code}
quartz2://groupName/timerName?cron=0+0/5+12-18+?+*+MON-FRI&trigger.timeZone=Europe/Stockholm
{code}

The timeZone value is the values accepted by {{java.util.TimeZone}}.


h2. Using QuartzScheduledPollConsumerScheduler

The [Quartz2] component provides a [Polling Consumer] scheduler which allows to use cron based scheduling for [Polling Consumers] such as the [File|File2] and [FTP|FTP2] consumers.

For example to use a cron based expression to poll for files every 2nd second, then a Camel route can be define simply as:
{code}
    from("file:inbox?scheduler=quartz2&scheduler.cron=0/2+*+*+*+*+?")
       .to("bean:process");
{code}

Notice we define the {{scheduler=quartz2}} to instruct Camel to use the [Quartz2] based scheduler. Then we use {{scheduler.xxx}} options to configure the scheduler. The [Quart2] scheduler requires the cron option to be set. 

The following options is supported:

{div:class=confluenceTableSmall}
|| Parameter || Default || Type || Description ||
| {{quartzScheduler}} | {{null}} | {{org.quartz.Scheduler}} | To use a custom Quartz scheduler. If none configure then the shared scheduler from the [Quartz2] component is used. |
| {{cron}} | {{null}} | {{String}} | *Mandatory*: To define the cron expression for triggering the polls. |
| {{triggerId}} | {{null}} | {{String}} | To specify the trigger id. If none provided then an UUID is generated and used. |
| {{triggerGroup}} | {{QuartzScheduledPollConsumerScheduler}} | {{String}} | To specify the trigger group. |
{div}


{include:Endpoint See Also}
* [Quartz]
* [Timer]