org.fenixedu.bennu.scheduler.domain

Class SchedulerSystem

java.lang.Object

pt.ist.fenixframework.core.AbstractDomainObject

org.fenixedu.bennu.scheduler.domain.SchedulerSystem_Base

org.fenixedu.bennu.scheduler.domain.SchedulerSystem

All Implemented Interfaces:

Serializable, DomainObject

public class SchedulerSystem
extends SchedulerSystem_Base

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class pt.ist.fenixframework.core.AbstractDomainObject

pt.ist.fenixframework.core.AbstractDomainObject.SerializedForm

Field Summary

Fields

Modifier and Type	Field and Description
static LinkedBlockingQueue<TaskRunner>	queue
static Set<TaskRunner>	runningTasks
static Set<TaskSchedule>	scheduledTasks

Method Summary

Modifier and Type	Method and Description
static void	addTask(String className, Task taskAnnotation)
static void	destroy()
static SchedulerSystem	getInstance()
static ExecutionLogRepository	getLogRepository() Returns the currently configured ExecutionLogRepository.
static String	getLogsPath() Used by CronTask to store tasks' output files and custom logging.
static String	getTaskName(String className)
static Map<String,Task>	getTasks()
Set<TaskSchedule>	getTaskScheduleSet()
static void	init() This method starts the scheduler if lease is expired.
static Boolean	isActive()
static Boolean	isRunning()
static void	queue(TaskRunner taskRunner)
static void	schedule(TaskSchedule schedule) Schedules a task.
static void	setLogRepository(ExecutionLogRepository repo) Configures a new log repository to be used by the scheduler system.
static void	unschedule(TaskSchedule schedule) Remove schedule from the scheduler.

Methods inherited from class org.fenixedu.bennu.scheduler.domain.SchedulerSystem_Base

addTaskSchedule, getBennu, getLease, getLoggingStorage, getRelationSchedulerSystemLocalFileSystemStorage, getRelationSchedulerSystemSchedulerSystem, getRelationTaskTaskSchedule, removeTaskSchedule, setBennu, setLease, setLoggingStorage

Methods inherited from class pt.ist.fenixframework.core.AbstractDomainObject

checkForDeletionBlockers, deleteDomainObject, ensureOid, equals, getDeletionBlockers, getDomainModel, getExternalId, getOid, hashCode, init$Instance, makeSerializedForm, toString, writeReplace

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

queue

public static LinkedBlockingQueue<TaskRunner> queue

runningTasks

public static Set<TaskRunner> runningTasks

scheduledTasks

public static Set<TaskSchedule> scheduledTasks

Method Detail

getInstance

public static SchedulerSystem getInstance()

getTaskScheduleSet

public Set<TaskSchedule> getTaskScheduleSet()

Overrides:

getTaskScheduleSet in class SchedulerSystem_Base

isRunning

public static Boolean isRunning()

Returns:

true if scheduler is running in this server instance.

isActive

public static Boolean isActive()

Returns:

true if this server instance is responsible for running the scheduler.

init

public static void init()

This method starts the scheduler if lease is expired.

schedule

public static void schedule(TaskSchedule schedule)

Schedules a task. If the task is not already queued and is not running add it to the processing queue. ProcessQueue threads will run pending tasks.

Parameters:

schedule - The task to be added to the queue

unschedule

public static void unschedule(TaskSchedule schedule)

Remove schedule from the scheduler. This will not delete the TaskSchedule, only removes the scheduling.

Parameters:

schedule - The task to be removed from the queue

addTask

public static final void addTask(String className,
                                 Task taskAnnotation)

destroy

public static void destroy()

getTasks

public static Map<String,Task> getTasks()

getTaskName

public static String getTaskName(String className)

getLogsPath

public static String getLogsPath()

Used by CronTask to store tasks' output files and custom logging.

Returns:

the physical absolute path of the logging storage.

queue

public static void queue(TaskRunner taskRunner)

setLogRepository

public static void setLogRepository(ExecutionLogRepository repo)

Configures a new log repository to be used by the scheduler system.

Parameters:

repo - The new log repository

Throws:

NullPointerException - If the provided repository is null

getLogRepository

public static ExecutionLogRepository getLogRepository()

Returns the currently configured ExecutionLogRepository. By default, a FileSystemLogRepository is used, with a dispersion factor of 3.

Returns:

The current log repository