Skip navigation links

oracle.iam.connectors.icfcommon.prov
Class ICProvisioningManager

java.lang.Object
oracle.iam.connectors.icfcommon.prov.ICProvisioningManager

All Implemented Interfaces:

ProvisioningManager

public final class ICProvisioningManager

extends java.lang.Object

implements ProvisioningManager

Common Provisioning Manager for ICF based connectors. Methods in this class should be used by OIM Connector's adapter tasks.

Constructor Summary

ICProvisioningManager(java.lang.String itResourceFieldName, long processInstanceKey, com.thortech.xl.dataaccess.tcDataProvider dataProvider)
Creates instance of ICProvisioningManager

Method Summary

java.lang.String	addChildTableValue(java.lang.String objectType, java.lang.String childTableName, long childPrimaryKey) Updates the target by adding the newly added row in child table.
java.lang.String	createObject(java.lang.String objectType) Creates object of specified type on target resource, the values are taken from current Form
java.lang.String	deleteObject(java.lang.String objectType) Deletes object of specified type on target resource
java.lang.String	disableObject(java.lang.String objectType) Disables current object on target resource
java.lang.String	disableUser() Deprecated.
java.lang.String	enableObject(java.lang.String objectType) Enables current object on target resource
java.lang.String	enableUser() Deprecated.
java.lang.String	removeChildTableValue(java.lang.String objectType, java.lang.String childTableName, java.lang.Integer taskInstanceKey) Updates the target by removing the row which was just deleted from child table
void	setEffectiveITResourceName(java.lang.String itResourceName) If the connector needs to use different IT Resource for provisioning operations, it can be set by this method
void	setOperationOptions(java.util.Map options) Sets OperationOptions which are going to be used for any provisioning operation called on this instance.
java.lang.String	updateAttributeValue(java.lang.String objectType, java.lang.String attrFieldName) Updates object on target resource, only the attribute with the provided label is updated
java.lang.String	updateAttributeValues(java.lang.String objectType, java.util.Map fields) Updates multiple attributes on target resource
java.lang.String	updateAttributeValues(java.lang.String objectType, java.util.Map fields, java.util.Map oldFields) Updates multiple attributes on target resource (including original value a.k.a CURRENT_ATTRIBUTES)
java.lang.String	updateAttributeValues(java.lang.String objectType, java.lang.String[] labels) Use this method if there is a group update of fields.
java.lang.String	updateChildTableValue(java.lang.String objectType, java.lang.String childTableName, java.lang.Integer taskInstanceKey, long childPrimaryKey) Updates the target by removing the deleted row and adding the newly created row
java.lang.String	updateChildTableValues(java.lang.String objectType, java.lang.String childTableName) Updates values provided in child table on target resource
java.lang.String	updatePassword(java.lang.String objectType, java.lang.String pswdFieldLabel, java.lang.String oldPassword) Use this method in Adapter ONLY if you need to provide old password value, currently there is no way to get the old value using the formAPI.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ICProvisioningManager

public ICProvisioningManager(java.lang.String itResourceFieldName,
                             long processInstanceKey,
                             com.thortech.xl.dataaccess.tcDataProvider dataProvider)

Creates instance of ICProvisioningManager

Parameters:

itResourceFieldName - ITResource Field Name

processInstanceKey - Process Instance Key

dataProvider - OIM Data Provider

Method Detail

addChildTableValue

public java.lang.String addChildTableValue(java.lang.String objectType,
                                           java.lang.String childTableName,
                                           long childPrimaryKey)

Updates the target by adding the newly added row in child table.

Specified by:

addChildTableValue in interface ProvisioningManager

Parameters:

objectType - Object Type, can't be null

childTableName - Child table name which is being updated

childPrimaryKey - Child primary key representing the new row added into child row

Returns:

removeChildTableValue

public java.lang.String removeChildTableValue(java.lang.String objectType,
                                              java.lang.String childTableName,
                                              java.lang.Integer taskInstanceKey)

Updates the target by removing the row which was just deleted from child table

Specified by:

removeChildTableValue in interface ProvisioningManager

Parameters:

objectType - Object Type, can't be null

childTableName - Child table name which is being updated

taskInstanceKey - Task instance key responsible for deleting the row from child table

Returns:

Response Code as String

updateChildTableValue

public java.lang.String updateChildTableValue(java.lang.String objectType,
                                              java.lang.String childTableName,
                                              java.lang.Integer taskInstanceKey,
                                              long childPrimaryKey)

Updates the target by removing the deleted row and adding the newly created row

Specified by:

updateChildTableValue in interface ProvisioningManager

Parameters:

objectType - Object Type, can't be null

childTableName - Child table name which is being updated

taskInstanceKey - Task instance key responsible for deleting the row from child table

childPrimaryKey - Child primary key representing the new row added into child row

Returns:

Response Code as String

setEffectiveITResourceName

public void setEffectiveITResourceName(java.lang.String itResourceName)

If the connector needs to use different IT Resource for provisioning operations, it can be set by this method

Parameters:

itResourceName - IT Resource Name which will be used for provisioning operations

setOperationOptions

public void setOperationOptions(java.util.Map options)

Sets OperationOptions which are going to be used for any provisioning operation called on this instance. This is helpfull in cases when OIM Process/Adapter needs to set some operation option explicitly.

Note ICF INTG has also way of mapping the form fields to operation options.

If both ways are used the the maps are going to be merged into one (options set by this method are used first, the form field mapping can override them)

Parameters:

options - Map of operation options to set

createObject

public java.lang.String createObject(java.lang.String objectType)

Creates object of specified type on target resource, the values are taken from current Form

Specified by:

createObject in interface ProvisioningManager

Parameters:

objectType - Object Type, can't be null

Returns:

Response Code as String

deleteObject

public java.lang.String deleteObject(java.lang.String objectType)

Deletes object of specified type on target resource

Specified by:

deleteObject in interface ProvisioningManager

Parameters:

objectType - Object Type, can't be null

Returns:

Response Code as String

updateAttributeValue

public java.lang.String updateAttributeValue(java.lang.String objectType,
                                             java.lang.String attrFieldName)

Updates object on target resource, only the attribute with the provided label is updated

Specified by:

updateAttributeValue in interface ProvisioningManager

Parameters:

objectType - Object Type to update, can't be null

attrFieldName - Field Label to update, can't be null

Returns:

Response Code as String

updateAttributeValues

public java.lang.String updateAttributeValues(java.lang.String objectType,
                                              java.lang.String[] labels)

Use this method if there is a group update of fields. This will be useful when a set of attributes have to updated together.

Parameters:

objectType - Object Type

labels - List of attribute field names to be updated

Returns:

Response code

updateAttributeValues

public java.lang.String updateAttributeValues(java.lang.String objectType,
                                              java.util.Map fields)

Description copied from interface: ProvisioningManager

Updates multiple attributes on target resource

Specified by:

updateAttributeValues in interface ProvisioningManager

Parameters:

objectType - Object Type, can't be null

fields - Map of field names/values which needs to be updated

Returns:

Response Code as String

updateAttributeValues

public java.lang.String updateAttributeValues(java.lang.String objectType,
                                              java.util.Map fields,
                                              java.util.Map oldFields)

Description copied from interface: ProvisioningManager

Updates multiple attributes on target resource (including original value a.k.a CURRENT_ATTRIBUTES)

Specified by:

updateAttributeValues in interface ProvisioningManager

Parameters:

objectType - Object Type, can't be null

fields - Map of field names/values which needs to be updated

oldFields - Map of field names/values with values before they were updated

Returns:

Response Code as String

updateChildTableValues

public java.lang.String updateChildTableValues(java.lang.String objectType,
                                               java.lang.String childTableName)

Updates values provided in child table on target resource

Specified by:

updateChildTableValues in interface ProvisioningManager

Parameters:

objectType - ObjectType, can't be null

childTableName - Child table name which was changed

Returns:

Response Code as String

updatePassword

public java.lang.String updatePassword(java.lang.String objectType,
                                       java.lang.String pswdFieldLabel,
                                       java.lang.String oldPassword)

Use this method in Adapter ONLY if you need to provide old password value, currently there is no way to get the old value using the formAPI. If you don't need old password value to change the password, use ICProvisioningManager.updateAttributeValue(String, String) method instead.

Parameters:

objectType - Object Type

pswdFieldLabel - Password Field Label

oldPassword - Old Password Value

Returns:

Response code

enableUser

@Deprecated
public java.lang.String enableUser()

Deprecated.

Enables current user on target resource
Deprecated, use ProvisioningManager.enableObject(String) instead

Specified by:

enableUser in interface ProvisioningManager

Returns:

Response Code as String

disableUser

@Deprecated
public java.lang.String disableUser()

Deprecated.

Disables current user on target resource
Deprecated, user ProvisioningManager.disableObject(String) instead

Specified by:

disableUser in interface ProvisioningManager

Returns:

Response Code as String

enableObject

public java.lang.String enableObject(java.lang.String objectType)

Enables current object on target resource

Specified by:

enableObject in interface ProvisioningManager

Parameters:

objectType - ObjectType, can't be null

Returns:

Response Code as String

disableObject

public java.lang.String disableObject(java.lang.String objectType)

Disables current object on target resource

Specified by:

disableObject in interface ProvisioningManager

Parameters:

objectType - ObjectType, can't be null

Returns:

Response Code as String

Skip navigation links