Skip navigation links

Oracle Internet Directory API Reference
11g Release 1 (11.1.1)

E10664-01


oracle.idm.user
Class JndiUser

java.lang.Object
  extended by oracle.idm.user.JndiUser

All Implemented Interfaces:
java.io.Serializable, IdmUser

public class JndiUser
extends java.lang.Object
implements IdmUser, java.io.Serializable

ImdUser Implementation using JNDI access method. This class is serialized for HA requirements. Only those functions which pass Dircontext object explicitly and dont rely on LdapContext dirctx member variable are guarenteed to work in HA Environment.

See Also:
Serialized Form

Field Summary
protected  User baseuser
           

 

Fields inherited from interface oracle.idm.user.IdmUser
ADD_ATTRIBUTE, CMDLINE, DELETE_ATTRIBUTE, DEPROVISION_FAILURE, DEPROVISION_IN_PROGRESS, DEPROVISION_REQUIRED, DEPROVISION_SUCCESS, GUI, PENDING_UPGRADE, PROVISION_FAILURE, PROVISION_IN_PROGRESS, PROVISION_NOT_REQUIRED, PROVISION_REQUIRED, PROVISION_SUCCESS, REPLACE_ATTRIBUTE, STATUS_UNKNOWN, UPGRADE_FAILURE, UPGRADE_IN_PROGRESS, USER_INTERFACE

 

Constructor Summary
JndiUser(OIDContext oidctx, User baseuser)
           
JndiUser(java.lang.String dn, java.lang.String orclGuid)
           

 

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
 Configuration getProvisioningConfiguration()
           
 java.lang.String getProvisioningStatus(Application app)
          Get the Provisioning Status of this user for the given applciation.
 java.lang.String getProvisioningStatus(ApplicationContext appCtx)
          Deprecated. to 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 setLdapContext(javax.naming.ldap.LdapContext lCtx)
           
 void setPasswordHint(java.lang.String hint, java.lang.String answer)
          Set password hint question and its answer for the user.
 void setProvisioningConfiguration(Configuration cfg)
          Set the provisioining configuration object for this user
 void setProvisioningStatus(ApplicationContext appCtx, java.lang.String status, java.lang.String statusMsg)
          Deprecated. To be removed in the next label
 void setProvisioningStatus(Application app, java.lang.String status, java.lang.String statusMsg)
           
 boolean setTimeZone(java.lang.String timezone)
          Set time zone
 java.lang.String toString()
           

 

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

 

Field Detail

baseuser

protected User baseuser

Constructor Detail

JndiUser

public JndiUser(OIDContext oidctx,
                User baseuser)

JndiUser

public JndiUser(java.lang.String dn,
                java.lang.String orclGuid)

Method Detail

getGUID

public java.lang.String getGUID()
                         throws UtilException
Description copied from interface: IdmUser
Return the User GUID
Specified by:
getGUID in interface IdmUser
Returns:
user GUID
Throws:
UtilException

getDN

public java.lang.String getDN()
                       throws UtilException
Description copied from interface: IdmUser
Return the User DN
Specified by:
getDN in interface IdmUser
Returns:
user DN
Throws:
UtilException

getProperty

public Property getProperty(java.lang.String attr)
                     throws UtilException
Description copied from interface: IdmUser
Gets the user attribute and its associated values as an user property
Specified by:
getProperty in interface IdmUser
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
Description copied from interface: IdmUser
Gets the user attributes and their respective values as user properties.
Specified by:
getProperties in interface IdmUser
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
Description copied from interface: IdmUser
Gets all the user attributes and respective values as user properties.
Specified by:
getAllProperties in interface IdmUser
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
Description copied from interface: IdmUser
Gets the attribute associated this user. Similar to IdmUser.getProperty(String)
Specified by:
getAttribute in interface IdmUser
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
Description copied from interface: IdmUser
Gets the attributes associated this user. Similar to IdmUser.getProperties(String[])
Specified by:
getAttributes in interface IdmUser
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
Description copied from interface: IdmUser
Modify user attributes. The order of the modifications is not specified.
Specified by:
modifyAttributes in interface IdmUser
Parameters:
mod_op - the modification operation, one of: IdmUser.ADD_ATTRIBUTE, IdmUser.REPLACE_ATTRIBUTE, IdmUser.DELETE_ATTRIBUTE
Throws:
UtilException - if attributes couldn't be modified

modifyAttributes

public void modifyAttributes(ModPropertySet pset)
                      throws UtilException
Description copied from interface: IdmUser
Modify user attributes with the attributes in specified order.
Specified by:
modifyAttributes in interface IdmUser
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
Description copied from interface: IdmUser
Set the application properties.
Specified by:
setExtendedProperties in interface IdmUser
Parameters:
appCtx - ApplicationContext object
baseUserPset - Base User atributes.
appUserPset - App User attributes to be used in modification.
Throws:
UtilException

setProvisioningStatus

public void setProvisioningStatus(ApplicationContext appCtx,
                                  java.lang.String status,
                                  java.lang.String statusMsg)
                           throws UtilException
Deprecated. To be removed in the next label
Description copied from interface: IdmUser
Set the Provisioning Status of this user for the given applciation.
Specified by:
setProvisioningStatus in interface IdmUser
Parameters:
appCtx - application Context
status - 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
statusMsg - Status Description message
Throws:
UtilException

setProvisioningStatus

public void setProvisioningStatus(Application app,
                                  java.lang.String status,
                                  java.lang.String statusMsg)
                           throws UtilException
Specified by:
setProvisioningStatus in interface IdmUser
Throws:
UtilException

getExtendedProperties

public PropertySetCollection getExtendedProperties(ApplicationContext appCtx)
                                            throws UtilException
Description copied from interface: IdmUser
Get the application properties.
Specified by:
getExtendedProperties in interface IdmUser
Parameters:
appCtx - ApplicationContext object
Returns:
property set collection.
Throws:
UtilException

getProvisioningStatus

public java.lang.String getProvisioningStatus(ApplicationContext appCtx)
                                       throws UtilException
Deprecated. to be removed in the next label
Description copied from interface: IdmUser
Get the Provisioning Status of this user for the given applciation.
Specified by:
getProvisioningStatus in interface IdmUser
Parameters:
appCtx - 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
Description copied from interface: IdmUser
Get the Provisioning Status of this user for the given applciation.
Specified by:
getProvisioningStatus in interface IdmUser
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

getUserApplications

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

changeSSOPassword

public void changeSSOPassword(java.lang.String oldPass,
                              java.lang.String newPass,
                              boolean verify)
                       throws UtilException
Description copied from interface: IdmUser
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.
Specified by:
changeSSOPassword in interface IdmUser
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
Description copied from interface: IdmUser
Set password hint question and its answer for the user.
Specified by:
setPasswordHint in interface IdmUser
Parameters:
hint - hint question
answer - answer to hint question
Throws:
UtilException - if operation fails

getPasswordHint

public java.lang.String getPasswordHint()
                                 throws UtilException
Description copied from interface: IdmUser
Get password hint for the user
Specified by:
getPasswordHint in interface IdmUser
Returns:
password hint question. Possibly null
Throws:
UtilException - if operation fails

getPasswordHintAnswer

public java.lang.String getPasswordHintAnswer()
                                       throws UtilException
Description copied from interface: IdmUser
Get password hint answer for the user
Specified by:
getPasswordHintAnswer in interface IdmUser
Returns:
password hint answer. Possibly null
Throws:
UtilException - if operation fails

setTimeZone

public boolean setTimeZone(java.lang.String timezone)
                    throws UtilException
Description copied from interface: IdmUser
Set time zone
Specified by:
setTimeZone in interface IdmUser
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
Description copied from interface: IdmUser
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
Specified by:
resetPassword in interface IdmUser
Parameters:
hintanswer - answer to hint question
otherValidationProps - array of other required validation properties
Throws:
UtilException - if operation fails

setProvisioningConfiguration

public void setProvisioningConfiguration(Configuration cfg)
Description copied from interface: IdmUser
Set the provisioining configuration object for this user
Specified by:
setProvisioningConfiguration in interface IdmUser
Parameters:
cfg - Provisioning configuration object.

getProvisioningConfiguration

public Configuration getProvisioningConfiguration()

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

setLdapContext

public void setLdapContext(javax.naming.ldap.LdapContext lCtx)

Skip navigation links

Oracle Internet Directory API Reference
11g Release 1 (11.1.1)

E10664-01


Copyright © 1999, 2009 Oracle. All Rights Reserved.