com.dpslink.base.util

Class ScheduledTaskManager

java.lang.Object

com.dpslink.base.util.ScheduledTaskManager

All Implemented Interfaces:

java.io.Serializable

public class ScheduledTaskManager
extends java.lang.Object
implements java.io.Serializable

The manager of server scheduled tasks.

• Initializes preconfigured scheduled tasks when the server is started (see the BaseStartup class) and adds the configured tasks to the FIFO thread queue.
• Terminates all scheduled tasks when the server is shutdown (see the BaseStartup class).
• Allows other scheduled tasks to be added to the FIFO thread queue.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private static java.util.ArrayList<ScheduledTask>	cvScheduledTasks The current set of scheduled tasks.
private static long	serialVersionUID The class' serialization version id.

Constructor Summary

Constructors

Constructor and Description
ScheduledTaskManager()

Method Summary

Modifier and Type	Method and Description
static boolean	addToQueue(ScheduledTask task, java.util.Date start, long rerun) Adds a scheduled task to the FIFO thread queue.
static boolean	addToQueue(ScheduledTask task, long start, long rerun) Adds a scheduled task to the FIFO thread queue.
private static java.util.Date	calcAbsoluteTime(java.lang.String time) Calculates and returns an absolute time value.
private static long	calcRelativeTime(java.lang.String time) Calculates and returns a relative time value.
static java.util.ArrayList<ScheduledTask>	getTasks() Returns the current set of scheduled tasks.
static boolean	hasTasks() Answers if any scheduled tasks are configured.
static void	removeFromQueue(ScheduledTask task, boolean cancel) Removes a scheduled task from the FIFO thread queue.
static void	removeFromQueue(java.lang.String id, boolean cancel) Removes a scheduled task from the FIFO thread queue.
static void	startTasks() Creates and schedules configured scheduled tasks for execution.
static void	stopTasks() Terminates scheduled tasks.

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

The class' serialization version id.

See Also:

Constant Field Values

cvScheduledTasks

private static java.util.ArrayList<ScheduledTask> cvScheduledTasks

The current set of scheduled tasks.

Constructor Detail

ScheduledTaskManager

public ScheduledTaskManager()

Method Detail

addToQueue

public static boolean addToQueue(ScheduledTask task,
                                 java.util.Date start,
                                 long rerun)

Adds a scheduled task to the FIFO thread queue.

Parameters:

task - (ScheduledTask) The task to add.

start - (Date) The date and time when the task should execute for the first time.

rerun - (long) The interval of time (milliseconds) that should elapse between repeated executions of the task. A zero value indicates no repeated execution.

Returns:

boolean - true if the task is successfully added to the queue, otherwise false.

addToQueue

public static boolean addToQueue(ScheduledTask task,
                                 long start,
                                 long rerun)

Adds a scheduled task to the FIFO thread queue.

Parameters:

task - (ScheduledTask) The task to add.

start - (long) The amount of time (milliseconds) the task should wait before executing for the first time. A zero value indicates immediate execution.

rerun - (long) The interval of time (milliseconds) that should elapse between repeated executions of the task. A zero value indicates no repeated execution.

Returns:

boolean - true if the task is successfully added to the queue, otherwise false.

removeFromQueue

public static void removeFromQueue(ScheduledTask task,
                                   boolean cancel)

Removes a scheduled task from the FIFO thread queue.

Parameters:

task - (ScheduledTask) The task to remove.

cancel - (boolean) true if execution of the task should be canceled, otherwise false.

removeFromQueue

public static void removeFromQueue(java.lang.String id,
                                   boolean cancel)

Removes a scheduled task from the FIFO thread queue.

Parameters:

id - (String) The id of the task to remove.

cancel - (boolean) true if execution of the task should be canceled, otherwise false.

getTasks

public static java.util.ArrayList<ScheduledTask> getTasks()

Returns the current set of scheduled tasks.

Returns:

ArrayList - The scheduled tasks.

hasTasks

public static boolean hasTasks()

Answers if any scheduled tasks are configured.

Returns:

boolean - true if tasks are configured, otherwise false.

startTasks

public static void startTasks()

Creates and schedules configured scheduled tasks for execution.

stopTasks

public static void stopTasks()

Terminates scheduled tasks. Typically invoked during server shutdown.

calcAbsoluteTime

private static java.util.Date calcAbsoluteTime(java.lang.String time)
                                        throws java.lang.Exception

Calculates and returns an absolute time value.

Parameters:

time - (String) The time on which to base the absolute time. The supplied value must be formatted as "hh:mm a".

Returns:

Date - The absolute time.

Throws:

java.lang.Exception

calcRelativeTime

private static long calcRelativeTime(java.lang.String time)
                              throws java.lang.Exception

Calculates and returns a relative time value.

Parameters:

time - (String) The time on which to base the relative time. The supplied value must be formatted as "hh:mm".

Returns:

long - The relative time (milliseconds).

Throws:

java.lang.Exception