org.jboss.security.idm
Class Identity

java.lang.Object
  extended by org.jboss.security.idm.Identity
All Implemented Interfaces:
java.io.Serializable

public class Identity
extends java.lang.Object
implements java.io.Serializable

Identity represents the identity information related to the user being authenticated by the Single Sign On engine. This object is a key component of the system and is used by other parts of the system where identity related information needs to be processed. It tends to cover most of the information needed to associate with a user's profile. However, applications have the option to extend this class in order to integrate custom data that needs to be identity information as per their application requirements

Author:
Sohil Shah - sohil.shah@jboss.com
See Also:
Serialized Form

Field Summary
static java.lang.String NULL
           
 
Constructor Summary
Identity()
          Initializes the Identity object
 
Method Summary
 void addEmail(java.lang.String email)
           
 void addPhoneNumber(java.lang.String phoneNumber)
           
 Address getCompanyAddress()
           
 java.lang.String getCompanyName()
           
 java.lang.String getCompanyRole()
           
 java.lang.String getCompanyTitle()
           
 java.lang.String getEmail()
           
 java.lang.String getFullName()
           
 java.util.Collection getOtherEmails()
           
 byte[] getPassword()
           
 java.util.Collection getPhoneNumbers()
           
 java.util.Collection getRoles(LoginProvider provider)
          Returns the set of roles that this identity belongs to in the system
 java.lang.String getUserName()
           
 boolean isActive()
           
 void setActive(boolean active)
           
 void setCompanyAddress(Address companyAddress)
           
 void setCompanyName(java.lang.String companyName)
           
 void setCompanyRole(java.lang.String companyRole)
           
 void setCompanyTitle(java.lang.String companyTitle)
           
 void setEmail(java.lang.String email)
           
 void setFullName(java.lang.String fullName)
           
 void setOtherEmails(java.util.Collection otherEmails)
           
 void setPassword(byte[] password)
           
 void setPhoneNumbers(java.util.Collection phoneNumbers)
           
 void setUserName(java.lang.String username)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

NULL

public static final java.lang.String NULL
See Also:
Constant Field Values
Constructor Detail

Identity

public Identity()
Initializes the Identity object

Method Detail

getUserName

public java.lang.String getUserName()
Returns:

setUserName

public void setUserName(java.lang.String username)
Parameters:
username -

getPassword

public byte[] getPassword()
Returns:

setPassword

public void setPassword(byte[] password)
Parameters:
password -

isActive

public boolean isActive()
Returns:

setActive

public void setActive(boolean active)
Parameters:
active -

getEmail

public java.lang.String getEmail()
Returns:

setEmail

public void setEmail(java.lang.String email)
Parameters:
email -

getFullName

public java.lang.String getFullName()
Returns:

setFullName

public void setFullName(java.lang.String fullName)
Parameters:
fullName -

getOtherEmails

public java.util.Collection getOtherEmails()
Returns:

setOtherEmails

public void setOtherEmails(java.util.Collection otherEmails)
Parameters:
otherEmails -

getPhoneNumbers

public java.util.Collection getPhoneNumbers()
Returns:

setPhoneNumbers

public void setPhoneNumbers(java.util.Collection phoneNumbers)
Parameters:
phoneNumbers -

addPhoneNumber

public void addPhoneNumber(java.lang.String phoneNumber)
Parameters:
phoneNumber -

addEmail

public void addEmail(java.lang.String email)
Parameters:
email -

getCompanyName

public java.lang.String getCompanyName()
Returns:

setCompanyName

public void setCompanyName(java.lang.String companyName)
Parameters:
companyName -

getCompanyRole

public java.lang.String getCompanyRole()
Returns:

setCompanyRole

public void setCompanyRole(java.lang.String companyRole)
Parameters:
companyRole -

getCompanyTitle

public java.lang.String getCompanyTitle()
Returns:

setCompanyTitle

public void setCompanyTitle(java.lang.String companyTitle)
Parameters:
companyTitle -

getCompanyAddress

public Address getCompanyAddress()
Returns:

setCompanyAddress

public void setCompanyAddress(Address companyAddress)
Parameters:
companyAddress -

getRoles

public java.util.Collection getRoles(LoginProvider provider)
Returns the set of roles that this identity belongs to in the system

Parameters:
provider - the LoginProvider that provides access to the Identity store
Returns:
roles