|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.terracotta.quartz.AbstractTerracottaJobStore
public abstract class AbstractTerracottaJobStore
| Field Summary | |
|---|---|
static String |
TC_CONFIG_PROP
|
static String |
TC_CONFIGURL_PROP
|
static String |
TC_REJOIN_PROP
|
| Constructor Summary | |
|---|---|
AbstractTerracottaJobStore()
|
|
| Method Summary | |
|---|---|
List<OperableTrigger> |
acquireNextTriggers(long noLaterThan,
int maxCount,
long timeWindow)
Get a handle to the next trigger to be fired, and mark it as 'reserved' by the calling scheduler. |
boolean |
checkExists(JobKey jobKey)
Determine whether a Job with the given identifier already
exists within the scheduler. |
boolean |
checkExists(TriggerKey triggerKey)
Determine whether a Trigger with the given identifier already
exists within the scheduler. |
void |
clearAllSchedulingData()
Clear (delete!) all scheduling data - all Jobs, Triggers
Calendars. |
List<String> |
getCalendarNames()
Get the names of all of the s
in the JobStore. |
long |
getEstimatedTimeToReleaseAndAcquireTrigger()
How long (in milliseconds) the JobStore implementation
estimates that it will take to release a trigger and acquire a new one. |
List<String> |
getJobGroupNames()
Get the names of all of the
groups. |
Set<JobKey> |
getJobKeys(GroupMatcher<JobKey> matcher)
Get the keys of all of the s that
have the given group name. |
int |
getNumberOfCalendars()
Get the number of s that are
stored in the JobsStore. |
int |
getNumberOfJobs()
Get the number of s that are
stored in the JobsStore. |
int |
getNumberOfTriggers()
Get the number of s that are
stored in the JobsStore. |
Set<String> |
getPausedTriggerGroups()
|
protected TerracottaJobStoreExtensions |
getRealJobStore()
|
List<String> |
getTriggerGroupNames()
Get the names of all of the
groups. |
Set<TriggerKey> |
getTriggerKeys(GroupMatcher<TriggerKey> matcher)
Get the names of all of the s
that have the given group name. |
List<OperableTrigger> |
getTriggersForJob(JobKey jobKey)
Get all of the Triggers that are associated to the given Job. |
Trigger.TriggerState |
getTriggerState(TriggerKey triggerKey)
Get the current state of the identified . |
String |
getUUID()
|
void |
initialize(ClassLoadHelper loadHelper,
SchedulerSignaler signaler)
Called by the QuartzScheduler before the JobStore is
used, in order to give the it a chance to initialize. |
boolean |
isClustered()
Whether or not the JobStore implementation is clustered. |
void |
pauseAll()
Pause all triggers - equivalent of calling pauseTriggerGroup(group)
on every group. |
void |
pauseJob(JobKey jobKey)
Pause the with the given name - by
pausing all of its current Triggers. |
Collection<String> |
pauseJobs(GroupMatcher<JobKey> matcher)
Pause all of the in the given
group - by pausing all of their Triggers. |
void |
pauseTrigger(TriggerKey triggerKey)
Pause the with the given key. |
Collection<String> |
pauseTriggers(GroupMatcher<TriggerKey> matcher)
Pause all of the in the
given group. |
void |
releaseAcquiredTrigger(OperableTrigger trigger)
Inform the JobStore that the scheduler no longer plans to
fire the given Trigger, that it had previously acquired
(reserved). |
boolean |
removeCalendar(String calName)
Remove (delete) the with the
given name. |
boolean |
removeJob(JobKey jobKey)
Remove (delete) the with the given
key, and any s that reference
it. |
boolean |
removeJobs(List<JobKey> arg0)
|
boolean |
removeTrigger(TriggerKey triggerKey)
Remove (delete) the with the
given key. |
boolean |
removeTriggers(List<TriggerKey> arg0)
|
boolean |
replaceTrigger(TriggerKey triggerKey,
OperableTrigger newTrigger)
Remove (delete) the with the
given key, and store the new given one - which must be associated
with the same job. |
void |
resumeAll()
Resume (un-pause) all triggers - equivalent of calling resumeTriggerGroup(group)
on every group. |
void |
resumeJob(JobKey jobKey)
Resume (un-pause) the with the
given key. |
Collection<String> |
resumeJobs(GroupMatcher<JobKey> matcher)
Resume (un-pause) all of the in
the given group. |
void |
resumeTrigger(TriggerKey triggerKey)
Resume (un-pause) the with the
given key. |
Collection<String> |
resumeTriggers(GroupMatcher<TriggerKey> matcher)
Resume (un-pause) all of the
in the given group. |
Calendar |
retrieveCalendar(String calName)
Retrieve the given . |
JobDetail |
retrieveJob(JobKey jobKey)
Retrieve the for the given
. |
OperableTrigger |
retrieveTrigger(TriggerKey triggerKey)
Retrieve the given . |
void |
schedulerPaused()
Called by the QuartzScheduler to inform the JobStore that
the scheduler has been paused. |
void |
schedulerResumed()
Called by the QuartzScheduler to inform the JobStore that
the scheduler has resumed after being paused. |
void |
schedulerStarted()
Called by the QuartzScheduler to inform the JobStore that
the scheduler has started. |
void |
setEstimatedTimeToReleaseAndAcquireTrigger(long estimate)
|
void |
setInstanceId(String schedInstId)
Inform the JobStore of the Scheduler instance's Id,
prior to initialize being invoked. |
void |
setInstanceName(String schedName)
Inform the JobStore of the Scheduler instance's name,
prior to initialize being invoked. |
void |
setMisfireThreshold(long threshold)
|
void |
setRejoin(String rejoin)
|
void |
setSynchronousWrite(String synchWrite)
|
void |
setTcConfig(String tcConfig)
|
void |
setTcConfigUrl(String tcConfigUrl)
|
void |
setTcRetryInterval(long tcRetryInterval)
|
void |
setThreadPoolSize(int poolSize)
Tells the JobStore the pool size used to execute jobs |
void |
shutdown()
Called by the QuartzScheduler to inform the JobStore that
it should free up all of it's resources because the scheduler is
shutting down. |
void |
storeCalendar(String name,
Calendar calendar,
boolean replaceExisting,
boolean updateTriggers)
Store the given . |
void |
storeJob(JobDetail newJob,
boolean replaceExisting)
Store the given . |
void |
storeJobAndTrigger(JobDetail newJob,
OperableTrigger newTrigger)
Store the given and . |
void |
storeJobsAndTriggers(Map<JobDetail,Set<? extends Trigger>> arg0,
boolean arg1)
|
void |
storeTrigger(OperableTrigger newTrigger,
boolean replaceExisting)
Store the given . |
boolean |
supportsPersistence()
|
void |
triggeredJobComplete(OperableTrigger trigger,
JobDetail jobDetail,
Trigger.CompletedExecutionInstruction instruction)
Inform the JobStore that the scheduler has completed the
firing of the given Trigger (and the execution of its
associated Job completed, threw an exception, or was vetoed),
and that the
in the given JobDetail should be updated if the Job
is stateful. |
List<TriggerFiredResult> |
triggersFired(List<OperableTrigger> triggers)
Inform the JobStore that the scheduler is now firing the
given Trigger (executing its associated Job),
that it had previously acquired (reserved). |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
public static final String TC_CONFIG_PROP
public static final String TC_CONFIGURL_PROP
public static final String TC_REJOIN_PROP
| Constructor Detail |
|---|
public AbstractTerracottaJobStore()
| Method Detail |
|---|
public String getUUID()
public void setMisfireThreshold(long threshold)
public void setTcRetryInterval(long tcRetryInterval)
public List<OperableTrigger> acquireNextTriggers(long noLaterThan,
int maxCount,
long timeWindow)
throws JobPersistenceException
JobStore
acquireNextTriggers in interface JobStorenoLaterThan - If > 0, the JobStore should only return a Trigger
that will fire no later than the time represented in this value as
milliseconds.
JobPersistenceException#releaseAcquiredTrigger(Trigger)
public List<String> getCalendarNames()
throws JobPersistenceException
JobStoreCalendar s
in the JobStore.
If there are no Calendars in the given group name, the result should be
a zero-length array (not null).
getCalendarNames in interface JobStoreJobPersistenceException
public List<String> getJobGroupNames()
throws JobPersistenceException
JobStoreJob
groups.
If there are no known group names, the result should be a zero-length
array (not null).
getJobGroupNames in interface JobStoreJobPersistenceException
public Set<JobKey> getJobKeys(GroupMatcher<JobKey> matcher)
throws JobPersistenceException
JobStoreJob s that
have the given group name.
If there are no jobs in the given group name, the result should be
an empty collection (not null).
getJobKeys in interface JobStoreJobPersistenceException
public int getNumberOfCalendars()
throws JobPersistenceException
JobStoreCalendar s that are
stored in the JobsStore.
getNumberOfCalendars in interface JobStoreJobPersistenceException
public int getNumberOfJobs()
throws JobPersistenceException
JobStoreJob s that are
stored in the JobsStore.
getNumberOfJobs in interface JobStoreJobPersistenceException
public int getNumberOfTriggers()
throws JobPersistenceException
JobStoreTrigger s that are
stored in the JobsStore.
getNumberOfTriggers in interface JobStoreJobPersistenceException
public Set<String> getPausedTriggerGroups()
throws JobPersistenceException
getPausedTriggerGroups in interface JobStoreJobPersistenceException
public List<String> getTriggerGroupNames()
throws JobPersistenceException
JobStoreTrigger
groups.
If there are no known group names, the result should be a zero-length
array (not null).
getTriggerGroupNames in interface JobStoreJobPersistenceException
public Set<TriggerKey> getTriggerKeys(GroupMatcher<TriggerKey> matcher)
throws JobPersistenceException
JobStoreTrigger s
that have the given group name.
If there are no triggers in the given group name, the result should be a
zero-length array (not null).
getTriggerKeys in interface JobStoreJobPersistenceException
public List<OperableTrigger> getTriggersForJob(JobKey jobKey)
throws JobPersistenceException
JobStoreIf there are no matches, a zero-length array should be returned.
getTriggersForJob in interface JobStoreJobPersistenceException
public Trigger.TriggerState getTriggerState(TriggerKey triggerKey)
throws JobPersistenceException
JobStoreTrigger.
getTriggerState in interface JobStoreJobPersistenceExceptionTrigger.TriggerState
public void initialize(ClassLoadHelper loadHelper,
SchedulerSignaler signaler)
throws SchedulerConfigException
JobStoreJobStore is
used, in order to give the it a chance to initialize.
initialize in interface JobStoreSchedulerConfigException
public void pauseAll()
throws JobPersistenceException
JobStorepauseTriggerGroup(group)
on every group.
When resumeAll() is called (to un-pause), trigger misfire
instructions WILL be applied.
pauseAll in interface JobStoreJobPersistenceExceptionJobStore.resumeAll(),
#pauseTriggers(String)
public void pauseJob(JobKey jobKey)
throws JobPersistenceException
JobStoreJob with the given name - by
pausing all of its current Triggers.
pauseJob in interface JobStoreJobPersistenceExceptionJobStore.resumeJob(JobKey)
public Collection<String> pauseJobs(GroupMatcher<JobKey> matcher)
throws JobPersistenceException
JobStoreJobs in the given
group - by pausing all of their Triggers.
The JobStore should "remember" that the group is paused, and impose the pause on any new jobs that are added to the group while the group is paused.
pauseJobs in interface JobStoreJobPersistenceException#resumeJobGroup(String)
public void pauseTrigger(TriggerKey triggerKey)
throws JobPersistenceException
JobStoreTrigger with the given key.
pauseTrigger in interface JobStoreJobPersistenceExceptionJobStore.resumeTrigger(TriggerKey)
public Collection<String> pauseTriggers(GroupMatcher<TriggerKey> matcher)
throws JobPersistenceException
JobStoreTriggers in the
given group.
The JobStore should "remember" that the group is paused, and impose the pause on any new triggers that are added to the group while the group is paused.
pauseTriggers in interface JobStoreJobPersistenceException#resumeTriggerGroup(String)public void releaseAcquiredTrigger(OperableTrigger trigger)
JobStoreJobStore that the scheduler no longer plans to
fire the given Trigger, that it had previously acquired
(reserved).
releaseAcquiredTrigger in interface JobStore
public boolean removeCalendar(String calName)
throws JobPersistenceException
JobStoreCalendar with the
given name.
If removal of the Calendar would result in
Triggers pointing to non-existent calendars, then a
JobPersistenceException will be thrown.
removeCalendar in interface JobStorecalName - The name of the Calendar to be removed.
true if a Calendar with the given name
was found and removed from the store.
JobPersistenceException
public boolean removeJob(JobKey jobKey)
throws JobPersistenceException
JobStoreJob with the given
key, and any Trigger s that reference
it.
If removal of the Job results in an empty group, the
group should be removed from the JobStore's list of
known group names.
removeJob in interface JobStoretrue if a Job with the given name &
group was found and removed from the store.
JobPersistenceException
public boolean removeTrigger(TriggerKey triggerKey)
throws JobPersistenceException
JobStoreTrigger with the
given key.
If removal of the Trigger results in an empty group, the
group should be removed from the JobStore's list of
known group names.
If removal of the Trigger results in an 'orphaned' Job
that is not 'durable', then the Job should be deleted
also.
removeTrigger in interface JobStoretrue if a Trigger with the given
name & group was found and removed from the store.
JobPersistenceException
public boolean replaceTrigger(TriggerKey triggerKey,
OperableTrigger newTrigger)
throws JobPersistenceException
JobStoreTrigger with the
given key, and store the new given one - which must be associated
with the same job.
replaceTrigger in interface JobStorenewTrigger - The new Trigger to be stored.
true if a Trigger with the given
name & group was found and removed from the store.
JobPersistenceException
public void resumeAll()
throws JobPersistenceException
JobStoreresumeTriggerGroup(group)
on every group.
If any Trigger missed one or more fire-times, then the
Trigger's misfire instruction will be applied.
resumeAll in interface JobStoreJobPersistenceExceptionJobStore.pauseAll()
public void resumeJob(JobKey jobKey)
throws JobPersistenceException
JobStoreJob with the
given key.
If any of the Job'sTrigger s missed one
or more fire-times, then the Trigger's misfire
instruction will be applied.
resumeJob in interface JobStoreJobPersistenceExceptionJobStore.pauseJob(JobKey)
public Collection<String> resumeJobs(GroupMatcher<JobKey> matcher)
throws JobPersistenceException
JobStoreJobs in
the given group.
If any of the Job s had Trigger s that
missed one or more fire-times, then the Trigger's
misfire instruction will be applied.
resumeJobs in interface JobStoreJobPersistenceException#pauseJobGroup(String)
public void resumeTrigger(TriggerKey triggerKey)
throws JobPersistenceException
JobStoreTrigger with the
given key.
If the Trigger missed one or more fire-times, then the
Trigger's misfire instruction will be applied.
resumeTrigger in interface JobStoreJobPersistenceExceptionJobStore.pauseTrigger(TriggerKey)
public Collection<String> resumeTriggers(GroupMatcher<TriggerKey> matcher)
throws JobPersistenceException
JobStoreTriggers
in the given group.
If any Trigger missed one or more fire-times, then the
Trigger's misfire instruction will be applied.
resumeTriggers in interface JobStoreJobPersistenceException#pauseTriggers(String)
public Calendar retrieveCalendar(String calName)
throws JobPersistenceException
JobStoreTrigger.
retrieveCalendar in interface JobStorecalName - The name of the Calendar to be retrieved.
Calendar, or null if there is no
match.
JobPersistenceException
public JobDetail retrieveJob(JobKey jobKey)
throws JobPersistenceException
JobStoreJobDetail for the given
Job.
retrieveJob in interface JobStoreJob, or null if there is no match.
JobPersistenceException
public OperableTrigger retrieveTrigger(TriggerKey triggerKey)
throws JobPersistenceException
JobStoreTrigger.
retrieveTrigger in interface JobStoreTrigger, or null if there is no
match.
JobPersistenceException
public void schedulerStarted()
throws SchedulerException
JobStoreJobStore that
the scheduler has started.
schedulerStarted in interface JobStoreSchedulerExceptionpublic void schedulerPaused()
JobStoreJobStore that
the scheduler has been paused.
schedulerPaused in interface JobStorepublic void schedulerResumed()
JobStoreJobStore that
the scheduler has resumed after being paused.
schedulerResumed in interface JobStorepublic void setInstanceId(String schedInstId)
JobStoreJobStore of the Scheduler instance's Id,
prior to initialize being invoked.
setInstanceId in interface JobStorepublic void setInstanceName(String schedName)
JobStoreJobStore of the Scheduler instance's name,
prior to initialize being invoked.
setInstanceName in interface JobStorepublic void setThreadPoolSize(int poolSize)
JobStore
setThreadPoolSize in interface JobStorepoolSize - amount of threads allocated for job executionpublic void shutdown()
JobStoreJobStore that
it should free up all of it's resources because the scheduler is
shutting down.
shutdown in interface JobStore
public void storeCalendar(String name,
Calendar calendar,
boolean replaceExisting,
boolean updateTriggers)
throws ObjectAlreadyExistsException,
JobPersistenceException
JobStoreCalendar.
storeCalendar in interface JobStorecalendar - The Calendar to be stored.replaceExisting - If true, any Calendar existing
in the JobStore with the same name & group
should be over-written.updateTriggers - If true, any Triggers existing
in the JobStore that reference an existing
Calendar with the same name with have their next fire time
re-computed with the new Calendar.
ObjectAlreadyExistsException - if a Calendar with the same name already
exists, and replaceExisting is set to false.
JobPersistenceException
public void storeJob(JobDetail newJob,
boolean replaceExisting)
throws ObjectAlreadyExistsException,
JobPersistenceException
JobStoreJobDetail.
storeJob in interface JobStorenewJob - The JobDetail to be stored.replaceExisting - If true, any Job existing in the
JobStore with the same name & group should be
over-written.
ObjectAlreadyExistsException - if a Job with the same name/group already
exists, and replaceExisting is set to false.
JobPersistenceException
public void storeJobAndTrigger(JobDetail newJob,
OperableTrigger newTrigger)
throws ObjectAlreadyExistsException,
JobPersistenceException
JobStoreJobDetail and Trigger.
storeJobAndTrigger in interface JobStorenewJob - The JobDetail to be stored.newTrigger - The Trigger to be stored.
ObjectAlreadyExistsException - if a Job with the same name/group already
exists.
JobPersistenceException
public void storeTrigger(OperableTrigger newTrigger,
boolean replaceExisting)
throws ObjectAlreadyExistsException,
JobPersistenceException
JobStoreTrigger.
storeTrigger in interface JobStorenewTrigger - The Trigger to be stored.replaceExisting - If true, any Trigger existing in
the JobStore with the same name & group should
be over-written.
ObjectAlreadyExistsException - if a Trigger with the same name/group already
exists, and replaceExisting is set to false.
JobPersistenceExceptionJobStore.pauseTriggers(org.quartz.impl.matchers.GroupMatcher)public boolean supportsPersistence()
supportsPersistence in interface JobStore
public void triggeredJobComplete(OperableTrigger trigger,
JobDetail jobDetail,
Trigger.CompletedExecutionInstruction instruction)
JobStoreJobStore that the scheduler has completed the
firing of the given Trigger (and the execution of its
associated Job completed, threw an exception, or was vetoed),
and that the JobDataMap
in the given JobDetail should be updated if the Job
is stateful.
triggeredJobComplete in interface JobStore
public List<TriggerFiredResult> triggersFired(List<OperableTrigger> triggers)
throws JobPersistenceException
JobStoreJobStore that the scheduler is now firing the
given Trigger (executing its associated Job),
that it had previously acquired (reserved).
triggersFired in interface JobStoreJobPersistenceExceptionpublic void setTcConfig(String tcConfig)
public void setTcConfigUrl(String tcConfigUrl)
public void setSynchronousWrite(String synchWrite)
public void setRejoin(String rejoin)
public long getEstimatedTimeToReleaseAndAcquireTrigger()
JobStoreJobStore implementation
estimates that it will take to release a trigger and acquire a new one.
getEstimatedTimeToReleaseAndAcquireTrigger in interface JobStorepublic void setEstimatedTimeToReleaseAndAcquireTrigger(long estimate)
public boolean isClustered()
JobStoreJobStore implementation is clustered.
isClustered in interface JobStore
public boolean checkExists(JobKey jobKey)
throws JobPersistenceException
JobStoreJob with the given identifier already
exists within the scheduler.
checkExists in interface JobStorejobKey - the identifier to check for
JobPersistenceException
public boolean checkExists(TriggerKey triggerKey)
throws JobPersistenceException
JobStoreTrigger with the given identifier already
exists within the scheduler.
checkExists in interface JobStoretriggerKey - the identifier to check for
JobPersistenceException
public void clearAllSchedulingData()
throws JobPersistenceException
JobStoreJobs, Triggers
Calendars.
clearAllSchedulingData in interface JobStoreJobPersistenceException
public boolean removeTriggers(List<TriggerKey> arg0)
throws JobPersistenceException
removeTriggers in interface JobStoreJobPersistenceException
public boolean removeJobs(List<JobKey> arg0)
throws JobPersistenceException
removeJobs in interface JobStoreJobPersistenceException
public void storeJobsAndTriggers(Map<JobDetail,Set<? extends Trigger>> arg0,
boolean arg1)
throws ObjectAlreadyExistsException,
JobPersistenceException
storeJobsAndTriggers in interface JobStoreObjectAlreadyExistsException
JobPersistenceExceptionprotected TerracottaJobStoreExtensions getRealJobStore()
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||