com.ibm.are.platform
Class UserInfo

java.lang.Object
  extended by com.ibm.are.platform.UserInfo
Direct Known Subclasses:
IBMiUser

public class UserInfo
extends java.lang.Object

The UserInfo class provides an abstract, platform neutral way to retrieve information about the user that is running ARE.

Version:
1.0
Author:
IBM

Field Summary
static java.lang.String COPYRIGHT
          Copyright for class bytecode
 
Constructor Summary
protected UserInfo()
          Constructs a new UserInfo object with an empty user name
  UserInfo(java.lang.String name)
          Constructs a new UserInfo object for the specified user name
  UserInfo(UserInfo objToCopy)
          Constructs a new UserInfo object by copying all of the information from the provided UserInfo object.
 
Method Summary
 java.lang.String getAttribute(java.lang.String name)
          Retrieves the value for the specified user attribute
 java.lang.String getName()
          Retrieves the user name
 void setAttribute(java.lang.String name, java.lang.String value)
          Sets the specified user attribute
protected  void setName(java.lang.String newName)
          Sets the user name to the specified value
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT
Copyright for class bytecode

See Also:
Constant Field Values
Constructor Detail

UserInfo

public UserInfo(java.lang.String name)
Constructs a new UserInfo object for the specified user name

Parameters:
name - The user name

UserInfo

public UserInfo(UserInfo objToCopy)
Constructs a new UserInfo object by copying all of the information from the provided UserInfo object.

Parameters:
objToCopy - The UserInfo object to copy

UserInfo

protected UserInfo()
Constructs a new UserInfo object with an empty user name

Method Detail

getName

public java.lang.String getName()
Retrieves the user name

Returns:
The user name

setName

protected void setName(java.lang.String newName)
Sets the user name to the specified value

Parameters:
newName - The value to set the user name to

getAttribute

public java.lang.String getAttribute(java.lang.String name)
Retrieves the value for the specified user attribute

Parameters:
name - The name of the user attribute to retrieve
Returns:
The value for the specified attribute, or null if no such attribute exists

setAttribute

public void setAttribute(java.lang.String name,
                         java.lang.String value)
Sets the specified user attribute

Parameters:
name - The attribute name
value - The attribute value