Skip navigation links

oracle.security.idm
Interface UserProfile

All Superinterfaces:

Identity, User

public interface UserProfile

extends User

This interface represents detailed profile of a user. It allows for user properties to be access in generic manner.
It is possbile to read/modify any property of user using following apis:
1. getProperty(java.lang.String)
2. getProperties(java.lang.String[])
3. setProperty(oracle.security.idm.ModProperty)
4. setProperties(oracle.security.idm.ModProperty[])

Constants for the commonly accessed user properties have been defined. Also setXXXX() and getXXXX() convenience methods have been provided to set/get these commonly used user properties respectively. eg Property DESCRIPTION has setDescription(String) and getDescription() methods defined for ease of use.
The getXXXX() methods return only one value of the property. If the property is not defined/set in underlying repository then this method returns null. In case of multivalued property this method will get the first value returned by underlying repository.
The setXXXX() methods replace all the previous values of the property with the new value specified as argument.

Since:

10.1.3

Field Summary

static java.lang.String	BUSINESS_CITY
static java.lang.String	BUSINESS_COUNTRY
static java.lang.String	BUSINESS_EMAIL
static java.lang.String	BUSINESS_FAX
static java.lang.String	BUSINESS_MOBILE
static java.lang.String	BUSINESS_PAGER
static java.lang.String	BUSINESS_PHONE
static java.lang.String	BUSINESS_PO_BOX
static java.lang.String	BUSINESS_POSTAL_ADDR
static java.lang.String	BUSINESS_POSTAL_CODE
static java.lang.String	BUSINESS_STATE
static java.lang.String	BUSINESS_STREET
static java.lang.String	DATE_OF_BIRTH
static java.lang.String	DATE_OF_HIRE
static java.lang.String	DEFAULT_GROUP
static java.lang.String	DEPARTMENT
static java.lang.String	DESCRIPTION
static java.lang.String	DISPLAY_NAME
static java.lang.String	EMPLOYEE_NUMBER
static java.lang.String	EMPLOYEE_TYPE
static java.lang.String	FIRST_NAME
static java.lang.String	GUID
static java.lang.String	HOME_ADDRESS
static java.lang.String	HOME_PHONE
static java.lang.String	INITIALS
static java.lang.String	JPEG_PHOTO
static java.lang.String	LAST_NAME
static java.lang.String	MAIDEN_NAME
static java.lang.String	MANAGER
static java.lang.String	MIDDLE_NAME
static java.lang.String	NAME
static java.lang.String	NAME_SUFFIX
static java.lang.String	ORGANIZATION
static java.lang.String	ORGANIZATIONAL_UNIT
static java.lang.String	PASSWORD
static java.lang.String	PREFERRED_LANGUAGE
static java.lang.String	TIME_ZONE
static java.lang.String	TITLE
static java.lang.String	UI_ACCESS_MODE
static java.lang.String	USER_CERTIFICATE
static java.lang.String	USER_ID
static java.lang.String	USER_NAME
static java.lang.String	WIRELESS_ACCT_NUMBER

Method Summary

PropertySet	getAllUserProperties()
java.lang.String	getBusinessCity()
java.lang.String	getBusinessCountry()
java.lang.String	getBusinessEmail()
java.lang.String	getBusinessFax()
java.lang.String	getBusinessMobile()
java.lang.String	getBusinessPager()
java.lang.String	getBusinessPhone()
java.lang.String	getBusinessPOBox()
java.lang.String	getBusinessPostalAddr()
java.lang.String	getBusinessPostalCode()
java.lang.String	getBusinessState()
java.lang.String	getBusinessStreet()
java.lang.String	getDateofBirth()
java.lang.String	getDateofHire()
java.lang.String	getDefaultGroup()
java.lang.String	getDepartment()
java.lang.String	getDepartmentNumber()
java.lang.String	getDescription()
java.lang.String	getEmployeeNumber()
java.lang.String	getEmployeeType()
java.lang.String	getFirstName()
java.lang.String	getGivenName()
java.lang.String	getHomeAddress()
java.lang.String	getHomePhone()
java.lang.String	getInitials()
byte[]	getJPEGPhoto()
java.lang.String	getLastName()
java.lang.String	getMaidenName()
java.util.List	getManagementChain(int maxLevel, java.lang.String upToManagerName, java.lang.String upToTitle) Get Management chain heirarchy for this user.
java.lang.String	getManager()
java.lang.String	getMiddleName()
java.lang.String	getNameSuffix()
java.lang.String	getOrganization()
java.lang.String	getOrganiztionalUnit()
java.lang.String	getPreferredLanguage()
PropertySet	getProperties(java.lang.String[] props)
Property	getProperty(java.lang.String propName)
java.lang.Object	getPropertyVal(java.lang.String prop)
SearchResponse	getReportees(boolean direct) Get reportee for this user.
java.lang.String	getTimeZone()
java.lang.String	getTitle()
java.lang.String	getUIAccessMode()
byte[]	getUserCertificate()
java.lang.String	getUserID()
java.lang.String	getUserName()
java.lang.String	getWirelessAcctNumber()
void	setBusinessCity(java.lang.String city)
void	setBusinessCountry(java.lang.String country)
void	setBusinessEmail(java.lang.String email)
void	setBusinessFax(java.lang.String fax)
void	setBusinessMobile(java.lang.String mobile)
void	setBusinessPager(java.lang.String pager)
void	setBusinessPhone(java.lang.String phone)
void	setBusinessPOBox(java.lang.String pobox)
void	setBusinessPostalAddr(java.lang.String addr)
void	setBusinessPostalCode(java.lang.String postalcode)
void	setBusinessState(java.lang.String state)
void	setBusinessStreet(java.lang.String street)
void	setDateofBirth(java.lang.String dob)
void	setDateofHire(java.lang.String hiredate)
void	setDefaultGroup(java.lang.String defgroup)
void	setDepartment(java.lang.String dept)
void	setDepartmentNumber(java.lang.String departmentnumber)
void	setDescription(java.lang.String desc)
void	setDisplayName(java.lang.String dispname)
void	setEmployeeNumber(java.lang.String employeeNumber)
void	setEmployeeType(java.lang.String emptype)
void	setFirstName(java.lang.String firstname)
void	setGivenName(java.lang.String givenname)
void	setHomeAddress(java.lang.String homeaddr)
void	setHomePhone(java.lang.String homephone)
void	setInitials(java.lang.String initials)
void	setJPEGPhoto(java.lang.String imgpath)
void	setLastName(java.lang.String lastname)
void	setMaidenName(java.lang.String maidenname)
void	setManager(java.lang.String manager)
void	setMiddleName(java.lang.String middlename)
void	setName(java.lang.String name)
void	setNameSuffix(java.lang.String suffix)
void	setOrganization(java.lang.String org)
void	setOrganizationalUnit(java.lang.String ouUnit)
void	setPassword(char[] oldPasswd, char[] newPasswd)
void	setPreferredLanguage(java.lang.String language)
void	setProperties(ModProperty[] mprops)
void	setProperty(ModProperty mprop) Set property values.
void	setTimeZone(java.lang.String zone)
void	setTitle(java.lang.String title)
void	setUIAccessMode(java.lang.String access)
void	setUserCertificate(byte[] cert)
void	setUserID(java.lang.String userid)
void	setUserName(java.lang.String uname)
void	setWirelessAcctNumber(java.lang.String wirelessacct)

Methods inherited from interface oracle.security.idm.User

getUserProfile

Methods inherited from interface oracle.security.idm.Identity

getDisplayName, getGUID, getName, getPrincipal, getUniqueName

Field Detail

USER_ID

static final java.lang.String USER_ID

See Also:

Constant Field Values

USER_CERTIFICATE

static final java.lang.String USER_CERTIFICATE

See Also:

Constant Field Values

DISPLAY_NAME

static final java.lang.String DISPLAY_NAME

See Also:

Constant Field Values

BUSINESS_EMAIL

static final java.lang.String BUSINESS_EMAIL

See Also:

Constant Field Values

DESCRIPTION

static final java.lang.String DESCRIPTION

See Also:

Constant Field Values

EMPLOYEE_TYPE

static final java.lang.String EMPLOYEE_TYPE

See Also:

Constant Field Values

DEPARTMENT

static final java.lang.String DEPARTMENT

See Also:

Constant Field Values

DATE_OF_BIRTH

static final java.lang.String DATE_OF_BIRTH

See Also:

Constant Field Values

BUSINESS_FAX

static final java.lang.String BUSINESS_FAX

See Also:

Constant Field Values

BUSINESS_CITY

static final java.lang.String BUSINESS_CITY

See Also:

Constant Field Values

BUSINESS_COUNTRY

static final java.lang.String BUSINESS_COUNTRY

See Also:

Constant Field Values

DATE_OF_HIRE

static final java.lang.String DATE_OF_HIRE

See Also:

Constant Field Values

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

PREFERRED_LANGUAGE

static final java.lang.String PREFERRED_LANGUAGE

See Also:

Constant Field Values

BUSINESS_POSTAL_ADDR

static final java.lang.String BUSINESS_POSTAL_ADDR

See Also:

Constant Field Values

MIDDLE_NAME

static final java.lang.String MIDDLE_NAME

See Also:

Constant Field Values

ORGANIZATIONAL_UNIT

static final java.lang.String ORGANIZATIONAL_UNIT

See Also:

Constant Field Values

WIRELESS_ACCT_NUMBER

static final java.lang.String WIRELESS_ACCT_NUMBER

See Also:

Constant Field Values

BUSINESS_PO_BOX

static final java.lang.String BUSINESS_PO_BOX

See Also:

Constant Field Values

BUSINESS_STATE

static final java.lang.String BUSINESS_STATE

See Also:

Constant Field Values

HOME_ADDRESS

static final java.lang.String HOME_ADDRESS

See Also:

Constant Field Values

NAME_SUFFIX

static final java.lang.String NAME_SUFFIX

See Also:

Constant Field Values

BUSINESS_STREET

static final java.lang.String BUSINESS_STREET

See Also:

Constant Field Values

INITIALS

static final java.lang.String INITIALS

See Also:

Constant Field Values

USER_NAME

static final java.lang.String USER_NAME

See Also:

Constant Field Values

BUSINESS_POSTAL_CODE

static final java.lang.String BUSINESS_POSTAL_CODE

See Also:

Constant Field Values

BUSINESS_PAGER

static final java.lang.String BUSINESS_PAGER

See Also:

Constant Field Values

LAST_NAME

static final java.lang.String LAST_NAME

See Also:

Constant Field Values

BUSINESS_PHONE

static final java.lang.String BUSINESS_PHONE

See Also:

Constant Field Values

FIRST_NAME

static final java.lang.String FIRST_NAME

See Also:

Constant Field Values

TIME_ZONE

static final java.lang.String TIME_ZONE

See Also:

Constant Field Values

MAIDEN_NAME

static final java.lang.String MAIDEN_NAME

See Also:

Constant Field Values

PASSWORD

static final java.lang.String PASSWORD

See Also:

Constant Field Values

DEFAULT_GROUP

static final java.lang.String DEFAULT_GROUP

See Also:

Constant Field Values

ORGANIZATION

static final java.lang.String ORGANIZATION

See Also:

Constant Field Values

HOME_PHONE

static final java.lang.String HOME_PHONE

See Also:

Constant Field Values

BUSINESS_MOBILE

static final java.lang.String BUSINESS_MOBILE

See Also:

Constant Field Values

UI_ACCESS_MODE

static final java.lang.String UI_ACCESS_MODE

See Also:

Constant Field Values

JPEG_PHOTO

static final java.lang.String JPEG_PHOTO

See Also:

Constant Field Values

MANAGER

static final java.lang.String MANAGER

See Also:

Constant Field Values

TITLE

static final java.lang.String TITLE

See Also:

Constant Field Values

EMPLOYEE_NUMBER

static final java.lang.String EMPLOYEE_NUMBER

See Also:

Constant Field Values

GUID

static final java.lang.String GUID

See Also:

Constant Field Values

Method Detail

setPassword

void setPassword(char[] oldPasswd,
                 char[] newPasswd)
                 throws IMException

Throws:

IMException

getUserCertificate

byte[] getUserCertificate()
                          throws IMException

Throws:

IMException

setUserCertificate

void setUserCertificate(byte[] cert)
                        throws IMException

Throws:

IMException

getEmployeeNumber

java.lang.String getEmployeeNumber()
                                   throws IMException

Throws:

IMException

setEmployeeNumber

void setEmployeeNumber(java.lang.String employeeNumber)
                       throws IMException

Throws:

IMException

getBusinessPostalAddr

java.lang.String getBusinessPostalAddr()
                                       throws IMException

Throws:

IMException

setBusinessPostalAddr

void setBusinessPostalAddr(java.lang.String addr)
                           throws IMException

Throws:

IMException

getBusinessPOBox

java.lang.String getBusinessPOBox()
                                  throws IMException

Throws:

IMException

setBusinessPOBox

void setBusinessPOBox(java.lang.String pobox)
                      throws IMException

Throws:

IMException

getJPEGPhoto

byte[] getJPEGPhoto()
                    throws IMException

Throws:

IMException

setJPEGPhoto

void setJPEGPhoto(java.lang.String imgpath)
                  throws IMException

Throws:

IMException

getTimeZone

java.lang.String getTimeZone()
                             throws IMException

Throws:

IMException

setTimeZone

void setTimeZone(java.lang.String zone)
                 throws IMException

Throws:

IMException

getDescription

java.lang.String getDescription()
                                throws IMException

Throws:

IMException

setDescription

void setDescription(java.lang.String desc)
                    throws IMException

Throws:

IMException

getDepartmentNumber

java.lang.String getDepartmentNumber()
                                     throws IMException

Throws:

IMException

setDepartmentNumber

void setDepartmentNumber(java.lang.String departmentnumber)
                         throws IMException

Throws:

IMException

getGivenName

java.lang.String getGivenName()
                              throws IMException

Throws:

IMException

setGivenName

void setGivenName(java.lang.String givenname)
                  throws IMException

Throws:

IMException

getBusinessEmail

java.lang.String getBusinessEmail()
                                  throws IMException

Throws:

IMException

setBusinessEmail

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

Throws:

IMException

getBusinessPager

java.lang.String getBusinessPager()
                                  throws IMException

Throws:

IMException

setBusinessPager

void setBusinessPager(java.lang.String pager)
                      throws IMException

Throws:

IMException

getOrganization

java.lang.String getOrganization()
                                 throws IMException

Throws:

IMException

setOrganization

void setOrganization(java.lang.String org)
                     throws IMException

Throws:

IMException

setName

void setName(java.lang.String name)
             throws IMException

Throws:

IMException

getBusinessCity

java.lang.String getBusinessCity()
                                 throws IMException

Throws:

IMException

setBusinessCity

void setBusinessCity(java.lang.String city)
                     throws IMException

Throws:

IMException

getMaidenName

java.lang.String getMaidenName()
                               throws IMException

Throws:

IMException

setMaidenName

void setMaidenName(java.lang.String maidenname)
                   throws IMException

Throws:

IMException

getDepartment

java.lang.String getDepartment()
                               throws IMException

Throws:

IMException

setDepartment

void setDepartment(java.lang.String dept)
                   throws IMException

Throws:

IMException

getBusinessFax

java.lang.String getBusinessFax()
                                throws IMException

Throws:

IMException

setBusinessFax

void setBusinessFax(java.lang.String fax)
                    throws IMException

Throws:

IMException

getUserName

java.lang.String getUserName()
                             throws IMException

Throws:

IMException

setUserName

void setUserName(java.lang.String uname)
                 throws IMException

Throws:

IMException

getBusinessMobile

java.lang.String getBusinessMobile()
                                   throws IMException

Throws:

IMException

setBusinessMobile

void setBusinessMobile(java.lang.String mobile)
                       throws IMException

Throws:

IMException

getDateofHire

java.lang.String getDateofHire()
                               throws IMException

Throws:

IMException

setDateofHire

void setDateofHire(java.lang.String hiredate)
                   throws IMException

Throws:

IMException

getTitle

java.lang.String getTitle()
                          throws IMException

Throws:

IMException

setTitle

void setTitle(java.lang.String title)
              throws IMException

Throws:

IMException

getNameSuffix

java.lang.String getNameSuffix()
                               throws IMException

Throws:

IMException

setNameSuffix

void setNameSuffix(java.lang.String suffix)
                   throws IMException

Throws:

IMException

getMiddleName

java.lang.String getMiddleName()
                               throws IMException

Throws:

IMException

setMiddleName

void setMiddleName(java.lang.String middlename)
                   throws IMException

Throws:

IMException

getHomePhone

java.lang.String getHomePhone()
                              throws IMException

Throws:

IMException

setHomePhone

void setHomePhone(java.lang.String homephone)
                  throws IMException

Throws:

IMException

setDisplayName

void setDisplayName(java.lang.String dispname)
                    throws IMException

Throws:

IMException

getEmployeeType

java.lang.String getEmployeeType()
                                 throws IMException

Throws:

IMException

setEmployeeType

void setEmployeeType(java.lang.String emptype)
                     throws IMException

Throws:

IMException

getLastName

java.lang.String getLastName()
                             throws IMException

Throws:

IMException

setLastName

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

Throws:

IMException

getDateofBirth

java.lang.String getDateofBirth()
                                throws IMException

Throws:

IMException

setDateofBirth

void setDateofBirth(java.lang.String dob)
                    throws IMException

Throws:

IMException

getManager

java.lang.String getManager()
                            throws IMException

Throws:

IMException

setManager

void setManager(java.lang.String manager)
                throws IMException

Throws:

IMException

getBusinessState

java.lang.String getBusinessState()
                                  throws IMException

Throws:

IMException

setBusinessState

void setBusinessState(java.lang.String state)
                      throws IMException

Throws:

IMException

getHomeAddress

java.lang.String getHomeAddress()
                                throws IMException

Throws:

IMException

setHomeAddress

void setHomeAddress(java.lang.String homeaddr)
                    throws IMException

Throws:

IMException

getBusinessStreet

java.lang.String getBusinessStreet()
                                   throws IMException

Throws:

IMException

setBusinessStreet

void setBusinessStreet(java.lang.String street)
                       throws IMException

Throws:

IMException

getBusinessPostalCode

java.lang.String getBusinessPostalCode()
                                       throws IMException

Throws:

IMException

setBusinessPostalCode

void setBusinessPostalCode(java.lang.String postalcode)
                           throws IMException

Throws:

IMException

getInitials

java.lang.String getInitials()
                             throws IMException

Throws:

IMException

setInitials

void setInitials(java.lang.String initials)
                 throws IMException

Throws:

IMException

getUserID

java.lang.String getUserID()
                           throws IMException

Throws:

IMException

setUserID

void setUserID(java.lang.String userid)
               throws IMException

Throws:

IMException

getFirstName

java.lang.String getFirstName()
                              throws IMException

Throws:

IMException

setFirstName

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

Throws:

IMException

getDefaultGroup

java.lang.String getDefaultGroup()
                                 throws IMException

Throws:

IMException

setDefaultGroup

void setDefaultGroup(java.lang.String defgroup)
                     throws IMException

Throws:

IMException

getOrganiztionalUnit

java.lang.String getOrganiztionalUnit()
                                      throws IMException

Throws:

IMException

setOrganizationalUnit

void setOrganizationalUnit(java.lang.String ouUnit)
                           throws IMException

Throws:

IMException

getWirelessAcctNumber

java.lang.String getWirelessAcctNumber()
                                       throws IMException

Throws:

IMException

setWirelessAcctNumber

void setWirelessAcctNumber(java.lang.String wirelessacct)
                           throws IMException

Throws:

IMException

getBusinessPhone

java.lang.String getBusinessPhone()
                                  throws IMException

Throws:

IMException

setBusinessPhone

void setBusinessPhone(java.lang.String phone)
                      throws IMException

Throws:

IMException

getBusinessCountry

java.lang.String getBusinessCountry()
                                    throws IMException

Throws:

IMException

setBusinessCountry

void setBusinessCountry(java.lang.String country)
                        throws IMException

Throws:

IMException

getPreferredLanguage

java.lang.String getPreferredLanguage()
                                      throws IMException

Throws:

IMException

setPreferredLanguage

void setPreferredLanguage(java.lang.String language)
                          throws IMException

Throws:

IMException

getUIAccessMode

java.lang.String getUIAccessMode()
                                 throws IMException

Throws:

IMException

setUIAccessMode

void setUIAccessMode(java.lang.String access)
                     throws IMException

Throws:

IMException

getManagementChain

java.util.List getManagementChain(int maxLevel,
                                  java.lang.String upToManagerName,
                                  java.lang.String upToTitle)
                                  throws IMException

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

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

getProperty

Property getProperty(java.lang.String propName)
                     throws IMException

Throws:

IMException

getProperties

PropertySet getProperties(java.lang.String[] props)
                          throws IMException

Throws:

IMException

getPropertyVal

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

Throws:

IMException

setProperty

void setProperty(ModProperty mprop)
                 throws IMException

Set property values.

Throws:

OperationNotSupportedException - Thrown by the service provider if it doesn't support this operation.

NoPermissionException - Thrown if the caller doesn't have permission to set the property values.

OperationFailureException - Thrown in case of operation failure

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

setProperties

void setProperties(ModProperty[] mprops)
                   throws IMException

Throws:

IMException

getReportees

SearchResponse getReportees(boolean direct)
                            throws IMException

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

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

getAllUserProperties

PropertySet getAllUserProperties()
                                 throws IMException

Throws:

IMException

Skip navigation links