org.springframework.boot.actuate.quartz

Class QuartzEndpoint

java.lang.Object

org.springframework.boot.actuate.quartz.QuartzEndpoint

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

Endpoint to expose Quartz Scheduler jobs and triggers.

Since:

2.5.0

Author:

Vedran Pavic, Stephane Nicoll

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	QuartzEndpoint.CalendarIntervalTriggerDescription A description of a CalendarIntervalTrigger.
static class	QuartzEndpoint.CronTriggerDescription A description of a CronTrigger.
static class	QuartzEndpoint.CustomTriggerDescription A description of a custom Trigger.
static class	QuartzEndpoint.DailyTimeIntervalTriggerDescription A description of a DailyTimeIntervalTrigger.
static class	QuartzEndpoint.GroupNames A set of group names, primarily intended for serialization to JSON.
static class	QuartzEndpoint.QuartzGroups A summary for each group identified by name, primarily intended for serialization to JSON.
static class	QuartzEndpoint.QuartzJobDetails Details of a Quartz Job, primarily intended for serialization to JSON.
static class	QuartzEndpoint.QuartzJobGroupSummary A summary report of the jobs in a given group.
static class	QuartzEndpoint.QuartzJobSummary Details of a Quartz Job, primarily intended for serialization to JSON.
static class	QuartzEndpoint.QuartzReport A report of available job and trigger group names, primarily intended for serialization to JSON.
static class	QuartzEndpoint.QuartzTriggerGroupSummary A summary report of the triggers in a given group.
static class	QuartzEndpoint.SimpleTriggerDescription A description of a SimpleTrigger.
static class	QuartzEndpoint.TriggerDescription Base class for descriptions of a Trigger.

Constructor Summary

Constructors

Constructor and Description
QuartzEndpoint(org.quartz.Scheduler scheduler) Create an instance for the specified Scheduler using a default Sanitizer.
QuartzEndpoint(org.quartz.Scheduler scheduler, Sanitizer sanitizer) Create an instance for the specified Scheduler and Sanitizer.

Method Summary

Modifier and Type	Method and Description
QuartzEndpoint.QuartzJobDetails	quartzJob(String groupName, String jobName) Return the details of the job identified with the given group name and job name.
QuartzEndpoint.QuartzGroups	quartzJobGroups() Return the available job names, identified by group name.
QuartzEndpoint.QuartzJobGroupSummary	quartzJobGroupSummary(String group) Return a summary of the jobs group with the specified name or null if no such group exists.
QuartzEndpoint.QuartzReport	quartzReport() Return the available job and trigger group names.
Map<String,Object>	quartzTrigger(String groupName, String triggerName) Return the details of the trigger identified by the given group name and trigger name.
QuartzEndpoint.QuartzGroups	quartzTriggerGroups() Return the available trigger names, identified by group name.
QuartzEndpoint.QuartzTriggerGroupSummary	quartzTriggerGroupSummary(String group) Return a summary of the triggers group with the specified name or null if no such group exists.

Methods inherited from class java.lang.Object

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

Constructor Detail

QuartzEndpoint

public QuartzEndpoint(org.quartz.Scheduler scheduler)

Create an instance for the specified Scheduler using a default Sanitizer.

Parameters:

scheduler - the scheduler to use to retrieve jobs and triggers details

QuartzEndpoint

public QuartzEndpoint(org.quartz.Scheduler scheduler,
                      Sanitizer sanitizer)

Create an instance for the specified Scheduler and Sanitizer.

Parameters:

scheduler - the scheduler to use to retrieve jobs and triggers details

sanitizer - the sanitizer to use to sanitize data maps

Method Detail

quartzReport

@ReadOperation
public QuartzEndpoint.QuartzReport quartzReport()
                                                        throws org.quartz.SchedulerException

Return the available job and trigger group names.

Returns:

a report of the available group names

Throws:

org.quartz.SchedulerException - if retrieving the information from the scheduler failed

quartzJobGroups

public QuartzEndpoint.QuartzGroups quartzJobGroups()
                                            throws org.quartz.SchedulerException

Return the available job names, identified by group name.

Returns:

the available job names

Throws:

org.quartz.SchedulerException - if retrieving the information from the scheduler failed

quartzTriggerGroups

public QuartzEndpoint.QuartzGroups quartzTriggerGroups()
                                                throws org.quartz.SchedulerException

Return the available trigger names, identified by group name.

Returns:

the available trigger names

Throws:

org.quartz.SchedulerException - if retrieving the information from the scheduler failed

quartzJobGroupSummary

public QuartzEndpoint.QuartzJobGroupSummary quartzJobGroupSummary(String group)
                                                           throws org.quartz.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:

org.quartz.SchedulerException - if retrieving the information from the scheduler failed

quartzTriggerGroupSummary

public QuartzEndpoint.QuartzTriggerGroupSummary quartzTriggerGroupSummary(String group)
                                                                   throws org.quartz.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:

org.quartz.SchedulerException - if retrieving the information from the scheduler failed

quartzJob

public QuartzEndpoint.QuartzJobDetails quartzJob(String groupName,
                                                 String jobName)
                                          throws org.quartz.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

Returns:

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

Throws:

org.quartz.SchedulerException - if retrieving the information from the scheduler failed

quartzTrigger

public Map<String,Object> quartzTrigger(String groupName,
                                        String triggerName)
                                 throws org.quartz.SchedulerException

Return the details of the trigger identified by the given group name and trigger name.

Parameters:

groupName - the name of the group

triggerName - the name of the trigger

Returns:

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

Throws:

org.quartz.SchedulerException - if retrieving the information from the scheduler failed