de.gerdiproject.harvest.scheduler

Class Scheduler

java.lang.Object

de.gerdiproject.harvest.rest.AbstractRestObject<Scheduler,SchedulerResponse>

de.gerdiproject.harvest.scheduler.Scheduler

All Implemented Interfaces:

IEventListener, ICachedObject

public class Scheduler
extends AbstractRestObject<Scheduler,SchedulerResponse>
implements ICachedObject

This class manages a schedule of cron tabs that trigger harvests. The schedule is saved to and loaded from disk.

Author:

Robin Weiss

Field Summary

Fields inherited from class de.gerdiproject.harvest.rest.AbstractRestObject

moduleName

Constructor Summary

Constructors

Constructor and Description
Scheduler(String moduleName, String cacheFilePath) Constructor that initializes the timer and task registry.

Method Summary

Modifier and Type	Method and Description
void	addEventListeners() Adds event listeners.
String	addTask(ChangeSchedulerRequest addRequest) Adds a new task to the scheduler.
String	deleteAllTasks() Deletes all tasks.
String	deleteTask(ChangeSchedulerRequest deleteRequest) This method deletes a single crontab.
SchedulerResponse	getAsJson(javax.ws.rs.core.MultivaluedMap<String,String> query) Returns a JSON representation of this object.
Date	getNextHarvestDate() Returns the date of the earliest scheduled harvest.
protected String	getPrettyPlainText() Returns a pretty print representation of this object.
void	loadFromDisk() Attempts to load a schedule from disk.
protected void	onContextDestroyed(ContextDestroyedEvent event) Removes event listeners, cancels the timer and removes all registered tasks.
void	removeEventListeners() Removes all event listeners of this class.
void	saveToDisk() Saves all cron tabs to disk as a JSON array.
int	size() Returns the number of registered cron tabs.

Methods inherited from class de.gerdiproject.harvest.rest.AbstractRestObject

getAsPlainText

Methods inherited from class java.lang.Object

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

Constructor Detail

Scheduler

public Scheduler(String moduleName,
                 String cacheFilePath)

Constructor that initializes the timer and task registry.

Parameters:

moduleName - the name of the service

cacheFilePath - the path to the cache file in which the JSON representation of this class is cached

Method Detail

addEventListeners

public void addEventListeners()

Description copied from interface: IEventListener

Adds event listeners.

Specified by:

addEventListeners in interface IEventListener

Overrides:

addEventListeners in class AbstractRestObject<Scheduler,SchedulerResponse>

removeEventListeners

public void removeEventListeners()

Description copied from interface: IEventListener

Removes all event listeners of this class.

Specified by:

removeEventListeners in interface IEventListener

Overrides:

removeEventListeners in class AbstractRestObject<Scheduler,SchedulerResponse>

saveToDisk

public void saveToDisk()

Saves all cron tabs to disk as a JSON array.

Specified by:

saveToDisk in interface ICachedObject

loadFromDisk

public void loadFromDisk()

Attempts to load a schedule from disk.

Specified by:

loadFromDisk in interface ICachedObject

size

public int size()

Returns the number of registered cron tabs.

Returns:

the number of registered cron tabs

getNextHarvestDate

public Date getNextHarvestDate()

Returns the date of the earliest scheduled harvest.

Returns:

the date of the earliest scheduled harvest, or -1 if nothing was scheduled

onContextDestroyed

protected void onContextDestroyed(ContextDestroyedEvent event)

Removes event listeners, cancels the timer and removes all registered tasks.

Overrides:

onContextDestroyed in class AbstractRestObject<Scheduler,SchedulerResponse>

Parameters:

event - the event that triggered the callback function

getPrettyPlainText

protected String getPrettyPlainText()

Description copied from class: AbstractRestObject

Returns a pretty print representation of this object.

Specified by:

getPrettyPlainText in class AbstractRestObject<Scheduler,SchedulerResponse>

Returns:

a pretty print representation of this object

getAsJson

public SchedulerResponse getAsJson(javax.ws.rs.core.MultivaluedMap<String,String> query)

Description copied from class: AbstractRestObject

Returns a JSON representation of this object.

Specified by:

getAsJson in class AbstractRestObject<Scheduler,SchedulerResponse>

Parameters:

query - optional query parameters from the HTTP request

Returns:

a JSON representation of this object

addTask

public String addTask(ChangeSchedulerRequest addRequest)

Adds a new task to the scheduler.

Parameters:

addRequest - the request that is to add a new task

Returns:

a feedback String

deleteTask

public String deleteTask(ChangeSchedulerRequest deleteRequest)
                  throws IllegalArgumentException

This method deletes a single crontab.

Parameters:

deleteRequest - a JSON object that transports the cron tab to be deleted

Returns:

a feedback message

Throws:

IllegalArgumentException - thrown if the cron tab is not registered

deleteAllTasks

public String deleteAllTasks()

Deletes all tasks.

Returns:

a feedback message