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