de.mhus.lib.core.schedule

Class CronJob

java.lang.Object

java.util.TimerTask

de.mhus.lib.core.MTimerTask

de.mhus.lib.core.schedule.SchedulerJob

de.mhus.lib.core.schedule.CronJob

All Implemented Interfaces:

Named, MutableSchedulerJob, Operation, Runnable, Observer

public class CronJob
extends SchedulerJob
implements MutableSchedulerJob

Schedule tasks like Crontab (man -S 5 crontab). Next scheduling is done after execution of a task. Example * * * * * every minute, field allowed values ----- -------------- minute 0-59 hour 0-23 day of month 1-31 month 1-12 (or names, see below) day of week 1-7 (1 is Sunday)

Since:

3.2.9

Version:

$Id: $Id

Author:

mikehummel

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CronJob.Definition

Nested classes/interfaces inherited from class de.mhus.lib.core.schedule.SchedulerJob

SchedulerJob.MyTaskContext

Field Summary

Fields inherited from class de.mhus.lib.core.schedule.SchedulerJob

CALCULATE_NEXT, context, DISABLED_TIME, log, REMOVE_TIME

Constructor Summary

Constructors

Constructor and Description
CronJob(String name, CronJob.Definition definition, boolean restrictive, Observer task) Constructor for CronJob.
CronJob(String definition, Observer task) Constructor for CronJob.
CronJob(String name, String definition, boolean restrictive, Observer task) Constructor for CronJob.
CronJob(String name, String definition, Observer task) Constructor for CronJob.
CronJob(String minute, String hour, String dayOfMonth, String month, String dayOfWeek, Observer task) Constructor for CronJob.

Method Summary

Modifier and Type	Method and Description
void	doCaclulateNextExecution() Calculate the next executionTime and store it into nextExecutionTime
boolean	doReconfigure(String config) Reconfigure the scheduler.
void	doReschedule(Scheduler queue, long time) doReschedule.
protected boolean	isExecutionTimeReached() By default the function will compare the nextExecutionTime with the current time.
boolean	isRestrictive() isRestrictive.
void	setDone(boolean done) Setter for the field done.
void	setRestrictive(boolean restrictive) Setter for the field restrictive.
void	setScheduledTime(long scheduledTime) Setter for the field scheduledTime.
String	toString()

Methods inherited from class de.mhus.lib.core.schedule.SchedulerJob

canExecute, doError, doExecute, doExecute2, doit, doSchedule, doTick, doTimeoutReached, getDescription, getLastExecutionStart, getLastExecutionStop, getNextExecutionTime, getOwner, getScheduledTime, getTask, getThread, getTimeoutInMinutes, hasAccess, isBusy, isDone, releaseBusy, setBusy, setNextExecutionTime, setTask, setTimeoutInMinutes

Methods inherited from class de.mhus.lib.core.MTimerTask

cancel, getName, isCanceled, onError, onFinal, run, setCanceled, setName, update

Methods inherited from class java.util.TimerTask

scheduledExecutionTime

Methods inherited from class java.lang.Object

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

Constructor Detail

CronJob

public CronJob(String name,
               CronJob.Definition definition,
               boolean restrictive,
               Observer task)

Constructor for CronJob.

Parameters:

name - a String object.

definition - a CronJob.Definition object.

restrictive - a boolean.

task - a Observer object.

CronJob

public CronJob(String minute,
               String hour,
               String dayOfMonth,
               String month,
               String dayOfWeek,
               Observer task)

Constructor for CronJob.

Parameters:

minute - a String object.

hour - a String object.

dayOfMonth - a String object.

month - a String object.

dayOfWeek - a String object.

task - a Observer object.

CronJob

public CronJob(String definition,
               Observer task)

Constructor for CronJob.

Parameters:

definition - a String object.

task - a Observer object.

CronJob

public CronJob(String name,
               String definition,
               Observer task)

Constructor for CronJob.

Parameters:

name - a String object.

definition - a String object.

task - a Observer object.

CronJob

public CronJob(String name,
               String definition,
               boolean restrictive,
               Observer task)

Constructor for CronJob.

Parameters:

name - a String object.

definition - a String object.

restrictive - a boolean.

task - a Observer object.

Method Detail

doCaclulateNextExecution

public void doCaclulateNextExecution()

Calculate the next executionTime and store it into nextExecutionTime

Specified by:

doCaclulateNextExecution in class SchedulerJob

isExecutionTimeReached

protected boolean isExecutionTimeReached()

By default the function will compare the nextExecutionTime with the current time. If the time is come it will return true. If nextExecutionTime is 0 or less it will return false in every case.

Overrides:

isExecutionTimeReached in class SchedulerJob

Returns:

a boolean.

isRestrictive

public boolean isRestrictive()

isRestrictive.

Returns:

a boolean.

setRestrictive

public void setRestrictive(boolean restrictive)

Setter for the field restrictive.

Parameters:

restrictive - a boolean.

toString

public String toString()

Overrides:

toString in class SchedulerJob

doReschedule

public void doReschedule(Scheduler queue,
                         long time)

doReschedule.

Specified by:

doReschedule in interface MutableSchedulerJob

Overrides:

doReschedule in class SchedulerJob

Parameters:

queue - a Scheduler object.

time - a long.

setDone

public void setDone(boolean done)

Setter for the field done.

Specified by:

setDone in interface MutableSchedulerJob

Overrides:

setDone in class SchedulerJob

Parameters:

done - a boolean.

doReconfigure

public boolean doReconfigure(String config)

Reconfigure the scheduler. Returns true if it was successful.

Specified by:

doReconfigure in interface MutableSchedulerJob

Parameters:

config - a String object.

Returns:

a boolean.

setScheduledTime

public void setScheduledTime(long scheduledTime)

Setter for the field scheduledTime.

Specified by:

setScheduledTime in interface MutableSchedulerJob

Overrides:

setScheduledTime in class SchedulerJob

Parameters:

scheduledTime - a long.