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
  • Constructor Details

  • Method Details

    • 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, boolean showUnsanitized) 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
      showUnsanitized - 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