Package org.opends.quicksetup

Enum Step

java.lang.Object

java.lang.Enum<Step>

org.opends.quicksetup.Step

All Implemented Interfaces:

Serializable, Comparable<Step>, WizardStep

public enum Step
extends Enum<Step>
implements WizardStep

This enumeration just represents the different steps that we can have in the installation and uninstallation wizards.

Enum Constant Summary

Enum Constants

Enum Constant	Description
CONFIRM_UNINSTALL	Confirmation panel for the uninstallation.
CREATE_GLOBAL_ADMINISTRATOR	Global Administrator creation panel.
FINISHED	Finished panel.
LICENSE	License approval step for the installation.
NEW_SUFFIX_OPTIONS	Data Options panel (suffix dn, LDIF path, etc.).
PROGRESS	Progress panel.
REMOTE_REPLICATION_PORTS	Panel when the user specifies the replication ports of the remote servers that have not defined it.
REPLICATION_OPTIONS	Data Replication panel (standalone or replicated).
REVIEW	Review panel for the install.
RUNTIME_OPTIONS	Runtime options panel for the install.
SERVER_SETTINGS	Server Settings step (path, port, etc.).
SUFFIXES_OPTIONS	Suffixes to Replicate.
WELCOME	Welcome step for the installation.

Method Summary

Modifier and Type	Method	Description
org.forgerock.i18n.LocalizableMessage	getDisplayMessage()	Gets this steps message key.
boolean	isFinishedStep()	Indicates whether this is the finished step for the application or not.
boolean	isLicenseStep()	Indicates whether this is the license approval step.
boolean	isProgressStep()	Indicates that when this step is displayed the application will be asked to launch itself.
static Step	valueOf(String name)	Returns the enum constant of this type with the specified name.
static Step[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

WELCOME

public static final Step WELCOME

Welcome step for the installation.

LICENSE

public static final Step LICENSE

License approval step for the installation.

CONFIRM_UNINSTALL

public static final Step CONFIRM_UNINSTALL

Confirmation panel for the uninstallation.

SERVER_SETTINGS

public static final Step SERVER_SETTINGS

Server Settings step (path, port, etc.).

REPLICATION_OPTIONS

public static final Step REPLICATION_OPTIONS

Data Replication panel (standalone or replicated).

CREATE_GLOBAL_ADMINISTRATOR

public static final Step CREATE_GLOBAL_ADMINISTRATOR

Global Administrator creation panel.

SUFFIXES_OPTIONS

public static final Step SUFFIXES_OPTIONS

Suffixes to Replicate.

REMOTE_REPLICATION_PORTS

public static final Step REMOTE_REPLICATION_PORTS

Panel when the user specifies the replication ports of the remote servers that have not defined it.

NEW_SUFFIX_OPTIONS

public static final Step NEW_SUFFIX_OPTIONS

Data Options panel (suffix dn, LDIF path, etc.).

RUNTIME_OPTIONS

public static final Step RUNTIME_OPTIONS

Runtime options panel for the install.

REVIEW

public static final Step REVIEW

Review panel for the install.

PROGRESS

public static final Step PROGRESS

Progress panel.

FINISHED

public static final Step FINISHED

Finished panel.

Method Detail

values

public static Step[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Step c : Step.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Step valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getDisplayMessage

public org.forgerock.i18n.LocalizableMessage getDisplayMessage()

Gets this steps message key.

Specified by:

getDisplayMessage in interface WizardStep

Returns:

String message key used to access a message catalog to retrieve this step's display name

isProgressStep

public boolean isProgressStep()

Description copied from interface: WizardStep

Indicates that when this step is displayed the application will be asked to launch itself.

Specified by:

isProgressStep in interface WizardStep

Returns:

true indicating that this is the progress step for the application

isFinishedStep

public boolean isFinishedStep()

Description copied from interface: WizardStep

Indicates whether this is the finished step for the application or not.

Specified by:

isFinishedStep in interface WizardStep

Returns:

true if this is the finished step for the application and false otherwise.

isLicenseStep

public boolean isLicenseStep()

Description copied from interface: WizardStep

Indicates whether this is the license approval step.

Specified by:

isLicenseStep in interface WizardStep

Returns:

true if this is the license approval step and false otherwise.