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
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
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
Copyright © 2005, 2009, Oracle. All rights reserved.