Package ortus.boxlang.runtime.async.tasks

Class BoxScheduler

java.lang.Object

ortus.boxlang.runtime.async.tasks.BaseScheduler

ortus.boxlang.runtime.async.tasks.BoxScheduler

All Implemented Interfaces:

IScheduler

public class BoxScheduler
extends BaseScheduler

This class acts as a wrapper around the target BoxLang scheduler. It implements the IScheduler interface and provides the life-cycle callbacks that are required by the BoxLang scheduler system.

Field Summary

Fields inherited from class ortus.boxlang.runtime.async.tasks.BaseScheduler

asyncService, context, executor, logger, name, started, startedAt, tasks, timezone

Constructor Summary

Constructors

Constructor	Description
BoxScheduler(IClassRunnable target, IBoxContext context)	Constructor

Method Summary

Modifier and Type	Method	Description
void	afterAnyTask(ScheduledTask task, Optional<?> result)	Called after ANY task runs
void	beforeAnyTask(ScheduledTask task)	Called before ANY task runs
void	configure()	Configure the scheduler
void	onAnyTaskError(ScheduledTask task, Exception exception)	Called whenever ANY task fails
void	onAnyTaskSuccess(ScheduledTask task, Optional<?> result)	Called whenever ANY task succeeds
void	onShutdown()	Called before the scheduler is going to be shutdown
void	onStartup()	Called after the scheduler has registered all schedules

Methods inherited from class ortus.boxlang.runtime.async.tasks.BaseScheduler

clearTasks, getAsyncService, getContext, getExecutor, getLogger, getRegisteredTasks, getSchedulerName, getStartedAt, getTaskRecord, getTasks, getTaskStats, getTimezone, hasStarted, hasTask, isRunning, removeTask, restart, setContext, setDefaultTimezone, setExecutor, setSchedulerName, setTimezone, setTimezone, shutdown, shutdown, shutdown, startup, startupTask, startupTask, task, task, xtask, xtask

Methods inherited from class java.lang.Object

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

Methods inherited from interface ortus.boxlang.runtime.async.tasks.IScheduler

getSchedulerNameAsKey

Constructor Details

BoxScheduler

public BoxScheduler(IClassRunnable target,
 IBoxContext context)

Constructor

Parameters:

target - The target scheduler

Method Details

configure

public void configure()

Configure the scheduler

Specified by:

configure in interface IScheduler

Overrides:

configure in class BaseScheduler

onShutdown

public void onShutdown()

Called before the scheduler is going to be shutdown

Specified by:

onShutdown in interface IScheduler

Overrides:

onShutdown in class BaseScheduler

onStartup

public void onStartup()

Called after the scheduler has registered all schedules

Specified by:

onStartup in interface IScheduler

Overrides:

onStartup in class BaseScheduler

onAnyTaskError

public void onAnyTaskError(ScheduledTask task,
 Exception exception)

Called whenever ANY task fails

Specified by:

onAnyTaskError in interface IScheduler

Overrides:

onAnyTaskError in class BaseScheduler

Parameters:

task - The task that got executed

exception - The exception object

onAnyTaskSuccess

public void onAnyTaskSuccess(ScheduledTask task,
 Optional<?> result)

Called whenever ANY task succeeds

Specified by:

onAnyTaskSuccess in interface IScheduler

Overrides:

onAnyTaskSuccess in class BaseScheduler

Parameters:

task - The task that got executed

result - The result (if any) that the task produced

beforeAnyTask

public void beforeAnyTask(ScheduledTask task)

Called before ANY task runs

Specified by:

beforeAnyTask in interface IScheduler

Overrides:

beforeAnyTask in class BaseScheduler

Parameters:

task - The task about to be executed

afterAnyTask

public void afterAnyTask(ScheduledTask task,
 Optional<?> result)

Called after ANY task runs

Specified by:

afterAnyTask in interface IScheduler

Overrides:

afterAnyTask in class BaseScheduler

Parameters:

task - The task that got executed

result - The result (if any) that the task produced