Skip navigation links

oracle.security.am.engines.common.identity.provider
Interface UserInfo

public interface UserInfo

Interface for user object.

Since:

11gR1PS1

Version:

$Header: ngam/src/engines/common/identity/src/main/java/oracle/security/am/engines/common/identity/provider/UserInfo.java /main/6 2012/09/27 16:46:43 lahariha Exp $

Method Summary

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

Method Detail

getUserId

java.lang.String getUserId()

Returns the User Id of the user.

Returns:

String The user id.

getDN

java.lang.String getDN()

Returns the DN associated with this user

Returns:

String The Distinguished Name of this user.

getIdStoreName

java.lang.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

getUserObject

java.lang.Object getUserObject()

Returns:

getPrincipal

java.security.Principal getPrincipal()
                                     throws IdentityProviderException

Gets the principal of the entity object.

Returns:

Principal

Throws:

IdentityProviderException

getGUID

java.lang.String getGUID()

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

Returns:

setFirstName

void setFirstName(java.lang.String firstname)
                  throws IdentityProviderException

Utility method to get user firstname user properties.

Throws:

IdentityProviderException

setLastName

void setLastName(java.lang.String lastname)
                 throws IdentityProviderException

Set last name for the user

Parameters:

lastname -

Throws:

IdentityProviderException

setBusinessEmail

void setBusinessEmail(java.lang.String email)
                      throws IdentityProviderException

Set Business email for the user

Parameters:

email -

Throws:

IdentityProviderException

getEmployeeNumber

java.lang.String getEmployeeNumber()
                                   throws IdentityProviderException

Set employee number

Returns:

Throws:

IdentityProviderException

getBusinessPostalAddr

java.lang.String getBusinessPostalAddr()
                                       throws IdentityProviderException

Set business postal address

Returns:

Throws:

IdentityProviderException

getBusinessPOBox

java.lang.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

java.lang.String getTimeZone()
                             throws IdentityProviderException

Set timezone for the user

Returns:

Throws:

IdentityProviderException

getDescription

java.lang.String getDescription()
                                throws IdentityProviderException

Set the description for the user

Returns:

Throws:

IdentityProviderException

getDepartmentNumber

java.lang.String getDepartmentNumber()
                                     throws IdentityProviderException

Returns:

Throws:

IdentityProviderException

getGivenName

java.lang.String getGivenName()
                              throws IdentityProviderException

Return given name for user

Returns:

Throws:

IdentityProviderException

getBusinessEmail

java.lang.String getBusinessEmail()
                                  throws IdentityProviderException

Return business email for the user

Returns:

Throws:

IdentityProviderException

getBusinessPager

java.lang.String getBusinessPager()
                                  throws IdentityProviderException

Return business pager detail for the user

Returns:

Throws:

IdentityProviderException

getOrganization

java.lang.String getOrganization()
                                 throws IdentityProviderException

Return organization for the user

Returns:

Throws:

IdentityProviderException

getBusinessCity

java.lang.String getBusinessCity()
                                 throws IdentityProviderException

Return business city for the user

Returns:

Throws:

IdentityProviderException

getMaidenName

java.lang.String getMaidenName()
                               throws IdentityProviderException

Return maiden name for the user

Returns:

Throws:

IdentityProviderException

getDepartment

java.lang.String getDepartment()
                               throws IdentityProviderException

Return user department

Returns:

Throws:

IdentityProviderException

getBusinessFax

java.lang.String getBusinessFax()
                                throws IdentityProviderException

Return business fax for user

Returns:

Throws:

IdentityProviderException

getUserName

java.lang.String getUserName()
                             throws IdentityProviderException

Return username of the user

Returns:

Throws:

IdentityProviderException

getBusinessMobile

java.lang.String getBusinessMobile()
                                   throws IdentityProviderException

Return business mobile

Returns:

Throws:

IdentityProviderException

getDateofHire

java.lang.String getDateofHire()
                               throws IdentityProviderException

Return date of hire

Returns:

Throws:

IdentityProviderException

getTitle

java.lang.String getTitle()
                          throws IdentityProviderException

Return user title

Returns:

Throws:

IdentityProviderException

getNameSuffix

java.lang.String getNameSuffix()
                               throws IdentityProviderException

Return user name suffix

Returns:

Throws:

IdentityProviderException

getMiddleName

java.lang.String getMiddleName()
                               throws IdentityProviderException

Return user middlename

Returns:

Throws:

IdentityProviderException

getHomePhone

java.lang.String getHomePhone()
                              throws IdentityProviderException

Return home phone number

Returns:

Throws:

IdentityProviderException

getEmployeeType

java.lang.String getEmployeeType()
                                 throws IdentityProviderException

Return employee type

Returns:

Throws:

IdentityProviderException

getLastName

java.lang.String getLastName()
                             throws IdentityProviderException

Return user lastname

Returns:

Throws:

IdentityProviderException

getDateofBirth

java.lang.String getDateofBirth()
                                throws IdentityProviderException

Return user date of birth

Returns:

Throws:

IdentityProviderException

getManager

java.lang.String getManager()
                            throws IdentityProviderException

Return user's manager

Returns:

Throws:

IdentityProviderException

getBusinessState

java.lang.String getBusinessState()
                                  throws IdentityProviderException

Return business state

Returns:

Throws:

IdentityProviderException

getHomeAddress

java.lang.String getHomeAddress()
                                throws IdentityProviderException

Return home address

Returns:

Throws:

IdentityProviderException

getBusinessStreet

java.lang.String getBusinessStreet()
                                   throws IdentityProviderException

Return business street of user

Returns:

Throws:

IdentityProviderException

getBusinessPostalCode

java.lang.String getBusinessPostalCode()
                                       throws IdentityProviderException

Return business postal code

Returns:

Throws:

IdentityProviderException

getInitials

java.lang.String getInitials()
                             throws IdentityProviderException

Return user initials

Returns:

Throws:

IdentityProviderException

getUserID

java.lang.String getUserID()
                           throws IdentityProviderException

Return user id

Returns:

Throws:

IdentityProviderException

getFirstName

java.lang.String getFirstName()
                              throws IdentityProviderException

Return user firstname

Returns:

Throws:

IdentityProviderException

getDefaultGroup

java.lang.String getDefaultGroup()
                                 throws IdentityProviderException

Return user default group

Returns:

Throws:

IdentityProviderException

getOrganiztionalUnit

java.lang.String getOrganiztionalUnit()
                                      throws IdentityProviderException

Return org unit

Returns:

Throws:

IdentityProviderException

getWirelessAcctNumber

java.lang.String getWirelessAcctNumber()
                                       throws IdentityProviderException

Return wireless acct number

Returns:

Throws:

IdentityProviderException

getBusinessPhone

java.lang.String getBusinessPhone()
                                  throws IdentityProviderException

Return business phone

Returns:

Throws:

IdentityProviderException

getBusinessCountry

java.lang.String getBusinessCountry()
                                    throws IdentityProviderException

Return business country

Returns:

Throws:

IdentityProviderException

getPreferredLanguage

java.lang.String getPreferredLanguage()
                                      throws IdentityProviderException

Return user's preferred language

Returns:

Throws:

IdentityProviderException

getUIAccessMode

java.lang.String getUIAccessMode()
                                 throws IdentityProviderException

Return UI access mode

Returns:

Throws:

IdentityProviderException

getManagementChain

java.util.List<UserInfo> getManagementChain(int maxLevel,
                                            java.lang.String upToManagerName,
                                            java.lang.String upToTitle)
                                            throws IdentityProviderException

Get Management chain heirarchy for this user. Search results are reported up to the heirarchy, where any one of the three specified conditions are met or management chain ends.

Parameters:

maxLevel - search management chain heirarchy only up to supplied level. Complete management heirarchy search is done if -ve value is supplied.

upToManagerName - Search management chain heirarchy up to supplied manager's name (UserProfile.NAME) this criteria is ignored from search if null value is supplied.

upToTitle - Search management chain heirarchy up to the supplied title this criteria is ignored from search if null value is supplied.

Returns:

java.util.List instance containing management chain upto and including the teminating identity

Throws:

NoPermissionException - Thrown if the caller doesn't have permission to execute this operation.

OperationFailureException - Thrown in case of operation failure

IdentityProviderException - Thrown by the service provider in case of any other problem.

getPropertyVal

java.lang.Object getPropertyVal(java.lang.String prop)
                                throws IdentityProviderException

Get a specific property value

Parameters:

prop - - property name

Returns:

Throws:

IdentityProviderException

getReportees

java.util.List<UserInfo> getReportees(boolean direct)
                                      throws IdentityProviderException

Get reportee for this user.

Parameters:

direct - if true only direct reportees are returned else all are returned.

Returns:

SearchResponse instance containing the reportees.

Throws:

ObjectNotFoundException - Thrown if the search doesn't return any results.

NoPermissionException - Thrown if the caller doesn't have permission to execute this operation.

OperationFailureException - Thrown in case of operation failure

IdentityProviderException - Thrown by the service provider in case of any other problem.

getAllUserProperties

java.util.Map<java.lang.String,java.lang.Object> getAllUserProperties()
                                                                      throws IdentityProviderException

Get all user's properties

Returns:

Throws:

IdentityProviderException

Skip navigation links