AbstractAgent (agents 0.1.0 API)

java.lang.Object
- net.obvj.agents.AbstractAgent

All Implemented Interfaces:

Runnable

Direct Known Subclasses:

CronAgent, TimerAgent
```
public abstract class AbstractAgent
extends Object
implements Runnable
```
A common interface for all managed agents

Author:

oswaldo.bapvic.jr

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class AbstractAgent.State

Nested Classes
Modifier and Type	Class and Description
`static class`	`AbstractAgent.State`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`net.obvj.performetrics.util.Duration`	`getAverageRunDuration()`
`AgentConfiguration`	`getConfiguration()`
`Calendar`	`getLastRunDate()`
`String`	`getName()`
`Calendar`	`getStartDate()`
`AbstractAgent.State`	`getState()`
`abstract String`	`getStatusString()`
`AgentType`	`getType()`
`boolean`	`isRunning()`
`boolean`	`isStarted()`
`boolean`	`isStopped()`
`abstract void`	`onStart()`
`abstract void`	`onStop()`
`void`	`run()` The method called by the system to execute the agent task automatically.
`void`	`run(boolean manualFlag)`
`void`	`start()` Starts this agent timer considering the interval settled in this object for execution.
`void`	`stop()` Suspends this agent.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getName
```
public String getName()
```
    Returns:
    
    This agent's identifier name, as in AgentConfiguration.
  - getType
```
public AgentType getType()
```
    Returns:
    
    This agent's type, as in AgentConfiguration.
  - getConfiguration
```
public AgentConfiguration getConfiguration()
```
    Returns:
    
    This agent's configuration data
  - getState
```
public AbstractAgent.State getState()
```
    Returns:
    
    This agent's current state
  - isStarted
```
public boolean isStarted()
```
    Returns:
    
    true if this agent's timer (not its task) is currently started; otherwise false.
  - isRunning
```
public boolean isRunning()
```
    Returns:
    
    true if this agent's task is currently running; otherwise false.
  - isStopped
```
public boolean isStopped()
```
    Returns:
    
    true if this agent's timer is currently stopped; otherwise false.
  - getStartDate
```
public Calendar getStartDate()
```
    Returns:
    
    The date and time when this agent was started (scheduled).
  - getLastRunDate
```
public Calendar getLastRunDate()
```
    Returns:
    
    The date and time when this agent task was last executed.
  - start
```
public final void start()
```
    Starts this agent timer considering the interval settled in this object for execution.
  - onStart
```
public abstract void onStart()
```
  - stop
```
public final void stop()
```
    Suspends this agent.
  - onStop
```
public abstract void onStop()
```
  - run
```
public void run()
```
    The method called by the system to execute the agent task automatically.
    
    Specified by:
    
    run in interface Runnable
  - run
```
public void run(boolean manualFlag)
```
  - getAverageRunDuration
```
public net.obvj.performetrics.util.Duration getAverageRunDuration()
```
  - getStatusString
```
public abstract String getStatusString()
```

Class AbstractAgent

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getName

getType

getConfiguration

getState

isStarted

isRunning

isStopped

getStartDate

getLastRunDate

start

onStart

stop

onStop

run

run

getAverageRunDuration

getStatusString