Package org.forgerock.openam.auth.node.api.upgrade

Class UnsupportedUpgrade

java.lang.Object

org.forgerock.openam.auth.node.api.upgrade.UnsupportedUpgrade

All Implemented Interfaces:

NodeVersionUpgrader

@Evolving
public class UnsupportedUpgrade
extends Object
implements NodeVersionUpgrader

This class represents an unsupported upgrade operation for a node.

Nested Class Summary

Nested classes/interfaces inherited from interface org.forgerock.openam.auth.node.api.upgrade.NodeVersionUpgrader

NodeVersionUpgrader.UpgraderMetadata

Constructor Summary

Constructors

Constructor	Description
UnsupportedUpgrade()

Method Summary

Modifier and Type	Method	Description
JsonValue	upgrade(JsonValue config)	Upgrade the node to this version.

Methods inherited from class java.lang.Object

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

Constructor Details

UnsupportedUpgrade

public UnsupportedUpgrade()

Method Details

upgrade

public JsonValue upgrade(JsonValue config)
                  throws NodeUpgradeException

Description copied from interface: NodeVersionUpgrader

Upgrade the node to this version.

Specified by:

upgrade in interface NodeVersionUpgrader

Parameters:

config - the configuration to upgrade.

Returns:

the config after the upgrade.

Throws:

NodeUpgradeException - if the upgrade fails for any reason.