Agent

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> edu >> mit >> media >> hive >> [ agent overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of edu.mit.media.hive.agent.Agent

SOURCE |

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

edu.mit.media.hive.agent
Interface Agent

All Superinterfaces:: edu.mit.media.hive.rdf.Describable, java.rmi.Remote

All Known Subinterfaces:: DJAgent, EventReceivingAgent, EventSendingAgent, EventTransceivingAgent, FloatSourceAgent, edu.mit.media.hive.agent.desktop.MusicPlayingAgent, TwoWayConnectionAgent

All Known Implementing Classes:: AgentImpl, DJAgentImpl, EventReceivingAgentImpl, EventSendingAgentImpl, EventTransceivingAgentImpl, TwoWayConnectionAgentImpl

public interface Agent
extends java.rmi.Remote, edu.mit.media.hive.rdf.Describable

the base remote interface for all agents. methods in this interface and its children are visible over the network. all methods must throw remoteexception.

Version:: $Revision: 2.0 $

Method Summary

void blockUntilReady()
          block if this agent is not yet ready, this method will release the caller when this agent has become ready

void configure(org.w3c.dom.Document doc)
          Tells the agent to configure itself from the DOM Node doc.

boolean connectTo(Agent otherAgent)
          connects this agent to some other agent.

void diePlease()
          ask this agent to politely die

void disconnectFrom(Agent otherAgent)
          disconnects this agent from the specified other agent.

void disconnectFromAll()
          disconnects this agent from all agents.

java.util.Vector getActionCommands()
          get a list of strings which are the labels for this agent's command menu

edu.mit.media.hive.cell.RemoteCell getCell()
          find out which server the agent lives on.

edu.mit.media.hive.rdf.Description getDescription()
          get the semantic description of this agent.

edu.mit.media.hive.support.SerializableImage getIcon()
          get the icon for this agent.

java.lang.String getName()
          get a name for this agent.

boolean invokeActionCommand(java.lang.String com)
          ask this agent to invoke a command from the agent's command menu

boolean isReady()
          see if this agent is ready for business

java.util.Vector listAllIncomingConnections()
          ask this agent for all its incoming connections

java.util.Vector listAllOutgoingConnections()
          ask this agent for all its outgoing connections

Methods inherited from interface edu.mit.media.hive.rdf.Describable

setDescription

Method Detail

getCell

public edu.mit.media.hive.cell.RemoteCell getCell()
                                           throws java.rmi.RemoteException

find out which server the agent lives on.

isReady

public boolean isReady()
                throws java.rmi.RemoteException

see if this agent is ready for business

blockUntilReady

public void blockUntilReady()
                     throws java.rmi.RemoteException

block if this agent is not yet ready, this method will release the caller when this agent has become ready

diePlease

public void diePlease()
               throws java.rmi.RemoteException

ask this agent to politely die

connectTo

public boolean connectTo(Agent otherAgent)
                  throws java.rmi.RemoteException

connects this agent to some other agent. it is up to the agent to define the semantics of what this means.

disconnectFromAll

public void disconnectFromAll()
                       throws java.rmi.RemoteException

disconnects this agent from all agents.

disconnectFrom

public void disconnectFrom(Agent otherAgent)
                    throws java.rmi.RemoteException

disconnects this agent from the specified other agent.

listAllIncomingConnections

public java.util.Vector listAllIncomingConnections()
                                            throws java.rmi.RemoteException

ask this agent for all its incoming connections

listAllOutgoingConnections

public java.util.Vector listAllOutgoingConnections()
                                            throws java.rmi.RemoteException

ask this agent for all its outgoing connections

getDescription

public edu.mit.media.hive.rdf.Description getDescription()
                                                  throws java.rmi.RemoteException

get the semantic description of this agent.

Specified by:: getDescription in interface edu.mit.media.hive.rdf.Describable

getIcon

public edu.mit.media.hive.support.SerializableImage getIcon()
                                                     throws java.rmi.RemoteException

get the icon for this agent.

getName

public java.lang.String getName()
                         throws java.rmi.RemoteException

get a name for this agent.

configure

public void configure(org.w3c.dom.Document doc)
               throws java.rmi.RemoteException

Tells the agent to configure itself from the DOM Node doc.

getActionCommands

public java.util.Vector getActionCommands()
                                   throws java.rmi.RemoteException

get a list of strings which are the labels for this agent's command menu

invokeActionCommand

public boolean invokeActionCommand(java.lang.String com)
                            throws java.rmi.RemoteException

ask this agent to invoke a command from the agent's command menu