AID

java.lang.Object
- jade.core.AID

All Implemented Interfaces:

Serializable, Comparable

Direct Known Subclasses:

OntoAID
```
public class AID
extends Object
implements Comparable, Serializable
```
This class represents a JADE Agent Identifier. JADE internal agent tables use this class to record agent names and addresses.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`private List`	`addresses`
`static String`	`AGENT_CLASSNAME` Key to retrieve the agent class name as a user defined slot of the AID included in the AMSAgentDescription registered with the AMS.
`private static int`	`EXPECTED_ADDRESSES_SIZE`
`private static int`	`EXPECTED_RESOLVERS_SIZE`
`private int`	`hashCode`
`static boolean`	`ISGUID` constant to be used in the constructor of the AID
`static boolean`	`ISLOCALNAME` constant to be used in the constructor of the AID
`private String`	`name`
`private Long`	`persistentID`
`private static String`	`platformID`
`private List`	`resolvers`
`private Properties`	`userDefSlots`

Constructor Summary

Constructors
Constructor and Description
`AID()` Constructs an Agent-Identifier whose slot name is set to an empty string
`AID(String guid)` Deprecated. This constructor might generate a wrong AID, if the passed parameter is not a guid (globally unique identifier), but the local name of an agent (e.g. "da0").
`AID(String name, boolean isGUID)` Constructor for an Agent-identifier

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAddresses(String url)` This method permits to add a transport address where the agent can be contacted.
`void`	`addResolvers(AID aid)` This method permits to add the AID of a resolver (an agent where name resolution services for the agent can be contacted)
`void`	`addUserDefinedSlot(String key, String value)` To add a user defined slot (a pair key, value).
`void`	`clearAllAddresses()` To remove all addresses of the agent
`void`	`clearAllResolvers()` To remove all resolvers.
`Object`	`clone()` Clone the AID object.
`int`	`compareTo(Object o)` Comparison operation.
`boolean`	`equals(Object o)` Equality operation.
`String[]`	`getAddressesArray()` Returns an array of string containing all the addresses of the agent
`Iterator`	`getAllAddresses()` Returns an iterator of all the addresses of the agent.
`Iterator`	`getAllResolvers()` Returns an iterator of all the resolvers.
`Properties`	`getAllUserDefinedSlot()` Returns the user-defined slots as properties.
`String`	`getHap()` Returns the HAP of the agent or null if the GUID of this `AID` is not of the form @
`String`	`getLocalName()` Returns the local name of the agent (without the HAP).
`String`	`getName()` This method returns the name of the agent.
`private Long`	`getPersistentID()`
`(package private) static String`	`getPlatformID()`
`AID[]`	`getResolversArray()` Returns an array containing all the AIDs of the resolvers.
`int`	`hashCode()` Hash code.
`boolean`	`removeAddresses(String url)` To remove a transport address.
`boolean`	`removeResolvers(AID aid)` To remove a resolver.
`boolean`	`removeUserDefinedSlot(String key)` To remove a user defined slot.
`private void`	`setAddressesArray(String[] arr)`
`void`	`setLocalName(String n)` This method permits to set the symbolic name of an agent.
`void`	`setName(String n)` This method permits to set the symbolic name of an agent.
`private void`	`setPersistentID(Long l)`
`(package private) static void`	`setPlatformID(String id)`
`private void`	`setResolversArray(AID[] arr)`
`String`	`toString()` Converts this agent identifier into a readable string.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - platformID
```
private static String platformID
```
  - name
```
private String name
```
  - hashCode
```
private int hashCode
```
  - EXPECTED_ADDRESSES_SIZE
```
private static final int EXPECTED_ADDRESSES_SIZE
```
    See Also:
    
    Constant Field Values
  - EXPECTED_RESOLVERS_SIZE
```
private static final int EXPECTED_RESOLVERS_SIZE
```
    See Also:
    
    Constant Field Values
  - addresses
```
private List addresses
```
  - resolvers
```
private List resolvers
```
  - userDefSlots
```
private Properties userDefSlots
```
  - ISGUID
```
public static final boolean ISGUID
```
    constant to be used in the constructor of the AID
    
    See Also:
    
    Constant Field Values
  - ISLOCALNAME
```
public static final boolean ISLOCALNAME
```
    constant to be used in the constructor of the AID
    
    See Also:
    
    Constant Field Values
  - AGENT_CLASSNAME
```
public static final String AGENT_CLASSNAME
```
    Key to retrieve the agent class name as a user defined slot of the AID included in the AMSAgentDescription registered with the AMS.
    
    See Also:
    
    Constant Field Values
  - persistentID
```
private transient Long persistentID
```
- Constructor Detail
  - AID
```
public AID()
```
    Constructs an Agent-Identifier whose slot name is set to an empty string
  - AID
```
public AID(String guid)
```
    Deprecated. This constructor might generate a wrong AID, if the passed parameter is not a guid (globally unique identifier), but the local name of an agent (e.g. "da0").
    
    Constructor for an Agent-identifier This constructor (which is deprecated), examines the name to see if the "@" chararcter is present. If so, it calls this(name, ISGUID) otherwise it calls this(name, ISLOCALNAME) This ensures better compatibility with JADE2.2 code.
    Parameters: guid - is the Globally Unique identifer for the agent. The slot name assumes that value in the constructed object. See Also: AID(String boolean)
  AID public AID(String name, boolean isGUID) Constructor for an Agent-identifier Parameters: name - is the value for the slot name for the agent. isGUID - indicates if the passed name is already a globally unique identifier or not. Two constants ISGUID, ISLOCALNAME have also been defined for setting a value for this parameter. If the name is a local name, then the HAP (Home Agent Platform) is concatenated to the name, separated by "@".
Method Detail getPlatformID static final String getPlatformID() setPlatformID static final void setPlatformID(String id) setName public void setName(String n) This method permits to set the symbolic name of an agent. The passed parameter must be a GUID and not a local name. setLocalName public void setLocalName(String n) This method permits to set the symbolic name of an agent. The passed parameter must be a local name. getName public String getName() This method returns the name of the agent. addAddresses public void addAddresses(String url) This method permits to add a transport address where the agent can be contacted. The address is added only if not yet present removeAddresses public boolean removeAddresses(String url) To remove a transport address. Parameters: url - the address to remove Returns: true if the addres has been found and removed, false otherwise. clearAllAddresses public void clearAllAddresses() To remove all addresses of the agent getAllAddresses public Iterator getAllAddresses() Returns an iterator of all the addresses of the agent. See Also: Iterator addResolvers public void addResolvers(AID aid) This method permits to add the AID of a resolver (an agent where name resolution services for the agent can be contacted) removeResolvers public boolean removeResolvers(AID aid) To remove a resolver. Parameters: aid - the AID of the resolver to remove Returns: true if the resolver has been found and removed, false otherwise. clearAllResolvers public void clearAllResolvers() To remove all resolvers. getAllResolvers public Iterator getAllResolvers() Returns an iterator of all the resolvers. See Also: Iterator addUserDefinedSlot public void addUserDefinedSlot(String key, String value) To add a user defined slot (a pair key, value). Parameters: key - the name of the property value - the corresponding value of the property removeUserDefinedSlot public boolean removeUserDefinedSlot(String key) To remove a user defined slot. Parameters: key - the name of the property Returns: true if the property has been found and removed, false otherwise getAddressesArray public String[] getAddressesArray() Returns an array of string containing all the addresses of the agent setAddressesArray private void setAddressesArray(String[] arr) getResolversArray public AID[] getResolversArray() Returns an array containing all the AIDs of the resolvers. setResolversArray private void setResolversArray(AID[] arr) getAllUserDefinedSlot public Properties getAllUserDefinedSlot() Returns the user-defined slots as properties. Returns: all the user-defined slots as a jade.util.leap.Properties java Object. See Also: Properties toString public String toString() Converts this agent identifier into a readable string. Overrides: toString in class Object Returns: the String full representation of this AID clone public Object clone() Clone the AID object. Overrides: clone in class Object equals public boolean equals(Object o) Equality operation. This method compares an AID object with another or with a Java String. The comparison is case insensitive. Overrides: equals in class Object Parameters: o - The Java object to compare this AID to. Returns: true if one of the following holds: The argument o is an AID object with the same GUID in its name slot (apart from differences in case). The argument o is a String that is equal to the GUID contained in the name slot of this Agent ID (apart from differences in case). compareTo public int compareTo(Object o) Comparison operation. This operation imposes a total order relationship over Agent IDs. Specified by: compareTo in interface Comparable Parameters: o - Another AID object, that will be compared with the current AID. Returns: -1, 0 or 1 according to the lexicographical order of the GUID of the two agent IDs, apart from differences in case. hashCode public int hashCode() Hash code. This method returns an hash code in such a way that two AID objects with equal names or with names differing only in case have the same hash code. Overrides: hashCode in class Object Returns: The hash code for this AID object. getLocalName public String getLocalName() Returns the local name of the agent (without the HAP). If the agent is not local, then the method returns its GUID. getHap public String getHap() Returns the HAP of the agent or null if the GUID of this AID is not of the form @ getPersistentID private Long getPersistentID() setPersistentID private void setPersistentID(Long l)

Class AID

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

platformID

name

hashCode

EXPECTED_ADDRESSES_SIZE

EXPECTED_RESOLVERS_SIZE

addresses

resolvers

userDefSlots

ISGUID

ISLOCALNAME

AGENT_CLASSNAME

persistentID

Constructor Detail

AID

AID

AID

Method Detail

getPlatformID

setPlatformID

setName

setLocalName

getName

addAddresses

removeAddresses

clearAllAddresses

getAllAddresses

addResolvers

removeResolvers

clearAllResolvers

getAllResolvers

addUserDefinedSlot

removeUserDefinedSlot

getAddressesArray

setAddressesArray

getResolversArray

setResolversArray

getAllUserDefinedSlot

toString

clone

equals

compareTo

hashCode

getLocalName

getHap

getPersistentID

setPersistentID