org.apache.camel.component.quartz

Class QuartzEndpoint

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.impl.DefaultEndpoint

org.apache.camel.component.quartz.QuartzEndpoint

All Implemented Interfaces:

org.apache.camel.CamelContextAware, org.apache.camel.Endpoint, org.apache.camel.IsSingleton, org.apache.camel.Service, org.apache.camel.ShutdownableService, org.apache.camel.spi.HasId, org.apache.camel.StatefulService, org.apache.camel.SuspendableService

@UriEndpoint(firstVersion="1.0.0",
             scheme="quartz",
             title="Quartz",
             syntax="quartz:groupName/timerName",
             consumerOnly=true,
             consumerClass=QuartzConsumer.class,
             label="scheduling")
public class QuartzEndpoint
extends org.apache.camel.impl.DefaultEndpoint
implements org.apache.camel.ShutdownableService

Provides a scheduled delivery of messages using the Quartz 1.x scheduler.

Field Summary

Fields inherited from class org.apache.camel.support.ServiceSupport

shutdown, shuttingdown, starting, stopped, stopping, suspended, suspending

Constructor Summary

Constructors

Constructor and Description
QuartzEndpoint(String endpointUri, QuartzComponent component)

Method Summary

Modifier and Type	Method and Description
void	addTrigger(org.quartz.Trigger trigger, org.quartz.JobDetail detail)
void	consumerStarted(QuartzConsumer consumer)
void	consumerStopped(QuartzConsumer consumer)
QuartzConsumer	createConsumer(org.apache.camel.Processor processor)
protected String	createEndpointUri()
org.apache.camel.Exchange	createExchange(org.quartz.JobExecutionContext jobExecutionContext)
protected org.apache.camel.processor.loadbalancer.LoadBalancer	createLoadBalancer()
org.apache.camel.Producer	createProducer()
void	deleteTrigger(org.quartz.Trigger trigger)
protected void	doShutdown()
protected void	doStart()
protected void	doStop()
QuartzComponent	getComponent()
String	getCron()
String	getGroupName()
org.quartz.JobDetail	getJobDetail()
protected String	getJobName()
Map<String,Object>	getJobParameters()
org.apache.camel.processor.loadbalancer.LoadBalancer	getLoadBalancer()
int	getStartDelayedSeconds()
String	getTimerName()
org.quartz.Trigger	getTrigger()
Map<String,Object>	getTriggerParameters()
boolean	isDeleteJob()
boolean	isFireNow()
boolean	isPauseJob()
boolean	isSingleton()
boolean	isStateful()
boolean	isUsingFixedCamelContextName()
void	onJobExecute(org.quartz.JobExecutionContext jobExecutionContext) This method is invoked when a Quartz job is fired.
void	pauseTrigger(org.quartz.Trigger trigger)
void	setCron(String cron) Specifies a cron expression to define when to trigger.
void	setDeleteJob(boolean deleteJob) If set to true, then the trigger automatically delete when route stop.
void	setFireNow(boolean fireNow) Whether to fire the scheduler asap when its started using the simple trigger (this option does not support cron)
void	setGroupName(String groupName) The quartz group name to use.
void	setJobDetail(org.quartz.JobDetail jobDetail)
void	setJobParameters(Map<String,Object> jobParameters) To configure additional options on the job.
void	setLoadBalancer(org.apache.camel.processor.loadbalancer.LoadBalancer loadBalancer)
void	setPauseJob(boolean pauseJob) If set to true, then the trigger automatically pauses when route stop.
void	setStartDelayedSeconds(int startDelayedSeconds) Seconds to wait before starting the quartz scheduler.
void	setStateful(boolean stateful) Uses a Quartz StatefulJob instead of the default job.
void	setTimerName(String timerName) The quartz timer name to use.
void	setTrigger(org.quartz.Trigger trigger)
void	setTriggerParameters(Map<String,Object> triggerParameters) To configure additional options on the trigger.
void	setUsingFixedCamelContextName(boolean usingFixedCamelContextName) If it is true, JobDataMap uses the CamelContext name directly to reference the CamelContext, if it is false, JobDataMap uses use the CamelContext management name which could be changed during the deploy time.

Methods inherited from class org.apache.camel.impl.DefaultEndpoint

configureConsumer, configurePollingConsumer, configureProperties, createEndpointConfiguration, createExchange, createExchange, createExchange, createPollingConsumer, equals, getCamelContext, getConsumerProperties, getEndpointConfiguration, getEndpointKey, getEndpointUri, getExceptionHandler, getExchangePattern, getId, getPollingConsumerBlockTimeout, getPollingConsumerQueueSize, hashCode, isBridgeErrorHandler, isLenientProperties, isPollingConsumerBlockWhenFull, isSynchronous, setBridgeErrorHandler, setCamelContext, setConsumerProperties, setEndpointConfiguration, setEndpointUri, setEndpointUriIfNotSpecified, setExceptionHandler, setExchangePattern, setPollingConsumerBlockTimeout, setPollingConsumerBlockWhenFull, setPollingConsumerQueueSize, setProperties, setSynchronous, toString

Methods inherited from class org.apache.camel.support.ServiceSupport

doResume, doSuspend, getStatus, getVersion, isRunAllowed, isStarted, isStarting, isStopped, isStopping, isStoppingOrStopped, isSuspended, isSuspending, isSuspendingOrSuspended, resume, shutdown, start, stop, suspend

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.camel.ShutdownableService

shutdown

Methods inherited from interface org.apache.camel.Service

start, stop

Constructor Detail

QuartzEndpoint

public QuartzEndpoint(String endpointUri,
                      QuartzComponent component)

Method Detail

addTrigger

public void addTrigger(org.quartz.Trigger trigger,
                       org.quartz.JobDetail detail)
                throws org.quartz.SchedulerException

Throws:

org.quartz.SchedulerException

pauseTrigger

public void pauseTrigger(org.quartz.Trigger trigger)
                  throws org.quartz.SchedulerException

Throws:

org.quartz.SchedulerException

deleteTrigger

public void deleteTrigger(org.quartz.Trigger trigger)
                   throws org.quartz.SchedulerException

Throws:

org.quartz.SchedulerException

onJobExecute

public void onJobExecute(org.quartz.JobExecutionContext jobExecutionContext)
                  throws org.quartz.JobExecutionException

This method is invoked when a Quartz job is fired.

Parameters:

jobExecutionContext - the Quartz Job context

Throws:

org.quartz.JobExecutionException

createExchange

public org.apache.camel.Exchange createExchange(org.quartz.JobExecutionContext jobExecutionContext)

createProducer

public org.apache.camel.Producer createProducer()
                                         throws Exception

Specified by:

createProducer in interface org.apache.camel.Endpoint

Throws:

Exception

createConsumer

public QuartzConsumer createConsumer(org.apache.camel.Processor processor)
                              throws Exception

Specified by:

createConsumer in interface org.apache.camel.Endpoint

Throws:

Exception

createEndpointUri

protected String createEndpointUri()

Overrides:

createEndpointUri in class org.apache.camel.impl.DefaultEndpoint

getJobName

protected String getJobName()

getComponent

public QuartzComponent getComponent()

Overrides:

getComponent in class org.apache.camel.impl.DefaultEndpoint

isSingleton

public boolean isSingleton()

Specified by:

isSingleton in interface org.apache.camel.IsSingleton

getLoadBalancer

public org.apache.camel.processor.loadbalancer.LoadBalancer getLoadBalancer()

getGroupName

public String getGroupName()

setGroupName

public void setGroupName(String groupName)

The quartz group name to use. The combination of group name and timer name should be unique.

getTimerName

public String getTimerName()

setTimerName

public void setTimerName(String timerName)

The quartz timer name to use. The combination of group name and timer name should be unique.

getCron

public String getCron()

setCron

public void setCron(String cron)

Specifies a cron expression to define when to trigger.

setLoadBalancer

public void setLoadBalancer(org.apache.camel.processor.loadbalancer.LoadBalancer loadBalancer)

getJobDetail

public org.quartz.JobDetail getJobDetail()

setJobDetail

public void setJobDetail(org.quartz.JobDetail jobDetail)

getTrigger

public org.quartz.Trigger getTrigger()

setTrigger

public void setTrigger(org.quartz.Trigger trigger)

isStateful

public boolean isStateful()

setStateful

public void setStateful(boolean stateful)

Uses a Quartz StatefulJob instead of the default job.

isDeleteJob

public boolean isDeleteJob()

setDeleteJob

public void setDeleteJob(boolean deleteJob)

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. Notice you cannot have both deleteJob and pauseJob set to true.

isPauseJob

public boolean isPauseJob()

setPauseJob

public void setPauseJob(boolean pauseJob)

If set to true, then the trigger automatically pauses 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. Notice you cannot have both deleteJob and pauseJob set to true.

isFireNow

public boolean isFireNow()

setFireNow

public void setFireNow(boolean fireNow)

Whether to fire the scheduler asap when its started using the simple trigger (this option does not support cron)

getStartDelayedSeconds

public int getStartDelayedSeconds()

setStartDelayedSeconds

public void setStartDelayedSeconds(int startDelayedSeconds)

Seconds to wait before starting the quartz scheduler.

isUsingFixedCamelContextName

public boolean isUsingFixedCamelContextName()

setUsingFixedCamelContextName

public void setUsingFixedCamelContextName(boolean usingFixedCamelContextName)

If it is true, JobDataMap uses the CamelContext name directly to reference the CamelContext, if it is false, JobDataMap uses use the CamelContext management name which could be changed during the deploy time.

getTriggerParameters

public Map<String,Object> getTriggerParameters()

setTriggerParameters

public void setTriggerParameters(Map<String,Object> triggerParameters)

To configure additional options on the trigger.

getJobParameters

public Map<String,Object> getJobParameters()

setJobParameters

public void setJobParameters(Map<String,Object> jobParameters)

To configure additional options on the job.

consumerStarted

public void consumerStarted(QuartzConsumer consumer)
                     throws org.quartz.SchedulerException

Throws:

org.quartz.SchedulerException

consumerStopped

public void consumerStopped(QuartzConsumer consumer)
                     throws org.quartz.SchedulerException

Throws:

org.quartz.SchedulerException

createLoadBalancer

protected org.apache.camel.processor.loadbalancer.LoadBalancer createLoadBalancer()

doStart

protected void doStart()
                throws Exception

Overrides:

doStart in class org.apache.camel.impl.DefaultEndpoint

Throws:

Exception

doStop

protected void doStop()
               throws Exception

Overrides:

doStop in class org.apache.camel.impl.DefaultEndpoint

Throws:

Exception

doShutdown

protected void doShutdown()
                   throws Exception

Overrides:

doShutdown in class org.apache.camel.support.ServiceSupport

Throws:

Exception