Class QuartzEndpoint

java.lang.Object

org.springframework.boot.quartz.actuate.endpoint.QuartzEndpoint

@Endpoint(id="quartz")
public class QuartzEndpoint
extends Object

Endpoint to expose Quartz Scheduler jobs and triggers.

Since:

4.0.0

Author:

Vedran Pavic, Stephane Nicoll

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	QuartzEndpoint.CalendarIntervalTriggerDescriptor	Description of a CalendarIntervalTrigger.
static final class	QuartzEndpoint.CronTriggerDescriptor	Description of a CronTrigger.
static final class	QuartzEndpoint.CustomTriggerDescriptor	Description of a custom Trigger.
static final class	QuartzEndpoint.DailyTimeIntervalTriggerDescriptor	Description of a DailyTimeIntervalTrigger.
static class	QuartzEndpoint.GroupNamesDescriptor	Description of group names.
static final class	QuartzEndpoint.QuartzDescriptor	Description of available job and trigger group names.
static class	QuartzEndpoint.QuartzGroupsDescriptor	Description of each group identified by name.
static final class	QuartzEndpoint.QuartzJobDetailsDescriptor	Description of a Quartz Job.
static final class	QuartzEndpoint.QuartzJobGroupSummaryDescriptor	Description of the jobs in a given group.
static final class	QuartzEndpoint.QuartzJobSummaryDescriptor	Description of a Quartz Job.
static final class	QuartzEndpoint.QuartzJobTriggerDescriptor	Description of a triggered on-demand Quartz Job.
static final class	QuartzEndpoint.QuartzTriggerGroupSummaryDescriptor	Description of the triggers in a given group.
static final class	QuartzEndpoint.SimpleTriggerDescriptor	Description of a SimpleTrigger.
static class	QuartzEndpoint.TriggerDescriptor	Base class for descriptions of a Trigger.

Constructor Summary

Constructors

Constructor	Description
QuartzEndpoint(Scheduler scheduler, Iterable<SanitizingFunction> sanitizingFunctions)

Method Summary

Modifier and Type	Method	Description
@Nullable QuartzEndpoint.QuartzJobDetailsDescriptor	quartzJob(String groupName, String jobName, boolean showUnsanitized)	Return the details of the job identified with the given group name and job name.
QuartzEndpoint.QuartzGroupsDescriptor	quartzJobGroups()	Return the available job names, identified by group name.
@Nullable QuartzEndpoint.QuartzJobGroupSummaryDescriptor	quartzJobGroupSummary(String group)	Return a summary of the jobs group with the specified name or null if no such group exists.
QuartzEndpoint.QuartzDescriptor	quartzReport()	Return the available job and trigger group names.
QuartzEndpoint.QuartzGroupsDescriptor	quartzTriggerGroups()	Return the available trigger names, identified by group name.
@Nullable QuartzEndpoint.QuartzTriggerGroupSummaryDescriptor	quartzTriggerGroupSummary(String group)	Return a summary of the triggers group with the specified name or null if no such group exists.
@Nullable QuartzEndpoint.QuartzJobTriggerDescriptor	triggerQuartzJob(String groupName, String jobName)	Triggers (execute it now) a Quartz job by its group and job name.

Methods inherited from class Object

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

Constructor Details

QuartzEndpoint

public QuartzEndpoint(Scheduler scheduler,
 Iterable<SanitizingFunction> sanitizingFunctions)

Method Details

quartzReport

@ReadOperation
public QuartzEndpoint.QuartzDescriptor quartzReport()
                                             throws SchedulerException

Return the available job and trigger group names.

Returns:

a report of the available group names

Throws:

SchedulerException - if retrieving the information from the scheduler failed

quartzJobGroups

public QuartzEndpoint.QuartzGroupsDescriptor quartzJobGroups()
                                                      throws SchedulerException

Return the available job names, identified by group name.

Returns:

the available job names

Throws:

SchedulerException - if retrieving the information from the scheduler failed

quartzTriggerGroups

public QuartzEndpoint.QuartzGroupsDescriptor quartzTriggerGroups()
                                                          throws SchedulerException

Return the available trigger names, identified by group name.

Returns:

the available trigger names

Throws:

SchedulerException - if retrieving the information from the scheduler failed

quartzJobGroupSummary

public @Nullable QuartzEndpoint.QuartzJobGroupSummaryDescriptor quartzJobGroupSummary(String group)
                                                                               throws SchedulerException

Return a summary of the jobs group with the specified name or null if no such group exists.

Parameters:

group - the name of a jobs group

Returns:

a summary of the jobs in the given group

Throws:

SchedulerException - if retrieving the information from the scheduler failed

quartzTriggerGroupSummary

public @Nullable QuartzEndpoint.QuartzTriggerGroupSummaryDescriptor quartzTriggerGroupSummary(String group)
                                                                                       throws SchedulerException

Return a summary of the triggers group with the specified name or null if no such group exists.

Parameters:

group - the name of a triggers group

Returns:

a summary of the triggers in the given group

Throws:

SchedulerException - if retrieving the information from the scheduler failed

quartzJob

public @Nullable QuartzEndpoint.QuartzJobDetailsDescriptor quartzJob(String groupName,
 String jobName,
 boolean showUnsanitized)
                                                              throws SchedulerException

Return the details of the job identified with the given group name and job name.

Parameters:

groupName - the name of the group

jobName - the name of the job

showUnsanitized - whether to sanitize values in data map

Returns:

the details of the job or null if such job does not exist

Throws:

SchedulerException - if retrieving the information from the scheduler failed

triggerQuartzJob

public @Nullable QuartzEndpoint.QuartzJobTriggerDescriptor triggerQuartzJob(String groupName,
 String jobName)
                                                                     throws SchedulerException

Triggers (execute it now) a Quartz job by its group and job name.

Parameters:

groupName - the name of the job's group

jobName - the name of the job

Returns:

a description of the triggered job or null if the job does not exist

Throws:

SchedulerException - if there is an error triggering the job