Package org.forgerock.openam.upgrade.helpers

Class IdRepoServiceHelper

java.lang.Object

com.sun.identity.sm.AbstractUpgradeHelper

org.forgerock.openam.upgrade.helpers.IdRepoServiceHelper

All Implemented Interfaces:

UpgradeHelper

public class IdRepoServiceHelper
extends AbstractUpgradeHelper

This service upgrade helper ensures that IdRepo schema is being updated to reference to the DJ SDK based implementation.

Author:

Peter Major

Field Summary

Fields inherited from class com.sun.identity.sm.AbstractUpgradeHelper

attributes

Constructor Summary

Constructors

Constructor	Description
IdRepoServiceHelper()

Method Summary

Modifier and Type	Method	Description
AttributeSchemaImpl	upgradeAttribute(AttributeSchemaImpl oldAttr, AttributeSchemaImpl newAttr)	Implement this method to perform modifications to an existing attribute based on custom logic.

Methods inherited from class com.sun.identity.sm.AbstractUpgradeHelper

addNewAttribute, encryptValues, getAttributes, updateChoiceValues, updateDefaultValues, updateExampleValues, updateNode, updateOptional, upgradeAttribute

Methods inherited from class java.lang.Object

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

Constructor Detail

IdRepoServiceHelper

public IdRepoServiceHelper()

Method Detail

upgradeAttribute

public AttributeSchemaImpl upgradeAttribute(AttributeSchemaImpl oldAttr,
                                            AttributeSchemaImpl newAttr)
                                     throws UpgradeException

Description copied from class: AbstractUpgradeHelper

Implement this method to perform modifications to an existing attribute based on custom logic. In order to create a hook for a certain attribute, during upgradehelper initialization the attribute name should be captured in AbstractUpgradeHelper.attributes.

Specified by:

upgradeAttribute in interface UpgradeHelper

Specified by:

upgradeAttribute in class AbstractUpgradeHelper

Parameters:

oldAttr - The attribute schema definition currently specified.

newAttr - The attribute schema definition we are planning to upgrade to.

Returns:

If there is nothing to upgrade (i.e. there is no real difference between old and new attribute), implementations MUST return null, otherwise either the amended attribute or the newAttr can be returned directly.

Throws:

UpgradeException - If there was an error while performing the attribute upgrade.