org.nuiton.updater.ApplicationUpdaterCallback Maven / Gradle / Ivy

Go to download
package org.nuiton.updater;

/*
 * #%L
 * Nuiton Application Updater
 * $Id: ApplicationUpdaterCallback.java 2588 2013-07-20 14:25:42Z tchemit $
 * $HeadURL: https://nuiton.org/svn/nuiton-updater/tags/nuiton-updater-3.0-alpha-2/src/main/java/org/nuiton/updater/ApplicationUpdaterCallback.java $
 * %%
 * Copyright (C) 2013 CodeLutin, Tony Chemit
 * %%
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as 
 * published by the Free Software Foundation, either version 3 of the 
 * License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Lesser Public License for more details.
 * 
 * You should have received a copy of the GNU General Lesser Public 
 * License along with this program.  If not, see
 * .
 * #L%
 */

import java.util.Map;

/**
 * Permet d'interagir avec ApplicationUpdater.
 *
 * @author bpoussin 
 * @author tchemit 
 * @since 2.7
 */
public interface ApplicationUpdaterCallback {
    /**
     * Appeler avant la recuperation des nouvelles versions
     * 
     * Permet de modifier le repertoire destination ou l'url du zip de
     * l'application pour une application/version
     * particuliere ou d'annuler la mise a jour en le supprimant de la map
     * qui sera retourne.
     * 

     * Si {@link ApplicationInfo#needAuthentication} est vrai, il faut que
     * les valeurs {@link ApplicationInfo#login} et {@link ApplicationInfo#password}
     * soient renseignees. Si elle ne le sont pas la recuperation de la
     * ressource echouera. Pour des raisons de securite vous pouvez souhaiter
     * mettre le mot de passe sous une forme encrypte. Dans ce cas il doit
     * etre encadrer par '{' et '}'. Pour encrypter le mot de passe
     * vous devez utiliser:
     * 
     * java -cp commons-vfs-2.0.jar org.apache.commons.vfs2.util.EncryptUtil encrypt mypassword
     * 
     *
     * @param appToUpdate liste des applications a mettre a jour
     * @return null or empty map if we don't want update, otherwize list of
     *         app to update
     */
    Map updateToDo(Map appToUpdate);

    /**
     * Appeler au démarrage d'une mise à jour.
     *
     * @param info application à mettre à jour
     * @since 2.7
     */
    void startUpdate(ApplicationInfo info);

    /**
     * Appeler une fois qu'une mise a jour a parfaitement fonctionné.
     *
     * @param appToUpdate    le dictionnaire des applications mises à jour
     * @param appUpdateError le dictionnaires des erreurs rencontrées lors des mises à jour
     */
    void updateDone(Map appToUpdate,
                    Map appUpdateError);

    /**
     * Called when exception occur during process initialization
     *
     * @param propertiesURL url use to download properties release information
     * @param eee           exception throw during process
     */
    void aborted(String propertiesURL, Exception eee);
}