com.unet.warmachine.peerlocator
Class MembershipList

java.lang.Object
  |
  +--com.unet.warmachine.peerlocator.MembershipList

public class MembershipList

extends java.lang.Object

This data object is a collection of known members of the same group. Members are unique by name.

As client code is responsible for persistency of data, an instance should be created by client code, used to record known agent data and passed to the agent at startup. Once it is passed to the agent, it is maintained by the agent and subsequent changes by client are ignored.

Constructor Summary

MembershipList(java.lang.String groupName)
Constructor.

Method Summary

Member	addMember(java.lang.String name, java.net.InetAddress iPAddress, int portNo, boolean staticIP, java.util.Date creationTime, java.util.Date modificationTime) Creates new member, adds it to list and returns it.
void	deleteMember(Member member) Removes member from list.
java.lang.String	getGroupName() Returns shared group name of members.
Member	getMember(java.lang.String name) Returns named member, if any.
java.util.Enumeration	members() Returns list of all members.
int	size() Returns number of members.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MembershipList

public MembershipList(java.lang.String groupName)

Constructor.

Parameters:

groupName - Group name of members.

Method Detail

getGroupName

public java.lang.String getGroupName()

Returns shared group name of members.

Returns:

Group name of members.

addMember

public Member addMember(java.lang.String name,
                        java.net.InetAddress iPAddress,
                        int portNo,
                        boolean staticIP,
                        java.util.Date creationTime,
                        java.util.Date modificationTime)

Creates new member, adds it to list and returns it. This is ignored if a member with the same name already exists or the list has been passed to the agent to be updated.

Parameters:

name - Member name.

iPAddress - Last known IP address.

portNO - TCP port no.

staticIP - Whether member uses static IP address.

creationTime - Date and time member was created.

modificationTime - Date and time of last message received from member.

Returns:

Created member or null if unsuccessful.

deleteMember

public void deleteMember(Member member)

Removes member from list. This is ignored if the list has been passed to the agent to be updated.

size

public int size()

Returns number of members.

Returns:

Number of members.

getMember

public Member getMember(java.lang.String name)

Returns named member, if any.

Returns:

Named member or null if it doesn't exist.

members

public java.util.Enumeration members()

Returns list of all members.

Returns:

Enumeration of all members.