org.kquiet.jobscheduler

Class JobController

java.lang.Object

org.kquiet.jobscheduler.JobController

public class JobController
extends Object

This class controls whole execution process of all associated jobs.

Author:

Kimberly

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JobController.InteractionType
static class	JobController.PauseTarget

Constructor Summary

Constructors

Constructor and Description
JobController() Create a new job controller.

Method Summary

Modifier and Type	Method and Description
boolean	acceptBrowserTask(org.kquiet.browser.ActionComposer task) Accept a browser task to be executed in internal browser.
void	awaitInteraction() Await the external interaction.
void	forwardEvent(JobBase sourceJob, Object event) Forward event from source job to the other managed jobs.
Consumer<String>	getExecutingJobDescriptionConsumer() Get the function consuming the description of executing job at the moment.
JobController.InteractionType	getLatestInteraction() Get the latest interaction.
boolean	isPaused(JobController.PauseTarget target) Check if the specified target has already paused.
boolean	pause(JobController.PauseTarget target)
boolean	pause(JobController.PauseTarget target, boolean autoResumable) Pause the execution of specified target.
void	restartBrowserTaskManager() Close current internal browser and recreate a new one.
boolean	resume(JobController.PauseTarget target)
boolean	resume(JobController.PauseTarget target, boolean autoResumable) Resume the execution of specified target.
void	setAfterPauseFunction(JobController.PauseTarget target, Runnable afterPauseFunc) Set the function to execute after pause.
void	setAfterResumeFunction(JobController.PauseTarget target, Runnable afterResumeFunc) Set the function to execute after resume.
void	setExecutingJobDescriptionConsumer(Consumer<String> executingJobDescriptionConsumer) Set the function consuming the description of executing job at the moment.
void	setPostInteractionFunction(Runnable func) Set the function to be executed after awaiting interaction.
void	setPreInteractionFunction(Runnable func) Set the function to be executed before awaiting interaction.
void	signalInteractionType(JobController.InteractionType interaction) Signal the interaction type.
void	start()
void	start(Iterable<JobBase> jobList) Start to initialize jobs and schedule them by configuration.
void	stop() Stop this controller and all scheduled jobs it manages.

Methods inherited from class java.lang.Object

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

Constructor Detail

JobController

public JobController()

Create a new job controller.

Method Detail

start

public void start()

start

public void start(Iterable<JobBase> jobList)

Start to initialize jobs and schedule them by configuration.

Parameters:

jobList - the jobs to be scheduled; if not presented, this controller will try to load job from jobscheduler.config

stop

public void stop()

Stop this controller and all scheduled jobs it manages.

pause

public boolean pause(JobController.PauseTarget target,
                     boolean autoResumable)

Pause the execution of specified target.

Parameters:

target - the target to pause

autoResumable - indicate whether this pause could be resumed automatically

Returns:

true if paused, otherwise false

pause

public boolean pause(JobController.PauseTarget target)

resume

public boolean resume(JobController.PauseTarget target,
                      boolean autoResumable)

Resume the execution of specified target.

Parameters:

target - the target to resume

autoResumable - indicate whether this resume is automatically or manually

Returns:

true if resumed, otherwise false

resume

public boolean resume(JobController.PauseTarget target)

isPaused

public boolean isPaused(JobController.PauseTarget target)

Check if the specified target has already paused.

Parameters:

target - the target to check

Returns:

true if paused, otherwise false

signalInteractionType

public void signalInteractionType(JobController.InteractionType interaction)

Signal the interaction type.

Parameters:

interaction - the interaction type

forwardEvent

public final void forwardEvent(JobBase sourceJob,
                               Object event)

Forward event from source job to the other managed jobs.

Parameters:

sourceJob - the job raising the event

event - the event object to forward

setAfterPauseFunction

public void setAfterPauseFunction(JobController.PauseTarget target,
                                  Runnable afterPauseFunc)

Set the function to execute after pause.

Parameters:

target - the target to pause

afterPauseFunc - the pauseDelegate to set

setAfterResumeFunction

public void setAfterResumeFunction(JobController.PauseTarget target,
                                   Runnable afterResumeFunc)

Set the function to execute after resume.

Parameters:

target - the target to resume

afterResumeFunc - the resumeDelegate to set

acceptBrowserTask

public boolean acceptBrowserTask(org.kquiet.browser.ActionComposer task)

Accept a browser task to be executed in internal browser.

Parameters:

task - browser task

Returns:

true if the browser task is successfully accepted, otherwise false

restartBrowserTaskManager

public void restartBrowserTaskManager()

Close current internal browser and recreate a new one.

awaitInteraction

public void awaitInteraction()

Await the external interaction.

getLatestInteraction

public JobController.InteractionType getLatestInteraction()

Get the latest interaction.

Returns:

the latest interaction

setPreInteractionFunction

public void setPreInteractionFunction(Runnable func)

Set the function to be executed before awaiting interaction.

Parameters:

func - the function to set

setPostInteractionFunction

public void setPostInteractionFunction(Runnable func)

Set the function to be executed after awaiting interaction.

Parameters:

func - the function to set

getExecutingJobDescriptionConsumer

public Consumer<String> getExecutingJobDescriptionConsumer()

Get the function consuming the description of executing job at the moment.

Returns:

consumer function

setExecutingJobDescriptionConsumer

public void setExecutingJobDescriptionConsumer(Consumer<String> executingJobDescriptionConsumer)

Set the function consuming the description of executing job at the moment.

Parameters:

executingJobDescriptionConsumer - consumer function