net.obvj.agents.conf

Class AgentConfiguration

java.lang.Object

net.obvj.agents.conf.AgentConfiguration

public class AgentConfiguration
extends Object

An object that parses and stores the configuration data for a particular agent.

Author:

oswaldo.bapvic.jr

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AgentConfiguration.Builder An AgentConfiguration builder.
static class	AgentConfiguration.Source Enumerates supported configuration sources and their precedence levels.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object object)
static AgentConfiguration	fromAnnotatedClass(Class<?> agentClass) Parses the agent configuration by checking the Agent annotation in the specified class.
String	getClassName()
static AgentConfiguration	getHighestPrecedenceConfiguration(Collection<AgentConfiguration> agentConfigurations) Returns the AgentConfiguration with the highest precedence level among the objects in the specified Collection.
String	getInterval()
String	getName()
AgentConfiguration.Source	getSource()
AgentType	getType()
int	hashCode()
String	toString() Generates a string representation of this AgentConfiguration.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

getName

public String getName()

getType

public AgentType getType()

getClassName

public String getClassName()

getInterval

public String getInterval()

getSource

public AgentConfiguration.Source getSource()

fromAnnotatedClass

public static AgentConfiguration fromAnnotatedClass(Class<?> agentClass)

Parses the agent configuration by checking the Agent annotation in the specified class.

Parameters:

agentClass - the class to be mapped

Returns:

an AgentConfiguration mapped from the specified source class

Throws:

AgentConfigurationException - if the annotation is not present in the class

toString

public String toString()

Generates a string representation of this AgentConfiguration.

Overrides:

toString in class Object

Returns:

a string representation of the object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object object)

Overrides:

equals in class Object

getHighestPrecedenceConfiguration

public static AgentConfiguration getHighestPrecedenceConfiguration(Collection<AgentConfiguration> agentConfigurations)

Returns the AgentConfiguration with the highest precedence level among the objects in the specified Collection.

IMPORTANT: Although it is assumed that all agents contained in the specified collection have the same class name, this method performs no validation on this requirement. In other words, the object with higher precedence among the other ones will be returned regardless of any other agent attribute.

Parameters:

agentConfigurations - a collection of AgentConfiguration objects to be evaluated

Returns:

the object with the highest precedence level among the specified ones

Throws:

IllegalArgumentException - if an empty or null collection is received, or the specified collection does not contain at least one non-null object