io.logspace.jvm.agent.shaded.quartz.core.jmx.QuartzSchedulerMBean Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of logspace-jvm-agent Show documentation
The newest version!
package io.logspace.jvm.agent.shaded.quartz.core.jmx;

import java.util.Date;
import java.util.List;
import java.util.Map;
import java.util.Set;

import javax.management.openmbean.CompositeData;
import javax.management.openmbean.TabularData;

public interface QuartzSchedulerMBean {
    static final String SCHEDULER_STARTED = "schedulerStarted";
    static final String SCHEDULER_PAUSED = "schedulerPaused";
    static final String SCHEDULER_SHUTDOWN = "schedulerShutdown";
    static final String SCHEDULER_ERROR = "schedulerError";

    static final String JOB_ADDED = "jobAdded";
    static final String JOB_DELETED = "jobDeleted";
    static final String JOB_SCHEDULED = "jobScheduled";
    static final String JOB_UNSCHEDULED = "jobUnscheduled";
    
    static final String JOBS_PAUSED = "jobsPaused";
    static final String JOBS_RESUMED = "jobsResumed";

    static final String JOB_EXECUTION_VETOED = "jobExecutionVetoed";
    static final String JOB_TO_BE_EXECUTED = "jobToBeExecuted";
    static final String JOB_WAS_EXECUTED = "jobWasExecuted";

    static final String TRIGGER_FINALIZED = "triggerFinalized";

    static final String TRIGGERS_PAUSED = "triggersPaused";
    static final String TRIGGERS_RESUMED = "triggersResumed";

    static final String SCHEDULING_DATA_CLEARED = "schedulingDataCleared";

    static final String SAMPLED_STATISTICS_ENABLED = "sampledStatisticsEnabled";
    static final String SAMPLED_STATISTICS_RESET = "sampledStatisticsReset";

    String getSchedulerName();

    String getSchedulerInstanceId();

    boolean isStandbyMode();

    boolean isShutdown();

    String getVersion();

    String getJobStoreClassName();

    String getThreadPoolClassName();

    int getThreadPoolSize();

    long getJobsScheduledMostRecentSample();

    long getJobsExecutedMostRecentSample();

    long getJobsCompletedMostRecentSample();

    Map getPerformanceMetrics();

    /**
     * @return TabularData of CompositeData:JobExecutionContext
     * @throws Exception
     */
    TabularData getCurrentlyExecutingJobs() throws Exception;

    /**
     * @return TabularData of CompositeData:JobDetail
     * @throws Exception
     * @see JobDetailSupport
     */
    TabularData getAllJobDetails() throws Exception;

    /**
     * @return List of CompositeData:[CronTrigger|SimpleTrigger]
     * @throws Exception
     * @see TriggerSupport
     */
    List getAllTriggers() throws Exception;

    List getJobGroupNames() throws Exception;

    List getJobNames(String groupName)
            throws Exception;

    /**
     * @return CompositeData:JobDetail
     * @throws Exception
     * @see JobDetailSupport
     */
    CompositeData getJobDetail(String jobName, String jobGroupName) throws Exception;

    boolean isStarted();

    void start() throws Exception;

    void shutdown();

    void standby();

    void clear() throws Exception;
    
    /**
     * Schedule an existing job with an existing trigger.
     * 
     * @param jobName
     * @param jobGroup
     * @param triggerName
     * @param triggerGroup
     * @return date of nextFireTime
     * @throws Exception
     */
    Date scheduleJob(String jobName, String jobGroup,
            String triggerName, String triggerGroup) throws Exception;

    /**
     * Schedules a job using the given Cron/Simple triggerInfo.
     * 
     * The triggerInfo and jobDetailInfo must contain well-known attribute values.
     *     TriggerInfo attributes: name, group, description, calendarName, priority,
     *       CronExpression | (startTime, endTime, repeatCount, repeatInterval) 
     *     JobDetailInfo attributes: name, group, description, jobClass, jobDataMap, durability,
     *       shouldRecover
     */
    void scheduleBasicJob(Map jobDetailInfo, Map triggerInfo)
            throws Exception;

    /**
     * Schedules an arbitrary job described by abstractJobInfo using a trigger specified by abstractTriggerInfo.
     * 
     * AbtractTriggerInfo and AbstractJobInfo must contain the following String attributes.
     *     AbstractTriggerInfo: triggerClass, the fully-qualified class name of a concrete Trigger type
     *     AbstractJobInfo: jobDetailClass, the fully-qualified class name of a concrete JobDetail type
     *
     * If the Trigger and JobDetail can be successfully instantiated, the remaining attributes will be
     * reflectively applied to those instances. The remaining attributes are limited to the types:
     *   Integer, Double, Float, String, Boolean, Date, Character, Map.
     * Maps are further limited to containing values from the same set of types, less Map itself.
     * 
     * @throws Exception 
     */
    void scheduleJob(Map abstractJobInfo,
            Map abstractTriggerInfo) throws Exception;
    
    /**
     * Schedules the specified job using a trigger described by abstractTriggerInfo, which must contain the
     * fully-qualified trigger class name under the key "triggerClass."  That trigger type must contain a
     * no-arg constructor and have public access. Other attributes are applied reflectively and are limited
     * to the types:
     *   Integer, Double, Float, String, Boolean, Date, Character, Map.
     * Maps are limited to containing values from the same set of types, less Map itself.
     * 
     * @param jobName
     * @param jobGroup
     * @param abstractTriggerInfo
     * @throws Exception
     */
    void scheduleJob(String jobName, String jobGroup,
            Map abstractTriggerInfo) throws Exception;
    
    boolean unscheduleJob(String triggerName, String triggerGroup) throws Exception;

    boolean interruptJob(String jobName, String jobGroupName) throws Exception;

    boolean interruptJob(String fireInstanceId) throws Exception;
    
    void triggerJob(String jobName, String jobGroupName,
            Map jobDataMap) throws Exception;

    boolean deleteJob(String jobName, String jobGroupName)
            throws Exception;

    void addJob(CompositeData jobDetail, boolean replace) throws Exception;

    /**
     * Adds a durable job described by abstractJobInfo, which must contain the fully-qualified JobDetail
     * class name under the key "jobDetailClass."  That JobDetail type must contain a no-arg constructor
     * and have public access. Other attributes are applied reflectively and are limited
     * to the types:
     *   Integer, Double, Float, String, Boolean, Date, Character, Map.
     * Maps are limited to containing values from the same set of types, less Map itself.
     * 
     * @param abstractJobInfo map of attributes defining job
     * @param replace whether or not to replace a pre-existing job with the same key
     * @throws Exception
     */
    void addJob(Map abstractJobInfo, boolean replace)
            throws Exception;

    void pauseJobGroup(String jobGroup) throws Exception;

    /**
     * Pause all jobs whose group starts with jobGroupPrefix
     * @throws Exception
     */
    void pauseJobsStartingWith(String jobGroupPrefix) throws Exception;

    /**
     * Pause all jobs whose group ends with jobGroupSuffix
     */
    void pauseJobsEndingWith(String jobGroupSuffix) throws Exception;

    /**
     * Pause all jobs whose group contains jobGroupToken
     */
    void pauseJobsContaining(String jobGroupToken) throws Exception;

    /**
     * Pause all jobs whose group is anything
     */
    void pauseJobsAll() throws Exception;

    /**
     * Resume all jobs in the given group
     */
    void resumeJobGroup(String jobGroup) throws Exception;

    /**
     * Resume all jobs whose group starts with jobGroupPrefix
     */
    void resumeJobsStartingWith(String jobGroupPrefix) throws Exception;

    /**
     * Resume all jobs whose group ends with jobGroupSuffix
     */
    void resumeJobsEndingWith(String jobGroupSuffix) throws Exception;

    /**
     * Resume all jobs whose group contains jobGroupToken
     */
    void resumeJobsContaining(String jobGroupToken) throws Exception;

    /**
     * Resume all jobs whose group is anything
     */
    void resumeJobsAll() throws Exception;

    void pauseJob(String jobName, String groupName) throws Exception;

    void resumeJob(String jobName, String jobGroupName)    throws Exception;

    List getTriggerGroupNames() throws Exception;

    List getTriggerNames(String triggerGroupName) throws Exception;

    CompositeData getTrigger(String triggerName, String triggerGroupName) throws Exception;

    String getTriggerState(String triggerName, String triggerGroupName) throws Exception;

    /**
     * @return List of CompositeData:[CronTrigger|SimpleTrigger] for the specified job.
     * @see TriggerSupport
     */
    List getTriggersOfJob(String jobName, String jobGroupName) throws Exception;

    Set getPausedTriggerGroups() throws Exception;

    void pauseAllTriggers() throws Exception;

    void resumeAllTriggers() throws Exception;

    void pauseTriggerGroup(String triggerGroup) throws Exception;

    /**
     * Pause all triggers whose group starts with triggerGroupPrefix
     */
    void pauseTriggersStartingWith(String triggerGroupPrefix) throws Exception;

    /**
     * Pause all triggers whose group ends with triggerGroupSuffix
     */
    void pauseTriggersEndingWith(String suffix) throws Exception;

    /**
     * Pause all triggers whose group contains triggerGroupToken
     */
    void pauseTriggersContaining(String triggerGroupToken) throws Exception;

    /**
     * Pause all triggers whose group is anything
     */
    void pauseTriggersAll() throws Exception;

    void resumeTriggerGroup(String triggerGroup) throws Exception;

    /**
     * Resume all triggers whose group starts with triggerGroupPrefix
     */
    void resumeTriggersStartingWith(String triggerGroupPrefix) throws Exception;

    /**
     * Resume all triggers whose group ends with triggerGroupSuffix
     */
    void resumeTriggersEndingWith(String triggerGroupSuffix) throws Exception;

    /**
     * Resume all triggers whose group contains triggerGroupToken
     */
    void resumeTriggersContaining(String triggerGroupToken) throws Exception;

    /**
     * Resume all triggers whose group is anything
     */
    void resumeTriggersAll() throws Exception;

    void pauseTrigger(String triggerName, String triggerGroupName) throws Exception;

    void resumeTrigger(String triggerName, String triggerGroupName) throws Exception;

    List getCalendarNames() throws Exception;

    void deleteCalendar(String name) throws Exception;

    void setSampledStatisticsEnabled(boolean enabled);

    boolean isSampledStatisticsEnabled();
}