org.openmrs.scheduler.timer

Class TimerSchedulerServiceImpl

java.lang.Object

org.openmrs.api.impl.BaseOpenmrsService

org.openmrs.scheduler.timer.TimerSchedulerServiceImpl

All Implemented Interfaces:

OpenmrsService, SchedulerService

@Transactional
public class TimerSchedulerServiceImpl
extends BaseOpenmrsService
implements SchedulerService

Simple scheduler service that uses JDK timer to trigger and execute scheduled tasks.

Constructor Summary

Constructors

Constructor and Description
TimerSchedulerServiceImpl()

Method Summary

Modifier and Type	Method and Description
void	deleteTask(Integer id) Delete the task with the given identifier.
Collection<TaskDefinition>	getRegisteredTasks() Get all registered tasks.
Collection<TaskDefinition>	getScheduledTasks() Get all scheduled tasks.
SchedulerDAO	getSchedulerDAO() Gets the scheduler data access object.
String	getStatus(Integer id) Checks the status of a scheduled task.
SortedMap<String,String>	getSystemVariables() Get system variables.
TaskDefinition	getTask(Integer id) Get the task with the given identifier.
TaskDefinition	getTaskByName(String name) Get the task with the given name.
TaskDefinition	getTaskByUuid(String uuid)
void	onShutdown() Shutdown hook for the scheduler and all of its scheduled tasks.
void	onStartup() Start up hook for the scheduler and all of its scheduled tasks.
void	registerTask(TaskDefinition definition) Register a new task by adding it to our task map with an empty schedule map.
void	rescheduleAllTasks() Loop over all currently started tasks and cycle them.
Task	rescheduleTask(TaskDefinition taskDefinition) Stop and start a scheduled task.
void	restoreFromMemento(OpenmrsMemento memento) Restore the scheduler service to state defined by Memento
void	saveTaskDefinition(TaskDefinition task) Save a task in the database.
OpenmrsMemento	saveToMemento() Saves and stops all active tasks
void	scheduleIfNotRunning(TaskDefinition taskDef) Schedules a task for execution if not already running
Task	scheduleTask(TaskDefinition taskDefinition) Schedule the given task according to the given schedule.
static void	setScheduledTasks(Map<Integer,TimerSchedulerTask> scheduledTasks)
void	setSchedulerDAO(SchedulerDAO dao) Sets the scheduler data access object.
void	shutdownAllTasks() Shutdown all running tasks.
void	shutdownTask(TaskDefinition taskDefinition) Stops a running task.

Methods inherited from class java.lang.Object

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

Constructor Detail

TimerSchedulerServiceImpl

public TimerSchedulerServiceImpl()

Method Detail

getSchedulerDAO

public SchedulerDAO getSchedulerDAO()

Gets the scheduler data access object.

setSchedulerDAO

public void setSchedulerDAO(SchedulerDAO dao)

Sets the scheduler data access object.

onStartup

public void onStartup()

Start up hook for the scheduler and all of its scheduled tasks.

Specified by:

onStartup in interface OpenmrsService

Specified by:

onStartup in interface SchedulerService

Overrides:

onStartup in class BaseOpenmrsService

See Also:

OpenmrsService.onStartup()

setScheduledTasks

public static void setScheduledTasks(Map<Integer,TimerSchedulerTask> scheduledTasks)

onShutdown

public void onShutdown()

Shutdown hook for the scheduler and all of its scheduled tasks.

Specified by:

onShutdown in interface OpenmrsService

Specified by:

onShutdown in interface SchedulerService

Overrides:

onShutdown in class BaseOpenmrsService

See Also:

OpenmrsService.onShutdown()

shutdownAllTasks

public void shutdownAllTasks()

Shutdown all running tasks.

scheduleTask

public Task scheduleTask(TaskDefinition taskDefinition)
                  throws SchedulerException

Schedule the given task according to the given schedule.

Specified by:

scheduleTask in interface SchedulerService

Parameters:

taskDefinition - the task to be scheduled Should should handle zero repeat interval

Returns:

the started Task, or null if there was a problem instantiating or scheduling the task

Throws:

SchedulerException

shutdownTask

public void shutdownTask(TaskDefinition taskDefinition)
                  throws SchedulerException

Stops a running task.

Specified by:

shutdownTask in interface SchedulerService

Parameters:

taskDefinition - the task to be stopped

Throws:

SchedulerException

See Also:

SchedulerService.shutdownTask(TaskDefinition)

rescheduleAllTasks

public void rescheduleAllTasks()
                        throws SchedulerException

Loop over all currently started tasks and cycle them. This should be done after the classloader has been changed (e.g. during module start/stop)

Specified by:

rescheduleAllTasks in interface SchedulerService

Throws:

SchedulerException

rescheduleTask

public Task rescheduleTask(TaskDefinition taskDefinition)
                    throws SchedulerException

Description copied from interface: SchedulerService

Stop and start a scheduled task.

Specified by:

rescheduleTask in interface SchedulerService

Parameters:

taskDefinition - the TaskDefinition to reschedule

Throws:

SchedulerException

See Also:

SchedulerService.rescheduleTask(org.openmrs.scheduler.TaskDefinition)

registerTask

public void registerTask(TaskDefinition definition)

Register a new task by adding it to our task map with an empty schedule map.

Parameters:

definition - task to register

getScheduledTasks

public Collection<TaskDefinition> getScheduledTasks()

Get all scheduled tasks.

Specified by:

getScheduledTasks in interface SchedulerService

Returns:

all scheduled tasks

getRegisteredTasks

@Transactional(readOnly=true)
public Collection<TaskDefinition> getRegisteredTasks()

Get all registered tasks.

Specified by:

getRegisteredTasks in interface SchedulerService

Returns:

all registerd tasks

getTask

@Transactional(readOnly=true)
public TaskDefinition getTask(Integer id)

Get the task with the given identifier.

Specified by:

getTask in interface SchedulerService

Parameters:

id - the identifier of the task

getTaskByName

@Transactional(readOnly=true)
public TaskDefinition getTaskByName(String name)

Get the task with the given name.

Specified by:

getTaskByName in interface SchedulerService

Parameters:

name - name of the task

saveTaskDefinition

public void saveTaskDefinition(TaskDefinition task)

Save a task in the database.

Specified by:

saveTaskDefinition in interface SchedulerService

Parameters:

task - the TaskDefinition to save

deleteTask

public void deleteTask(Integer id)

Delete the task with the given identifier.

Specified by:

deleteTask in interface SchedulerService

Parameters:

id - the identifier of the task

getSystemVariables

public SortedMap<String,String> getSystemVariables()

Get system variables.

Specified by:

getSystemVariables in interface SchedulerService

Returns:

SortedMap<String, String>

saveToMemento

public OpenmrsMemento saveToMemento()

Saves and stops all active tasks

Specified by:

saveToMemento in interface SchedulerService

Returns:

OpenmrsMemento

restoreFromMemento

public void restoreFromMemento(OpenmrsMemento memento)

Description copied from interface: SchedulerService

Restore the scheduler service to state defined by Memento

Specified by:

restoreFromMemento in interface SchedulerService

getStatus

public String getStatus(Integer id)

Description copied from interface: SchedulerService

Checks the status of a scheduled task.

Specified by:

getStatus in interface SchedulerService

Returns:

the String status of the task with the given identifier

See Also:

TODO internationalization of string status messages

scheduleIfNotRunning

public void scheduleIfNotRunning(TaskDefinition taskDef)

Description copied from interface: SchedulerService

Schedules a task for execution if not already running

Specified by:

scheduleIfNotRunning in interface SchedulerService

getTaskByUuid

@Transactional(readOnly=true)
public TaskDefinition getTaskByUuid(String uuid)

Specified by:

getTaskByUuid in interface SchedulerService

Parameters:

uuid - the unique identifier of the task

See Also:

SchedulerService.getTaskByUuid(java.lang.String)