org.opends.server.tools.upgrade

Interface UpgradeTask

public interface UpgradeTask

An upgrade task.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	UpgradeTask.TaskType Defines the different types of upgrade tasks.

Method Summary

Methods

Modifier and Type	Method and Description
void	perform(UpgradeContext context) Performs this upgrade task.
void	postponePostUpgrade(UpgradeContext context) This method will be invoked only if one of the previous post upgrade task has failed.
void	postUpgrade(UpgradeContext context) This method will be invoked after all upgrade tasks have completed successfully The post upgrade tasks are processes which should be launched after a successful upgrade.
void	prepare(UpgradeContext context) Performs any preparation work required before performing the upgrade task, including interacting with the user where needed (e.g.

Method Detail

prepare

void prepare(UpgradeContext context)
             throws com.forgerock.opendj.cli.ClientException

Performs any preparation work required before performing the upgrade task, including interacting with the user where needed (e.g. in order to ask for confirmation), and throw a ClientException if the upgrade cannot proceed.

Parameters:

context - Context through which tasks can interact with the server installation.

Throws:

com.forgerock.opendj.cli.ClientException - If the upgrade cannot proceed.

perform

void perform(UpgradeContext context)
             throws com.forgerock.opendj.cli.ClientException

Performs this upgrade task.

Parameters:

context - Context through which tasks can interact with the server installation.

Throws:

com.forgerock.opendj.cli.ClientException - If an error occurred while performing the task.

postUpgrade

void postUpgrade(UpgradeContext context)
                 throws com.forgerock.opendj.cli.ClientException

This method will be invoked after all upgrade tasks have completed successfully The post upgrade tasks are processes which should be launched after a successful upgrade.

Parameters:

context - Context through which tasks can interact with the server installation.

Throws:

com.forgerock.opendj.cli.ClientException - If the task cannot proceed.

postponePostUpgrade

void postponePostUpgrade(UpgradeContext context)
                         throws com.forgerock.opendj.cli.ClientException

This method will be invoked only if one of the previous post upgrade task has failed.

Parameters:

context - Context through which tasks can interact with the server installation.

Throws:

com.forgerock.opendj.cli.ClientException - If the task cannot proceed.