de.mhus.lib.core.schedule

Class SchedulerJobProxy

java.lang.Object

java.util.TimerTask

de.mhus.lib.core.MTimerTask

de.mhus.lib.core.schedule.SchedulerJob

de.mhus.lib.core.schedule.SchedulerJobProxy

All Implemented Interfaces:

Named, MutableSchedulerJob, Operation, Runnable, Observer

public class SchedulerJobProxy
extends SchedulerJob
implements MutableSchedulerJob

SchedulerJobProxy class.

Since:

3.2.9

Version:

$Id: $Id

Author:

mikehummel

Nested Class Summary

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
SchedulerJobProxy(SchedulerJob instance) Constructor for SchedulerJobProxy.

Method Summary

Modifier and Type	Method and Description
boolean	cancel()
boolean	canExecute(TaskContext context) canExecute.
protected void	doCaclulateNextExecution() Calculate the next executionTime and store it into nextExecutionTime
protected void	doError(Throwable t) doError.
protected OperationResult	doExecute2(TaskContext context) doExecute2.
void	doit() doit.
boolean	doReconfigure(String config) Reconfigure the scheduler.
void	doReschedule(Scheduler scheduler, long time) doReschedule.
void	doTick() 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() getDescription.
long	getLastExecutionStart() Getter for the field lastExecutionStart.
long	getLastExecutionStop() Getter for the field lastExecutionStop.
String	getName()
long	getNextExecutionTime() Getter for the field nextExecutionTime.
Object	getOwner() Getter for the field owner.
long	getScheduledTime() Getter for the field scheduledTime.
Observer	getTask() Getter for the field task.
long	getTimeoutInMinutes() Getter for the field timeoutInMinutes.
boolean	hasAccess() hasAccess.
boolean	isBusy() isBusy.
boolean	isCanceled() isCanceled.
boolean	isDone() isDone.
protected boolean	isExecutionTimeReached() By default the function will compare the nextExecutionTime with the current time.
boolean	releaseBusy(Object owner) releaseBusy.
long	scheduledExecutionTime()
boolean	setBusy(Object owner) setBusy.
void	setCanceled(boolean canceled) Setter for the field canceled.
void	setDone(boolean done) Setter for the field done.
void	setNextExecutionTime(long nextExecutionTime) Setter for the field nextExecutionTime.
void	setScheduledTime(long scheduledTime) Setter for the field scheduledTime.
void	setTimeoutInMinutes(long timeoutInMinutes) Setter for the field timeoutInMinutes.
String	toString()
void	update(Observable o, Object arg)

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

doExecute, doSchedule, getThread, setTask

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

onError, onFinal, run, setName

Methods inherited from class java.lang.Object

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

Constructor Detail

SchedulerJobProxy

public SchedulerJobProxy(SchedulerJob instance)

Constructor for SchedulerJobProxy.

Parameters:

instance - a SchedulerJob object.

Method Detail

doTick

public void doTick()

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.

Overrides:

doTick in class SchedulerJob

update

public void update(Observable o,
                   Object arg)

Specified by:

update in interface Observer

Overrides:

update in class MTimerTask

cancel

public boolean cancel()

Overrides:

cancel in class MTimerTask

isCanceled

public boolean isCanceled()

isCanceled.

Overrides:

isCanceled in class MTimerTask

Returns:

a boolean.

isBusy

public boolean isBusy()

isBusy.

Specified by:

isBusy in interface Operation

Overrides:

isBusy in class SchedulerJob

Returns:

a boolean.

setBusy

public boolean setBusy(Object owner)

setBusy.

Specified by:

setBusy in interface Operation

Overrides:

setBusy in class SchedulerJob

Parameters:

owner - a Object object.

Returns:

a boolean.

releaseBusy

public boolean releaseBusy(Object owner)

releaseBusy.

Specified by:

releaseBusy in interface Operation

Overrides:

releaseBusy in class SchedulerJob

Parameters:

owner - a Object object.

Returns:

a boolean.

scheduledExecutionTime

public long scheduledExecutionTime()

Overrides:

scheduledExecutionTime in class TimerTask

getOwner

public Object getOwner()

Getter for the field owner.

Overrides:

getOwner in class SchedulerJob

Returns:

a Object object.

isDone

public boolean isDone()

isDone.

Overrides:

isDone in class SchedulerJob

Returns:

a boolean.

hasAccess

public boolean hasAccess()

hasAccess.

Specified by:

hasAccess in interface Operation

Overrides:

hasAccess in class SchedulerJob

Returns:

a boolean.

canExecute

public boolean canExecute(TaskContext context)

canExecute.

Specified by:

canExecute in interface Operation

Overrides:

canExecute in class SchedulerJob

Parameters:

context - a TaskContext object.

Returns:

a boolean.

getDescription

public OperationDescription getDescription()

getDescription.

Specified by:

getDescription in interface Operation

Overrides:

getDescription in class SchedulerJob

Returns:

a OperationDescription object.

getTask

public Observer getTask()

Getter for the field task.

Overrides:

getTask in class SchedulerJob

Returns:

a Observer object.

doit

public void doit()
          throws Exception

doit.

Overrides:

doit in class SchedulerJob

Throws:

Exception - if any.

getNextExecutionTime

public long getNextExecutionTime()

Getter for the field nextExecutionTime.

Overrides:

getNextExecutionTime in class SchedulerJob

Returns:

a long.

getName

public String getName()

Specified by:

getName in interface Named

Overrides:

getName in class MTimerTask

getLastExecutionStart

public long getLastExecutionStart()

Getter for the field lastExecutionStart.

Overrides:

getLastExecutionStart in class SchedulerJob

Returns:

a long.

getLastExecutionStop

public long getLastExecutionStop()

Getter for the field lastExecutionStop.

Overrides:

getLastExecutionStop in class SchedulerJob

Returns:

a long.

getScheduledTime

public long getScheduledTime()

Getter for the field scheduledTime.

Overrides:

getScheduledTime in class SchedulerJob

Returns:

a long.

toString

public String toString()

Overrides:

toString in class SchedulerJob

getTimeoutInMinutes

public long getTimeoutInMinutes()

Getter for the field timeoutInMinutes.

Overrides:

getTimeoutInMinutes in class SchedulerJob

Returns:

a long.

setTimeoutInMinutes

public void setTimeoutInMinutes(long timeoutInMinutes)

Setter for the field timeoutInMinutes.

Overrides:

setTimeoutInMinutes in class SchedulerJob

Parameters:

timeoutInMinutes - a long.

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.

Overrides:

doTimeoutReached in class SchedulerJob

doCaclulateNextExecution

protected void doCaclulateNextExecution()

Calculate the next executionTime and store it into nextExecutionTime

Specified by:

doCaclulateNextExecution in class SchedulerJob

setCanceled

public void setCanceled(boolean canceled)

Setter for the field canceled.

Overrides:

setCanceled in class MTimerTask

Parameters:

canceled - a boolean.

doReschedule

public void doReschedule(Scheduler scheduler,
                         long time)

doReschedule.

Specified by:

doReschedule in interface MutableSchedulerJob

Overrides:

doReschedule in class SchedulerJob

Parameters:

scheduler - a Scheduler object.

time - a long.

doError

protected void doError(Throwable t)

doError.

Overrides:

doError in class SchedulerJob

Parameters:

t - a Throwable object.

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.

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.

doExecute2

protected OperationResult doExecute2(TaskContext context)
                              throws Exception

doExecute2.

Overrides:

doExecute2 in class SchedulerJob

Parameters:

context - a TaskContext object.

Returns:

a OperationResult object.

Throws:

Exception - if any.

setNextExecutionTime

public void setNextExecutionTime(long nextExecutionTime)

Setter for the field nextExecutionTime.

Overrides:

setNextExecutionTime in class SchedulerJob

Parameters:

nextExecutionTime - a long.

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.

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.