com.quartzdesk.api.agent.scheduler.quartz.v2_1_x
Class QuartzSchedulerMBeanImplExtensions

java.lang.Object
  com.quartzdesk.api.agent.scheduler.quartz.v2_1_x.QuartzSchedulerMBeanImplExtensions

public class QuartzSchedulerMBeanImplExtensions
extends Object

Class encapsulating the extended functionality added by the QuartzDesk JVM Agent to the instrumented QuartzSchedulerMBeanImpl class.

Version:

$Id:$

Author:

Jan Moravec

Constructor Summary

QuartzSchedulerMBeanImplExtensions(QuartzScheduler scheduler)
Creates a new instance wrapping the specified Quartz scheduler instance.

Method Summary

void	addTrigger(CompositeData compositeTrigger) Adds the specified trigger to the scheduler.
CompositeData[]	getAllTriggers(String filterQuery, Locale locale) Returns the list of all triggers.
CompositeData[]	getAvailableJobClasses() Returns the list of all available classes that implement the Quartz Job interface.
String	getClassLoaderInfo() Returns the date time when the Quartz scheduler was initialized.
CompositeData	getInitializedAt() Returns the date time when the Quartz scheduler was initialized.
Integer	getJobCount() Returns the number of job registered in the scheduler.
CompositeData	getJobDetail(String jobName, String jobGroupName) Returns the job detail with the specified name and group.
CompositeData[]	getJobDetails(String filterJobGroupName, String filterQuery) Returns the list of all job details in the specified job group (optional) matching the specified filter query (optional).
CompositeData[]	getJobListeners() Returns the list of Quartz JobListeners registered in the scheduler.
CompositeData[]	getJobNextFireTimes(String jobName, String jobGroupName, Integer maxFetchSize) Returns the list of the maximum of the maxFetchSize next fire times the specified job will be fired at.
CompositeData	getPausedAt() Returns the date time when the Quartz scheduler was paused if it is currently paused, null otherwise.
CompositeData	getPlannedJobExecutions(Date startTime, Date endTime, String jobGroupName, String filterQuery, Integer maxFetchSize, Locale locale) Returns the maximum of maxFetchSize planned job executions between the specified start and end date time.
CompositeData[]	getSchedulerListeners() Returns the list of Quartz SchedulerListeners registered in the scheduler.
CompositeData	getStartedAt() Returns the date time when the Quartz scheduler was started if it is currently started, null otherwise.
CompositeData	getStoppedAt() Returns the date time when the Quartz scheduler was stopped if it is currently stopped, null otherwise.
CompositeData	getTrigger(String triggerName, String triggerGroupName, Locale locale) Returns the trigger with the specified name and group.
Integer	getTriggerCount() Returns the number of trigger registered in the scheduler.
CompositeData[]	getTriggerFireTimes(String triggerName, String triggerGroupName, Date startTime, Date endTime, Integer maxFetchSize) Returns the list containing the maximum of the maxFetchSize fire times of the specified trigger between the specified start and end date time.
CompositeData[]	getTriggerListeners() Returns the list of Quartz TriggerListeners registered in the scheduler.
CompositeData[]	getTriggerNextFireTimes(CompositeData compositeTrigger, Integer maxFetchSize) Returns the list of the maximum of the maxFetchSize next fire times the specified trigger will be fired at.
CompositeData[]	getTriggerNextFireTimes(String triggerName, String triggerGroupName, Integer maxFetchSize) Returns the list of the maximum of the maxFetchSize next fire times the specified trigger will be fired at.
CompositeData[]	getTriggersOfJob(String jobName, String jobGroupName, String filterQuery, Locale locale) Returns the list of Quartz triggers for the specified job.
boolean	updateTrigger(CompositeData compositeTrigger) Updates the specified trigger in the scheduler.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

QuartzSchedulerMBeanImplExtensions

public QuartzSchedulerMBeanImplExtensions(QuartzScheduler scheduler)

Creates a new instance wrapping the specified Quartz scheduler instance.

Parameters:

scheduler - a Quartz scheduler instance.

Method Detail

getJobDetail

public CompositeData getJobDetail(String jobName,
                                  String jobGroupName)
                           throws Exception

Returns the job detail with the specified name and group.

Parameters:

jobName - a job name.

jobGroupName - a job group name.

Returns:

the job detail with the specified name and group.

Throws:

Exception

getJobDetails

public CompositeData[] getJobDetails(String filterJobGroupName,
                                     String filterQuery)
                              throws Exception

Returns the list of all job details in the specified job group (optional) matching the specified filter query (optional).

Parameters:

filterJobGroupName - an optional job group name.

filterQuery - an optional filter query.

Returns:

the list of job details.

Throws:

Exception

getJobNextFireTimes

public CompositeData[] getJobNextFireTimes(String jobName,
                                           String jobGroupName,
                                           Integer maxFetchSize)
                                    throws Exception

Returns the list of the maximum of the maxFetchSize next fire times the specified job will be fired at.

Parameters:

jobName - a job name.

jobGroupName - a job group name.

maxFetchSize - the maximum number of next fire times to return.

Returns:

the list of the job next fire times.

Throws:

Exception

getPlannedJobExecutions

public CompositeData getPlannedJobExecutions(Date startTime,
                                             Date endTime,
                                             String jobGroupName,
                                             String filterQuery,
                                             Integer maxFetchSize,
                                             Locale locale)
                                      throws Exception

Returns the maximum of maxFetchSize planned job executions between the specified start and end date time.

Parameters:

startTime - a start date time.

endTime - an end date time.

jobGroupName - an optional job group name.

filterQuery - an optional filter query.

maxFetchSize - the maximum number of executions to return.

locale - a locale.

Returns:

the list of job details.

Throws:

Exception

addTrigger

public void addTrigger(CompositeData compositeTrigger)
                throws Exception

Adds the specified trigger to the scheduler.

Parameters:

compositeTrigger - the domain trigger composite data.

Throws:

Exception

updateTrigger

public boolean updateTrigger(CompositeData compositeTrigger)
                      throws Exception

Updates the specified trigger in the scheduler.

Parameters:

compositeTrigger - the domain trigger composite data.

Returns:

true if the trigger was updated, false if the trigger was not found.

Throws:

Exception

getAllTriggers

public CompositeData[] getAllTriggers(String filterQuery,
                                      Locale locale)
                               throws Exception

Returns the list of all triggers.

Parameters:

filterQuery - an optional filter query.

locale - the locale used to format localizable data. If null, then the platform default locale is used.

Returns:

the list of all triggers.

Throws:

Exception

getTrigger

public CompositeData getTrigger(String triggerName,
                                String triggerGroupName,
                                Locale locale)
                         throws Exception

Returns the trigger with the specified name and group.

Parameters:

triggerName - a trigger name.

triggerGroupName - a trigger group name.

locale - the locale used to format localizable data. If null, then the platform default locale is used.

Returns:

the trigger with the specified name and group.

Throws:

Exception

getTriggersOfJob

public CompositeData[] getTriggersOfJob(String jobName,
                                        String jobGroupName,
                                        String filterQuery,
                                        Locale locale)
                                 throws Exception

Returns the list of Quartz triggers for the specified job.

Parameters:

jobName - a job name.

jobGroupName - a job group name.

filterQuery - an optional filter query.

locale - the locale used to format localizable data. If null, then the platform default locale is used.

Returns:

the list of Quartz triggers for the specified job.

Throws:

Exception

getTriggerNextFireTimes

public CompositeData[] getTriggerNextFireTimes(String triggerName,
                                               String triggerGroupName,
                                               Integer maxFetchSize)
                                        throws Exception

Returns the list of the maximum of the maxFetchSize next fire times the specified trigger will be fired at.

Parameters:

triggerName - a trigger name.

triggerGroupName - a trigger group name.

maxFetchSize - the maximum number of next fire times to return.

Returns:

the list of the trigger next fire times.

Throws:

Exception

getTriggerNextFireTimes

public CompositeData[] getTriggerNextFireTimes(CompositeData compositeTrigger,
                                               Integer maxFetchSize)
                                        throws Exception

Returns the list of the maximum of the maxFetchSize next fire times the specified trigger will be fired at.

Parameters:

compositeTrigger - the domain trigger composite data.

maxFetchSize - the maximum number of next fire times to return.

Returns:

the list of the trigger next fire times.

Throws:

Exception

getTriggerFireTimes

public CompositeData[] getTriggerFireTimes(String triggerName,
                                           String triggerGroupName,
                                           Date startTime,
                                           Date endTime,
                                           Integer maxFetchSize)
                                    throws Exception

Returns the list containing the maximum of the maxFetchSize fire times of the specified trigger between the specified start and end date time.

Parameters:

triggerName - a trigger name.

triggerGroupName - a trigger group name.

startTime - a start date time.

endTime - an end date time.

maxFetchSize - the maximum number of next fire times to return.

Returns:

the list of the trigger next fire times.

Throws:

Exception

getJobCount

public Integer getJobCount()
                    throws Exception

Returns the number of job registered in the scheduler.

Returns:

the number of job registered in the scheduler.

Throws:

Exception

getTriggerCount

public Integer getTriggerCount()
                        throws Exception

Returns the number of trigger registered in the scheduler.

Returns:

the number of trigger registered in the scheduler.

Throws:

Exception

getJobListeners

public CompositeData[] getJobListeners()
                                throws Exception

Returns the list of Quartz JobListeners registered in the scheduler.

Returns:

the list of Quartz JobListeners registered in the scheduler.

Throws:

Exception

getTriggerListeners

public CompositeData[] getTriggerListeners()
                                    throws Exception

Returns the list of Quartz TriggerListeners registered in the scheduler.

Returns:

the list of Quartz TriggerListeners registered in the scheduler.

Throws:

Exception

getSchedulerListeners

public CompositeData[] getSchedulerListeners()
                                      throws Exception

Returns the list of Quartz SchedulerListeners registered in the scheduler.

Returns:

the list of Quartz SchedulerListeners registered in the scheduler.

Throws:

Exception

getClassLoaderInfo

public String getClassLoaderInfo()
                          throws Exception

Returns the date time when the Quartz scheduler was initialized.

Returns:

the date time when the Quartz scheduler was initialized.

Throws:

Exception

getAvailableJobClasses

public CompositeData[] getAvailableJobClasses()
                                       throws Exception

Returns the list of all available classes that implement the Quartz Job interface.

Returns:

the list of available job classes.

Throws:

Exception

getInitializedAt

public CompositeData getInitializedAt()
                               throws Exception

Returns the date time when the Quartz scheduler was initialized.

Returns:

the date time when the Quartz scheduler was initialized.

Throws:

Exception

getStartedAt

public CompositeData getStartedAt()
                           throws Exception

Returns the date time when the Quartz scheduler was started if it is currently started, null otherwise.

Returns:

the date time when the Quartz scheduler was last started.

Throws:

Exception

getPausedAt

public CompositeData getPausedAt()
                          throws Exception

Returns the date time when the Quartz scheduler was paused if it is currently paused, null otherwise.

Returns:

the date time when the Quartz scheduler was paused.

Throws:

Exception

getStoppedAt

public CompositeData getStoppedAt()
                           throws Exception

Returns the date time when the Quartz scheduler was stopped if it is currently stopped, null otherwise.

Returns:

the date time when the Quartz scheduler was stopped.

Throws:

Exception