ABLE, Version 1.1b

com.ibm.able.platform.agents
Interface FipaAgent

All Known Subinterfaces:
FipaAccAgent, FipaAmsAgent, FipaDfAgent
All Known Implementing Classes:
FipaAgentDefaultAgent

public abstract interface FipaAgent
extends AbleAgent

This class defines the base interface, or behavior, which all FIPA agents must support. This behavior falls into two areas:

  1. A set of base control methods (invokeAgent, quitAgent and so on).
  2. A set of methods, each of which handles a specific FIPA ACL message type.

Version:
$Revision: 1.3 $, $Date: 2000/02/21 20:01:03 $

Method Summary
 void destroyAgent()
           
 void executeAgent()
           
 void invokeAgent()
           
 void moveAgent()
           
 void msgAcceptProposal(FipaAclMessage theAclMessage)
           
 void msgAgree(FipaAclMessage theAclMessage)
           
 void msgCancel(FipaAclMessage theAclMessage)
           
 void msgCfp(FipaAclMessage theAclMessage)
           
 void msgConfirm(FipaAclMessage theAclMessage)
           
 void msgDisconfirm(FipaAclMessage theAclMessage)
           
 void msgFailure(FipaAclMessage theAclMessage)
           
 void msgInform(FipaAclMessage theAclMessage)
           
 void msgInformIf(FipaAclMessage theAclMessage)
           
 void msgInformRef(FipaAclMessage theAclMessage)
           
 void msgNotUnderstood(FipaAclMessage theAclMessage)
           
 void msgPropose(FipaAclMessage theAclMessage)
           
 void msgQueryIf(FipaAclMessage theAclMessage)
           
 void msgQueryRef(FipaAclMessage theAclMessage)
           
 void msgRefuse(FipaAclMessage theAclMessage)
           
 void msgRejectProposal(FipaAclMessage theAclMessage)
           
 void msgRequest(FipaAclMessage theAclMessage)
          Handle an ACL message of type 'fipa-request'.
 void msgRequestWhen(FipaAclMessage theAclMessage)
           
 void msgRequestWhenever(FipaAclMessage theAclMessage)
           
 void msgSubscribe(FipaAclMessage theAclMessage)
           
 void quitAgent()
           
 void resumeAgent()
           
 void suspendAgent()
           
 void waitAgent()
           
 void 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

invokeAgent

public void invokeAgent()
                 throws java.rmi.RemoteException

destroyAgent

public void destroyAgent()
                  throws java.rmi.RemoteException

quitAgent

public void quitAgent()
               throws java.rmi.RemoteException

suspendAgent

public void suspendAgent()
                  throws java.rmi.RemoteException

resumeAgent

public void resumeAgent()
                 throws java.rmi.RemoteException

waitAgent

public void waitAgent()
               throws java.rmi.RemoteException

wakeUpAgent

public void wakeUpAgent()
                 throws java.rmi.RemoteException

moveAgent

public void moveAgent()
               throws java.rmi.RemoteException

executeAgent

public void executeAgent()
                  throws java.rmi.RemoteException

msgAcceptProposal

public void msgAcceptProposal(FipaAclMessage theAclMessage)
                       throws java.rmi.RemoteException

msgAgree

public void msgAgree(FipaAclMessage theAclMessage)
              throws java.rmi.RemoteException

msgCancel

public void msgCancel(FipaAclMessage theAclMessage)
               throws java.rmi.RemoteException

msgCfp

public void msgCfp(FipaAclMessage theAclMessage)
            throws java.rmi.RemoteException

msgConfirm

public void msgConfirm(FipaAclMessage theAclMessage)
                throws java.rmi.RemoteException

msgDisconfirm

public void msgDisconfirm(FipaAclMessage theAclMessage)
                   throws java.rmi.RemoteException

msgFailure

public void msgFailure(FipaAclMessage theAclMessage)
                throws java.rmi.RemoteException

msgInform

public void msgInform(FipaAclMessage theAclMessage)
               throws java.rmi.RemoteException

msgInformIf

public void msgInformIf(FipaAclMessage theAclMessage)
                 throws java.rmi.RemoteException

msgInformRef

public void msgInformRef(FipaAclMessage theAclMessage)
                  throws java.rmi.RemoteException

msgNotUnderstood

public void msgNotUnderstood(FipaAclMessage theAclMessage)
                      throws java.rmi.RemoteException

msgPropose

public void msgPropose(FipaAclMessage theAclMessage)
                throws java.rmi.RemoteException

msgQueryIf

public void msgQueryIf(FipaAclMessage theAclMessage)
                throws java.rmi.RemoteException

msgQueryRef

public void msgQueryRef(FipaAclMessage theAclMessage)
                 throws java.rmi.RemoteException

msgRefuse

public void msgRefuse(FipaAclMessage theAclMessage)
               throws java.rmi.RemoteException

msgRejectProposal

public void msgRejectProposal(FipaAclMessage theAclMessage)
                       throws java.rmi.RemoteException

msgRequest

public void msgRequest(FipaAclMessage theAclMessage)
                throws java.rmi.RemoteException
Handle an ACL message of type 'fipa-request'.
Parameters:
theAclMessage - The message as sent by the originating agent.

Throws:
java.rmi.RemoteException - On any error.
See Also:
msgRequestWhen(com.ibm.able.platform.agents.FipaAclMessage), msgRequestWhenever(com.ibm.able.platform.agents.FipaAclMessage)

msgRequestWhen

public void msgRequestWhen(FipaAclMessage theAclMessage)
                    throws java.rmi.RemoteException

msgRequestWhenever

public void msgRequestWhenever(FipaAclMessage theAclMessage)
                        throws java.rmi.RemoteException

msgSubscribe

public void msgSubscribe(FipaAclMessage theAclMessage)
                  throws java.rmi.RemoteException

ABLE, Version 1.1b

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