Package org.opends.quicksetup.event

Class ProgressUpdateEvent

java.lang.Object

org.opends.quicksetup.event.ProgressUpdateEvent

public class ProgressUpdateEvent
extends Object

The event that is generated when there is a change during the installation process (we get a new log message when starting the server, or we finished configuring the server for instance). In the current implementation this events are generated by the Installer objects and are notified to the objects implementing ProgressUpdateListener (QuickSetup object).

Constructor Summary

Constructors

Constructor	Description
ProgressUpdateEvent(ProgressStep step, Integer progressRatio, org.forgerock.i18n.LocalizableMessage currentPhaseSummary, org.forgerock.i18n.LocalizableMessage newLogs)	Constructor of the ProgressUpdateEvent.

Method Summary

Modifier and Type	Method	Description
org.forgerock.i18n.LocalizableMessage	getCurrentPhaseSummary()	Gets a localized message summary describing the install progress status.
org.forgerock.i18n.LocalizableMessage	getNewLogs()	Gets the new logs for the install progress.
Integer	getProgressRatio()	Gets the progress ratio for the install progress.
ProgressStep	getProgressStep()	Gets the current progress step.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProgressUpdateEvent

public ProgressUpdateEvent(ProgressStep step,
                           Integer progressRatio,
                           org.forgerock.i18n.LocalizableMessage currentPhaseSummary,
                           org.forgerock.i18n.LocalizableMessage newLogs)

Constructor of the ProgressUpdateEvent.

Parameters:

step - the ProgressStep object describing in which step of the installation we are (configuring server, starting server, etc.)

progressRatio - the integer that specifies which percentage of the whole installation has been completed.

currentPhaseSummary - the localized summary message for the current installation progress.

newLogs - the new log messages that we have for the installation.

Method Detail

getCurrentPhaseSummary

public org.forgerock.i18n.LocalizableMessage getCurrentPhaseSummary()

Gets a localized message summary describing the install progress status.

Returns:

the localized message summary describing the progress status.

getNewLogs

public org.forgerock.i18n.LocalizableMessage getNewLogs()

Gets the new logs for the install progress.

Returns:

the new logs for the current install progress.

getProgressRatio

public Integer getProgressRatio()

Gets the progress ratio for the install progress.

Returns:

the progress ratio for the install progress.

getProgressStep

public ProgressStep getProgressStep()

Gets the current progress step.

Returns:

the current progress step.