Skip navigation links

Oracle Internet Directory API Reference
10g(10.1.4)

B15992-01


oracle.idm.user
Interface IdmUser

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
JndiUser

public interface IdmUser
extends java.io.Serializable

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

ADD_ATTRIBUTE

public static final int ADD_ATTRIBUTE
This constant specifies to add an attribute with the specified values.
See Also:
Constant Field Values

REPLACE_ATTRIBUTE

public static final int REPLACE_ATTRIBUTE
This constant specifies to replace an attribute with specified values.
See Also:
Constant Field Values

DELETE_ATTRIBUTE

public static final int DELETE_ATTRIBUTE
This constant specifies to delete the specified attribute values from the attribute.
See Also:
Constant Field Values

USER_INTERFACE

public static final java.lang.String USER_INTERFACE
This environment property is supplied while creating instances of class implementing UserFactory interface. It specifies user interface of the calling program. It can be CMDLINE or GUI for command line or graphic user interface respectively.
See Also:
UserFactoryBuilder.createUserFactory(javax.naming.directory.DirContext, java.lang.String), Constant Field Values

CMDLINE

public static final java.lang.String CMDLINE
This property value specifies that calling program has command line interface
See Also:
Constant Field Values

GUI

public static final java.lang.String GUI
This property value specifies that calling program has graphic user interface
See Also:
Constant Field Values

PROVISION_REQUIRED

public static final java.lang.String PROVISION_REQUIRED
User Provisioning Staus
See Also:
Constant Field Values

PROVISION_NOT_REQUIRED

public static final java.lang.String PROVISION_NOT_REQUIRED
See Also:
Constant Field Values

PROVISION_SUCCESS

public static final java.lang.String PROVISION_SUCCESS
See Also:
Constant Field Values

PROVISION_FAILURE

public static final java.lang.String PROVISION_FAILURE
See Also:
Constant Field Values

PROVISION_IN_PROGRESS

public static final java.lang.String PROVISION_IN_PROGRESS
See Also:
Constant Field Values

DEPROVISION_REQUIRED

public static final java.lang.String DEPROVISION_REQUIRED
See Also:
Constant Field Values

DEPROVISION_SUCCESS

public static final java.lang.String DEPROVISION_SUCCESS
See Also:
Constant Field Values

DEPROVISION_FAILURE

public static final java.lang.String DEPROVISION_FAILURE
See Also:
Constant Field Values

DEPROVISION_IN_PROGRESS

public static final java.lang.String DEPROVISION_IN_PROGRESS
See Also:
Constant Field Values

PENDING_UPGRADE

public static final java.lang.String PENDING_UPGRADE
See Also:
Constant Field Values

UPGRADE_IN_PROGRESS

public static final java.lang.String UPGRADE_IN_PROGRESS
See Also:
Constant Field Values

UPGRADE_FAILURE

public static final java.lang.String UPGRADE_FAILURE
See Also:
Constant Field Values

STATUS_UNKNOWN

public static final java.lang.String STATUS_UNKNOWN
See Also:
Constant Field Values

Method Detail

getProperty

public Property getProperty(java.lang.String attr)
                     throws UtilException
Gets the user attribute and its associated values as an user property
Parameters:
attr - attribute name
Returns:
the user attribute and its values an Property object
Throws:
UtilException - if no such attribute exists in user

getProperties

public PropertySetCollection getProperties(java.lang.String[] attributes)
                                    throws UtilException
Gets the user attributes and their respective values as user properties.
Parameters:
attributes - array of attribute names
Returns:
the attributes and values as an PropertySetCollection object.
Throws:
UtilException - if one or more attributes do not exist in user

getAllProperties

public PropertySetCollection getAllProperties()
                                       throws UtilException
Gets all the user attributes and respective values as user properties.
Returns:
the attributes and values as an PropertySetCollection object.
Throws:
UtilException - if all the properties could not be obtained.

getAttribute

public javax.naming.directory.Attribute getAttribute(java.lang.String attr)
                                              throws UtilException
Gets the attribute associated this user. Similar to getProperty(String)
Parameters:
attr - attribute name
Returns:
the user attribute and its values as an instance of Attribute
Throws:
UtilException - if no such attribute exists in user

getAttributes

public javax.naming.directory.Attributes getAttributes(java.lang.String[] attrlist)
                                                throws UtilException
Gets the attributes associated this user. Similar to getProperties(String[])
Parameters:
attrlist - array of attribute names
Returns:
the attributes and values as an instance of Attributes.
Throws:
UtilException - if one or more attributes do not exist in user

modifyAttributes

public void modifyAttributes(int mod_op,
                             javax.naming.directory.Attributes attrs)
                      throws UtilException
Modify user attributes. The order of the modifications is not specified.
Parameters:
mod_op - the modification operation, one of: ADD_ATTRIBUTE, REPLACE_ATTRIBUTE, DELETE_ATTRIBUTE
Throws:
UtilException - if attributes couldn't be modified

modifyAttributes

public void modifyAttributes(ModPropertySet pset)
                      throws UtilException
Modify user attributes with the attributes in specified order.
Parameters:
pset - set of attributes and values to be used in modification.
Throws:
UtilException - if attributes couldn't be modified

setExtendedProperties

public void setExtendedProperties(ApplicationContext appCtx,
                                  ModPropertySet baseUserPset,
                                  ModPropertySet appUserPset)
                           throws UtilException
Set the application properties.
Parameters:
appCtx - ApplicationContext object
baseUserPset - Base User atributes.
appUserPset - App User attributes to be used in modification.
Throws:
UtilException

getExtendedProperties

public PropertySetCollection getExtendedProperties(ApplicationContext appctx)
                                            throws UtilException
Get the application properties.
Parameters:
appctx - ApplicationContext object
Returns:
property set collection.
Throws:
UtilException

getGUID

public java.lang.String getGUID()
                         throws UtilException
Return the User GUID
Returns:
user GUID
Throws:
UtilException

getDN

public java.lang.String getDN()
                       throws UtilException
Return the User DN
Returns:
user DN
Throws:
UtilException

changeSSOPassword

public void changeSSOPassword(java.lang.String oldPass,
                              java.lang.String newPass,
                              boolean verify)
                       throws UtilException
Change SSO password for the user. If parameter verify is set to true then current password of user is first macthed with value in parameter currPass. If matched then only new password is set. However if verify is set to false then argument oldPass is ignored and new password is set without any verification.
Parameters:
oldPass - current password
newPass - new password
verify - whether current password verification is to be performed
Throws:
UtilException - if password change fails

setPasswordHint

public void setPasswordHint(java.lang.String hint,
                            java.lang.String answer)
                     throws UtilException
Set password hint question and its answer for the user.
Parameters:
hint - hint question
answer - answer to hint question
Throws:
UtilException - if operation fails

getPasswordHint

public java.lang.String getPasswordHint()
                                 throws UtilException
Get password hint for the user
Returns:
password hint question. Possibly null
Throws:
UtilException - if operation fails

getPasswordHintAnswer

public java.lang.String getPasswordHintAnswer()
                                       throws UtilException
Get password hint answer for the user
Returns:
password hint answer. Possibly null
Throws:
UtilException - if operation fails

setTimeZone

public boolean setTimeZone(java.lang.String timezone)
                    throws UtilException
Set time zone
Parameters:
timezone - new time zone to be set
Returns:
TRUE if successful in setting password hint and the answer
Throws:
UtilException - if operation fails

resetPassword

public void resetPassword(java.lang.String hintanswer,
                          Property[] otherValidationProps)
                   throws UtilException
Reset user password. This method compares the hint answer and additional validation properties with the values provided by the end user. If there is match then it resets the password
Parameters:
hintanswer - answer to hint question
otherValidationProps - array of other required validation properties
Throws:
UtilException - if operation fails

setProvisioningConfiguration

public void setProvisioningConfiguration(Configuration config)
Set the provisioining configuration object for this user
Parameters:
config - Provisioning configuration object.

getProvisioningStatus

public java.lang.String getProvisioningStatus(ApplicationContext app)
                                       throws UtilException
Deprecated. will be removed in the next label
Get the Provisioning Status of this user for the given applciation.
Parameters:
app - application object
Returns:
this user's 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_PROGRESS
Throws:
UtilException

getProvisioningStatus

public java.lang.String getProvisioningStatus(Application app)
                                       throws UtilException
Get the Provisioning Status of this user for the given applciation.
Parameters:
app - application object
Returns:
this user's 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_PROGRESS
Throws:
UtilException

setProvisioningStatus

public void setProvisioningStatus(ApplicationContext appctx,
                                  java.lang.String provStatus,
                                  java.lang.String provStatusMsg)
                           throws UtilException
Set the Provisioning Status of this user for the given applciation.
Parameters:
appctx - application Context
provStatus - 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_PROGRESS
provStatusMsg - Status Description message
Throws:
UtilException

setProvisioningStatus

public void setProvisioningStatus(Application app,
                                  java.lang.String provStatus,
                                  java.lang.String provStatusMsg)
                           throws UtilException
Throws:
UtilException

getUserApplications

public Application[] getUserApplications(java.lang.String provStatus)
                                  throws UtilException
Get the application associated with the user for a given provisioning status.
Parameters:
provStatus - the provisioning status
Returns:
list application associated withe user for the given provisioning status.
Throws:
UtilException - in case of an error

Skip navigation links

Oracle Internet Directory API Reference
10g(10.1.4)

B15992-01


Copyright © 1999, 2006 Oracle. All Rights Reserved.