com.sas.hls.security.user
Class UserDescriptor

java.lang.Object
  extended by com.sas.hls.security.user.UserDescriptor
All Implemented Interfaces:
Identifiable, 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

Constructor Summary
UserDescriptor()
          Zero-arg constructor for a UserDescriptor.
 
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)
          Set the identifier of this UserDescriptor.
 void setObjectType(String objectType)
          Set the objectType of this userDescriptor
 void setPrincipalId(String principalId)
          Set the principalId of this userDescriptor.
 void setPrincipalName(String principalName)
          Set the principal name of this userDescriptor.
 void setUserId(String userId)
          Set the userId of this UserDescriptor.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

UserDescriptor

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

Method Detail

getIdentifier

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

Specified by:
getIdentifier in interface Identifiable
Returns:
the identifier

setIdentifier

public void setIdentifier(String identifier)
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

public void setUserId(String userId)
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

public void setObjectType(String objectType)
Set the objectType of this userDescriptor

Parameters:
objectType - the objectType to set

getPrincipalId

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

Returns:
the principalId

setPrincipalId

public void setPrincipalId(String principalId)
Set the principalId of this userDescriptor.

Parameters:
principalId - the principalId to set

getPrincipalName

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

Returns:
the principal name

setPrincipalName

public void setPrincipalName(String principalName)
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.

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

equals

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

Overrides:
equals in class Object
See Also:
Object.equals(java.lang.Object)


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