Package de.mhus.lib.core.schedule

Class SchedulerJob

java.lang.Object

java.util.TimerTask

de.mhus.lib.core.MTimerTask

de.mhus.lib.core.schedule.SchedulerJob

All Implemented Interfaces:

de.mhus.lib.basics.Named, ITimerTask, Operation, MNlsProvider, Nls, Runnable

Direct Known Subclasses:

CronJob, IntervalJob, IntervalWithStartTimeJob, OnceJob, SchedulerJobProxy

public abstract class SchedulerJob
extends MTimerTask
implements Operation

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	SchedulerJob.MyTaskContext

Field Summary

Fields

Modifier and Type	Field	Description
static long	CALCULATE_NEXT
protected SchedulerJob.MyTaskContext	context
static long	DISABLED_TIME
protected static Log	log
static long	REMOVE_TIME

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

CANCELLED, environment, EXECUTED, SCHEDULED, UNKNOWN, VIRGIN

Constructor Summary

Constructors

Constructor	Description
SchedulerJob(ITimerTask task)
SchedulerJob(String name, ITimerTask task)

Method Summary

Modifier and Type	Method	Description
boolean	canExecute(TaskContext context)
protected abstract void	doCaclulateNextExecution()	Calculate the next executionTime and store it into nextExecutionTime
protected void	doError(Throwable t)
OperationResult	doExecute(TaskContext context)
protected OperationResult	doExecute2(TaskContext context)
void	doit()
protected void	doReschedule(Scheduler scheduler, long time)
protected void	doSchedule(Scheduler scheduler)
void	doTick(boolean forced)	Call this method to fire ticks to the scheduler.
void	doTimeoutReached()	If you have defined a timeout, the event will be called every minute.
OperationDescription	getDescription()
String	getInfo()
TimerTaskIntercepter	getIntercepter()
long	getLastExecutionStart()
long	getLastExecutionStop()
String	getLogTrailConfig()
long	getNextExecutionTime()
MNls	getNls()
Object	getOwner()
long	getScheduledTime()
ITimerTask	getTask()
Thread	getThread()
long	getTimeoutInMinutes()
UUID	getUuid()
boolean	hasAccess()
boolean	isBusy()
boolean	isDone()
protected boolean	isExecutionTimeReached()	By default the function will compare the nextExecutionTime with the current time.
String	nls(String text)
boolean	releaseBusy(Object owner)
boolean	setBusy(Object owner)
protected void	setDone(boolean done)
void	setInfo(String info)
void	setIntercepter(TimerTaskIntercepter intercepter)
void	setLogTrailConfig(String logTrailConfig)
void	setNextExecutionTime(long nextExecutionTime)
protected void	setScheduledTime(long scheduledTime)
protected void	setTask(ITimerTask task)
void	setTimeoutInMinutes(long timeoutInMinutes)
String	toString()

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

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

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

Field Detail

CALCULATE_NEXT

public static final long CALCULATE_NEXT

See Also:

Constant Field Values

DISABLED_TIME

public static final long DISABLED_TIME

See Also:

Constant Field Values

REMOVE_TIME

public static final long REMOVE_TIME

See Also:

Constant Field Values

log

protected static Log log

context

protected SchedulerJob.MyTaskContext context

Constructor Detail

SchedulerJob

public SchedulerJob(ITimerTask task)

SchedulerJob

public SchedulerJob(String name,
                    ITimerTask task)

Method Detail

doTick

public void doTick(boolean forced)

Call this method to fire ticks to the scheduler. If the time is come the scheduler will execute the operation and set 'done' to true.

Parameters:

forced -

doCaclulateNextExecution

protected abstract void doCaclulateNextExecution()

Calculate the next executionTime and store it into nextExecutionTime

doExecute

public final OperationResult doExecute(TaskContext context)
                                throws Exception

Specified by:

doExecute in interface Operation

Throws:

Exception

doExecute2

protected OperationResult doExecute2(TaskContext context)
                              throws Exception

Throws:

Exception

isBusy

public boolean isBusy()

Specified by:

isBusy in interface Operation

setBusy

public boolean setBusy(Object owner)

Specified by:

setBusy in interface Operation

releaseBusy

public boolean releaseBusy(Object owner)

Specified by:

releaseBusy in interface Operation

getOwner

public Object getOwner()

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.

Returns:

isDone

public boolean isDone()

setDone

protected void setDone(boolean done)

hasAccess

public boolean hasAccess()

Specified by:

hasAccess in interface Operation

canExecute

public boolean canExecute(TaskContext context)

Specified by:

canExecute in interface Operation

getDescription

public OperationDescription getDescription()

Specified by:

getDescription in interface Operation

getTask

public ITimerTask getTask()

setTask

protected void setTask(ITimerTask task)

doit

public void doit()
          throws Exception

Specified by:

doit in class MTimerTask

Throws:

Exception

getNextExecutionTime

public long getNextExecutionTime()

doError

protected void doError(Throwable t)

doSchedule

protected void doSchedule(Scheduler scheduler)

doReschedule

protected void doReschedule(Scheduler scheduler,
                            long time)

getLastExecutionStart

public long getLastExecutionStart()

getLastExecutionStop

public long getLastExecutionStop()

getScheduledTime

public long getScheduledTime()

setScheduledTime

protected void setScheduledTime(long scheduledTime)

toString

public String toString()

Overrides:

toString in class Object

getTimeoutInMinutes

public long getTimeoutInMinutes()

setTimeoutInMinutes

public void setTimeoutInMinutes(long timeoutInMinutes)

doTimeoutReached

public void doTimeoutReached()

If you have defined a timeout, the event will be called every minute. Be carefully with the execution time of this event, it can hem the hole scheduler.

getThread

public Thread getThread()

setNextExecutionTime

public void setNextExecutionTime(long nextExecutionTime)

getNls

public MNls getNls()

Specified by:

getNls in interface MNlsProvider

nls

public String nls(String text)

Specified by:

nls in interface Nls

getInfo

public String getInfo()

setInfo

public void setInfo(String info)

getIntercepter

public TimerTaskIntercepter getIntercepter()

setIntercepter

public void setIntercepter(TimerTaskIntercepter intercepter)

getLogTrailConfig

public String getLogTrailConfig()

setLogTrailConfig

public void setLogTrailConfig(String logTrailConfig)

getUuid

public UUID getUuid()

Specified by:

getUuid in interface Operation