Package org.quartz.core.jmx
Interface QuartzSchedulerMBean
-
- All Known Implementing Classes:
QuartzSchedulerMBeanImpl
public interface QuartzSchedulerMBean
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
JOB_ADDED
static java.lang.String
JOB_DELETED
static java.lang.String
JOB_EXECUTION_VETOED
static java.lang.String
JOB_SCHEDULED
static java.lang.String
JOB_TO_BE_EXECUTED
static java.lang.String
JOB_UNSCHEDULED
static java.lang.String
JOB_WAS_EXECUTED
static java.lang.String
JOBS_PAUSED
static java.lang.String
JOBS_RESUMED
static java.lang.String
SAMPLED_STATISTICS_ENABLED
static java.lang.String
SAMPLED_STATISTICS_RESET
static java.lang.String
SCHEDULER_ERROR
static java.lang.String
SCHEDULER_PAUSED
static java.lang.String
SCHEDULER_SHUTDOWN
static java.lang.String
SCHEDULER_STARTED
static java.lang.String
SCHEDULING_DATA_CLEARED
static java.lang.String
TRIGGER_FINALIZED
static java.lang.String
TRIGGERS_PAUSED
static java.lang.String
TRIGGERS_RESUMED
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addJob(java.util.Map<java.lang.String,java.lang.Object> abstractJobInfo, boolean replace)
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.void
addJob(javax.management.openmbean.CompositeData jobDetail, boolean replace)
void
clear()
void
deleteCalendar(java.lang.String name)
boolean
deleteJob(java.lang.String jobName, java.lang.String jobGroupName)
javax.management.openmbean.TabularData
getAllJobDetails()
java.util.List<javax.management.openmbean.CompositeData>
getAllTriggers()
java.util.List<java.lang.String>
getCalendarNames()
javax.management.openmbean.TabularData
getCurrentlyExecutingJobs()
javax.management.openmbean.CompositeData
getJobDetail(java.lang.String jobName, java.lang.String jobGroupName)
java.util.List<java.lang.String>
getJobGroupNames()
java.util.List<java.lang.String>
getJobNames(java.lang.String groupName)
long
getJobsCompletedMostRecentSample()
long
getJobsExecutedMostRecentSample()
long
getJobsScheduledMostRecentSample()
java.lang.String
getJobStoreClassName()
java.util.Set<java.lang.String>
getPausedTriggerGroups()
java.util.Map<java.lang.String,java.lang.Long>
getPerformanceMetrics()
java.lang.String
getSchedulerInstanceId()
java.lang.String
getSchedulerName()
java.lang.String
getThreadPoolClassName()
int
getThreadPoolSize()
javax.management.openmbean.CompositeData
getTrigger(java.lang.String triggerName, java.lang.String triggerGroupName)
java.util.List<java.lang.String>
getTriggerGroupNames()
java.util.List<java.lang.String>
getTriggerNames(java.lang.String triggerGroupName)
java.util.List<javax.management.openmbean.CompositeData>
getTriggersOfJob(java.lang.String jobName, java.lang.String jobGroupName)
java.lang.String
getTriggerState(java.lang.String triggerName, java.lang.String triggerGroupName)
java.lang.String
getVersion()
boolean
interruptJob(java.lang.String fireInstanceId)
boolean
interruptJob(java.lang.String jobName, java.lang.String jobGroupName)
boolean
isSampledStatisticsEnabled()
boolean
isShutdown()
boolean
isStandbyMode()
boolean
isStarted()
void
pauseAllTriggers()
void
pauseJob(java.lang.String jobName, java.lang.String groupName)
void
pauseJobGroup(java.lang.String jobGroup)
void
pauseJobsAll()
Pause all jobs whose group is anythingvoid
pauseJobsContaining(java.lang.String jobGroupToken)
Pause all jobs whose group contains jobGroupTokenvoid
pauseJobsEndingWith(java.lang.String jobGroupSuffix)
Pause all jobs whose group ends with jobGroupSuffixvoid
pauseJobsStartingWith(java.lang.String jobGroupPrefix)
Pause all jobs whose group starts with jobGroupPrefixvoid
pauseTrigger(java.lang.String triggerName, java.lang.String triggerGroupName)
void
pauseTriggerGroup(java.lang.String triggerGroup)
void
pauseTriggersAll()
Pause all triggers whose group is anythingvoid
pauseTriggersContaining(java.lang.String triggerGroupToken)
Pause all triggers whose group contains triggerGroupTokenvoid
pauseTriggersEndingWith(java.lang.String suffix)
Pause all triggers whose group ends with triggerGroupSuffixvoid
pauseTriggersStartingWith(java.lang.String triggerGroupPrefix)
Pause all triggers whose group starts with triggerGroupPrefixvoid
resumeAllTriggers()
void
resumeJob(java.lang.String jobName, java.lang.String jobGroupName)
void
resumeJobGroup(java.lang.String jobGroup)
Resume all jobs in the given groupvoid
resumeJobsAll()
Resume all jobs whose group is anythingvoid
resumeJobsContaining(java.lang.String jobGroupToken)
Resume all jobs whose group contains jobGroupTokenvoid
resumeJobsEndingWith(java.lang.String jobGroupSuffix)
Resume all jobs whose group ends with jobGroupSuffixvoid
resumeJobsStartingWith(java.lang.String jobGroupPrefix)
Resume all jobs whose group starts with jobGroupPrefixvoid
resumeTrigger(java.lang.String triggerName, java.lang.String triggerGroupName)
void
resumeTriggerGroup(java.lang.String triggerGroup)
void
resumeTriggersAll()
Resume all triggers whose group is anythingvoid
resumeTriggersContaining(java.lang.String triggerGroupToken)
Resume all triggers whose group contains triggerGroupTokenvoid
resumeTriggersEndingWith(java.lang.String triggerGroupSuffix)
Resume all triggers whose group ends with triggerGroupSuffixvoid
resumeTriggersStartingWith(java.lang.String triggerGroupPrefix)
Resume all triggers whose group starts with triggerGroupPrefixvoid
scheduleBasicJob(java.util.Map<java.lang.String,java.lang.Object> jobDetailInfo, java.util.Map<java.lang.String,java.lang.Object> triggerInfo)
Schedules a job using the given Cron/Simple triggerInfo.java.util.Date
scheduleJob(java.lang.String jobName, java.lang.String jobGroup, java.lang.String triggerName, java.lang.String triggerGroup)
Schedule an existing job with an existing trigger.void
scheduleJob(java.lang.String jobName, java.lang.String jobGroup, java.util.Map<java.lang.String,java.lang.Object> abstractTriggerInfo)
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.void
scheduleJob(java.util.Map<java.lang.String,java.lang.Object> abstractJobInfo, java.util.Map<java.lang.String,java.lang.Object> abstractTriggerInfo)
Schedules an arbitrary job described by abstractJobInfo using a trigger specified by abstractTriggerInfo.void
setSampledStatisticsEnabled(boolean enabled)
void
shutdown()
void
standby()
void
start()
void
triggerJob(java.lang.String jobName, java.lang.String jobGroupName, java.util.Map<java.lang.String,java.lang.String> jobDataMap)
boolean
unscheduleJob(java.lang.String triggerName, java.lang.String triggerGroup)
-
-
-
Field Detail
-
SCHEDULER_STARTED
static final java.lang.String SCHEDULER_STARTED
- See Also:
- Constant Field Values
-
SCHEDULER_PAUSED
static final java.lang.String SCHEDULER_PAUSED
- See Also:
- Constant Field Values
-
SCHEDULER_SHUTDOWN
static final java.lang.String SCHEDULER_SHUTDOWN
- See Also:
- Constant Field Values
-
SCHEDULER_ERROR
static final java.lang.String SCHEDULER_ERROR
- See Also:
- Constant Field Values
-
JOB_ADDED
static final java.lang.String JOB_ADDED
- See Also:
- Constant Field Values
-
JOB_DELETED
static final java.lang.String JOB_DELETED
- See Also:
- Constant Field Values
-
JOB_SCHEDULED
static final java.lang.String JOB_SCHEDULED
- See Also:
- Constant Field Values
-
JOB_UNSCHEDULED
static final java.lang.String JOB_UNSCHEDULED
- See Also:
- Constant Field Values
-
JOBS_PAUSED
static final java.lang.String JOBS_PAUSED
- See Also:
- Constant Field Values
-
JOBS_RESUMED
static final java.lang.String JOBS_RESUMED
- See Also:
- Constant Field Values
-
JOB_EXECUTION_VETOED
static final java.lang.String JOB_EXECUTION_VETOED
- See Also:
- Constant Field Values
-
JOB_TO_BE_EXECUTED
static final java.lang.String JOB_TO_BE_EXECUTED
- See Also:
- Constant Field Values
-
JOB_WAS_EXECUTED
static final java.lang.String JOB_WAS_EXECUTED
- See Also:
- Constant Field Values
-
TRIGGER_FINALIZED
static final java.lang.String TRIGGER_FINALIZED
- See Also:
- Constant Field Values
-
TRIGGERS_PAUSED
static final java.lang.String TRIGGERS_PAUSED
- See Also:
- Constant Field Values
-
TRIGGERS_RESUMED
static final java.lang.String TRIGGERS_RESUMED
- See Also:
- Constant Field Values
-
SCHEDULING_DATA_CLEARED
static final java.lang.String SCHEDULING_DATA_CLEARED
- See Also:
- Constant Field Values
-
SAMPLED_STATISTICS_ENABLED
static final java.lang.String SAMPLED_STATISTICS_ENABLED
- See Also:
- Constant Field Values
-
SAMPLED_STATISTICS_RESET
static final java.lang.String SAMPLED_STATISTICS_RESET
- See Also:
- Constant Field Values
-
-
Method Detail
-
getSchedulerName
java.lang.String getSchedulerName()
-
getSchedulerInstanceId
java.lang.String getSchedulerInstanceId()
-
isStandbyMode
boolean isStandbyMode()
-
isShutdown
boolean isShutdown()
-
getVersion
java.lang.String getVersion()
-
getJobStoreClassName
java.lang.String getJobStoreClassName()
-
getThreadPoolClassName
java.lang.String getThreadPoolClassName()
-
getThreadPoolSize
int getThreadPoolSize()
-
getJobsScheduledMostRecentSample
long getJobsScheduledMostRecentSample()
-
getJobsExecutedMostRecentSample
long getJobsExecutedMostRecentSample()
-
getJobsCompletedMostRecentSample
long getJobsCompletedMostRecentSample()
-
getPerformanceMetrics
java.util.Map<java.lang.String,java.lang.Long> getPerformanceMetrics()
-
getCurrentlyExecutingJobs
javax.management.openmbean.TabularData getCurrentlyExecutingJobs() throws java.lang.Exception
- Returns:
- TabularData of CompositeData:JobExecutionContext
- Throws:
java.lang.Exception
-
getAllJobDetails
javax.management.openmbean.TabularData getAllJobDetails() throws java.lang.Exception
- Returns:
- TabularData of CompositeData:JobDetail
- Throws:
java.lang.Exception
- See Also:
JobDetailSupport
-
getAllTriggers
java.util.List<javax.management.openmbean.CompositeData> getAllTriggers() throws java.lang.Exception
- Returns:
- List of CompositeData:[CronTrigger|SimpleTrigger]
- Throws:
java.lang.Exception
- See Also:
TriggerSupport
-
getJobGroupNames
java.util.List<java.lang.String> getJobGroupNames() throws java.lang.Exception
- Throws:
java.lang.Exception
-
getJobNames
java.util.List<java.lang.String> getJobNames(java.lang.String groupName) throws java.lang.Exception
- Throws:
java.lang.Exception
-
getJobDetail
javax.management.openmbean.CompositeData getJobDetail(java.lang.String jobName, java.lang.String jobGroupName) throws java.lang.Exception
- Returns:
- CompositeData:JobDetail
- Throws:
java.lang.Exception
- See Also:
JobDetailSupport
-
isStarted
boolean isStarted()
-
start
void start() throws java.lang.Exception
- Throws:
java.lang.Exception
-
shutdown
void shutdown()
-
standby
void standby()
-
clear
void clear() throws java.lang.Exception
- Throws:
java.lang.Exception
-
scheduleJob
java.util.Date scheduleJob(java.lang.String jobName, java.lang.String jobGroup, java.lang.String triggerName, java.lang.String triggerGroup) throws java.lang.Exception
Schedule an existing job with an existing trigger.- Parameters:
jobName
-jobGroup
-triggerName
-triggerGroup
-- Returns:
- date of nextFireTime
- Throws:
java.lang.Exception
-
scheduleBasicJob
void scheduleBasicJob(java.util.Map<java.lang.String,java.lang.Object> jobDetailInfo, java.util.Map<java.lang.String,java.lang.Object> triggerInfo) throws java.lang.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- Throws:
java.lang.Exception
-
scheduleJob
void scheduleJob(java.util.Map<java.lang.String,java.lang.Object> abstractJobInfo, java.util.Map<java.lang.String,java.lang.Object> abstractTriggerInfo) throws java.lang.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<String, Object>
. Maps are further limited to containing values from the same set of types, less Map itself.- Throws:
java.lang.Exception
-
scheduleJob
void scheduleJob(java.lang.String jobName, java.lang.String jobGroup, java.util.Map<java.lang.String,java.lang.Object> abstractTriggerInfo) throws java.lang.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<String, Object>.
Maps are limited to containing values from the same set of types, less Map itself.- Parameters:
jobName
-jobGroup
-abstractTriggerInfo
-- Throws:
java.lang.Exception
-
unscheduleJob
boolean unscheduleJob(java.lang.String triggerName, java.lang.String triggerGroup) throws java.lang.Exception
- Throws:
java.lang.Exception
-
interruptJob
boolean interruptJob(java.lang.String jobName, java.lang.String jobGroupName) throws java.lang.Exception
- Throws:
java.lang.Exception
-
interruptJob
boolean interruptJob(java.lang.String fireInstanceId) throws java.lang.Exception
- Throws:
java.lang.Exception
-
triggerJob
void triggerJob(java.lang.String jobName, java.lang.String jobGroupName, java.util.Map<java.lang.String,java.lang.String> jobDataMap) throws java.lang.Exception
- Throws:
java.lang.Exception
-
deleteJob
boolean deleteJob(java.lang.String jobName, java.lang.String jobGroupName) throws java.lang.Exception
- Throws:
java.lang.Exception
-
addJob
void addJob(javax.management.openmbean.CompositeData jobDetail, boolean replace) throws java.lang.Exception
- Throws:
java.lang.Exception
-
addJob
void addJob(java.util.Map<java.lang.String,java.lang.Object> abstractJobInfo, boolean replace) throws java.lang.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<String, Object>.
Maps are limited to containing values from the same set of types, less Map itself.- Parameters:
abstractJobInfo
- map of attributes defining jobreplace
- whether or not to replace a pre-existing job with the same key- Throws:
java.lang.Exception
-
pauseJobGroup
void pauseJobGroup(java.lang.String jobGroup) throws java.lang.Exception
- Throws:
java.lang.Exception
-
pauseJobsStartingWith
void pauseJobsStartingWith(java.lang.String jobGroupPrefix) throws java.lang.Exception
Pause all jobs whose group starts with jobGroupPrefix- Throws:
java.lang.Exception
-
pauseJobsEndingWith
void pauseJobsEndingWith(java.lang.String jobGroupSuffix) throws java.lang.Exception
Pause all jobs whose group ends with jobGroupSuffix- Throws:
java.lang.Exception
-
pauseJobsContaining
void pauseJobsContaining(java.lang.String jobGroupToken) throws java.lang.Exception
Pause all jobs whose group contains jobGroupToken- Throws:
java.lang.Exception
-
pauseJobsAll
void pauseJobsAll() throws java.lang.Exception
Pause all jobs whose group is anything- Throws:
java.lang.Exception
-
resumeJobGroup
void resumeJobGroup(java.lang.String jobGroup) throws java.lang.Exception
Resume all jobs in the given group- Throws:
java.lang.Exception
-
resumeJobsStartingWith
void resumeJobsStartingWith(java.lang.String jobGroupPrefix) throws java.lang.Exception
Resume all jobs whose group starts with jobGroupPrefix- Throws:
java.lang.Exception
-
resumeJobsEndingWith
void resumeJobsEndingWith(java.lang.String jobGroupSuffix) throws java.lang.Exception
Resume all jobs whose group ends with jobGroupSuffix- Throws:
java.lang.Exception
-
resumeJobsContaining
void resumeJobsContaining(java.lang.String jobGroupToken) throws java.lang.Exception
Resume all jobs whose group contains jobGroupToken- Throws:
java.lang.Exception
-
resumeJobsAll
void resumeJobsAll() throws java.lang.Exception
Resume all jobs whose group is anything- Throws:
java.lang.Exception
-
pauseJob
void pauseJob(java.lang.String jobName, java.lang.String groupName) throws java.lang.Exception
- Throws:
java.lang.Exception
-
resumeJob
void resumeJob(java.lang.String jobName, java.lang.String jobGroupName) throws java.lang.Exception
- Throws:
java.lang.Exception
-
getTriggerGroupNames
java.util.List<java.lang.String> getTriggerGroupNames() throws java.lang.Exception
- Throws:
java.lang.Exception
-
getTriggerNames
java.util.List<java.lang.String> getTriggerNames(java.lang.String triggerGroupName) throws java.lang.Exception
- Throws:
java.lang.Exception
-
getTrigger
javax.management.openmbean.CompositeData getTrigger(java.lang.String triggerName, java.lang.String triggerGroupName) throws java.lang.Exception
- Throws:
java.lang.Exception
-
getTriggerState
java.lang.String getTriggerState(java.lang.String triggerName, java.lang.String triggerGroupName) throws java.lang.Exception
- Throws:
java.lang.Exception
-
getTriggersOfJob
java.util.List<javax.management.openmbean.CompositeData> getTriggersOfJob(java.lang.String jobName, java.lang.String jobGroupName) throws java.lang.Exception
- Returns:
- List of CompositeData:[CronTrigger|SimpleTrigger] for the specified job.
- Throws:
java.lang.Exception
- See Also:
TriggerSupport
-
getPausedTriggerGroups
java.util.Set<java.lang.String> getPausedTriggerGroups() throws java.lang.Exception
- Throws:
java.lang.Exception
-
pauseAllTriggers
void pauseAllTriggers() throws java.lang.Exception
- Throws:
java.lang.Exception
-
resumeAllTriggers
void resumeAllTriggers() throws java.lang.Exception
- Throws:
java.lang.Exception
-
pauseTriggerGroup
void pauseTriggerGroup(java.lang.String triggerGroup) throws java.lang.Exception
- Throws:
java.lang.Exception
-
pauseTriggersStartingWith
void pauseTriggersStartingWith(java.lang.String triggerGroupPrefix) throws java.lang.Exception
Pause all triggers whose group starts with triggerGroupPrefix- Throws:
java.lang.Exception
-
pauseTriggersEndingWith
void pauseTriggersEndingWith(java.lang.String suffix) throws java.lang.Exception
Pause all triggers whose group ends with triggerGroupSuffix- Throws:
java.lang.Exception
-
pauseTriggersContaining
void pauseTriggersContaining(java.lang.String triggerGroupToken) throws java.lang.Exception
Pause all triggers whose group contains triggerGroupToken- Throws:
java.lang.Exception
-
pauseTriggersAll
void pauseTriggersAll() throws java.lang.Exception
Pause all triggers whose group is anything- Throws:
java.lang.Exception
-
resumeTriggerGroup
void resumeTriggerGroup(java.lang.String triggerGroup) throws java.lang.Exception
- Throws:
java.lang.Exception
-
resumeTriggersStartingWith
void resumeTriggersStartingWith(java.lang.String triggerGroupPrefix) throws java.lang.Exception
Resume all triggers whose group starts with triggerGroupPrefix- Throws:
java.lang.Exception
-
resumeTriggersEndingWith
void resumeTriggersEndingWith(java.lang.String triggerGroupSuffix) throws java.lang.Exception
Resume all triggers whose group ends with triggerGroupSuffix- Throws:
java.lang.Exception
-
resumeTriggersContaining
void resumeTriggersContaining(java.lang.String triggerGroupToken) throws java.lang.Exception
Resume all triggers whose group contains triggerGroupToken- Throws:
java.lang.Exception
-
resumeTriggersAll
void resumeTriggersAll() throws java.lang.Exception
Resume all triggers whose group is anything- Throws:
java.lang.Exception
-
pauseTrigger
void pauseTrigger(java.lang.String triggerName, java.lang.String triggerGroupName) throws java.lang.Exception
- Throws:
java.lang.Exception
-
resumeTrigger
void resumeTrigger(java.lang.String triggerName, java.lang.String triggerGroupName) throws java.lang.Exception
- Throws:
java.lang.Exception
-
getCalendarNames
java.util.List<java.lang.String> getCalendarNames() throws java.lang.Exception
- Throws:
java.lang.Exception
-
deleteCalendar
void deleteCalendar(java.lang.String name) throws java.lang.Exception
- Throws:
java.lang.Exception
-
setSampledStatisticsEnabled
void setSampledStatisticsEnabled(boolean enabled)
-
isSampledStatisticsEnabled
boolean isSampledStatisticsEnabled()
-
-