Class QuartzEndpoint
java.lang.Object
org.springframework.boot.actuate.quartz.QuartzEndpoint
Endpoint
to expose Quartz Scheduler jobs and triggers.- Since:
- 2.5.0
- Author:
- Vedran Pavic, Stephane Nicoll
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
Description of aCalendarIntervalTrigger
.static final class
Description of aCronTrigger
.static final class
Description of a customTrigger
.static final class
Description of aDailyTimeIntervalTrigger
.static class
Description of group names.static final class
Description of available job and trigger group names.static class
Description of each group identified by name.static final class
Description of aQuartz Job
.static final class
Description of thejobs
in a given group.static final class
Description of aQuartz Job
.static final class
Description of thetriggers
in a given group.static final class
Description of aSimpleTrigger
.static class
Base class for descriptions of aTrigger
. -
Constructor Summary
ConstructorDescriptionQuartzEndpoint
(org.quartz.Scheduler scheduler, Iterable<SanitizingFunction> sanitizingFunctions) -
Method Summary
Modifier and TypeMethodDescriptionReturn thedetails of the job
identified with the given group name and job name.Return the available job names, identified by group name.quartzJobGroupSummary
(String group) Return a summary of the jobs group with the specified name ornull
if no such group exists.Return the available job and trigger group names.Return the available trigger names, identified by group name.quartzTriggerGroupSummary
(String group) Return a summary of the triggers group with the specified name ornull
if no such group exists.
-
Constructor Details
-
QuartzEndpoint
public QuartzEndpoint(org.quartz.Scheduler scheduler, Iterable<SanitizingFunction> sanitizingFunctions)
-
-
Method Details
-
quartzReport
@ReadOperation public QuartzEndpoint.QuartzDescriptor quartzReport() throws org.quartz.SchedulerExceptionReturn 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
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.QuartzGroupsDescriptor quartzTriggerGroups() throws org.quartz.SchedulerExceptionReturn 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.QuartzJobGroupSummaryDescriptor quartzJobGroupSummary(String group) throws org.quartz.SchedulerException Return a summary of the jobs group with the specified name ornull
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.QuartzTriggerGroupSummaryDescriptor quartzTriggerGroupSummary(String group) throws org.quartz.SchedulerException Return a summary of the triggers group with the specified name ornull
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.QuartzJobDetailsDescriptor quartzJob(String groupName, String jobName, boolean showUnsanitized) throws org.quartz.SchedulerException Return thedetails of the job
identified with the given group name and job name.- Parameters:
groupName
- the name of the groupjobName
- the name of the jobshowUnsanitized
- whether to sanitize values in data map- 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
-