net.obvj.agents.annotation

Annotation Type Agent

@Retention(value=RUNTIME)
 @Target(value=TYPE)
public @interface Agent

Identifies the annotated class as an Agent.

Author:

oswaldo.bapvic.jr

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	enableStatistics Indicates whether or not the system will process and store statistical data (e.g.: average execution duration) for this agent.
String	interval The interval between executions.
boolean	modulate Indicates whether or not the first execution should be delayed to cause the next ones to occur on the interval boundary (default is false).
String	name The agent name.
AgentType	type The agent type.

Element Detail

name

public abstract String name

The agent name.

If not specified, the agent name will be equal to the canonical class name.

Returns:

the agent name

Default:

""

type

public abstract AgentType type

The agent type.

If not specified, AgentType.TIMER will be considered.

Returns:

the agent type

Default:

net.obvj.agents.AgentType.TIMER

interval

public abstract String interval

The interval between executions.

If not specified, a default interval will be considered for, which is defined by the agent type.

Returns:

a string representing the configured interval between executions

Default:

""

modulate

public abstract boolean modulate

Indicates whether or not the first execution should be delayed to cause the next ones to occur on the interval boundary (default is false).

For example:

• [modulate = true]: if the current hour is 3h25 am and the agent interval is 4 hours then the first execution will be delayed to 4h, and then the next ones will occur at 8h, 12h, 16h, etc.
• [modulate = false]: if the current hour is 3h25 am and the agent interval is 4 hours then the first execution will occur immediately (3h25), and then the next ones will occur at 7h25, 11h25, 15h25, etc.

NOTE: This option is only applicable for agents of type AgentType.TIMER.

Returns:

a flag determining whether or not interval modulation is enabled for this agent

Since:

0.2.0

Default:

false

enableStatistics

public abstract boolean enableStatistics

Indicates whether or not the system will process and store statistical data (e.g.: average execution duration) for this agent.

Returns:

a flag determining whether or not statistics are enabled for this agent

Since:

0.3.0

Default:

false