001/*
002 * CDDL HEADER START
003 *
004 * The contents of this file are subject to the terms of the
005 * Common Development and Distribution License, Version 1.0 only
006 * (the "License").  You may not use this file except in compliance
007 * with the License.
008 *
009 * You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
010 * or http://forgerock.org/license/CDDLv1.0.html.
011 * See the License for the specific language governing permissions
012 * and limitations under the License.
013 *
014 * When distributing Covered Code, include this CDDL HEADER in each
015 * file and include the License file at legal-notices/CDDLv1_0.txt.
016 * If applicable, add the following below this CDDL HEADER, with the
017 * fields enclosed by brackets "[]" replaced with your own identifying
018 * information:
019 *      Portions Copyright [yyyy] [name of copyright owner]
020 *
021 * CDDL HEADER END
022 *
023 *
024 *      Copyright 2008 Sun Microsystems, Inc.
025 *      Portions Copyright 2014 ForgeRock AS
026 */
027
028package org.opends.quicksetup.event;
029
030import org.forgerock.i18n.LocalizableMessage;
031
032/**
033 * Inteface for applications that advertise status to interested
034 * listeners.
035 */
036public interface ProgressNotifier {
037
038  /**
039   * Adds a listener to the list of those that are
040   * notified about the progress state change of
041   * an application.
042   * @param l ProgressUpdateListener
043   */
044  void addProgressUpdateListener(ProgressUpdateListener l);
045
046  /**
047   * Removes a listener from this list of those that
048   * are notified about a progress state change.
049   * @param l ProgressUpdateListener
050   */
051  void removeProgressUpdateListener(ProgressUpdateListener l);
052
053  /**
054   * Notifies all registered listeners about a change
055   * in progress state.
056   * @param ratio Integer specifying the percentage of the whole
057   *        process that has been completed
058   * @param currentPhaseSummary localized summary message for
059 *        the current installation progress in formatted
060 *        form
061   * @param newLogDetail new log messages in formatted form
062   */
063  void notifyListeners(Integer ratio, LocalizableMessage currentPhaseSummary,
064      LocalizableMessage newLogDetail);
065
066}