com.cometway.ak
Interface AgentInterface

All Superinterfaces:
HasStateMachineModel
All Known Implementing Classes:
AbstractJFrameAgent, AbstractJFrameController, AbstractPropsPoolAgent, Agent, AgentKernel, AgentReplicator, AgentServer, AutoReplyAgent, CRLFConversionAgent, DeleteFileAgent, DelimitedLineExportAgent, DelimitedLineImportAgent, EmailBugReportAgent, EmailListAgent, EmailReporter, FileLoggerAgent, FileObjectManager, FileReaper, FileReporter, HTTPAccessRestriction, HTTPAuthenticationAgent, HTTPcgi, HTTPDownloaderAgent, HTTPFileDownloadAgent, HTTPFileServerAgent, HTTPPathRewrite, HTTPProxyAgent, HTTPPutAgent, HTTPRedirectAgent, HTTPSetProperty, HTTPThrottledFileServer, JDBCAgent, JDBCCreateTableAgent, JDBCDropTableAgent, JDBCExecutive, JDBCExportAgent, JDBCServiceAgent, JDBCToXMLAgent, LightBox, LogMonitorAgent, LogViewerPage, MessageAgent, MinRPCAgent, MoveFileAgent, ObjectManager, ObjectManagerArchiver, ObjectManagerArchiver, PooledJDBCAgent, PropsEditor, PropsListAgent, PropsListIteratorAgent, PropsListServiceManager, ReceiveEmailAgent, ReceivePOP3EmailAgent, RequestAgent, RequestDumperAgent, RequestFilterAgent, RunnableAgent, ScheduledAgent, Scheduler, SecureServiceManager, SecureWebServer, SendEmailAgent, ServiceAgent, ServiceManager, SessionManager, SessionReaper, ShellCommandAgent, StartupAgent, StartupAgentBuilder, StartupEditor, SystemExitAgent, WebServer, WebServerExtension, XMLPropsList, XMLPropsListExportAgent, XMLPropsListImportAgent, XMLRequestAgent, XMLStartupAgent

public interface AgentInterface
extends HasStateMachineModel

A standard interface for Agents.


Method Summary
 void debug(java.lang.String message)
          Sends the debugging message to the agent's standard output.
 void destroy()
          Called by agent kernel for special cleanup before an agent is destroyed.
 void error(java.lang.String message)
          Sends the error message to the agent's error output.
 void error(java.lang.String message, java.lang.Exception e)
          Sends the error message and associated exception to the agent's error output.
 Props getProps()
          Returns the Props assigned to this agent.
 void initProps()
          Initialize agent properties before it is started.
 void println(java.lang.String message)
          Sends the message to the agent's standard output.
 void setAgentController(AgentControllerInterface agentController)
          Assigns an AgentController to this agent.
 void setProps(Props p)
          Called by the agent kernel to assign a Props to this agent.
 void start()
          Called by agent kernel to initiate activities for this agent.
 void stop()
          Called by agent kernel to send stop requests from the agent kernel.
 java.lang.String toString()
          Returns the string representation of this agent.
 void warning(java.lang.String message)
          Sends the warning message to the agent's standard output.
 void warning(java.lang.String message, java.lang.Exception e)
          Sends the warning message and associated exception to the agent's error output.
 
Methods inherited from interface com.cometway.states.HasStateMachineModel
getStateMachineModel
 

Method Detail

getProps

Props getProps()
Returns the Props assigned to this agent.


setProps

void setProps(Props p)
Called by the agent kernel to assign a Props to this agent.


setAgentController

void setAgentController(AgentControllerInterface agentController)
Assigns an AgentController to this agent.


initProps

void initProps()
Initialize agent properties before it is started.


start

void start()
Called by agent kernel to initiate activities for this agent.


stop

void stop()
Called by agent kernel to send stop requests from the agent kernel.


destroy

void destroy()
Called by agent kernel for special cleanup before an agent is destroyed.


debug

void debug(java.lang.String message)
Sends the debugging message to the agent's standard output.


error

void error(java.lang.String message)
Sends the error message to the agent's error output.


error

void error(java.lang.String message,
           java.lang.Exception e)
Sends the error message and associated exception to the agent's error output.


println

void println(java.lang.String message)
Sends the message to the agent's standard output.


warning

void warning(java.lang.String message)
Sends the warning message to the agent's standard output.


warning

void warning(java.lang.String message,
             java.lang.Exception e)
Sends the warning message and associated exception to the agent's error output.


toString

java.lang.String toString()
Returns the string representation of this agent.

Overrides:
toString in class java.lang.Object