oracle.idm.user
Interface IdmUser

public interface IdmUser

This interface represents an identity management user in OID.

Field Summary

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	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 java.lang.String	STATUS_UNKNOWN
static java.lang.String	UPGRADE_FAILURE
static java.lang.String	UPGRADE_IN_PROGRESS

Method Summary

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
PropertySetCollection	getProperties(java.lang.String[] attrlist) 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	setExtendedProperties(ApplicationContext appCtx, ModPropertySet baseUserPset, ModPropertySet appUserPset) Set the application properties.
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)

Field Detail

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[] attrlist)
                                    throws UtilException

Gets the user attributes and their respective values as user properties.

Parameters:

attrlist - 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,

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

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 object

provStatus - 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

provStatusMsg - Status 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