Index (agents 0.2.0 API)

A B C D E F G H I L M N O R S T V

A

AbstractAgent - Class in net.obvj.agents: A common interface for all managed agents
AbstractAgent.State - Enum in net.obvj.agents
afterRun() - Method in class net.obvj.agents.CronAgent
afterRun() - Method in class net.obvj.agents.TimerAgent
Agent - Annotation Type in net.obvj.agents.annotation: Identifies the annotated class as an Agent.
AgentConfiguration - Class in net.obvj.agents.conf: An object that parses and stores the configuration data for a particular agent.
agentConfiguration(String, Object...) - Static method in class net.obvj.agents.util.Exceptions: Creates an AgentConfigurationException with a formatted message.
agentConfiguration(Throwable, String, Object...) - Static method in class net.obvj.agents.util.Exceptions: Creates an AgentConfigurationException with a cause and a formatted message.
AgentConfiguration.Builder - Class in net.obvj.agents.conf: An AgentConfiguration builder.
AgentConfigurationException - Exception in net.obvj.agents.exception: An exception that can be thrown in cases of bad agent configuration.
AgentConfigurationException(String) - Constructor for exception net.obvj.agents.exception.AgentConfigurationException: Constructs an AgentConfigurationException with the specified detail message.
AgentConfigurationException(String, Throwable) - Constructor for exception net.obvj.agents.exception.AgentConfigurationException: Constructs a new exception with the specified detail message and cause.
AgentConfigurationException(Throwable) - Constructor for exception net.obvj.agents.exception.AgentConfigurationException: Constructs a new exception with the specified cause and a detail message of {@code (cause==null ?
AgentFactory - Class in net.obvj.agents.util: A factory that creates AbstractAgent objects based on given AgentConfiguration.
AgentManager - Class in net.obvj.agents: A component that provides methods for Agents maintenance.
agentRuntime(String, Object...) - Static method in class net.obvj.agents.util.Exceptions: Creates an AgentRuntimeException with a formatted message.
agentRuntime(Throwable, String, Object...) - Static method in class net.obvj.agents.util.Exceptions: Creates an AgentRuntimeException with a cause and a formatted message.
AgentRuntimeException - Exception in net.obvj.agents.exception: An exception that can be thrown by agents at runtime.
AgentRuntimeException(String) - Constructor for exception net.obvj.agents.exception.AgentRuntimeException: Constructs an AgentRuntimeException with the specified detail message.
AgentRuntimeException(String, Throwable) - Constructor for exception net.obvj.agents.exception.AgentRuntimeException: Constructs a new exception with the specified detail message and cause.
AgentRuntimeException(Throwable) - Constructor for exception net.obvj.agents.exception.AgentRuntimeException: Constructs a new exception with the specified cause and a detail message of {@code (cause==null ?
AgentThreadFactory - Class in net.obvj.agents.util: An object that creates new threads for SMART agents.
AgentThreadFactory(String) - Constructor for class net.obvj.agents.util.AgentThreadFactory: Creates a new thread factory for the agent identified by the given name.
AgentType - Enum in net.obvj.agents: Enumerates available Agent types and associated facilities.
AnnotatedAgentScanner - Class in net.obvj.agents.util: Contains methods for scanning package(s) to find annotated agents.
AnnotationUtils - Class in net.obvj.agents.util: Utility methods for working with annotations and package scanning.
AnnotationUtils.MethodFilter - Enum in net.obvj.agents.util: Enumerates applicable method filters.
ApplicationContextFacade - Class in net.obvj.agents.util: A facade for the Application Context holding the components required by this project.

B

build() - Method in class net.obvj.agents.conf.AgentConfiguration.Builder
Builder() - Constructor for class net.obvj.agents.conf.AgentConfiguration.Builder

C

className(String) - Method in class net.obvj.agents.conf.AgentConfiguration.Builder
convert(long, TimeUnit) - Method in enum net.obvj.agents.util.TimeUnit: Converts the given time duration from a source Time Unit to this Time Unit.
create(AgentConfiguration) - Static method in class net.obvj.agents.util.AgentFactory: Creates a new agent instance from the given AgentConfiguration.
CronAgent - Class in net.obvj.agents: An agent that runs a particular task at specified times and dates, similar to the Cron service available in Unix/Linux systems.

D

DateUtils - Class in net.obvj.agents.util: Utility methods for working with dates
DEFAULT - Static variable in enum net.obvj.agents.util.TimeUnit: The default time unit
defaultInstance() - Static method in class net.obvj.agents.AgentManager: Returns the default instance of this component.
DynamicAgent - Class in net.obvj.agents.impl: An object that prepares and holds the required metadata and infrastructure for the execution of a dynamic agent, which may vary depending on the associated AgentConfiguration.
DynamicAgent(AgentConfiguration) - Constructor for class net.obvj.agents.impl.DynamicAgent: Validates annotations and prepares all objects for execution.
DynamicCronAgent - Class in net.obvj.agents.impl: A CronAgent that runs a dynamic agent object.
DynamicCronAgent(AgentConfiguration) - Constructor for class net.obvj.agents.impl.DynamicCronAgent: Creates a new DynamicCronAgent for the given AgentConfiguration.
DynamicTimerAgent - Class in net.obvj.agents.impl: A TimerAgent that runs a dynamic agent object.
DynamicTimerAgent(AgentConfiguration) - Constructor for class net.obvj.agents.impl.DynamicTimerAgent: Creates a new DynamicTimerAgent for the given AgentConfiguration.

E

equals(Object) - Method in class net.obvj.agents.conf.AgentConfiguration
equals(Object) - Method in class net.obvj.agents.util.TimeInterval
Exceptions - Class in net.obvj.agents.util: Shorthands creating exceptions with a formatted message.

F

findAgentByName(String) - Method in class net.obvj.agents.AgentManager: Searches and returns the agent with the specified name in this manager's scope.
findByIdentifier(String) - Static method in enum net.obvj.agents.util.TimeUnit: Returns a TimeUnit that is identifiable by the given string.
findClassesWithAnnotation(Class<? extends Annotation>, String) - Static method in class net.obvj.agents.util.AnnotationUtils: Scans the class path from a base package to find classes annotated with a given annotation.
firstWinsMerger() - Static method in class net.obvj.agents.util.Functions: A merger operation upon two operands of the same type, typically for handling collisions between values associated with the same key in a Map, where the first object is always applied.
formatDate(Calendar) - Static method in class net.obvj.agents.util.DateUtils: Formats the given calendar using a standardized date format.
formatDate(ZonedDateTime) - Static method in class net.obvj.agents.util.DateUtils: Formats the given ZonedDateTime using a standardized date format.
formatDate(Date) - Static method in class net.obvj.agents.util.DateUtils: Formats the given date using a standardized date format.
fromAnnotatedClass(Class<?>) - Static method in class net.obvj.agents.conf.AgentConfiguration: Parses the agent configuration by checking the Agent annotation in the specified class.
Functions - Class in net.obvj.agents.util: This class provides common functions for use with Streams and Collectors.

G

getAgentClass() - Method in class net.obvj.agents.impl.DynamicAgent
getAgentInstance() - Method in class net.obvj.agents.impl.DynamicAgent
getAgents() - Method in class net.obvj.agents.AgentManager
getAgents() - Method in class net.obvj.agents.conf.GlobalConfiguration: Returns a list of AgentConfiguration.Builder (candidates), as retrieved by the configuration container.
getAgentStatusStr(String) - Method in class net.obvj.agents.AgentManager: Returns a string containing agent status information for reporting.
getAverageRunDuration() - Method in class net.obvj.agents.AbstractAgent
getBean(Class<T>) - Static method in class net.obvj.agents.util.ApplicationContextFacade: Return the bean instance that uniquely matches the given object type.
getCalendarConstant() - Method in enum net.obvj.agents.util.TimeUnit: Returns the Calendar constant associated with this Time Unit.
getClassName() - Method in class net.obvj.agents.conf.AgentConfiguration
getClonedCalendar(Calendar) - Static method in class net.obvj.agents.util.DateUtils: Creates and returns a clone of the given calendar object.
getConfiguration() - Method in class net.obvj.agents.AbstractAgent
getCronExpression() - Method in class net.obvj.agents.CronAgent
getDefaultInterval() - Method in enum net.obvj.agents.AgentType: Returns the default interval for an agent type.
getDuration() - Method in class net.obvj.agents.util.TimeInterval: Returns the duration of this TimeUnit.
getFactoryFunction() - Method in enum net.obvj.agents.AgentType: Returns the default factory Function to be applied for instantiating new agents of this type.
getHighestPrecedenceConfigurationByAgentClassName(String) - Method in class net.obvj.agents.conf.GlobalConfigurationHolder: Returns the highest-precedence AgentConfiguration object associated with a given class name.
getInterval() - Method in class net.obvj.agents.conf.AgentConfiguration
getInterval() - Method in class net.obvj.agents.TimerAgent: Returns the interval configured for this TimerAgent.
getLastRunDate() - Method in class net.obvj.agents.AbstractAgent
getName() - Method in class net.obvj.agents.AbstractAgent
getName() - Method in class net.obvj.agents.conf.AgentConfiguration
getNextExactDateEveryInterval(int, TimeUnit) - Static method in class net.obvj.agents.util.DateUtils: Return the next exact date for a given interval and time unit after the current time.
getNextExactDateEveryInterval(int, TimeUnit, Date) - Static method in class net.obvj.agents.util.DateUtils: Return the next exact date given a specific interval and time unit after the specified date.
getNextExactDateEveryInterval(int, TimeUnit, Calendar) - Static method in class net.obvj.agents.util.DateUtils: Return the next exact date given a specific interval and time unit after the specified Calendar instance.
getNextExecutionDate() - Method in class net.obvj.agents.CronAgent
getRunMethod() - Method in class net.obvj.agents.impl.DynamicAgent
getSinglePublicMethodWithAnnotation(Class<? extends Annotation>, Class<?>) - Static method in class net.obvj.agents.util.AnnotationUtils: Returns the public method of the given class that is annotated with the given annotation, provided that only a single method containing this annotation exists in the class.
getSinglePublicMethodWithAnnotation(Class<? extends Annotation>, Class<?>, AnnotationUtils.MethodFilter) - Static method in class net.obvj.agents.util.AnnotationUtils: Returns the public method of the given class that is annotated with the given annotation, provided that only a single method containing this annotation exists in the class.
getStartDate() - Method in class net.obvj.agents.AbstractAgent
getState() - Method in class net.obvj.agents.AbstractAgent
getStatusString() - Method in class net.obvj.agents.AbstractAgent
getStatusString() - Method in class net.obvj.agents.CronAgent
getStatusString() - Method in class net.obvj.agents.TimerAgent
getTimeUnit() - Method in class net.obvj.agents.util.TimeInterval: Returns the TimeUnit associated with this TimeInterval.
getType() - Method in class net.obvj.agents.AbstractAgent
getType() - Method in class net.obvj.agents.conf.AgentConfiguration
GlobalConfiguration - Class in net.obvj.agents.conf: An object containing global configuration data from a particular source.
GlobalConfiguration() - Constructor for class net.obvj.agents.conf.GlobalConfiguration: Constructs a new GlobalConfiguration.
GlobalConfigurationHolder - Class in net.obvj.agents.conf: An object that holds multiple configuration objects for the several configuration sources.
GlobalConfigurationHolder() - Constructor for class net.obvj.agents.conf.GlobalConfigurationHolder: Builds a GlobalConfigurationHolder, loaded with configuration data mapped from all of the supported configuration sources.

H

hashCode() - Method in class net.obvj.agents.conf.AgentConfiguration
hashCode() - Method in class net.obvj.agents.util.TimeInterval: Returns a hash code value for the object, to support hash tables.

I

illegalArgument(String, Object...) - Static method in class net.obvj.agents.util.Exceptions: Creates an IllegalArgumentException with a formatted message.
illegalArgument(Throwable, String, Object...) - Static method in class net.obvj.agents.util.Exceptions: Creates an IllegalArgumentException with a cause and a formatted message.
illegalState(String, Object...) - Static method in class net.obvj.agents.util.Exceptions: Creates an IllegalStateException with a formatted message.
illegalState(Throwable, String, Object...) - Static method in class net.obvj.agents.util.Exceptions: Creates an IllegalStateException with a cause and a formatted message.
interval(String) - Method in class net.obvj.agents.conf.AgentConfiguration.Builder
invalidClass(String, Object...) - Static method in class net.obvj.agents.util.Exceptions: Creates a InvalidClassException with a formatted message.
invalidClass(Throwable, String, Object...) - Static method in class net.obvj.agents.util.Exceptions: Creates a InvalidClassException with a cause and a formatted message.
InvalidClassException - Exception in net.obvj.agents.exception: An exception that can be thrown in cases of invalid class setup.
InvalidClassException(String) - Constructor for exception net.obvj.agents.exception.InvalidClassException: Constructs a new InvalidClassException with the specified detail message.
InvalidClassException(String, Throwable) - Constructor for exception net.obvj.agents.exception.InvalidClassException: Constructs a new InvalidClassException with the specified detail message and cause.
InvalidClassException(Throwable) - Constructor for exception net.obvj.agents.exception.InvalidClassException: Constructs a new InvalidClassException with the specified cause and a detail message of {@code (cause==null ?
isAgentRunning(String) - Method in class net.obvj.agents.AgentManager: Returns a flag indicating whether an agent is running or not.
isAgentStarted(String) - Method in class net.obvj.agents.AgentManager: Returns a flag indicating whether an agent is started or not.
isIdentifiableBy(String) - Method in enum net.obvj.agents.util.TimeUnit: Checks a given string against a list of known identifiers for a TimeUnit, returning true if a match is found.
isModulate() - Method in class net.obvj.agents.conf.AgentConfiguration
isRunning() - Method in class net.obvj.agents.AbstractAgent
isStarted() - Method in class net.obvj.agents.AbstractAgent
isStopped() - Method in class net.obvj.agents.AbstractAgent

L

lastWinsMerger() - Static method in class net.obvj.agents.util.Functions: A merger operation upon two operands of the same type, typically for handling collisions between values associated with the same key in a Map, where the second object is always applied.

M

modulate(boolean) - Method in class net.obvj.agents.conf.AgentConfiguration.Builder

N

name(String) - Method in class net.obvj.agents.conf.AgentConfiguration.Builder
net.obvj.agents - package net.obvj.agents: The base package.
net.obvj.agents.annotation - package net.obvj.agents.annotation: Provides annotations for agents setup.
net.obvj.agents.conf - package net.obvj.agents.conf: Provides classes for working with agents configuration.
net.obvj.agents.exception - package net.obvj.agents.exception: Provides custom exceptions for proper error handling, whether on agents setup, configuration, or runtime.
net.obvj.agents.impl - package net.obvj.agents.impl: Provides mainly internal classes for agents runtime.
net.obvj.agents.util - package net.obvj.agents.util: Provides utility classes in general.
newThread(Runnable) - Method in class net.obvj.agents.util.AgentThreadFactory: Constructs a new Thread.
now() - Static method in class net.obvj.agents.util.DateUtils: Returns the current date-time as a ZonedDateTime, using the system clock.

O

of(String) - Static method in class net.obvj.agents.util.TimeInterval: Builds a TimerInterval by parsing the given string.
onStart() - Method in class net.obvj.agents.AbstractAgent
onStart() - Method in class net.obvj.agents.CronAgent: Starts this agent schedule considering the Cron expression.
onStart() - Method in class net.obvj.agents.TimerAgent: Starts this agent timer considering the interval settled in this object for execution.
onStop() - Method in class net.obvj.agents.AbstractAgent
onStop() - Method in class net.obvj.agents.CronAgent
onStop() - Method in class net.obvj.agents.TimerAgent: Terminates this agent timer gracefully.

R

removeAgent(String) - Method in class net.obvj.agents.AgentManager: Removes an agent identified by the given name, if it is not started
resetAgent(String) - Method in class net.obvj.agents.AgentManager: Creates a new instance of the agent identified by the given name.
run() - Method in class net.obvj.agents.AbstractAgent: The method called by the system to execute the agent task automatically.
run(boolean) - Method in class net.obvj.agents.AbstractAgent
Run - Annotation Type in net.obvj.agents.annotation: Identifies the annotated method as the one to be executed for a class annotated with @Agent.
runAgentTask() - Method in class net.obvj.agents.impl.DynamicAgent: Invokes the method annotated as @Run for the agent.
runNow(String) - Method in class net.obvj.agents.AgentManager: Posts immediate execution of the agent identified by the given name.

S

scanPackage(String) - Method in class net.obvj.agents.AgentManager: Scans the specified base package for agent candidates, then looks for higher precedence configuration sources and, finally, instantiates the agents, and keeps theirs reference for management purposes.
scanPackage(String) - Static method in class net.obvj.agents.util.AnnotatedAgentScanner: Scans the specified base package for agents.
start() - Method in class net.obvj.agents.AbstractAgent: Starts this agent timer considering the interval settled in this object for execution.
startAgent(String) - Method in class net.obvj.agents.AgentManager: Starts the agent identified by the given name.
startAllAgents() - Method in class net.obvj.agents.AgentManager
stop() - Method in class net.obvj.agents.AbstractAgent: Suspends this agent.
stopAgent(String) - Method in class net.obvj.agents.AgentManager: Posts a graceful stop request for the agent identified by the given name.

T

TimeInterval - Class in net.obvj.agents.util: An object that represents a time interval, which consists of a duration and a TimeUnit, with advanced text parsing logic.
TimeInterval(int, TimeUnit) - Constructor for class net.obvj.agents.util.TimeInterval: Builds a TimeInterval with a given duration and TimeUnit.
TimeInterval(TimeInterval) - Constructor for class net.obvj.agents.util.TimeInterval: Builds a new TimeInterval with the same attributes from a preset object.
TimerAgent - Class in net.obvj.agents: 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.
TimeUnit - Enum in net.obvj.agents.util: Enumerates the supported time units for Timer agents execution.
toMillis() - Method in class net.obvj.agents.util.TimeInterval: Returns this time interval's duration, in milliseconds.
toMillis(long) - Method in enum net.obvj.agents.util.TimeUnit: Converts the given amount into milliseconds.
toString() - Method in class net.obvj.agents.conf.AgentConfiguration.Builder: Returns a string representation of the target AgentConfiguration.
toString() - Method in class net.obvj.agents.conf.AgentConfiguration: Generates a string representation of this AgentConfiguration.
toString() - Method in class net.obvj.agents.conf.GlobalConfiguration: Returns a string representation of this GlobalConfiguration.
toString() - Method in class net.obvj.agents.impl.DynamicCronAgent
toString() - Method in class net.obvj.agents.impl.DynamicTimerAgent
toString() - Method in class net.obvj.agents.util.TimeInterval: Returns a human-friendly string representation of this TimeInterval, for example: "2 minute(s)".
toString() - Method in enum net.obvj.agents.util.TimeUnit: Returns a string representation of this TimeUnit.
type(AgentType) - Method in class net.obvj.agents.conf.AgentConfiguration.Builder

V

valueOf(String) - Static method in enum net.obvj.agents.AbstractAgent.State: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum net.obvj.agents.AgentType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum net.obvj.agents.util.AnnotationUtils.MethodFilter: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum net.obvj.agents.util.TimeUnit: Returns the enum constant of this type with the specified name.
values() - Static method in enum net.obvj.agents.AbstractAgent.State: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum net.obvj.agents.AgentType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum net.obvj.agents.util.AnnotationUtils.MethodFilter: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum net.obvj.agents.util.TimeUnit: Returns an array containing the constants of this enum type, in the order they are declared.

A B C D E F G H I L M N O R S T V