ABLE, Version 1.1b

com.ibm.able.platform.agents
Class FipaAmsAgentDescription

java.lang.Object
  |
  +--com.ibm.able.platform.agents.FipaAmsAgentDescription

public class FipaAmsAgentDescription
extends java.lang.Object
implements java.io.Serializable

This class provides an implementation of a FIPA AMS agent description.

This class also contains some ABLE extensions, the most interesting of which is a Java reference to the agent that this description describes. Therefore, when one looks up an agent in the AMS and obtains a description of the agent, addressability to the actual agent can be obtained by calling getReference() on the description. (The returned reference must be cast to the expected agent type before being used.) Two other extensions, class name and host name, allow an AMS to create agents on any remote system where an AblePlatformSupport object is running.

Version:
$Revision: 1.2 $, $Date: 2000/02/08 15:13:58 $
See Also:
Serialized Form

Constructor Summary
FipaAmsAgentDescription()
          Create a new, empty FIPA AMS agent description.
FipaAmsAgentDescription(java.lang.String theAgentName, java.lang.String theAddress)
          Create a new FIPA AMS agent description, and initialize it with specified parameters.
 
Method Summary
static java.lang.String Copyright()
          Determine the copyright of this class.
 java.lang.String getAddress()
          Retrieve the address of the agent.
 java.lang.String getAgentName()
          Retrieve the name of the agent.
 int getApState()
          Retrieve the AP state.
 java.lang.String getClassName()
          Retrieve the class name.
 java.lang.String getDelegateAgentName()
          Retrieve the delegate agent name.
 java.lang.String getHostName()
          Retrieve the host name.
 java.lang.String getOwnership()
          Retrieve the ownership.
 java.lang.Object getReference()
          Retrieve the reference.
 java.lang.String getSignature()
          Retrieve the signature.
 void setAddress(java.lang.String theAddress)
          Set the address of the agent.
 void setAgentName(java.lang.String theAgentName)
          Set the name of the agent.
 void setApState(int theApStateId)
          Set the AP state.
 void setClassName(java.lang.String theClassName)
          Set the class name.
 void setDelegateAgentName(java.lang.String theDelegateAgentName)
          Set the DelegateAgentName.
 void setHostName(java.lang.String theHostName)
          Set the host name.
 void setOwnership(java.lang.String theOwnership)
          Set the ownership.
 void setReference(java.lang.Object theReference)
          Set the reference.
 void setSignature(java.lang.String theSignature)
          Set the signature.
 java.lang.String toString()
          Retrieve a string describing (the contents of) the object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

FipaAmsAgentDescription

public FipaAmsAgentDescription()
Create a new, empty FIPA AMS agent description. The content must be filled in before the object can be used.

FipaAmsAgentDescription

public FipaAmsAgentDescription(java.lang.String theAgentName,
                               java.lang.String theAddress)
Create a new FIPA AMS agent description, and initialize it with specified parameters.
Parameters:
theAgentName - The name of the agent.

theAddress - The address of the agent.

Method Detail

getAgentName

public java.lang.String getAgentName()
Retrieve the name of the agent.
Returns:
An agent name.

setAgentName

public void setAgentName(java.lang.String theAgentName)
Set the name of the agent.
Parameters:
theAgentName - A name of an agent.


getAddress

public java.lang.String getAddress()
Retrieve the address of the agent.
Returns:
An agent address.

setAddress

public void setAddress(java.lang.String theAddress)
Set the address of the agent.
Parameters:
theAddress - A address of an agent.


getApState

public int getApState()
Retrieve the AP state.
Returns:
The AP state.

setApState

public void setApState(int theApStateId)
                throws java.lang.IllegalArgumentException
Set the AP state.
Parameters:
theApStateId - The AP state.

Throws:
java.lang.IllegalArgumentException - if the ApStateId is unknown; that is, not predefined in Fipa.java.

getDelegateAgentName

public java.lang.String getDelegateAgentName()
Retrieve the delegate agent name.
Returns:
The delegate agent name.

setDelegateAgentName

public void setDelegateAgentName(java.lang.String theDelegateAgentName)
Set the DelegateAgentName.
Parameters:
theDelegateAgentName - The delegate agent name.


getOwnership

public java.lang.String getOwnership()
Retrieve the ownership.
Returns:
The ownership.

setOwnership

public void setOwnership(java.lang.String theOwnership)
Set the ownership.
Parameters:
theOwnership - The ownership.


getSignature

public java.lang.String getSignature()
Retrieve the signature.
Returns:
The signature.

setSignature

public void setSignature(java.lang.String theSignature)
Set the signature.
Parameters:
theSignature - The signature.


getClassName

public java.lang.String getClassName()
Retrieve the class name.
Returns:
The class name.

setClassName

public void setClassName(java.lang.String theClassName)
Set the class name.
Parameters:
the - className The class name.


getHostName

public java.lang.String getHostName()
Retrieve the host name.
Returns:
The host name.

setHostName

public void setHostName(java.lang.String theHostName)
Set the host name.
Parameters:
the - hostName The host name.


getReference

public java.lang.Object getReference()
Retrieve the reference.
Returns:
The reference.

setReference

public void setReference(java.lang.Object theReference)
Set the reference.
Parameters:
the - reference The reference.


toString

public java.lang.String toString()
Retrieve a string describing (the contents of) the object.
Returns:
A String containing the current contents of the object.
Overrides:
toString in class java.lang.Object

Copyright

public static java.lang.String Copyright()
Determine the copyright of this class.
Returns:
A String containing this class's copyright statement.

ABLE, Version 1.1b

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