All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.ibm.devtools.SIPNoTE.UserRecord

java.lang.Object
   |
   +----com.ibm.devtools.SIPNoTE.UserRecord

public class UserRecord
extends Object
This class represents the registry entry for a user within the SIPNoTE system. It keeps track of the user, their locations, as well as their subscription information.

See Also:
SNServer

Constructor Index

 o UserRecord(String, HostRecord)
Create a new user record for the user with the new location.

Method Index

 o addLocation(HostRecord)
Adds a new location record for this user if it is not already present.
 o addSubscriptions(String[])
Add instance subscriptions to this user's record.
 o getLocation()
Get a list of locations for this particular user.
 o isSubscribedTo(String)
Checks to see if the user is subscribed to this instance.
 o removeLocation(HostRecord)
Remove a particular location from this user's record.

Constructors

 o UserRecord
 public UserRecord(String userid,
                   HostRecord location)
Create a new user record for the user with the new location.

Parameters:
userid - The userid to be added
location - The new location for this userid.

Methods

 o addLocation
 public void addLocation(HostRecord location)
Adds a new location record for this user if it is not already present.

Parameters:
location - The location record to be added.
 o addSubscriptions
 public void addSubscriptions(String subs[])
Add instance subscriptions to this user's record. A subscription will not be added again if it already exists.

Parameters:
subs - The array of strings with subscription information.
 o isSubscribedTo
 public boolean isSubscribedTo(String sub)
Checks to see if the user is subscribed to this instance.

Parameters:
sub - The subscription to check for.
 o getLocation
 public Enumeration getLocation()
Get a list of locations for this particular user.

Returns:
An enumeration of the locations.
 o removeLocation
 public int removeLocation(HostRecord location)
Remove a particular location from this user's record.

Parameters:
location - The location to be removed.
Returns:
Number of locations remaining for this user.

All Packages  Class Hierarchy  This Package  Previous  Next  Index