ABLE, Version 1.1b

com.ibm.able.platform.agents
Interface FipaAmsAgent

All Known Implementing Classes:
FipaAmsAgentAppl

public abstract interface FipaAmsAgent
extends FipaAgent

This class defines the base interface, or behavior, which all FIPA AMS agents must support.

Version:
$Revision: 1.2 $, $Date: 2000/02/08 15:13:58 $

Method Summary
 void authenticate(FipaAmsAgentDescription theDescription)
          Authenticate a registered agent.
 java.lang.Object createAgent(FipaAmsAgentDescription theDescription)
          Create an agent on this or another host as specified in the description, and then register it with this AMS.
 FipaAmsAgentDescription deregisterAgent(FipaAmsAgentDescription theDescription)
          Deregister an agent from this AMS.
 java.util.Hashtable getRegisteredAgents()
          Get all the registered agents from this AMS.
 void invokeAgent(java.lang.String theAgentName)
          Invoke a registered agent.
 void modifyAgent(FipaAmsAgentDescription theDescription)
          Modify a registered agent.
 FipaApDescription queryPlatformProfile()
          Retrieve the platform profile for this distributed agent platform.
 FipaAmsAgentDescription registerAgent(FipaAmsAgentDescription theDescription)
          Register an agent with this AMS.
 FipaAmsAgentDescription searchAgent(FipaAmsAgentDescription theDescription)
          Search the agent registry for an agent with specific attributes.
 void terminateAgent(java.lang.String theAgentName)
          Terminate a registered agent.
 
Methods inherited from interface com.ibm.able.platform.agents.FipaAgent
destroyAgent, executeAgent, invokeAgent, moveAgent, msgAcceptProposal, msgAgree, msgCancel, msgCfp, msgConfirm, msgDisconfirm, msgFailure, msgInform, msgInformIf, msgInformRef, msgNotUnderstood, msgPropose, msgQueryIf, msgQueryRef, msgRefuse, msgRejectProposal, msgRequest, msgRequestWhen, msgRequestWhenever, msgSubscribe, quitAgent, resumeAgent, suspendAgent, waitAgent, wakeUpAgent
 
Methods inherited from interface com.ibm.able.agents.AbleAgent
addEventConnection, getAgentAddr, getAgentHost, getAgentName, getDataSource, getNumEpochs, getProcessList, isActiveDataSource, removeEventConnection, setActiveDataSource, setProcessList
 
Methods inherited from interface com.ibm.able.AbleBean
addAbleEventListener, addDestBufferConnection, addPropertyChangeListener, addPropertyConnection, addSourceBufferConnection, dataChanged, flushAbleEventQueue, getAbleEventListeners, getAbleEventProcessingEnabled, getAbleEventQueueSize, getComment, getDestBufferConnections, getFileName, getInputBuffer, getInputBuffer, getInputBufferAsStringArray, getInputBufferContents, getLogger, getName, getOutputBuffer, getOutputBuffer, getOutputBufferAsStringArray, getOutputBufferContents, getParent, getPropertyConnectionManager, getSleepTime, getSourceBufferConnections, getState, hasInputBuffer, hasOutputBuffer, init, init, isChanged, isConnectable, isDataFlowEnabled, isTimerEventProcessingEnabled, notifyAbleEventListeners, process, processBufferConnections, propertyChange, quitAll, quitEnabledEventProcessing, removeAbleEventListener, removeAllBufferConnections, removeDestBufferConnection, removePropertyChangeListener, removePropertyConnection, removeSourceBufferConnection, reset, restartEnabledEventProcessing, restoreFromFile, restoreFromFile, resumeAll, resumeEnabledEventProcessing, saveToFile, saveToFile, setAbleEventProcessingEnabled, setChanged, setComment, setDataFlowEnabled, setFileName, setInputBuffer, setInputBuffer, setLogger, setName, setOutputBuffer, setOutputBuffer, setParent, setSleepTime, setState, setTimerEventProcessingEnabled, startEnabledEventProcessing, suspendAll, suspendEnabledEventProcessing
 
Methods inherited from interface com.ibm.able.AbleBeanContainer
addBean, containsBean, containsBean, getBean, getBeans, removeAllBeans, removeBean
 
Methods inherited from interface com.ibm.able.beans.AbleSensorManager
addSensor, getSensors, invokeSensor, removeSensor, setSensors
 
Methods inherited from interface com.ibm.able.beans.AbleEffectorManager
addEffector, getEffectors, invokeEffector, removeEffector, setEffectors
 
Methods inherited from interface com.ibm.able.AbleEventListener
handleAbleEvent
 
Methods inherited from interface com.ibm.able.AbleEventQueueProcessor
processAbleEvent, processNoEventProcessingEnabledSituation, processTimerEvent
 

Method Detail

registerAgent

public FipaAmsAgentDescription registerAgent(FipaAmsAgentDescription theDescription)
                                      throws java.rmi.RemoteException
Register an agent with this AMS.
Parameters:
theDescription - A FIPA AMS agent description identifying the agent to be registered.

Returns:
The same FIPA AMS agent description.
Throws:
java.rmi.RemoteException - On any error.

deregisterAgent

public FipaAmsAgentDescription deregisterAgent(FipaAmsAgentDescription theDescription)
                                        throws java.rmi.RemoteException
Deregister an agent from this AMS.
Parameters:
theDescription - A FIPA AMS agent description identifying the agent to be deregistered. The agent must, of course, already be registered with this AMS.

Returns:
The FIPA AMS agent description of the deregistered agent, or null if the agent was not found in the registry.
Throws:
java.rmi.RemoteException - On any error.

searchAgent

public FipaAmsAgentDescription searchAgent(FipaAmsAgentDescription theDescription)
                                    throws java.rmi.RemoteException
Search the agent registry for an agent with specific attributes.
Parameters:
theDescription - A FIPA AMS agent description containing search attributes.

Returns:
The FIPA AMS agent description of the single agent that matches the search attributes, or null if no matching agent was found.
Throws:
java.rmi.RemoteException - On any error.

modifyAgent

public void modifyAgent(FipaAmsAgentDescription theDescription)
                 throws java.rmi.RemoteException
Modify a registered agent.
Parameters:
theDescription - A FIPA AMS agent description identifying the agent to be modified, and how it is to be modified. The agent must, of course, be registered with this AMS.

Throws:
java.rmi.RemoteException - On any error.

authenticate

public void authenticate(FipaAmsAgentDescription theDescription)
                  throws java.rmi.RemoteException
Authenticate a registered agent.
Parameters:
theDescription - A FIPA AMS agent description identifying the agent to be authenticated. The agent must, of course, be registered with this AMS.

Throws:
java.rmi.RemoteException - On any error.

queryPlatformProfile

public FipaApDescription queryPlatformProfile()
                                       throws java.rmi.RemoteException
Retrieve the platform profile for this distributed agent platform.
Returns:
A FIPA Agent Platform Profile
Throws:
java.rmi.RemoteException - On any error.

createAgent

public java.lang.Object createAgent(FipaAmsAgentDescription theDescription)
                             throws java.rmi.RemoteException
Create an agent on this or another host as specified in the description, and then register it with this AMS.
Parameters:
theDescription - A FIPA AMS agent description identifying the agent to be created, and where it is to be created. Note that an AblePlatformSupport object must be running on the host where the agent is to be created.

Returns:
An interface that can be used to access the agent directly.
Throws:
java.rmi.RemoteException - On any error.

invokeAgent

public void invokeAgent(java.lang.String theAgentName)
                 throws java.rmi.RemoteException
Invoke a registered agent.
Parameters:
theAgentName - A String containing the name of the agent to invoke. The agent must, of course, be registered with this AMS.

Throws:
java.rmi.RemoteException - On any error.

terminateAgent

public void terminateAgent(java.lang.String theAgentName)
                    throws java.rmi.RemoteException
Terminate a registered agent.
Parameters:
theAgentName - A String containing the name of the agent to invoke. The agent must, of course, be registered with this AMS.

Throws:
java.rmi.RemoteException - On any error.

getRegisteredAgents

public java.util.Hashtable getRegisteredAgents()
                                        throws java.rmi.RemoteException
Get all the registered agents from this AMS.
Returns:
A copy of the hashtable of that contains all registered FIPA AMS agent names and descriptions (FipaAmsAgentDescription objects).
Throws:
java.rmi.RemoteException - On any error.

ABLE, Version 1.1b

ABLE: Produced by Joe, Don, and Jeff who say, 'Thanks for your support.'