Field Detail

• log

  protected static org.apache.commons.logging.Log log

  Logging

• enabled

  protected boolean enabled

  Current status of the scheduler

Constructor Detail

• QuartzSchedulerService

  public QuartzSchedulerService()

Method Detail

• init

  public void init()
            throws InitializationException

  Initializes the SchedulerService.

  Specified by:

  init in interface Initable

  Overrides:

  init in class TurbineBaseService

  Throws:

  InitializationException - Something went wrong in the init stage

• shutdown

  public void shutdown()

  Shutdowns the service. This methods interrupts the housekeeping thread.

  Specified by:

  shutdown in interface Initable

  Overrides:

  shutdown in class TurbineBaseService

• newJob

  public JobEntry newJob(int sec,
                int min,
                int hour,
                int wd,
                int day_mo,
                String task)
                  throws TurbineException

  Description copied from interface: ScheduleService
  Factory method for a new Job Schedule a job to run on a certain point of time.
  Example 1: Run the DefaultScheduledJob at 8:00am every 15th of the month -
  JobEntry je = newJob(0,0,8,-1,15,"DefaultScheduledJob");
  Example 2: Run the DefaultScheduledJob at 8:00am every day -
  JobEntry je = newJob(0,0,8,-1,-1,"DefaultScheduledJob");
  Example 3: Run the DefaultScheduledJob every 2 hours. -
  JobEntry je = newJob(0,120,-1,-1,-1,"DefaultScheduledJob");
  Example 4: Run the DefaultScheduledJob every 30 seconds. -
  JobEntry je = newJob(30,-1,-1,-1,-1,"DefaultScheduledJob");
  

  Specified by:

  newJob in interface ScheduleService

  Parameters:

  sec - Value for entry "seconds".

  min - Value for entry "minutes".

  hour - Value for entry "hours".

  wd - Value for entry "week days".

  day_mo - Value for entry "month days".

  task - Task to execute.

  Returns:

  A JobEntry.

  Throws:

  TurbineException - could not create job

  See Also:

  ScheduleService.newJob(int, int, int, int, int, java.lang.String)

• getJob

  public JobEntry getJob(int oid)
                  throws TurbineException

  Get a specific Job from Storage.

  Specified by:

  getJob in interface ScheduleService

  Parameters:

  oid - The int id for the job.

  Returns:

  A JobEntry.

  Throws:

  TurbineException - job could not be retrieved.

• addJob

  public void addJob(JobEntry je)
              throws TurbineException

  Add a new job to the queue.

  Specified by:

  addJob in interface ScheduleService

  Parameters:

  je - A JobEntry with the job to add.

  Throws:

  TurbineException - job could not be added

• removeJob

  public void removeJob(JobEntry je)
                 throws TurbineException

  Remove a job from the queue.

  Specified by:

  removeJob in interface ScheduleService

  Parameters:

  je - A JobEntry with the job to remove.

  Throws:

  TurbineException - job could not be removed

• updateJob

  public void updateJob(JobEntry je)
                 throws TurbineException

  Add or update a job.

  Specified by:

  updateJob in interface ScheduleService

  Parameters:

  je - A JobEntry with the job to modify

  Throws:

  TurbineException - job could not be updated

• listJobs

  public List<? extends JobEntry> listJobs()

  List jobs in the queue. This is used by the scheduler UI.

  Specified by:

  listJobs in interface ScheduleService

  Returns:

  A List of jobs.

• setEnabled

  protected void setEnabled(boolean enabled)

  Sets the enabled status of the scheduler

  Parameters:

  enabled -

• isEnabled

  public boolean isEnabled()

  Determines if the scheduler service is currently enabled.

  Specified by:

  isEnabled in interface ScheduleService

  Returns:

  Status of the scheduler service.

• startScheduler

  public void startScheduler()

  Starts or restarts the scheduler if not already running.

  Specified by:

  startScheduler in interface ScheduleService

• stopScheduler

  public void stopScheduler()

  Stops the scheduler if it is currently running.

  Specified by:

  stopScheduler in interface ScheduleService

• restart

  public void restart()

  Start (or restart) a thread to process commands, or wake up an existing thread if one is already running. This method can be invoked if the background thread crashed due to an unrecoverable exception in an executed command.