Package org.forgerock.am.trees.api

Interface NodeUpgrader

public interface NodeUpgrader

Interface for upgrading a node configuration from one version to another.

Method Summary

Modifier and Type	Method	Description
JsonValue	upgrade(String nodeName, int currentVersion, int targetVersion, JsonValue config)	Upgrade the node configuration from the current version to the target version.

Method Details

upgrade

JsonValue upgrade(String nodeName,
 int currentVersion,
 int targetVersion,
 JsonValue config)
           throws NodeUpgradeException

Upgrade the node configuration from the current version to the target version.

Parameters:

nodeName - the name of the node being upgraded.

currentVersion - the current version of the node configuration.

targetVersion - the target version to upgrade to.

config - the configuration to upgrade, must be non-null.

Returns:

the upgraded configuration as a JsonValue object.

Throws:

NodeUpgradeException - if the upgrade fails for any reason, including if the target version does not have an upgrader defined.