OpenSymphony - RemoteScheduler (Quartz Enterprise Job Scheduler API

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.quartz.impl
Class RemoteScheduler

java.lang.Object
  org.quartz.impl.RemoteScheduler

All Implemented Interfaces:: Scheduler

public class RemoteScheduler
extends Object
implements Scheduler
extends Object
implements Scheduler

An implementation of the Scheduler interface that remotely proxies all method calls to the equivalent call on a given QuartzScheduler instance, via RMI.

Author:: James House
See Also:: Scheduler, QuartzScheduler, SchedulingContext

Field Summary

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

Constructor Summary

RemoteScheduler(SchedulingContext schedCtxt, String schedId, String host, int port)
           Construct a RemoteScheduler instance to proxy the given RemoteableQuartzScheduler instance, and with the given SchedulingContext.

Method Summary

void addCalendar(String calName, Calendar calendar, boolean replace, boolean updateTriggers)
           Calls the equivalent method on the 'proxied' QuartzScheduler, passing the SchedulingContext associated with this instance.

void addGlobalJobListener(JobListener jobListener)
           Calls the equivalent method on the 'proxied' QuartzScheduler.

void addGlobalTriggerListener(TriggerListener triggerListener)
           Calls the equivalent method on the 'proxied' QuartzScheduler.

void addJob(JobDetail jobDetail, boolean replace)
           Calls the equivalent method on the 'proxied' QuartzScheduler, passing the SchedulingContext associated with this instance.

void addJobListener(JobListener jobListener)
           Calls the equivalent method on the 'proxied' QuartzScheduler.

void addSchedulerListener(SchedulerListener schedulerListener)
           Calls the equivalent method on the 'proxied' QuartzScheduler.

void addTriggerListener(TriggerListener triggerListener)
           Calls the equivalent method on the 'proxied' QuartzScheduler.

boolean deleteCalendar(String calName)
           Calls the equivalent method on the 'proxied' QuartzScheduler, passing the SchedulingContext associated with this instance.

boolean deleteJob(String jobName, String groupName)
           Calls the equivalent method on the 'proxied' QuartzScheduler, passing the SchedulingContext associated with this instance.

Calendar getCalendar(String calName)
           Calls the equivalent method on the 'proxied' QuartzScheduler, passing the SchedulingContext associated with this instance.

String[] getCalendarNames()
           Calls the equivalent method on the 'proxied' QuartzScheduler, passing the SchedulingContext associated with this instance.

SchedulerContext getContext()
           Returns the SchedulerContext of the Scheduler.

List getCurrentlyExecutingJobs()
           Calls the equivalent method on the 'proxied' QuartzScheduler.

JobListener getGlobalJobListener(String name)
           Calls the equivalent method on the 'proxied' QuartzScheduler.

List getGlobalJobListeners()
           Calls the equivalent method on the 'proxied' QuartzScheduler.

TriggerListener getGlobalTriggerListener(String name)
           Calls the equivalent method on the 'proxied' QuartzScheduler.

List getGlobalTriggerListeners()
           Calls the equivalent method on the 'proxied' QuartzScheduler.

JobDetail getJobDetail(String jobName, String jobGroup)
           Calls the equivalent method on the 'proxied' QuartzScheduler, passing the SchedulingContext associated with this instance.

String[] getJobGroupNames()
           Calls the equivalent method on the 'proxied' QuartzScheduler, passing the SchedulingContext associated with this instance.

JobListener getJobListener(String name)
           Calls the equivalent method on the 'proxied' QuartzScheduler.

Set getJobListenerNames()
           Calls the equivalent method on the 'proxied' QuartzScheduler.

String[] getJobNames(String groupName)
           Calls the equivalent method on the 'proxied' QuartzScheduler, passing the SchedulingContext associated with this instance.

SchedulerMetaData getMetaData()
           Get a SchedulerMetaData object describiing the settings and capabilities of the scheduler instance.

Set getPausedTriggerGroups()
           Get the names of all Trigger groups that are paused.

protected RemotableQuartzScheduler getRemoteScheduler()


String getSchedulerInstanceId()
           Returns the instance Id of the Scheduler.

List getSchedulerListeners()
           Calls the equivalent method on the 'proxied' QuartzScheduler.

String getSchedulerName()
           Returns the name of the Scheduler.

Trigger getTrigger(String triggerName, String triggerGroup)
           Calls the equivalent method on the 'proxied' QuartzScheduler, passing the SchedulingContext associated with this instance.

String[] getTriggerGroupNames()
           Calls the equivalent method on the 'proxied' QuartzScheduler, passing the SchedulingContext associated with this instance.

TriggerListener getTriggerListener(String name)
           Calls the equivalent method on the 'proxied' QuartzScheduler.

Set getTriggerListenerNames()
           Calls the equivalent method on the 'proxied' QuartzScheduler.

String[] getTriggerNames(String groupName)
           Calls the equivalent method on the 'proxied' QuartzScheduler, passing the SchedulingContext associated with this instance.

Trigger[] getTriggersOfJob(String jobName, String groupName)
           Calls the equivalent method on the 'proxied' QuartzScheduler, passing the SchedulingContext associated with this instance.

int getTriggerState(String triggerName, String triggerGroup)
           Calls the equivalent method on the 'proxied' QuartzScheduler, passing the SchedulingContext associated with this instance.

boolean interrupt(String jobName, String groupName)
           Request the interruption, within this Scheduler instance, of all currently executing instances of the identified Job, which must be an implementor of the InterruptableJob interface.

protected SchedulerException invalidateHandleCreateException(String msg, Exception cause)


boolean isInStandbyMode()
           Calls the equivalent method on the 'proxied' QuartzScheduler.

boolean isPaused()


boolean isShutdown()
           Calls the equivalent method on the 'proxied' QuartzScheduler.

boolean isStarted()
          Whether the scheduler has been started.

void pause()
          Deprecated.

void pauseAll()
           Calls the equivalent method on the 'proxied' QuartzScheduler, passing the SchedulingContext associated with this instance.

void pauseJob(String jobName, String groupName)
           Calls the equivalent method on the 'proxied' QuartzScheduler, passing the SchedulingContext associated with this instance.

void pauseJobGroup(String groupName)
           Calls the equivalent method on the 'proxied' QuartzScheduler, passing the SchedulingContext associated with this instance.

void pauseTrigger(String triggerName, String groupName)
           Calls the equivalent method on the 'proxied' QuartzScheduler, passing the SchedulingContext associated with this instance.

void pauseTriggerGroup(String groupName)
           Calls the equivalent method on the 'proxied' QuartzScheduler, passing the SchedulingContext associated with this instance.

boolean removeGlobalJobListener(JobListener jobListener)
          Deprecated. Use removeGlobalJobListener(String)

boolean removeGlobalJobListener(String name)
           Calls the equivalent method on the 'proxied' QuartzScheduler.

boolean removeGlobalTriggerListener(String name)
           Calls the equivalent method on the 'proxied' QuartzScheduler.

boolean removeGlobalTriggerListener(TriggerListener triggerListener)
          Deprecated. Use removeGlobalTriggerListener(String)

boolean removeJobListener(String name)
           Calls the equivalent method on the 'proxied' QuartzScheduler.

boolean removeSchedulerListener(SchedulerListener schedulerListener)
           Calls the equivalent method on the 'proxied' QuartzScheduler.

boolean removeTriggerListener(String name)
           Calls the equivalent method on the 'proxied' QuartzScheduler.

Date rescheduleJob(String triggerName, String groupName, Trigger newTrigger)
           Calls the equivalent method on the 'proxied' QuartzScheduler, passing the SchedulingContext associated with this instance.

void resumeAll()
           Calls the equivalent method on the 'proxied' QuartzScheduler, passing the SchedulingContext associated with this instance.

void resumeJob(String jobName, String groupName)
           Calls the equivalent method on the 'proxied' QuartzScheduler, passing the SchedulingContext associated with this instance.

void resumeJobGroup(String groupName)
           Calls the equivalent method on the 'proxied' QuartzScheduler, passing the SchedulingContext associated with this instance.

void resumeTrigger(String triggerName, String groupName)
           Calls the equivalent method on the 'proxied' QuartzScheduler, passing the SchedulingContext associated with this instance.

void resumeTriggerGroup(String groupName)
           Calls the equivalent method on the 'proxied' QuartzScheduler, passing the SchedulingContext associated with this instance.

Date scheduleJob(JobDetail jobDetail, Trigger trigger)
           Calls the equivalent method on the 'proxied' QuartzScheduler, passing the SchedulingContext associated with this instance.

Date scheduleJob(Trigger trigger)
           Calls the equivalent method on the 'proxied' QuartzScheduler, passing the SchedulingContext associated with this instance.

void setJobFactory(JobFactory factory)
           Set the JobFactory that will be responsible for producing instances of Job classes.

void shutdown()
           Calls the equivalent method on the 'proxied' QuartzScheduler.

void shutdown(boolean waitForJobsToComplete)
           Calls the equivalent method on the 'proxied' QuartzScheduler.

void standby()
           Calls the equivalent method on the 'proxied' QuartzScheduler.

void start()
           Calls the equivalent method on the 'proxied' QuartzScheduler.

void startDelayed(int seconds)
           Calls the equivalent method on the 'proxied' QuartzScheduler.

void triggerJob(String jobName, String groupName)
           Calls the equivalent method on the 'proxied' QuartzScheduler, passing the SchedulingContext associated with this instance.

void triggerJob(String jobName, String groupName, JobDataMap data)
           Calls the equivalent method on the 'proxied' QuartzScheduler, passing the SchedulingContext associated with this instance.

void triggerJobWithVolatileTrigger(String jobName, String groupName)
           Calls the equivalent method on the 'proxied' QuartzScheduler, passing the SchedulingContext associated with this instance.

void triggerJobWithVolatileTrigger(String jobName, String groupName, JobDataMap data)
           Calls the equivalent method on the 'proxied' QuartzScheduler, passing the SchedulingContext associated with this instance.

boolean unscheduleJob(String triggerName, String groupName)
           Calls the equivalent method on the 'proxied' QuartzScheduler, passing the SchedulingContext associated with this instance.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RemoteScheduler

public RemoteScheduler(SchedulingContext schedCtxt,
                       String schedId,
                       String host,
                       int port)

Construct a RemoteScheduler instance to proxy the given RemoteableQuartzScheduler instance, and with the given SchedulingContext.

Method Detail

getRemoteScheduler

protected RemotableQuartzScheduler getRemoteScheduler()
                                               throws SchedulerException

Throws:: SchedulerException

invalidateHandleCreateException

protected SchedulerException invalidateHandleCreateException(String msg,
                                                             Exception cause)

getSchedulerName

public String getSchedulerName()
                        throws SchedulerException

Returns the name of the Scheduler.

Specified by:: getSchedulerName in interface Scheduler

Throws:: SchedulerException

getSchedulerInstanceId

public String getSchedulerInstanceId()
                              throws SchedulerException

Returns the instance Id of the Scheduler.

Specified by:: getSchedulerInstanceId in interface Scheduler

Throws:: SchedulerException

getMetaData

public SchedulerMetaData getMetaData()
                              throws SchedulerException

Description copied from interface: Scheduler

Get a SchedulerMetaData object describiing the settings and capabilities of the scheduler instance.

Note that the data returned is an 'instantaneous' snap-shot, and that as soon as it's returned, the meta data values may be different.

Specified by:: getMetaData in interface Scheduler

Throws:: SchedulerException

getContext

public SchedulerContext getContext()
                            throws SchedulerException

Returns the SchedulerContext of the Scheduler.

Specified by:: getContext in interface Scheduler

Throws:: SchedulerException

start

public void start()
           throws SchedulerException

Calls the equivalent method on the 'proxied' QuartzScheduler.

Specified by:: start in interface Scheduler

Throws:: SchedulerException - if shutdown() has been called, or there is an error within the Scheduler.
See Also:: Scheduler.startDelayed(int), Scheduler.standby(), Scheduler.shutdown()

startDelayed

public void startDelayed(int seconds)
                  throws SchedulerException

Calls the equivalent method on the 'proxied' QuartzScheduler.

Specified by:: startDelayed in interface Scheduler

Throws:: SchedulerException - if shutdown() has been called, or there is an error within the Scheduler.
See Also:: Scheduler.start(), Scheduler.standby(), Scheduler.shutdown()

standby

public void standby()
             throws SchedulerException

Calls the equivalent method on the 'proxied' QuartzScheduler.

Specified by:: standby in interface Scheduler

Throws:: SchedulerException
See Also:: Scheduler.start(), Scheduler.pauseAll()

pause

public void pause()
           throws SchedulerException

Deprecated.

Specified by:: pause in interface Scheduler

Throws:: SchedulerException
See Also:: Scheduler.pause()

isStarted

public boolean isStarted()
                  throws SchedulerException

Whether the scheduler has been started.

Note: This only reflects whether start() has ever been called on this Scheduler, so it will return true even if the Scheduler is currently in standby mode or has been since shutdown.

Specified by:: isStarted in interface Scheduler

Throws:: SchedulerException
See Also:: start(), isShutdown(), isInStandbyMode()

isInStandbyMode

public boolean isInStandbyMode()
                        throws SchedulerException

Calls the equivalent method on the 'proxied' QuartzScheduler.

Specified by:: isInStandbyMode in interface Scheduler

Throws:: SchedulerException
See Also:: Scheduler.standby(), Scheduler.start()

isPaused

public boolean isPaused()
                 throws SchedulerException

Specified by:: isPaused in interface Scheduler

Throws:: SchedulerException
See Also:: Scheduler.isInStandbyMode()

shutdown

public void shutdown()
              throws SchedulerException

Calls the equivalent method on the 'proxied' QuartzScheduler.

Specified by:: shutdown in interface Scheduler

Throws:: SchedulerException
See Also:: Scheduler.shutdown(boolean)

shutdown

public void shutdown(boolean waitForJobsToComplete)
              throws SchedulerException

Calls the equivalent method on the 'proxied' QuartzScheduler.

Specified by:: shutdown in interface Scheduler

Parameters:: waitForJobsToComplete - if true the scheduler will not allow this method to return until all currently executing jobs have completed.
Throws:: SchedulerException
See Also:: Scheduler.shutdown()

isShutdown

public boolean isShutdown()
                   throws SchedulerException

Calls the equivalent method on the 'proxied' QuartzScheduler.

Specified by:: isShutdown in interface Scheduler

Throws:: SchedulerException

getCurrentlyExecutingJobs

public List getCurrentlyExecutingJobs()
                               throws SchedulerException

Calls the equivalent method on the 'proxied' QuartzScheduler.

Specified by:: getCurrentlyExecutingJobs in interface Scheduler

Throws:: SchedulerException
See Also:: JobExecutionContext