ProgressUpdateEvent.java revision a395dd575518d9e5280fc5d5d5ef47c61b174647
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster/*
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * CDDL HEADER START
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * The contents of this file are subject to the terms of the
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Common Development and Distribution License, Version 1.0 only
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * (the "License"). You may not use this file except in compliance
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * with the License.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * You can obtain a copy of the license at
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * trunk/opends/resource/legal-notices/OpenDS.LICENSE
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * or https://OpenDS.dev.java.net/OpenDS.LICENSE.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * See the License for the specific language governing permissions
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * and limitations under the License.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * When distributing Covered Code, include this CDDL HEADER in each
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * file and include the License file at
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * trunk/opends/resource/legal-notices/OpenDS.LICENSE. If applicable,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * add the following below this CDDL HEADER, with the fields enclosed
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * by brackets "[]" replaced with your own identifying information:
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Portions Copyright [yyyy] [name of copyright owner]
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * CDDL HEADER END
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Copyright 2006-2008 Sun Microsystems, Inc.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster */
abd02248a498b673140dafdeeed67e0112bd5026Peter Major
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterpackage org.opends.quicksetup.event;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport org.opends.messages.Message;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport org.opends.quicksetup.ProgressStep;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
0fdab8904a8fe223f6934b878769fe45e7651c60Andrew Forrest/**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * The event that is generated when there is a change during the installation
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * process (we get a new log message when starting the server, or we finished
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * configuring the server for instance).
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * In the current implementation this events are generated by the Installer
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * objects and are notified to the objects implementing
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * ProgressUpdateListener (QuickSetup object).
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterpublic class ProgressUpdateEvent {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster private ProgressStep step;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster private Integer progressRatio;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster private Message currentPhaseSummary;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster private Message newLogs;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster /**
80849398a45dca1fb917716907d6ec99be6222c2Peter Major * Constructor of the ProgressUpdateEvent.
89503929c8983c48e2049c77284b52e79ad37c32jeff.schenk * @param step the ProgressStep object describing in which step
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * of the installation we are (configuring server, starting server, etc.)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param progressRatio the integer that specifies which percentage of
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * the whole installation has been completed.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param currentPhaseSummary the localized summary message for the
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster* current installation progress.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param newLogs the new log messages that we have for the installation.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public ProgressUpdateEvent(ProgressStep step,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster Integer progressRatio, Message currentPhaseSummary, Message newLogs)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster this.step = step;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster this.progressRatio = progressRatio;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster this.currentPhaseSummary = currentPhaseSummary;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster this.newLogs = newLogs;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Gets a localized message summary describing the install progress
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * status.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return the localized message summary describing the progress status.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster */
89503929c8983c48e2049c77284b52e79ad37c32jeff.schenk public Message getCurrentPhaseSummary()
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster return currentPhaseSummary;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Gets the new logs for the install progress.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return the new logs for the current install progress.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public Message getNewLogs()
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster return newLogs;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Gets the progress ratio for the install progress.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return the progress ratio for the install progress.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public Integer getProgressRatio()
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster return progressRatio;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Gets the current progress step.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return the current progress step.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public ProgressStep getProgressStep()
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster return step;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster}
4a5a82da9bbab0a3ea1701c3ae9334c678d24ca5Mark de Reeper