com.sas.hls.security.user
Class UserDescriptor

java.lang.Object
  extended by com.sas.hls.security.user.UserDescriptor
All Implemented Interfaces:
Identifiable, AclPrincipal, Principal, Serializable
Direct Known Subclasses:
User

public class UserDescriptor
extends Object
implements Principal

Light weight representation of a user defined in the system. User has a unique userid that may be used to login and to identify the user in the system.

See Also:
Serialized Form

Field Summary
static String OBJECT_TYPE
           
 
Constructor Summary
UserDescriptor()
          Zero-arg constructor for a UserDescriptor.
UserDescriptor(String userId)
           
UserDescriptor(String identifier, String userId, String principalId, String principalName)
           
 
Method Summary
 boolean equals(Object obj)
          Indicate whether some other object is "equal to" this one.
 String getDisplayName()
          Get the displayName of this UserDescriptor.
 String getEmail()
          Get the email of this userDescriptor.
 String getIdentifier()
          Get the identifier of this UserDescriptor.
 String getObjectType()
          Get the objectType of this userDescriptor.
 String getPrincipalId()
          Get the principalId of this userDescriptor.
 String getPrincipalName()
          Get the principal name of this userDescriptor.
 String getUserId()
          Get the userId of this UserDescriptor.
 int hashCode()
          Return a hash code value for the object.
 void setDisplayName(String displayName)
          Set the displayName of this UserDescriptor.
 void setEmail(String email)
          Set the email value for this userDescriptor.
 void setIdentifier(String identifier)
          Deprecated. 
 void setObjectType(String objectType)
          Deprecated. 
 void setPrincipalId(String principalId)
          Deprecated. 
 void setPrincipalName(String principalName)
          Deprecated. 
 void setUserId(String userId)
          Deprecated. 
 String toString()
          Return a string representation of the object.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

OBJECT_TYPE

public static final String OBJECT_TYPE
See Also:
Constant Field Values
Constructor Detail

UserDescriptor

public UserDescriptor()
Zero-arg constructor for a UserDescriptor.


UserDescriptor

public UserDescriptor(String userId)

UserDescriptor

public UserDescriptor(String identifier,
                      String userId,
                      String principalId,
                      String principalName)
Method Detail

getIdentifier

public String getIdentifier()
Get the identifier of this UserDescriptor.

Specified by:
getIdentifier in interface Identifiable
Returns:
the identifier

setIdentifier

@Deprecated
public void setIdentifier(String identifier)
Deprecated. 

Set the identifier of this UserDescriptor.

Parameters:
identifier - the identifier value to set on this UserDescriptor.

getUserId

public String getUserId()
Get the userId of this UserDescriptor.

Returns:
the userId

setUserId

@Deprecated
public void setUserId(String userId)
Deprecated. 

Set the userId of this UserDescriptor.

Parameters:
userId - the userId to set

getDisplayName

public String getDisplayName()
Get the displayName of this UserDescriptor.

Returns:
the displayName

setDisplayName

public void setDisplayName(String displayName)
Set the displayName of this UserDescriptor.

Parameters:
displayName - the displayName to set

getEmail

public String getEmail()
Get the email of this userDescriptor.

Returns:
the email

setEmail

public void setEmail(String email)
Set the email value for this userDescriptor.

Parameters:
email - the email to set

getObjectType

public String getObjectType()
Get the objectType of this userDescriptor.

Specified by:
getObjectType in interface Identifiable
Returns:
the objectType

setObjectType

@Deprecated
public void setObjectType(String objectType)
Deprecated. 

Set the objectType of this userDescriptor

Parameters:
objectType - the objectType to set

getPrincipalId

public String getPrincipalId()
Get the principalId of this userDescriptor.

Specified by:
getPrincipalId in interface AclPrincipal
Returns:
the principalId

setPrincipalId

@Deprecated
public void setPrincipalId(String principalId)
Deprecated. 

Set the principalId of this userDescriptor.

Parameters:
principalId - the principalId to set

getPrincipalName

public String getPrincipalName()
Get the principal name of this userDescriptor.

Specified by:
getPrincipalName in interface AclPrincipal
Returns:
the principal name

setPrincipalName

@Deprecated
public void setPrincipalName(String principalName)
Deprecated. 

Set the principal name of this userDescriptor.

Parameters:
principalName - The principal name value to set on this userDescriptor.

hashCode

public int hashCode()
Return a hash code value for the object.

Specified by:
hashCode in interface AclPrincipal
Overrides:
hashCode in class Object
Returns:
a hash code representation of this object
See Also:
Object.hashCode()

equals

public boolean equals(Object obj)
Indicate whether some other object is "equal to" this one.

Specified by:
equals in interface AclPrincipal
Overrides:
equals in class Object
Parameters:
obj - to be compared
Returns:
true if the objects are equal, false otherwise
See Also:
Object.equals(java.lang.Object)

toString

public String toString()
Return a string representation of the object.

Overrides:
toString in class Object
See Also:
Object.toString()


Copyright (c) 2012, SAS Institute Inc., Cary, NC, USA