Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.rhq.enterprise.server.scheduler
Interface SchedulerServiceMBean

All Superinterfaces:
org.quartz.Scheduler
All Known Subinterfaces:
SchedulerLocal
All Known Implementing Classes:
SchedulerBean, SchedulerService
public interface SchedulerServiceMBean
extends org.quartz.Scheduler

MBean interface which is also the local interface to the scheduler SLSB. This is essentially the same interface as the Quartz scheduler. We have both an MBean and SLSB fascade to Quartz - see SchedulerLocal.

Field Summary
static ObjectName SCHEDULER_MBEAN_NAME
          The Scheduler MBean Server name.
 
Fields inherited from interface org.quartz.Scheduler
DEFAULT_FAIL_OVER_GROUP, DEFAULT_GROUP, DEFAULT_MANUAL_TRIGGERS, DEFAULT_RECOVERY_GROUP, FAILED_JOB_ORIGINAL_TRIGGER_FIRETIME_IN_MILLISECONDS, FAILED_JOB_ORIGINAL_TRIGGER_GROUP, FAILED_JOB_ORIGINAL_TRIGGER_NAME
 
Method Summary
 void addCalendar(String calName, org.quartz.Calendar calendar, boolean replace, boolean updateTriggers)
           
 void addGlobalJobListener(org.quartz.JobListener jobListener)
           
 void addGlobalTriggerListener(org.quartz.TriggerListener triggerListener)
           
 void addJob(org.quartz.JobDetail jobDetail, boolean replace)
           
 void addJobListener(org.quartz.JobListener jobListener)
           
 void addSchedulerListener(org.quartz.SchedulerListener schedulerListener)
           
 void addTriggerListener(org.quartz.TriggerListener triggerListener)
           
 boolean deleteCalendar(String calName)
           
 boolean deleteJob(String jobName, String groupName)
           
 org.quartz.Calendar getCalendar(String calName)
           
 String[] getCalendarNames()
           
 org.quartz.SchedulerContext getContext()
           
 List getCurrentlyExecutingJobs()
           
 Integer getDefaultOperationTimeout()
          Returns the configured operation timeout.
 List getGlobalJobListeners()
           
 List getGlobalTriggerListeners()
           
 org.quartz.JobDetail getJobDetail(String jobName, String jobGroup)
           
 String[] getJobGroupNames()
           
 org.quartz.JobListener getJobListener(String name)
           
 Set getJobListenerNames()
           
 String[] getJobNames(String groupName)
           
 org.quartz.SchedulerMetaData getMetaData()
           
 Set getPausedTriggerGroups()
           
 Properties getQuartzProperties()
          Get the properties for Quartz.
 String getSchedulerInstanceId()
           
 List getSchedulerListeners()
           
 String getSchedulerName()
           
 org.quartz.Trigger getTrigger(String triggerName, String triggerGroup)
           
 String[] getTriggerGroupNames()
           
 org.quartz.TriggerListener getTriggerListener(String name)
           
 Set getTriggerListenerNames()
           
 String[] getTriggerNames(String groupName)
           
 org.quartz.Trigger[] getTriggersOfJob(String jobName, String groupName)
           
 int getTriggerState(String triggerName, String triggerGroup)
           
 void initQuartzScheduler()
          This creates the scheduler but does not start it.
 boolean interrupt(String jobName, String groupName)
           
 boolean isInStandbyMode()
           
 boolean isPaused()
           
 boolean isShutdown()
           
 void pause()
           
 void pauseAll()
           
 void pauseJob(String jobName, String groupName)
           
 void pauseJobGroup(String groupName)
           
 void pauseTrigger(String triggerName, String groupName)
           
 void pauseTriggerGroup(String groupName)
           
 boolean removeGlobalJobListener(org.quartz.JobListener jobListener)
           
 boolean removeGlobalTriggerListener(org.quartz.TriggerListener triggerListener)
           
 boolean removeJobListener(String name)
           
 boolean removeSchedulerListener(org.quartz.SchedulerListener schedulerListener)
           
 boolean removeTriggerListener(String name)
           
 Date rescheduleJob(String triggerName, String groupName, org.quartz.Trigger newTrigger)
           
 void resumeAll()
           
 void resumeJob(String jobName, String groupName)
           
 void resumeJobGroup(String groupName)
           
 void resumeTrigger(String triggerName, String groupName)
           
 void resumeTriggerGroup(String groupName)
           
 Date scheduleJob(org.quartz.JobDetail jobDetail, org.quartz.Trigger trigger)
           
 Date scheduleJob(org.quartz.Trigger trigger)
           
 void setJobFactory(org.quartz.spi.JobFactory factory)
           
 void setQuartzProperties(Properties quartzProps)
          Set the properties for Quartz and reinitialize the Quartz scheduler factory.
 void shutdown()
           
 void shutdown(boolean waitForJobsToComplete)
           
 void standby()
           
 void start()
          This method's semantics are overloaded since start() is used both by the Quartz interface and the JBossAS MBean service interface.
 void startQuartzScheduler()
          This actually starts the scheduler.
 void triggerJob(String jobName, String groupName)
           
 void triggerJob(String jobName, String groupName, org.quartz.JobDataMap data)
           
 void triggerJobWithVolatileTrigger(String jobName, String groupName)
           
 void triggerJobWithVolatileTrigger(String jobName, String groupName, org.quartz.JobDataMap data)
           
 boolean unscheduleJob(String triggerName, String groupName)
           
 
Methods inherited from interface org.quartz.Scheduler
getGlobalJobListener, getGlobalTriggerListener, isStarted, removeGlobalJobListener, removeGlobalTriggerListener, startDelayed
 

Field Detail

SCHEDULER_MBEAN_NAME

static final ObjectName SCHEDULER_MBEAN_NAME
The Scheduler MBean Server name.

Method Detail

getQuartzProperties

Properties getQuartzProperties()
Get the properties for Quartz.

Returns:
Quartz configuration properties

setQuartzProperties

void setQuartzProperties(Properties quartzProps)
                         throws org.quartz.SchedulerException
Set the properties for Quartz and reinitialize the Quartz scheduler factory.

Parameters:
quartzProps - the new properties
Throws:
org.quartz.SchedulerException - if failed to initialize Quartz

getDefaultOperationTimeout

Integer getDefaultOperationTimeout()
Returns the configured operation timeout. The scheduler can have defined in its configuration a custom property that indicates how long an operation is allowed to run before it is considered to have timed out. This is used to clean out old running operations that are hung in the in-progress state.

Returns:
the default operation timeout, or null if not defined
See Also:
OperationManagerLocal#checkForTimedOutOperations()

initQuartzScheduler

void initQuartzScheduler()
                         throws org.quartz.SchedulerException
This creates the scheduler but does not start it. Calling this method will NOT start executing jobs.

Throws:
org.quartz.SchedulerException

startQuartzScheduler

void startQuartzScheduler()
                          throws org.quartz.SchedulerException
This actually starts the scheduler. Calling this method will start executing jobs. Make sure when you call this method that the server is fully up and all EJBs are deployed.

Throws:
org.quartz.SchedulerException

getSchedulerName

String getSchedulerName()
                        throws org.quartz.SchedulerException
Specified by:
getSchedulerName in interface org.quartz.Scheduler
Throws:
org.quartz.SchedulerException

getSchedulerInstanceId

String getSchedulerInstanceId()
                              throws org.quartz.SchedulerException
Specified by:
getSchedulerInstanceId in interface org.quartz.Scheduler
Throws:
org.quartz.SchedulerException

getContext

org.quartz.SchedulerContext getContext()
                                       throws org.quartz.SchedulerException
Specified by:
getContext in interface org.quartz.Scheduler
Throws:
org.quartz.SchedulerException

getMetaData

org.quartz.SchedulerMetaData getMetaData()
                                         throws org.quartz.SchedulerException
Specified by:
getMetaData in interface org.quartz.Scheduler
Throws:
org.quartz.SchedulerException

start

void start()
           throws org.quartz.SchedulerException
This method's semantics are overloaded since start() is used both by the Quartz interface and the JBossAS MBean service interface. Calling this method does not start the Quartz scheduler. It only starts the MBean service. To actually start the Quartz scheduler, the MBean service must have been started (that is, this method called) and startQuartzScheduler() must be called.

Specified by:
start in interface org.quartz.Scheduler
Throws:
org.quartz.SchedulerException
See Also:
startQuartzScheduler()

pause

void pause()
           throws org.quartz.SchedulerException
Specified by:
pause in interface org.quartz.Scheduler
Throws:
org.quartz.SchedulerException

isPaused

boolean isPaused()
                 throws org.quartz.SchedulerException
Specified by:
isPaused in interface org.quartz.Scheduler
Throws:
org.quartz.SchedulerException

shutdown

void shutdown()
              throws org.quartz.SchedulerException
Specified by:
shutdown in interface org.quartz.Scheduler
Throws:
org.quartz.SchedulerException

shutdown

void shutdown(boolean waitForJobsToComplete)
              throws org.quartz.SchedulerException
Specified by:
shutdown in interface org.quartz.Scheduler
Throws:
org.quartz.SchedulerException

isShutdown

boolean isShutdown()
                   throws org.quartz.SchedulerException
Specified by:
isShutdown in interface org.quartz.Scheduler
Throws:
org.quartz.SchedulerException

getCurrentlyExecutingJobs

List getCurrentlyExecutingJobs()
                               throws org.quartz.SchedulerException
Specified by:
getCurrentlyExecutingJobs in interface org.quartz.Scheduler
Throws:
org.quartz.SchedulerException

scheduleJob

Date scheduleJob(org.quartz.JobDetail jobDetail,
                 org.quartz.Trigger trigger)
                 throws org.quartz.SchedulerException
Specified by:
scheduleJob in interface org.quartz.Scheduler
Throws:
org.quartz.SchedulerException

scheduleJob

Date scheduleJob(org.quartz.Trigger trigger)
                 throws org.quartz.SchedulerException
Specified by:
scheduleJob in interface org.quartz.Scheduler
Throws:
org.quartz.SchedulerException

addJob

void addJob(org.quartz.JobDetail jobDetail,
            boolean replace)
            throws org.quartz.SchedulerException
Specified by:
addJob in interface org.quartz.Scheduler
Throws:
org.quartz.SchedulerException

deleteJob

boolean deleteJob(String jobName,
                  String groupName)
                  throws org.quartz.SchedulerException
Specified by:
deleteJob in interface org.quartz.Scheduler
Throws:
org.quartz.SchedulerException

unscheduleJob

boolean unscheduleJob(String triggerName,
                      String groupName)
                      throws org.quartz.SchedulerException
Specified by:
unscheduleJob in interface org.quartz.Scheduler
Throws:
org.quartz.SchedulerException

triggerJob

void triggerJob(String jobName,
                String groupName)
                throws org.quartz.SchedulerException
Specified by:
triggerJob in interface org.quartz.Scheduler
Throws:
org.quartz.SchedulerException

triggerJobWithVolatileTrigger

void triggerJobWithVolatileTrigger(String jobName,
                                   String groupName)
                                   throws org.quartz.SchedulerException
Specified by:
triggerJobWithVolatileTrigger in interface org.quartz.Scheduler
Throws:
org.quartz.SchedulerException

pauseTrigger

void pauseTrigger(String triggerName,
                  String groupName)
                  throws org.quartz.SchedulerException
Specified by:
pauseTrigger in interface org.quartz.Scheduler
Throws:
org.quartz.SchedulerException

pauseTriggerGroup

void pauseTriggerGroup(String groupName)
                       throws org.quartz.SchedulerException
Specified by:
pauseTriggerGroup in interface org.quartz.Scheduler
Throws:
org.quartz.SchedulerException

pauseJob

void pauseJob(String jobName,
              String groupName)
              throws org.quartz.SchedulerException
Specified by:
pauseJob in interface org.quartz.Scheduler
Throws:
org.quartz.SchedulerException

pauseJobGroup

void pauseJobGroup(String groupName)
                   throws org.quartz.SchedulerException
Specified by:
pauseJobGroup in interface org.quartz.Scheduler
Throws:
org.quartz.SchedulerException

resumeTrigger

void resumeTrigger(String triggerName,
                   String groupName)
                   throws org.quartz.SchedulerException
Specified by:
resumeTrigger in interface org.quartz.Scheduler
Throws:
org.quartz.SchedulerException

resumeTriggerGroup

void resumeTriggerGroup(String groupName)
                        throws org.quartz.SchedulerException
Specified by:
resumeTriggerGroup in interface org.quartz.Scheduler
Throws:
org.quartz.SchedulerException

resumeJob

void resumeJob(String jobName,
               String groupName)
               throws org.quartz.SchedulerException
Specified by:
resumeJob in interface org.quartz.Scheduler
Throws:
org.quartz.SchedulerException

resumeJobGroup

void resumeJobGroup(String groupName)
                    throws org.quartz.SchedulerException
Specified by:
resumeJobGroup in interface org.quartz.Scheduler
Throws:
org.quartz.SchedulerException

getJobGroupNames

String[] getJobGroupNames()
                          throws org.quartz.SchedulerException
Specified by:
getJobGroupNames in interface org.quartz.Scheduler
Throws:
org.quartz.SchedulerException

getJobNames

String[] getJobNames(String groupName)
                     throws org.quartz.SchedulerException
Specified by:
getJobNames in interface org.quartz.Scheduler
Throws:
org.quartz.SchedulerException

getTriggersOfJob

org.quartz.Trigger[] getTriggersOfJob(String jobName,
                                      String groupName)
                                      throws org.quartz.SchedulerException
Specified by:
getTriggersOfJob in interface org.quartz.Scheduler
Throws:
org.quartz.SchedulerException

getTriggerGroupNames

String[] getTriggerGroupNames()
                              throws org.quartz.SchedulerException
Specified by:
getTriggerGroupNames in interface org.quartz.Scheduler
Throws:
org.quartz.SchedulerException

getTriggerNames

String[] getTriggerNames(String groupName)
                         throws org.quartz.SchedulerException
Specified by:
getTriggerNames in interface org.quartz.Scheduler
Throws:
org.quartz.SchedulerException

getJobDetail

org.quartz.JobDetail getJobDetail(String jobName,
                                  String jobGroup)
                                  throws org.quartz.SchedulerException
Specified by:
getJobDetail in interface org.quartz.Scheduler
Throws:
org.quartz.SchedulerException

getTrigger

org.quartz.Trigger getTrigger(String triggerName,
                              String triggerGroup)
                              throws org.quartz.SchedulerException
Specified by:
getTrigger in interface org.quartz.Scheduler
Throws:
org.quartz.SchedulerException

deleteCalendar

boolean deleteCalendar(String calName)
                       throws org.quartz.SchedulerException
Specified by:
deleteCalendar in interface org.quartz.Scheduler
Throws:
org.quartz.SchedulerException

getCalendar

org.quartz.Calendar getCalendar(String calName)
                                throws org.quartz.SchedulerException
Specified by:
getCalendar in interface org.quartz.Scheduler
Throws:
org.quartz.SchedulerException

getCalendarNames

String[] getCalendarNames()
                          throws org.quartz.SchedulerException
Specified by:
getCalendarNames in interface org.quartz.Scheduler
Throws:
org.quartz.SchedulerException

addGlobalJobListener

void addGlobalJobListener(org.quartz.JobListener jobListener)
                          throws org.quartz.SchedulerException
Specified by:
addGlobalJobListener in interface org.quartz.Scheduler
Throws:
org.quartz.SchedulerException

addJobListener

void addJobListener(org.quartz.JobListener jobListener)
                    throws org.quartz.SchedulerException
Specified by:
addJobListener in interface org.quartz.Scheduler
Throws:
org.quartz.SchedulerException

removeGlobalJobListener

boolean removeGlobalJobListener(org.quartz.JobListener jobListener)
                                throws org.quartz.SchedulerException
Specified by:
removeGlobalJobListener in interface org.quartz.Scheduler
Throws:
org.quartz.SchedulerException

removeJobListener

boolean removeJobListener(String name)
                          throws org.quartz.SchedulerException
Specified by:
removeJobListener in interface org.quartz.Scheduler
Throws:
org.quartz.SchedulerException

getGlobalJobListeners

List getGlobalJobListeners()
                           throws org.quartz.SchedulerException
Specified by:
getGlobalJobListeners in interface org.quartz.Scheduler
Throws:
org.quartz.SchedulerException

getJobListenerNames

Set getJobListenerNames()
                        throws org.quartz.SchedulerException
Specified by:
getJobListenerNames in interface org.quartz.Scheduler
Throws:
org.quartz.SchedulerException

getJobListener

org.quartz.JobListener getJobListener(String name)
                                      throws org.quartz.SchedulerException
Specified by:
getJobListener in interface org.quartz.Scheduler
Throws:
org.quartz.SchedulerException

addGlobalTriggerListener

void addGlobalTriggerListener(org.quartz.TriggerListener triggerListener)
                              throws org.quartz.SchedulerException
Specified by:
addGlobalTriggerListener in interface org.quartz.Scheduler
Throws:
org.quartz.SchedulerException

addTriggerListener

void addTriggerListener(org.quartz.TriggerListener triggerListener)
                        throws org.quartz.SchedulerException
Specified by:
addTriggerListener in interface org.quartz.Scheduler
Throws:
org.quartz.SchedulerException

removeGlobalTriggerListener

boolean removeGlobalTriggerListener(org.quartz.TriggerListener triggerListener)
                                    throws org.quartz.SchedulerException
Specified by:
removeGlobalTriggerListener in interface org.quartz.Scheduler
Throws:
org.quartz.SchedulerException

removeTriggerListener

boolean removeTriggerListener(String name)
                              throws org.quartz.SchedulerException
Specified by:
removeTriggerListener in interface org.quartz.Scheduler
Throws:
org.quartz.SchedulerException

getGlobalTriggerListeners

List getGlobalTriggerListeners()
                               throws org.quartz.SchedulerException
Specified by:
getGlobalTriggerListeners in interface org.quartz.Scheduler
Throws:
org.quartz.SchedulerException

getTriggerListenerNames

Set getTriggerListenerNames()
                            throws org.quartz.SchedulerException
Specified by:
getTriggerListenerNames in interface org.quartz.Scheduler
Throws:
org.quartz.SchedulerException

getTriggerListener

org.quartz.TriggerListener getTriggerListener(String name)
                                              throws org.quartz.SchedulerException
Specified by:
getTriggerListener in interface org.quartz.Scheduler
Throws:
org.quartz.SchedulerException

addSchedulerListener

void addSchedulerListener(org.quartz.SchedulerListener schedulerListener)
                          throws org.quartz.SchedulerException
Specified by:
addSchedulerListener in interface org.quartz.Scheduler
Throws:
org.quartz.SchedulerException

removeSchedulerListener

boolean removeSchedulerListener(org.quartz.SchedulerListener schedulerListener)
                                throws org.quartz.SchedulerException
Specified by:
removeSchedulerListener in interface org.quartz.Scheduler
Throws:
org.quartz.SchedulerException

getSchedulerListeners

List getSchedulerListeners()
                           throws org.quartz.SchedulerException
Specified by:
getSchedulerListeners in interface org.quartz.Scheduler
Throws:
org.quartz.SchedulerException

addCalendar

void addCalendar(String calName,
                 org.quartz.Calendar calendar,
                 boolean replace,
                 boolean updateTriggers)
                 throws org.quartz.SchedulerException
Specified by:
addCalendar in interface org.quartz.Scheduler
Throws:
org.quartz.SchedulerException

getPausedTriggerGroups

Set getPausedTriggerGroups()
                           throws org.quartz.SchedulerException
Specified by:
getPausedTriggerGroups in interface org.quartz.Scheduler
Throws:
org.quartz.SchedulerException

getTriggerState

int getTriggerState(String triggerName,
                    String triggerGroup)
                    throws org.quartz.SchedulerException
Specified by:
getTriggerState in interface org.quartz.Scheduler
Throws:
org.quartz.SchedulerException

interrupt

boolean interrupt(String jobName,
                  String groupName)
                  throws org.quartz.UnableToInterruptJobException
Specified by:
interrupt in interface org.quartz.Scheduler
Throws:
org.quartz.UnableToInterruptJobException

isInStandbyMode

boolean isInStandbyMode()
                        throws org.quartz.SchedulerException
Specified by:
isInStandbyMode in interface org.quartz.Scheduler
Throws:
org.quartz.SchedulerException

pauseAll

void pauseAll()
              throws org.quartz.SchedulerException
Specified by:
pauseAll in interface org.quartz.Scheduler
Throws:
org.quartz.SchedulerException

rescheduleJob

Date rescheduleJob(String triggerName,
                   String groupName,
                   org.quartz.Trigger newTrigger)
                   throws org.quartz.SchedulerException
Specified by:
rescheduleJob in interface org.quartz.Scheduler
Throws:
org.quartz.SchedulerException

resumeAll

void resumeAll()
               throws org.quartz.SchedulerException
Specified by:
resumeAll in interface org.quartz.Scheduler
Throws:
org.quartz.SchedulerException

setJobFactory

void setJobFactory(org.quartz.spi.JobFactory factory)
                   throws org.quartz.SchedulerException
Specified by:
setJobFactory in interface org.quartz.Scheduler
Throws:
org.quartz.SchedulerException

standby

void standby()
             throws org.quartz.SchedulerException
Specified by:
standby in interface org.quartz.Scheduler
Throws:
org.quartz.SchedulerException

triggerJob

void triggerJob(String jobName,
                String groupName,
                org.quartz.JobDataMap data)
                throws org.quartz.SchedulerException
Specified by:
triggerJob in interface org.quartz.Scheduler
Throws:
org.quartz.SchedulerException

triggerJobWithVolatileTrigger

void triggerJobWithVolatileTrigger(String jobName,
                                   String groupName,
                                   org.quartz.JobDataMap data)
                                   throws org.quartz.SchedulerException
Specified by:
triggerJobWithVolatileTrigger in interface org.quartz.Scheduler
Throws:
org.quartz.SchedulerException
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2008-2012 Red Hat, Inc.. All Rights Reserved.