net.obvj.agents

Class TimerAgent

java.lang.Object

net.obvj.agents.AbstractAgent

net.obvj.agents.TimerAgent

All Implemented Interfaces:

Runnable

Direct Known Subclasses:

DynamicTimerAgent

public abstract class TimerAgent
extends AbstractAgent

A thread-safe extensible Agent for tasks that are scheduled in the system to run repeatedly, given an interval that is particular to each task. Available operations are: 'start', 'stop', 'run' and 'reset'

Author:

oswaldo.bapvic.jr

Nested Class Summary

Nested classes/interfaces inherited from class net.obvj.agents.AbstractAgent

AbstractAgent.State

Method Summary

Modifier and Type	Method and Description
void	afterRun() An event to be fired after agent task run.
TimeInterval	getInterval() Returns the interval configured for this TimerAgent.
String	getStatusJson()
void	onStart() Starts this agent timer considering the interval settled in this object for execution.
void	onStop() Terminates this agent timer gracefully.

Methods inherited from class net.obvj.agents.AbstractAgent

getAverageRunDuration, getConfiguration, getLastRunDate, getName, getStartDate, getState, getType, isRunning, isStarted, isStopped, run, run, start, stop

Methods inherited from class java.lang.Object

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

Method Detail

onStart

public final void onStart()

Starts this agent timer considering the interval settled in this object for execution.

Specified by:

onStart in class AbstractAgent

onStop

public final void onStop()

Terminates this agent timer gracefully. Does not interfere with a currently executing task, if it exists.

Specified by:

onStop in class AbstractAgent

afterRun

public void afterRun()

Description copied from class: AbstractAgent

An event to be fired after agent task run.

getInterval

public TimeInterval getInterval()

Returns the interval configured for this TimerAgent.

Returns:

the interval configured for this TimerAgent.

getStatusJson

public String getStatusJson()

Specified by:

getStatusJson in class AbstractAgent

Returns:

A string with current agent status in JSON format