Package hec.model

Class UserInfo

java.lang.Object

java.util.Observable

hec.lang.NamedType

hec.model.UserInfo

All Implemented Interfaces:

AsciiSerializable, FieldAccessor, Serializable, Cloneable, Comparable, Observer, Modifiable

public class UserInfo
extends NamedType

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ID_SEPARATOR

Fields inherited from class hec.lang.NamedType

_description, _ignoreModifiedEvents, _index, _isValid, _modified, _name, defaultDescription, defaultName, DESCRIPTION_CHANGED, NAME_CHANGED, RENAME_EVENT

Constructor Summary

Constructors

Constructor	Description
UserInfo(String hostId)

Method Summary

Modifier and Type	Method	Description
String	addUser(String userName, String app, long edipi, String clientHost)
String[]	findUserIds(String userName)	return the userIds for a given userName
String	findUserName(String userId)	return the username for a given userid
List	getClientsForUser(String userName)	get the list of clients that belong to the User with the login of userName
Object	getFieldObject(Field fld)	This method allows access to java.lang.reflect.Field objects within the implementing class.
String[]	getLoggedInUsers()	return a list of user names
String	getName()	get the NameType's name
Vector<UserLoginInfo>	getUserList()
UserLoginInfo	getUserLoginInfo(String userId)
boolean	isLoggedIn(String userId)	see if the given userId is logged in
boolean	removeUser(String userId)
boolean	setFieldObject(Field fld, Object fobj)	This allows access to fields withing the implementing object to set there data.
boolean	setKeyForUser(String userId, long key)
int	size()

Methods inherited from class hec.lang.NamedType

addModifiableListener, clone, compareTo, fireModifiedStateChanged, getDescription, getDisplayName, getIgnoreModifiedEvents, getIndex, isModified, isValid, readResolve, removeModifiableListener, rename, set, setDescription, setIgnoreModifiedEvents, setIndex, setModified, setName, setValid, toString, update, useRecursiveModifiedTest

Methods inherited from class java.util.Observable

addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers, setChanged

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

ID_SEPARATOR

public static final String ID_SEPARATOR

See Also:

• Constant Field Values

Constructor Details

UserInfo

public UserInfo(String hostId)

Method Details

addUser

public String addUser(String userName,
 String app,
 long edipi,
 String clientHost)

removeUser

public boolean removeUser(String userId)

findUserName

public String findUserName(String userId)

return the username for a given userid

findUserIds

public String[] findUserIds(String userName)

return the userIds for a given userName

setKeyForUser

public boolean setKeyForUser(String userId,
 long key)

isLoggedIn

public boolean isLoggedIn(String userId)

see if the given userId is logged in

getName

public String getName()

Description copied from class: NamedType

get the NameType's name

Overrides:

getName in class NamedType

Returns:

the name

getLoggedInUsers

public String[] getLoggedInUsers()

return a list of user names

getUserList

public Vector<UserLoginInfo> getUserList()

size

public int size()

getFieldObject

public Object getFieldObject(Field fld)

Description copied from interface: FieldAccessor

This method allows access to java.lang.reflect.Field objects within the implementing class.

Specified by:

getFieldObject in interface FieldAccessor

Overrides:

getFieldObject in class NamedType

Parameters:

fld - The field to get.

Returns:

The data object that is stored in the given field

setFieldObject

public boolean setFieldObject(Field fld,
 Object fobj)

Description copied from interface: FieldAccessor

This allows access to fields withing the implementing object to set there data.

Specified by:

setFieldObject in interface FieldAccessor

Overrides:

setFieldObject in class NamedType

Parameters:

fld - The java field object representing the member field to be set

fobj - The data to set in that field

Returns:

returns true if successful

getClientsForUser

public List getClientsForUser(String userName)

get the list of clients that belong to the User with the login of userName

Parameters:

userName - the User's login

Returns:

the list of clients. If no clients are found the list will be empty.

getUserLoginInfo

public UserLoginInfo getUserLoginInfo(String userId)