Package oracle.security.am.engines.common.identity.provider

Interface UserInfo

public interface UserInfo

Interface for user object.

Since:

11gR1PS1

Method Summary

Modifier and Type	Method	Description
Map<String,<wbr>Object>	getAllUserProperties()	Get all user's properties
Object	getAuthUserObject()	Returns user object from underlying implementation of identity service.
String	getBusinessCity()	Return business city for the user
String	getBusinessCountry()	Return business country
String	getBusinessEmail()	Return business email for the user
String	getBusinessFax()	Return business fax for user
String	getBusinessMobile()	Return business mobile
String	getBusinessPager()	Return business pager detail for the user
String	getBusinessPhone()	Return business phone
String	getBusinessPOBox()	Set business po box number for the user
String	getBusinessPostalAddr()	Set business postal address
String	getBusinessPostalCode()	Return business postal code
String	getBusinessState()	Return business state
String	getBusinessStreet()	Return business street of user
oracle.security.am.engines.common.identity.provider.CanonicalID	getCanonicalID()	Returns the CanonicalID for the user
String	getDateofBirth()	Return user date of birth
String	getDateofHire()	Return date of hire
String	getDefaultGroup()	Return user default group
String	getDepartment()	Return user department
String	getDepartmentNumber()
String	getDescription()	Set the description for the user
String	getDN()	Returns the DN associated with this user
String	getEmployeeNumber()	Set employee number
String	getEmployeeType()	Return employee type
String	getFirstName()	Return user firstname
String	getGivenName()	Return given name for user
String	getGUID()	Get the GUID of the object.
String	getHomeAddress()	Return home address
String	getHomePhone()	Return home phone number
String	getIdStoreName()	Returns the idStore name this user is associated with
String	getInitials()	Return user initials
byte[]	getJPEGPhoto()	Set jpeg photo for the user
String	getLastName()	Return user lastname
String	getMaidenName()	Return maiden name for the user
String	getManager()	Return user's manager
String	getMiddleName()	Return user middlename
String	getNameSuffix()	Return user name suffix
String	getOrganization()	Return organization for the user
String	getOrganiztionalUnit()	Return org unit
String	getPreferredLanguage()	Return user's preferred language
Principal	getPrincipal()	Gets the principal of the entity object.
Object	getPropertyVal<wbr>(String prop)	Get a specific property value
String	getTimeZone()	Set timezone for the user
String	getTitle()	Return user title
String	getUIAccessMode()	Return UI access mode
String	getUserId()	Returns the User Id of the user.
String	getUserName()	Return username of the user
String	getWirelessAcctNumber()	Return wireless acct number
void	setBusinessEmail<wbr>(String email)	Set Business email for the user
void	setFirstName<wbr>(String firstname)	Utility method to get user firstname user properties.
void	setLastName<wbr>(String lastname)	Set last name for the user

Method Details

getUserId

String getUserId()

Returns the User Id of the user.

Returns:

String The user id.

getDN

String getDN()

Returns the DN associated with this user

Returns:

String The Distinguished Name of this user.

getIdStoreName

String getIdStoreName()

Returns the idStore name this user is associated with

Returns:

String The name of the Id Store

getCanonicalID

oracle.security.am.engines.common.identity.provider.CanonicalID getCanonicalID()
                                                                        throws IdentityProviderException

Returns the CanonicalID for the user

Returns:

CanonicalID The CanonicalID.

Throws:

IdentityProviderException

getAuthUserObject

Object getAuthUserObject()

Returns user object from underlying implementation of identity service.

Returns:

user object

getPrincipal

Principal getPrincipal()
                throws IdentityProviderException

Gets the principal of the entity object.

Returns:

Principal

Throws:

IdentityProviderException

getGUID

String getGUID()

Get the GUID of the object. This is used as a unique identifier for the user

Returns:

setFirstName

void setFirstName<wbr>(String firstname)
           throws IdentityProviderException

Utility method to get user firstname user properties.

Throws:

IdentityProviderException

setLastName

void setLastName<wbr>(String lastname)
          throws IdentityProviderException

Set last name for the user

Parameters:

lastname -

Throws:

IdentityProviderException

setBusinessEmail

void setBusinessEmail<wbr>(String email)
               throws IdentityProviderException

Set Business email for the user

Parameters:

email -

Throws:

IdentityProviderException

getEmployeeNumber

String getEmployeeNumber()
                  throws IdentityProviderException

Set employee number

Returns:

Throws:

IdentityProviderException

getBusinessPostalAddr

String getBusinessPostalAddr()
                      throws IdentityProviderException

Set business postal address

Returns:

Throws:

IdentityProviderException

getBusinessPOBox

String getBusinessPOBox()
                 throws IdentityProviderException

Set business po box number for the user

Returns:

Throws:

IdentityProviderException

getJPEGPhoto

byte[] getJPEGPhoto()
             throws IdentityProviderException

Set jpeg photo for the user

Returns:

Throws:

IdentityProviderException

getTimeZone

String getTimeZone()
            throws IdentityProviderException

Set timezone for the user

Returns:

Throws:

IdentityProviderException

getDescription

String getDescription()
               throws IdentityProviderException

Set the description for the user

Returns:

Throws:

IdentityProviderException

getDepartmentNumber

String getDepartmentNumber()
                    throws IdentityProviderException

Returns:

Throws:

IdentityProviderException

getGivenName

String getGivenName()
             throws IdentityProviderException

Return given name for user

Returns:

Throws:

IdentityProviderException

getBusinessEmail

String getBusinessEmail()
                 throws IdentityProviderException

Return business email for the user

Returns:

Throws:

IdentityProviderException

getBusinessPager

String getBusinessPager()
                 throws IdentityProviderException

Return business pager detail for the user

Returns:

Throws:

IdentityProviderException

getOrganization

String getOrganization()
                throws IdentityProviderException

Return organization for the user

Returns:

Throws:

IdentityProviderException

getBusinessCity

String getBusinessCity()
                throws IdentityProviderException

Return business city for the user

Returns:

Throws:

IdentityProviderException

getMaidenName

String getMaidenName()
              throws IdentityProviderException

Return maiden name for the user

Returns:

Throws:

IdentityProviderException

getDepartment

String getDepartment()
              throws IdentityProviderException

Return user department

Returns:

Throws:

IdentityProviderException

getBusinessFax

String getBusinessFax()
               throws IdentityProviderException

Return business fax for user

Returns:

Throws:

IdentityProviderException

getUserName

String getUserName()
            throws IdentityProviderException

Return username of the user

Returns:

Throws:

IdentityProviderException

getBusinessMobile

String getBusinessMobile()
                  throws IdentityProviderException

Return business mobile

Returns:

Throws:

IdentityProviderException

getDateofHire

String getDateofHire()
              throws IdentityProviderException

Return date of hire

Returns:

Throws:

IdentityProviderException

getTitle

String getTitle()
         throws IdentityProviderException

Return user title

Returns:

Throws:

IdentityProviderException

getNameSuffix

String getNameSuffix()
              throws IdentityProviderException

Return user name suffix

Returns:

Throws:

IdentityProviderException

getMiddleName

String getMiddleName()
              throws IdentityProviderException

Return user middlename

Returns:

Throws:

IdentityProviderException

getHomePhone

String getHomePhone()
             throws IdentityProviderException

Return home phone number

Returns:

Throws:

IdentityProviderException

getEmployeeType

String getEmployeeType()
                throws IdentityProviderException

Return employee type

Returns:

Throws:

IdentityProviderException

getLastName

String getLastName()
            throws IdentityProviderException

Return user lastname

Returns:

Throws:

IdentityProviderException

getDateofBirth

String getDateofBirth()
               throws IdentityProviderException

Return user date of birth

Returns:

Throws:

IdentityProviderException

getManager

String getManager()
           throws IdentityProviderException

Return user's manager

Returns:

Throws:

IdentityProviderException

getBusinessState

String getBusinessState()
                 throws IdentityProviderException

Return business state

Returns:

Throws:

IdentityProviderException

getHomeAddress

String getHomeAddress()
               throws IdentityProviderException

Return home address

Returns:

Throws:

IdentityProviderException

getBusinessStreet

String getBusinessStreet()
                  throws IdentityProviderException

Return business street of user

Returns:

Throws:

IdentityProviderException

getBusinessPostalCode

String getBusinessPostalCode()
                      throws IdentityProviderException

Return business postal code

Returns:

Throws:

IdentityProviderException

getInitials

String getInitials()
            throws IdentityProviderException

Return user initials

Returns:

Throws:

IdentityProviderException

getFirstName

String getFirstName()
             throws IdentityProviderException

Return user firstname

Returns:

Throws:

IdentityProviderException

getDefaultGroup

String getDefaultGroup()
                throws IdentityProviderException

Return user default group

Returns:

Throws:

IdentityProviderException

getOrganiztionalUnit

String getOrganiztionalUnit()
                     throws IdentityProviderException

Return org unit

Returns:

Throws:

IdentityProviderException

getWirelessAcctNumber

String getWirelessAcctNumber()
                      throws IdentityProviderException

Return wireless acct number

Returns:

Throws:

IdentityProviderException

getBusinessPhone

String getBusinessPhone()
                 throws IdentityProviderException

Return business phone

Returns:

Throws:

IdentityProviderException

getBusinessCountry

String getBusinessCountry()
                   throws IdentityProviderException

Return business country

Returns:

Throws:

IdentityProviderException

getPreferredLanguage

String getPreferredLanguage()
                     throws IdentityProviderException

Return user's preferred language

Returns:

Throws:

IdentityProviderException

getUIAccessMode

String getUIAccessMode()
                throws IdentityProviderException

Return UI access mode

Returns:

Throws:

IdentityProviderException

getPropertyVal

Object getPropertyVal<wbr>(String prop)
               throws IdentityProviderException

Get a specific property value

Parameters:

prop - - property name

Returns:

Throws:

IdentityProviderException

getAllUserProperties

Map<String,<wbr>Object> getAllUserProperties()
                                 throws IdentityProviderException

Get all user's properties

Returns:

Throws:

IdentityProviderException