パッケージ org.springframework.boot.actuate.quartz

クラス QuartzEndpoint

java.lang.ObjectSE
org.springframework.boot.actuate.quartz.QuartzEndpoint
@Endpoint(id="quartz") public class QuartzEndpoint extends ObjectSE
Endpoint は、Quartz スケジューラーのジョブとトリガーを公開します。
導入:
2.5.0
作成者:
Vedran Pavic, Stephane Nicoll

  • コンストラクターの詳細

  • メソッドの詳細

    • quartzReport

      @ReadOperation public QuartzEndpoint.QuartzDescriptor quartzReport() throws org.quartz.SchedulerException
      使用可能なジョブとトリガーグループの名前を返します。
      戻り値:
      利用可能なグループ名のレポート
      例外:
      org.quartz.SchedulerException - スケジューラーからの情報の取得に失敗した場合

    • quartzJobGroups

      public QuartzEndpoint.QuartzGroupsDescriptor quartzJobGroups() throws org.quartz.SchedulerException
      グループ名で識別される使用可能なジョブ名を返します。
      戻り値:
      利用可能なジョブ名
      例外:
      org.quartz.SchedulerException - スケジューラーからの情報の取得に失敗した場合

    • quartzTriggerGroups

      public QuartzEndpoint.QuartzGroupsDescriptor quartzTriggerGroups() throws org.quartz.SchedulerException
      グループ名で識別される使用可能なトリガー名を返します。
      戻り値:
      利用可能なトリガー名
      例外:
      org.quartz.SchedulerException - スケジューラーからの情報の取得に失敗した場合

    • quartzJobGroupSummary

      public QuartzEndpoint.QuartzJobGroupSummaryDescriptor quartzJobGroupSummary(StringSE group) throws org.quartz.SchedulerException
      指定された名前のジョブグループの概要、またはそのようなグループが存在しない場合は null を返します。
      パラメーター:
      group - ジョブグループの名前
      戻り値:
      指定された group のジョブの概要
      例外:
      org.quartz.SchedulerException - スケジューラーからの情報の取得に失敗した場合

    • quartzTriggerGroupSummary

      public QuartzEndpoint.QuartzTriggerGroupSummaryDescriptor quartzTriggerGroupSummary(StringSE group) throws org.quartz.SchedulerException
      指定された名前のトリガーグループの概要、またはそのようなグループが存在しない場合は null を返します。
      パラメーター:
      group - トリガーグループの名前
      戻り値:
      指定された group のトリガーの概要
      例外:
      org.quartz.SchedulerException - スケジューラーからの情報の取得に失敗した場合

    • quartzJob

      public QuartzEndpoint.QuartzJobDetailsDescriptor quartzJob(StringSE groupName, StringSE jobName, boolean showUnsanitized) throws org.quartz.SchedulerException
      指定されたグループ名とジョブ名で識別される details of the job を返します。
      パラメーター:
      groupName - グループの名前
      jobName - ジョブの名前
      showUnsanitized - データマップの値をサニタイズするかどうか
      戻り値:
      ジョブの詳細、またはそのようなジョブが存在しない場合は null 
      例外:
      org.quartz.SchedulerException - スケジューラーからの情報の取得に失敗した場合

    • triggerQuartzJob

      public QuartzEndpoint.QuartzJobTriggerDescriptor triggerQuartzJob(StringSE groupName, StringSE jobName) throws org.quartz.SchedulerException
      グループとジョブ名によって Quartz ジョブをトリガー (今すぐ実行) します。
      パラメーター:
      groupName - ジョブのグループ名
      jobName - ジョブの名前
      戻り値:
      トリガーされたジョブの説明、またはジョブが存在しない場合は null 
      例外:
      org.quartz.SchedulerException - ジョブをトリガーするエラーが発生した場合
      導入:
      3.5.0