SMILA (incubation) API documentation

org.eclipse.smila.workermanager.keepalive
Class TaskKeepAlive

java.lang.Object
  extended by org.eclipse.smila.workermanager.keepalive.TaskKeepAlive
All Implemented Interfaces:
java.lang.Runnable

public class TaskKeepAlive
extends java.lang.Object
implements java.lang.Runnable

Helper class to store tasks and keep them alive.


Field Summary
static long DEFAULT_SCHEDULE_MILLIS
          default schedule time in ms between checking of the delay queue.
static long TIME_OUT_DEFAULT_SECONDS
          default timeout in s between keep alive calls.
 
Constructor Summary
TaskKeepAlive(TaskManager taskManager)
          Constructor.
TaskKeepAlive(TaskManager taskManager, long timeout)
          Constructor.
 
Method Summary
 void addKeepAliveFailureListener(TaskKeepAliveListener keepAliveListener)
          Adds a TaskKeepAliveListener to this instance of TaskKeepAlive.
 void addKeepAliveFailureListeners(java.util.Collection<TaskKeepAliveListener> keepAliveListeners)
          Adds all given TaskKeepAliveListener to this instance of TaskKeepAlive.
 void addTask(Task task)
          Adds a task to be regularly kept alive.
 java.util.Collection<TaskKeepAliveListener> getKeepAliveFailureListeners()
           
 void removeKeepAliveFailureListener(TaskKeepAliveListener keepAliveListener)
          Removes a TaskKeepAliveListener from this instance of TaskKeepAlive.
 void removeTask(Task task)
          Remove a task from the keep alive mechanism.
 void run()
          
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DEFAULT_SCHEDULE_MILLIS

public static final long DEFAULT_SCHEDULE_MILLIS
default schedule time in ms between checking of the delay queue.

See Also:
Constant Field Values

TIME_OUT_DEFAULT_SECONDS

public static final long TIME_OUT_DEFAULT_SECONDS
default timeout in s between keep alive calls.

See Also:
Constant Field Values
Constructor Detail

TaskKeepAlive

public TaskKeepAlive(TaskManager taskManager)
Constructor.

Parameters:
taskManager - a reference to the task manager.

TaskKeepAlive

public TaskKeepAlive(TaskManager taskManager,
                     long timeout)
Constructor.

Parameters:
taskManager - a reference to the task manager.
timeout - the timespan after which a task should be kept alive
Method Detail

removeTask

public void removeTask(Task task)
Remove a task from the keep alive mechanism.

Parameters:
task - the task to remove.

addTask

public void addTask(Task task)
Adds a task to be regularly kept alive.

Parameters:
task - the task to add.

run

public void run()

Specified by:
run in interface java.lang.Runnable

addKeepAliveFailureListener

public void addKeepAliveFailureListener(TaskKeepAliveListener keepAliveListener)
Adds a TaskKeepAliveListener to this instance of TaskKeepAlive.

Parameters:
keepAliveListener - the TaskKeepAliveListener to add.

addKeepAliveFailureListeners

public void addKeepAliveFailureListeners(java.util.Collection<TaskKeepAliveListener> keepAliveListeners)
Adds all given TaskKeepAliveListener to this instance of TaskKeepAlive.

Parameters:
keepAliveListeners - collection of TaskKeepAliveListener to add.

removeKeepAliveFailureListener

public void removeKeepAliveFailureListener(TaskKeepAliveListener keepAliveListener)
Removes a TaskKeepAliveListener from this instance of TaskKeepAlive.

Parameters:
keepAliveListener - the TaskKeepAliveListener to remove.

getKeepAliveFailureListeners

public java.util.Collection<TaskKeepAliveListener> getKeepAliveFailureListeners()
Returns:
all currently registered keep alive listeners.

SMILA (incubation) API documentation