|
Oracle Internet Directory API Reference 11g Release 1 (11.1.1) E10664-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IdmUser
This interface represents an identity management user in OID.
Field Summary | |
---|---|
static int |
ADD_ATTRIBUTE This constant specifies to add an attribute with the specified values. |
static java.lang.String |
CMDLINE This property value specifies that calling program has command line interface |
static int |
DELETE_ATTRIBUTE This constant specifies to delete the specified attribute values from the attribute. |
static java.lang.String |
DEPROVISION_FAILURE |
static java.lang.String |
DEPROVISION_IN_PROGRESS |
static java.lang.String |
DEPROVISION_REQUIRED |
static java.lang.String |
DEPROVISION_SUCCESS |
static java.lang.String |
GUI This property value specifies that calling program has graphic user interface |
static java.lang.String |
PENDING_UPGRADE |
static java.lang.String |
PROVISION_FAILURE |
static java.lang.String |
PROVISION_IN_PROGRESS |
static java.lang.String |
PROVISION_NOT_REQUIRED |
static java.lang.String |
PROVISION_REQUIRED User Provisioning Staus |
static java.lang.String |
PROVISION_SUCCESS |
static int |
REPLACE_ATTRIBUTE This constant specifies to replace an attribute with specified values. |
static java.lang.String |
STATUS_UNKNOWN |
static java.lang.String |
UPGRADE_FAILURE |
static java.lang.String |
UPGRADE_IN_PROGRESS |
static java.lang.String |
USER_INTERFACE This environment property is supplied while creating instances of class implementing UserFactory interface. |
Method Summary | |
---|---|
void |
changeSSOPassword(java.lang.String oldPass, java.lang.String newPass, boolean verify) Change SSO password for the user. |
PropertySetCollection |
getAllProperties() Gets all the user attributes and respective values as user properties. |
javax.naming.directory.Attribute |
getAttribute(java.lang.String attr) Gets the attribute associated this user. |
javax.naming.directory.Attributes |
getAttributes(java.lang.String[] attrlist) Gets the attributes associated this user. |
java.lang.String |
getDN() Return the User DN |
PropertySetCollection |
getExtendedProperties(ApplicationContext appctx) Get the application properties. |
java.lang.String |
getGUID() Return the User GUID |
java.lang.String |
getPasswordHint() Get password hint for the user |
java.lang.String |
getPasswordHintAnswer() Get password hint answer for the user |
PropertySetCollection |
getProperties(java.lang.String[] attributes) Gets the user attributes and their respective values as user properties. |
Property |
getProperty(java.lang.String attr) Gets the user attribute and its associated values as an user property |
java.lang.String |
getProvisioningStatus(Application app) Get the Provisioning Status of this user for the given applciation. |
java.lang.String |
getProvisioningStatus(ApplicationContext app) Deprecated. will be removed in the next label |
Application[] |
getUserApplications(java.lang.String provStatus) Get the application associated with the user for a given provisioning status. |
void |
modifyAttributes(int mod_op, javax.naming.directory.Attributes attrs) Modify user attributes. |
void |
modifyAttributes(ModPropertySet pset) Modify user attributes with the attributes in specified order. |
void |
resetPassword(java.lang.String hintanswer, Property[] otherValidationProps) Reset user password. |
void |
setExtendedProperties(ApplicationContext appCtx, ModPropertySet baseUserPset, ModPropertySet appUserPset) Set the application properties. |
void |
setPasswordHint(java.lang.String hint, java.lang.String answer) Set password hint question and its answer for the user. |
void |
setProvisioningConfiguration(Configuration config) Set the provisioining configuration object for this user |
void |
setProvisioningStatus(ApplicationContext appctx, java.lang.String provStatus, java.lang.String provStatusMsg) Set the Provisioning Status of this user for the given applciation. |
void |
setProvisioningStatus(Application app, java.lang.String provStatus, java.lang.String provStatusMsg) |
boolean |
setTimeZone(java.lang.String timezone) Set time zone |
Field Detail |
---|
static final int ADD_ATTRIBUTE
static final int REPLACE_ATTRIBUTE
static final int DELETE_ATTRIBUTE
static final java.lang.String USER_INTERFACE
CMDLINE
or GUI
for command line or graphic user interface respectively.
UserFactoryBuilder.createUserFactory(oracle.idm.user.OIDContext, java.util.Hashtable)
, Constant Field Valuesstatic final java.lang.String CMDLINE
static final java.lang.String GUI
static final java.lang.String PROVISION_REQUIRED
static final java.lang.String PROVISION_NOT_REQUIRED
static final java.lang.String PROVISION_SUCCESS
static final java.lang.String PROVISION_FAILURE
static final java.lang.String PROVISION_IN_PROGRESS
static final java.lang.String DEPROVISION_REQUIRED
static final java.lang.String DEPROVISION_SUCCESS
static final java.lang.String DEPROVISION_FAILURE
static final java.lang.String DEPROVISION_IN_PROGRESS
static final java.lang.String PENDING_UPGRADE
static final java.lang.String UPGRADE_IN_PROGRESS
static final java.lang.String UPGRADE_FAILURE
static final java.lang.String STATUS_UNKNOWN
Method Detail |
---|
Property getProperty(java.lang.String attr) throws UtilException
attr
- attribute nameUtilException
- if no such attribute exists in userPropertySetCollection getProperties(java.lang.String[] attributes) throws UtilException
attributes
- array of attribute namesUtilException
- if one or more attributes do not exist in userPropertySetCollection getAllProperties() throws UtilException
UtilException
- if all the properties could not be obtained.javax.naming.directory.Attribute getAttribute(java.lang.String attr) throws UtilException
getProperty(String)
attr
- attribute nameUtilException
- if no such attribute exists in userjavax.naming.directory.Attributes getAttributes(java.lang.String[] attrlist) throws UtilException
getProperties(String[])
attrlist
- array of attribute namesUtilException
- if one or more attributes do not exist in uservoid modifyAttributes(int mod_op, javax.naming.directory.Attributes attrs) throws UtilException
mod_op
- the modification operation, one of: ADD_ATTRIBUTE
, REPLACE_ATTRIBUTE
, DELETE_ATTRIBUTE
UtilException
- if attributes couldn't be modifiedvoid modifyAttributes(ModPropertySet pset) throws UtilException
pset
- set of attributes and values to be used in modification.UtilException
- if attributes couldn't be modifiedvoid setExtendedProperties(ApplicationContext appCtx, ModPropertySet baseUserPset, ModPropertySet appUserPset) throws UtilException
appCtx
- ApplicationContext objectbaseUserPset
- Base User atributes.appUserPset
- App User attributes to be used in modification.UtilException
PropertySetCollection getExtendedProperties(ApplicationContext appctx) throws UtilException
appctx
- ApplicationContext objectUtilException
java.lang.String getGUID() throws UtilException
UtilException
java.lang.String getDN() throws UtilException
UtilException
void changeSSOPassword(java.lang.String oldPass, java.lang.String newPass, boolean verify) throws UtilException
oldPass
- current passwordnewPass
- new passwordverify
- whether current password verification is to be performedUtilException
- if password change failsvoid setPasswordHint(java.lang.String hint, java.lang.String answer) throws UtilException
hint
- hint questionanswer
- answer to hint questionUtilException
- if operation failsjava.lang.String getPasswordHint() throws UtilException
UtilException
- if operation failsjava.lang.String getPasswordHintAnswer() throws UtilException
UtilException
- if operation failsboolean setTimeZone(java.lang.String timezone) throws UtilException
timezone
- new time zone to be setUtilException
- if operation failsvoid resetPassword(java.lang.String hintanswer, Property[] otherValidationProps) throws UtilException
hintanswer
- answer to hint questionotherValidationProps
- array of other required validation propertiesUtilException
- if operation failsvoid setProvisioningConfiguration(Configuration config)
config
- Provisioning configuration object.java.lang.String getProvisioningStatus(ApplicationContext app) throws UtilException
app
- application objectUtilException
java.lang.String getProvisioningStatus(Application app) throws UtilException
app
- application objectUtilException
void setProvisioningStatus(ApplicationContext appctx, java.lang.String provStatus, java.lang.String provStatusMsg) throws UtilException
appctx
- application ContextprovStatus
- Users provisioing status Possible values are PROVISION_REQUIRED, PROVISION_NOT_REQUIRED, PROVISION_SUCCESS, PROVISION_FAILURE, PROVISION_IN_PROGRESS, DEPROVISION_REQUIRED, DEPROVISION_SUCCESS, DEPROVISION_FAILURE and DEPROVISION_IN_PROGRESSprovStatusMsg
- Status Description messageUtilException
void setProvisioningStatus(Application app, java.lang.String provStatus, java.lang.String provStatusMsg) throws UtilException
UtilException
Application[] getUserApplications(java.lang.String provStatus) throws UtilException
provStatus
- the provisioning statusUtilException
- in case of an error
|
Oracle Internet Directory API Reference 11g Release 1 (11.1.1) E10664-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |