de.chandre.admintool.quartz

Interface AdminToolQuartzService

All Known Implementing Classes:

AdminToolQuartzServiceImpl

public interface AdminToolQuartzService

Interface for QuartzService

Author:

Andre

Method Summary

Modifier and Type	Method and Description
boolean	changeJob(JobTriggerTO triggerTO) changes the job information and replaces the job
boolean	changeTrigger(JobTriggerTO triggerTO, boolean add) changes (or adds) a trigger
void	changeTriggerState(String groupName, String jobName, String triggerGroup, String triggerName) pausing either the found trigger or all triggers of found job
Collection<String>	getCalendarNames()
String	getCronExpression(org.quartz.Trigger trigger, String defaultValue)
int	getCurrentlyExecutingAmount(org.quartz.JobKey jobKey)
Collection<JobTriggerTO>	getInstructionSets()
String	getJobDescription(org.quartz.JobKey jobKey)
List<String>	getJobGroups()
Set<org.quartz.JobKey>	getJobKeys(String group)
org.quartz.SchedulerMetaData	getMetaData() the scheduler configuration
JobTriggerTO	getTriggerInfo(String groupName, String jobName, String triggerGroup, String triggerName) returns the job and possibly the trigger info if triggerGroup and triggerName has beeen specified
List<? extends org.quartz.Trigger>	getTriggers(org.quartz.JobKey jobKey)
String	getTriggerState(org.quartz.JobKey jobKey, org.quartz.Trigger trigger) retuns "paused", "running" or "pending" depending on the triggers state
String	getTriggerStateCssClass(org.quartz.JobKey jobKey, org.quartz.Trigger trigger) retuns "btn-warning" for paused trigger, "btn-success" for running trigger else "btn-info"
void	interruptJob(String jobGroup, String jobName) interrupts all triggers of job
void	interruptTrigger(String jobGroup, String jobName, String triggerGroup, String triggerName) interrupts the trigger i found
boolean	isCronTrigger(org.quartz.Trigger trigger)
boolean	isCurrentlyRunning(org.quartz.JobKey jobKey, org.quartz.Trigger trigger) returns if the trigger is running currently
boolean	isInteruptable(org.quartz.JobKey jobKey)
boolean	isOnePaused(org.quartz.JobKey jobKey)
boolean	isPaused(org.quartz.JobKey jobKey)
boolean	isPaused(org.quartz.Trigger trigger)
boolean	isPrevGoupNotEq(String actualGroup) checks if the previous stored group is not equals the actual one or if previous is empty requires to use the setPrevGroup(String) method
boolean	isPrevJobNotEq(String actualJob) checks if the previous stored jobName is not equals the actual one or if previous is empty requires to use the setPrevJob(String) method
boolean	isSchedulerRunning()
boolean	isStateful(org.quartz.JobKey jobKey)
boolean	removeTrigger(String groupName, String jobName, String triggerGroup, String triggerName) removes trigger from job
boolean	setPrevGroup(String prevGroup) sets the given group as previous group dirty hack to call this method from thymeleaf to get control over row span
boolean	setPrevJob(String prevJob) sets the given jobName as previous jobName dirty hack to call this method from thymeleaf to get control over row span
void	startScheduler() starts the scheduler process
void	stopScheduler() stops the scheduler process
void	triggerJob(String groupName, String jobName) executes the job immediately with a custom trigger

Method Detail

startScheduler

void startScheduler()

starts the scheduler process

stopScheduler

void stopScheduler()

stops the scheduler process

isSchedulerRunning

boolean isSchedulerRunning()

Returns:

if scheduler is running

getMetaData

org.quartz.SchedulerMetaData getMetaData()
                                  throws org.quartz.SchedulerException

the scheduler configuration

Returns:

the scheduler meta data

Throws:

org.quartz.SchedulerException

getJobGroups

List<String> getJobGroups()
                   throws org.quartz.SchedulerException

Returns:

all job groups

Throws:

org.quartz.SchedulerException

isPrevGoupNotEq

boolean isPrevGoupNotEq(String actualGroup)

checks if the previous stored group is not equals the actual one or if previous is empty
requires to use the setPrevGroup(String) method

Parameters:

actualGroup - the actual job group

Returns:

true if previous is empty or if previous stored group is not equals the actual group

setPrevGroup

boolean setPrevGroup(String prevGroup)

sets the given group as previous group
dirty hack to call this method from thymeleaf to get control over row span

Parameters:

prevGroup -

Returns:

true

isPrevJobNotEq

boolean isPrevJobNotEq(String actualJob)

checks if the previous stored jobName is not equals the actual one or if previous is empty
requires to use the setPrevJob(String) method

Parameters:

actualJob -

Returns:

true if previous is empty or if previous stored jobName is not equals the actual jobName

setPrevJob

boolean setPrevJob(String prevJob)

sets the given jobName as previous jobName
dirty hack to call this method from thymeleaf to get control over row span

Parameters:

prevJob -

Returns:

true

getJobKeys

Set<org.quartz.JobKey> getJobKeys(String group)
                           throws org.quartz.SchedulerException

Parameters:

group - the actual job group

Returns:

all job keys for the given group

Throws:

org.quartz.SchedulerException

getJobDescription

String getJobDescription(org.quartz.JobKey jobKey)
                  throws org.quartz.SchedulerException

Parameters:

jobKey - the actual job key

Returns:

the job description

Throws:

org.quartz.SchedulerException

getTriggers

List<? extends org.quartz.Trigger> getTriggers(org.quartz.JobKey jobKey)
                                        throws org.quartz.SchedulerException

Parameters:

jobKey - the actual job key

Returns:

all triggers for the job

Throws:

org.quartz.SchedulerException

getCurrentlyExecutingAmount

int getCurrentlyExecutingAmount(org.quartz.JobKey jobKey)
                         throws org.quartz.SchedulerException

Parameters:

jobKey - the actual job key

Returns:

amount of triggers which are currently executing

Throws:

org.quartz.SchedulerException

isPaused

boolean isPaused(org.quartz.JobKey jobKey)
          throws org.quartz.SchedulerException

Parameters:

jobKey - the actual job key

Returns:

true if all triggers of job are in paused state

Throws:

org.quartz.SchedulerException

isOnePaused

boolean isOnePaused(org.quartz.JobKey jobKey)
             throws org.quartz.SchedulerException

Parameters:

jobKey - the actual job key

Returns:

true if all triggers of job are in paused state

Throws:

org.quartz.SchedulerException

isPaused

boolean isPaused(org.quartz.Trigger trigger)
          throws org.quartz.SchedulerException

Parameters:

trigger - the trigger

Returns:

if trigger is paused

Throws:

org.quartz.SchedulerException

getTriggerStateCssClass

String getTriggerStateCssClass(org.quartz.JobKey jobKey,
                               org.quartz.Trigger trigger)
                        throws org.quartz.SchedulerException

retuns "btn-warning" for paused trigger, "btn-success" for running trigger else "btn-info"

Parameters:

jobKey - the job key

trigger - the trigger

Returns:

Throws:

org.quartz.SchedulerException

getTriggerState

String getTriggerState(org.quartz.JobKey jobKey,
                       org.quartz.Trigger trigger)
                throws org.quartz.SchedulerException

retuns "paused", "running" or "pending" depending on the triggers state

Parameters:

jobKey - the job key

trigger - the trigger

Returns:

Throws:

org.quartz.SchedulerException

isCurrentlyRunning

boolean isCurrentlyRunning(org.quartz.JobKey jobKey,
                           org.quartz.Trigger trigger)
                    throws org.quartz.SchedulerException

returns if the trigger is running currently

Parameters:

jobKey - the job key

trigger - the trigger

Returns:

Throws:

org.quartz.SchedulerException

getCronExpression

String getCronExpression(org.quartz.Trigger trigger,
                         String defaultValue)

Parameters:

trigger - the actual trigger

defaultValue - a default value to be returned, if

Returns:

return the cron expression if it's a cron trigger otherwise the defaultValue will be returned

isCronTrigger

boolean isCronTrigger(org.quartz.Trigger trigger)

Parameters:

trigger -

Returns:

true if it's a cron trigger

isInteruptable

boolean isInteruptable(org.quartz.JobKey jobKey)
                throws org.quartz.SchedulerException

Parameters:

jobKey -

Returns:

true if job class implements the InterruptableJob interface

Throws:

org.quartz.SchedulerException

isStateful

boolean isStateful(org.quartz.JobKey jobKey)
            throws org.quartz.SchedulerException

Parameters:

jobKey -

Returns:

true if job class implements the StatefulJob interface

Throws:

org.quartz.SchedulerException

interruptJob

void interruptJob(String jobGroup,
                  String jobName)
           throws org.quartz.SchedulerException

interrupts all triggers of job

Parameters:

jobGroup - the jobGroup

jobName - the jobName

Throws:

org.quartz.SchedulerException

interruptTrigger

void interruptTrigger(String jobGroup,
                      String jobName,
                      String triggerGroup,
                      String triggerName)
               throws org.quartz.SchedulerException

interrupts the trigger i found

Parameters:

jobGroup -

jobName -

triggerGroup -

triggerName -

Throws:

org.quartz.SchedulerException

changeTriggerState

void changeTriggerState(String groupName,
                        String jobName,
                        String triggerGroup,
                        String triggerName)
                 throws org.quartz.SchedulerException

pausing either the found trigger or all triggers of found job

Parameters:

groupName -

jobName -

triggerGroup - (optional)

triggerName - (optional)

Throws:

org.quartz.SchedulerException

triggerJob

void triggerJob(String groupName,
                String jobName)
         throws org.quartz.SchedulerException

executes the job immediately with a custom trigger

Parameters:

groupName -

jobName -

Throws:

org.quartz.SchedulerException

removeTrigger

boolean removeTrigger(String groupName,
                      String jobName,
                      String triggerGroup,
                      String triggerName)
               throws org.quartz.SchedulerException

removes trigger from job

Parameters:

groupName -

jobName -

triggerGroup -

triggerName -

Returns:

false if trigger was not found or unscheduling was not successful

Throws:

org.quartz.SchedulerException

getTriggerInfo

JobTriggerTO getTriggerInfo(String groupName,
                            String jobName,
                            String triggerGroup,
                            String triggerName)
                     throws org.quartz.SchedulerException

returns the job and possibly the trigger info if triggerGroup and triggerName has beeen specified

Parameters:

groupName -

jobName -

triggerGroup - (optional)

triggerName - (optional)

Returns:

Throws:

org.quartz.SchedulerException

getCalendarNames

Collection<String> getCalendarNames()
                             throws org.quartz.SchedulerException

Returns:

the calendars associated with quartz

Throws:

org.quartz.SchedulerException

getInstructionSets

Collection<JobTriggerTO> getInstructionSets()

Returns:

the instructionSets (MisfireInstructions) and repeatIntervalUnits for JobTriggerTO.TriggerType.CRON, JobTriggerTO.TriggerType.SIMPLE,JobTriggerTO.TriggerType.CALENDAR,JobTriggerTO.TriggerType.DAILY,

changeJob

boolean changeJob(JobTriggerTO triggerTO)
           throws org.quartz.SchedulerException

changes the job information and replaces the job

Parameters:

triggerTO -

Returns:

Throws:

org.quartz.SchedulerException

changeTrigger

boolean changeTrigger(JobTriggerTO triggerTO,
                      boolean add)
               throws org.quartz.SchedulerException

changes (or adds) a trigger

Parameters:

triggerTO -

add - true: if a new trigger should be added (will only work, if there is no other trigger with same identifier)

Returns:

Throws:

org.quartz.SchedulerException