| org.apache.cocoon.components.cron.JobScheduler
All known Subclasses: org.apache.cocoon.components.cron.QuartzJobScheduler,
| JobScheduler | | public interface JobScheduler (Code) | | This component schedules jobs.
author:
Giacomo Pati
version:
CVS $Id: JobScheduler.java 433543 2006-08-22 06:22:54Z crossley $
since:
2.1.1 |
| Method Summary | |
| void | addJob(String name, String jobrole, String schedulingExpression, boolean canRunConcurrently)
Schedule a time based job. | | void | addJob(String name, String jobrole, String schedulingExpression, boolean canRunConcurrently, Parameters params, Map objects)
Schedule a time based job. | | void | addJob(String name, Object job, String schedulingExpression, boolean canRunConcurrently)
Schedule a time based job. | | void | addJob(String name, Object job, String schedulingExpression, boolean canRunConcurrently, Parameters params, Map objects)
Schedule a job. | | void | addPeriodicJob(String name, String jobrole, long period, boolean canRunConcurrently, Parameters params, Map objects)
Schedule a periodic job. | | void | addPeriodicJob(String name, Object job, long period, boolean canRunConcurrently, Parameters params, Map objects)
Schedule a periodic job. | | boolean | fireJob(String jobrole)
| | boolean | fireJob(Object job)
Fire a CronJob once immediately
Parameters:
job - The job object itself. | | boolean | fireJob(String jobrole, Parameters params, Map objects)
| | boolean | fireJob(Object job, Parameters params, Map objects)
Fire a job once immediately
Parameters:
job - The job object itself. | | void | fireJobAt(Date date, String name, String jobrole)
Fire a job once at a specific date Note that if a job with the same name has already beed added it is
overwritten. | | void | fireJobAt(Date date, String name, String jobrole, Parameters params, Map objects)
Fire a job once at a specific date Note that if a job with the same name has already beed added it is
overwritten. | | void | fireJobAt(Date date, String name, Object job)
Fire a job once at a specific date Note that if a job with the same name has already beed added it is
overwritten.
Parameters:
date - The date this job should be scheduled
Parameters:
name - the name of the job
Parameters:
job - The job object itself. | | void | fireJobAt(Date date, String name, Object job, Parameters params, Map objects)
Fire a job once at a specific date Note that if a job with the same name has already beed added it is
overwritten.
Parameters:
date - The date this job should be scheduled
Parameters:
name - the name of the job
Parameters:
job - The job object itself. | | String[] | getJobNames()
Get the names of all scheduled jobs. | | JobSchedulerEntry | getJobSchedulerEntry(String jobname)
| | void | removeJob(String name)
Remove a scheduled job by name. |
| addJob | | void addJob(String name, String jobrole, String schedulingExpression, boolean canRunConcurrently) throws CascadingException(Code) | | Schedule a time based job. Note that if a job with the same name has already beed added it is overwritten.
Parameters:
name - the name of the job
Parameters:
jobrole - The Avalon components role name of the job itself
Parameters:
schedulingExpression - the time specification using a scheduling expression
Parameters:
canRunConcurrently - whether this job can run even previous scheduled runs are still running |
| addJob | | void addJob(String name, String jobrole, String schedulingExpression, boolean canRunConcurrently, Parameters params, Map objects) throws CascadingException(Code) | | Schedule a time based job. Note that if a job with the same name has already beed added it is overwritten.
Parameters:
name - the name of the job
Parameters:
jobrole - The Avalon components role name of the job itself
Parameters:
schedulingExpression - the time specification using a scheduling expression
Parameters:
canRunConcurrently - whether this job can run even previous scheduled runs are still running
Parameters:
params - Additional Parameters to setup CronJob
Parameters:
objects - A Map with additional object to setup CronJob |
| addJob | | void addJob(String name, Object job, String schedulingExpression, boolean canRunConcurrently) throws CascadingException(Code) | | Schedule a time based job. Note that if a job with the same name has already beed added it is overwritten.
Parameters:
name - the name of the job
Parameters:
job - The job object itself. It must implement either CronJob, Runnable or might also be an implementationspecific class (i.e. org.quartz.Job)
Parameters:
schedulingExpression - the time specification using a scheduling expression
Parameters:
canRunConcurrently - whether this job can run even previous scheduled runs are still running |
| addJob | | void addJob(String name, Object job, String schedulingExpression, boolean canRunConcurrently, Parameters params, Map objects) throws CascadingException(Code) | | Schedule a job. Note that if a job with the same name has already beed added it is overwritten.
Parameters:
name - the name of the job
Parameters:
job - The job object itself. It must implement either CronJob, Runnable or might also be an implementationspecific class (i.e. org.quartz.Job)
Parameters:
schedulingExpression - the time specification using a scheduling expression
Parameters:
canRunConcurrently - whether this job can run even previous scheduled runs are still running
Parameters:
params - Additional Parameters to setup CronJob
Parameters:
objects - A Map with additional object to setup CronJob |
| addPeriodicJob | | void addPeriodicJob(String name, String jobrole, long period, boolean canRunConcurrently, Parameters params, Map objects) throws CascadingException(Code) | | Schedule a periodic job. The job is started the first time when the period has passed. Note that if a job with
the same name has already beed added it is overwritten.
Parameters:
name - the name of the job
Parameters:
jobrole - The Avalon components role name of the job itself
Parameters:
period - Every period seconds this job is started
Parameters:
canRunConcurrently - whether this job can run even previous scheduled runs are still running
Parameters:
params - Additional Parameters to setup CronJob
Parameters:
objects - A Map with additional object to setup CronJob |
| addPeriodicJob | | void addPeriodicJob(String name, Object job, long period, boolean canRunConcurrently, Parameters params, Map objects) throws CascadingException(Code) | | Schedule a periodic job. The job is started the first time when the period has passed. Note that if a job with
the same name has already beed added it is overwritten.
Parameters:
name - the name of the job
Parameters:
job - The job object itself. It must implement either CronJob, Runnable or might also be an implementationspecific class (i.e. org.quartz.Job)
Parameters:
period - Every period seconds this job is started
Parameters:
canRunConcurrently - whether this job can run even previous scheduled runs are still running
Parameters:
params - Additional Parameters to setup CronJob
Parameters:
objects - A Map with additional object to setup CronJob |
| fireJob | | boolean fireJob(String jobrole)(Code) | | Fire a job once immediately
Parameters:
jobrole - The Avalon components role name of the job itself success state adding the job |
| fireJob | | boolean fireJob(Object job)(Code) | | Fire a CronJob once immediately
Parameters:
job - The job object itself. It must implement either CronJob, Runnable or might also be an implementationspecific class (i.e. org.quartz.Job) whether the job has been successfully started |
| fireJob | | boolean fireJob(String jobrole, Parameters params, Map objects) throws CascadingException(Code) | | Fire a job once immediately
Parameters:
jobrole - The Avalon components role name of the job itself
Parameters:
params - Additional Parameters to setup CronJob
Parameters:
objects - A Map with additional object to setup CronJob whether the job has been successfully started |
| fireJob | | boolean fireJob(Object job, Parameters params, Map objects) throws CascadingException(Code) | | Fire a job once immediately
Parameters:
job - The job object itself. It must implement either CronJob, Runnable or might also be an implementationspecific class (i.e. org.quartz.Job)
Parameters:
params - Additional Parameters to setup CronJob
Parameters:
objects - A Map with additional object to setup CronJob whether the job has been successfully started |
| fireJobAt | | void fireJobAt(Date date, String name, String jobrole) throws CascadingException(Code) | | Fire a job once at a specific date Note that if a job with the same name has already beed added it is
overwritten.
Parameters:
date - The date this job should be scheduled
Parameters:
name - the name of the job
Parameters:
jobrole - The Avalon components role name of the job itself |
| fireJobAt | | void fireJobAt(Date date, String name, String jobrole, Parameters params, Map objects) throws CascadingException(Code) | | Fire a job once at a specific date Note that if a job with the same name has already beed added it is
overwritten.
Parameters:
date - The date this job should be scheduled
Parameters:
name - the name of the job
Parameters:
jobrole - The Avalon components role name of the job itself
Parameters:
params - Additional Parameters to setup CronJob
Parameters:
objects - A Map with additional object to setup CronJob |
| fireJobAt | | void fireJobAt(Date date, String name, Object job) throws CascadingException(Code) | | Fire a job once at a specific date Note that if a job with the same name has already beed added it is
overwritten.
Parameters:
date - The date this job should be scheduled
Parameters:
name - the name of the job
Parameters:
job - The job object itself. It must implement either CronJob, Runnable or might also be an implementationspecific class (i.e. org.quartz.Job) |
| fireJobAt | | void fireJobAt(Date date, String name, Object job, Parameters params, Map objects) throws CascadingException(Code) | | Fire a job once at a specific date Note that if a job with the same name has already beed added it is
overwritten.
Parameters:
date - The date this job should be scheduled
Parameters:
name - the name of the job
Parameters:
job - The job object itself. It must implement either CronJob, Runnable or might also be an implementationspecific class (i.e. org.quartz.Job)
Parameters:
params - Additional Parameters to setup CronJob
Parameters:
objects - A Map with additional object to setup CronJob |
| getJobNames | | String[] getJobNames()(Code) | | Get the names of all scheduled jobs.
state of execution successfullness |
|
|