ABLE, Version 1.1b

com.ibm.able.platform.agents
Interface FipaDfAgent

All Known Implementing Classes:
FipaDfAgentAppl

public abstract interface FipaDfAgent
extends FipaAgent

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

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

Method Summary
 FipaDfAgentDescription deregister(FipaDfAgentDescription theDescription)
          Deregister an agent from this DF.
 java.util.Hashtable getRegisteredAgents()
          Get all the registered agents from this DF.
 void modify(FipaDfAgentDescription theDescription)
          Modify a registered agent.
 FipaDfAgentDescription register(FipaDfAgentDescription theDescription)
          Register an agent with this DF.
 java.util.Vector search(FipaDfAgentDescription theDescription)
          Search the agent registry for an agent with specific attributes.
 
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

register

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

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

deregister

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

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

search

public java.util.Vector search(FipaDfAgentDescription theDescription)
                        throws java.rmi.RemoteException
Search the agent registry for an agent with specific attributes.
Parameters:
theDescription - A FIPA DF agent description containing search attributes.

Returns:
The FIPA DF 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.

modify

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

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

getRegisteredAgents

public java.util.Hashtable getRegisteredAgents()
                                        throws java.rmi.RemoteException
Get all the registered agents from this DF.
Returns:
A copy of the hashtable of that contains all registered FIPA DF agent names and descriptions (FipaDfAgentDescription 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.'