org.lsst.ccs.framework

Class AgentPeriodicTask

java.lang.Object

org.lsst.ccs.framework.AgentPeriodicTask

public class AgentPeriodicTask
extends Object

An Agent managed PeriodicTask is a centrally managed periodic task that will execute a Runnable. The periodic task must be provided a non null name. - runnable Runnable to execute - taskName name of this task Other parameters that define the Periodic task are: - isFixedRate true if this task will be executed at fixed rate, the default; false if this task will be run with fixed delay - logLevel level at which exceptions thrown by this task will be logged. By default Level.SEVERE will be used; - period the period between successive executions, or the delay between executions, depending on the value of isFixedRate argument. By default the task is configured to execute every second. - unit the time unit of the period parameter, by default TimeUnit.MILLISECONDS

Author:

The LSST CCS Team

Constructor Summary

Constructors

Constructor and Description
AgentPeriodicTask(String taskName, Runnable runnable) Create a periodic task by name.

Method Summary

Modifier and Type	Method and Description
Level	getLogLevel() Get the log level at which exceptions will be logged.
Duration	getPeriod() Get the task period.
Runnable	getRunnable() Get the Runnable to be executed.
String	getTaskName() Get the name for this task.
boolean	isIsFixedRate() Get if the task is to be executed at fixed rated or fixed delay.
AgentPeriodicTask	withIsFixedRate(boolean isFixedRate) Set if the task is to be executed with fixed rate or fixed delay.
AgentPeriodicTask	withLogLevel(Level logLevel) Set the log level for this periodic task.
AgentPeriodicTask	withPeriod(Duration period) Set the period between successive executions, or the delay between executions, depending on the value of isFixedRate argument.

Methods inherited from class java.lang.Object

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

Constructor Detail

AgentPeriodicTask

public AgentPeriodicTask(String taskName,
                         Runnable runnable)

Create a periodic task by name. The provided runnable will be executed according the periodic task parameters.

Parameters:

taskName -

runnable -

Method Detail

withIsFixedRate

public AgentPeriodicTask withIsFixedRate(boolean isFixedRate)

Set if the task is to be executed with fixed rate or fixed delay.

Parameters:

isFixedRate - true if this task will be executed at fixed rate; false if this task will be run with fixed delay

Returns:

The modified periodic task object.

withLogLevel

public AgentPeriodicTask withLogLevel(Level logLevel)

Set the log level for this periodic task.

Parameters:

logLevel - level at which exceptions thrown by this task will be logged

Returns:

The modified periodic task object.

withPeriod

public AgentPeriodicTask withPeriod(Duration period)

Set the period between successive executions, or the delay between executions, depending on the value of isFixedRate argument. The units of this period are specified by the unit parameter.

Parameters:

period - the period for this task

Returns:

The modified periodic task object.

getRunnable

public Runnable getRunnable()

Get the Runnable to be executed.

Returns:

The Runnable.

isIsFixedRate

public boolean isIsFixedRate()

Get if the task is to be executed at fixed rated or fixed delay.

Returns:

true if the task is to be executed at fixed rate.

getTaskName

public String getTaskName()

Get the name for this task.

Returns:

The task name.

getLogLevel

public Level getLogLevel()

Get the log level at which exceptions will be logged.

Returns:

The log level.

getPeriod

public Duration getPeriod()

Get the task period.

Returns:

The task period