org.kquiet.jobscheduler

Class JobBase

java.lang.Object

org.kquiet.jobscheduler.JobBase

All Implemented Interfaces:

Runnable

Direct Known Subclasses:

RestartBrowser

public abstract class JobBase
extends Object
implements Runnable

This class is the base of all jobs. Each job class should extend this class and provide their own implementation.

Author:

Kimberly

Constructor Summary

Constructors

Constructor and Description
JobBase() Create a new job with randomly generated name.
JobBase(String jobName) Create a new job with specified name.

Method Summary

Modifier and Type	Method and Description
protected void	awaitInteraction() Await external interaction from job controller.
LocalDateTime	calculateNextFireDateTime(LocalDateTime from) Calculate the date and time of next fire according to job configuration.
String	getInstanceName()
String	getJobName() Get the name of this job.
protected JobController.InteractionType	getLatestInteraction() Get the latest interaction from job controller.
String	getParameter(String name) Get parameter value.
SystemConfig.JobConfig	getTimerConfig()
protected boolean	isPaused()
protected void	onEvent(Object event)
protected boolean	pause()
protected void	pauseInternalBrowser() Pause the execution of internal browser.
void	raiseEvent(Object event) Raise an event from this job.
void	receiveEvent(Object event) Receive an event from the other jobs.
protected boolean	registerInternalBrowserTask(org.kquiet.browser.ActionComposer task) Register a browser task to be executed in internal browser.
protected void	restartInternalBrowser() Restart internal browser of controlling job controller.
protected boolean	resume()
protected void	resumeInternalBrowser() Resume the execution of internal browser.
abstract void	run() The processing logic of job goes here.
JobBase	setJobController(JobController ctrl)

Methods inherited from class java.lang.Object

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

Constructor Detail

JobBase

public JobBase()

Create a new job with randomly generated name.

JobBase

public JobBase(String jobName)

Create a new job with specified name.

Parameters:

jobName - the name of job

Method Detail

setJobController

public final JobBase setJobController(JobController ctrl)

run

public abstract void run()

The processing logic of job goes here.

Specified by:

run in interface Runnable

pause

protected boolean pause()

isPaused

protected boolean isPaused()

resume

protected boolean resume()

calculateNextFireDateTime

public final LocalDateTime calculateNextFireDateTime(LocalDateTime from)

Calculate the date and time of next fire according to job configuration.

Parameters:

from - the LocalDateTime to calculate from

Returns:

the LocalDateTime of next fire

raiseEvent

public final void raiseEvent(Object event)

Raise an event from this job. Associated job controller will forward this event to the other jobs.

Parameters:

event - the event to raise

receiveEvent

public final void receiveEvent(Object event)

Receive an event from the other jobs.

Parameters:

event - the event to receive

onEvent

protected void onEvent(Object event)

getInstanceName

public final String getInstanceName()

getTimerConfig

public final SystemConfig.JobConfig getTimerConfig()

getParameter

public final String getParameter(String name)

Get parameter value.

Parameters:

name - the name of parameter

Returns:

parameter value of specified parameter name

restartInternalBrowser

protected final void restartInternalBrowser()

Restart internal browser of controlling job controller.

pauseInternalBrowser

protected final void pauseInternalBrowser()

Pause the execution of internal browser. All executing browser tasks will remain running until they complete.

resumeInternalBrowser

protected final void resumeInternalBrowser()

Resume the execution of internal browser.

registerInternalBrowserTask

protected final boolean registerInternalBrowserTask(org.kquiet.browser.ActionComposer task)

Register a browser task to be executed in internal browser.

Parameters:

task - browser task

Returns:

true if the browser task is successfully accepted, otherwise false

awaitInteraction

protected final void awaitInteraction()

Await external interaction from job controller.

getLatestInteraction

protected final JobController.InteractionType getLatestInteraction()

Get the latest interaction from job controller.

Returns:

the latest interaction

getJobName

public final String getJobName()

Get the name of this job.

Returns:

job name