org.nuiton.updater

Class ApplicationUpdater

java.lang.Object

org.nuiton.updater.ApplicationUpdater

public class ApplicationUpdater
extends Object

Permet de telecharger des mises a jour d'application.

Le principe est qu'un fichier properties pointe par une URL indique les information necessaire pour la recuperation de l'application.

Si une nouvelle version de l'application existe, elle est alors telechargee et decompressee dans un repertoire specifique (elle ne remplace pas l'application courante).

Il est alors a la charge d'un script de mettre en place cette nouvelle application a la place de l'ancienne.

Il est possible d'interagir avec ApplicationUpdater via l'implantation d'un ApplicationUpdaterCallback passer en parametre de la methode update(java.lang.String, java.io.File, java.io.File, boolean, org.nuiton.updater.ApplicationUpdaterCallback)

Configuration possible

Vous pouvez passer un ApplicationConfig dans le constructeur ou utiliser la recherche du fichier de configuration par defaut (ApplicationUpdater.properties).

Cette configuration permet de récupérer les informations suivantes :

• http_proxy: le proxy a utiliser pour l'acces au reseau (ex: squid.chezmoi.fr:8080)
• os.name: le nom du systeme d'exploitation sur lequel l'application fonctionne (ex: Linux)
• os.arch: l'architecture du systeme d'exploitation sur lequel l'application fonctionne (ex: amd64)

format du fichier de properties

• [osName.][osArch.]appName.version=version de l'application
• [osName.][osArch.]appName.auth=true ou false selon que l'acces a l'url demande une authentification a fournir par le callback (voir ApplicationUpdaterCallback.updateToDo(java.util.Map<java.lang.String, org.nuiton.updater.ApplicationInfo>))
• [osName.][osArch.]appName.url=url du fichier compresse de la nouvelle version (format commons-vfs2)

• appName est a remplacer par le nom de l'application. Il est possible d'avoir plusieurs application dans le meme fichier ou plusieurs version en fonction de l'os et de l'architecture.
• osName et osArch sont toujours en minuscule.

format des fichiers compresses

Le fichier compresse doit avoir un repertoire racine qui contient l'ensemble de l'application c-a-d que les fichiers ne doivent pas etre directement a la racine lorsqu'on decompresse le fichier. Exemple de contenu de fichier compresse convenable

 MonApp-0.3/Readme.txt
 MonApp-0.3/License.txt
 

Ceci est du au fait qu'on renomme le repertoire racine avec le nom de l'application, donc si le repertoire racine n'existe pas ou qu'il y a plusieurs repertoires a la racine le resultat de l'operation n'est pas celui souhaite

os.name and os.arch

Exemple

os.name	os.arch
linux	amd64
linux	i386
mac	ppc
windows	x86
solaris	sparc

os.name est tronque apres le 1er mot donc "windows 2000" et "windows 2003" deviennet tous les deux "windows". Si vous souhaitez gérer plus finement vos url de telechargement vous pouvez modifier les donnees via ApplicationUpdaterCallback.updateToDo(java.util.Map) en modifiant l'url avant de retourner la map

Since:

2.7

Author:

Benjamin Poussin - poussin@codelutin.com, Tony Chemit - chemit@codelutin.com

Field Summary

Fields

Modifier and Type	Field and Description
protected org.nuiton.config.ApplicationConfig	config
protected static String	SEPARATOR_KEY
protected static String	VERSION_FILE
static String	ZERO_VERSION

Constructor Summary

Constructors

Constructor and Description
ApplicationUpdater() Utilise le fichier de configuration par defaut: ApplicationUpdater.properties
ApplicationUpdater(org.nuiton.config.ApplicationConfig config)

Method Summary

Methods

Modifier and Type	Method and Description
static void	createVersionFile(File dir, String version)
static File	getVersionFile(File dir)
Map<String,ApplicationInfo>	getVersions(String url, File currentDir)
static String	loadVersionFile(String appName, File dir)
static void	storeVersionFile(File dir, String version)
void	update(String url, File currentDir, File destDir, boolean async, ApplicationUpdaterCallback callback)
void	update(String url, File currentDir, File destDir, boolean async, ApplicationUpdaterCallback callback, DownloadMonitor downloadMonitor)

Methods inherited from class java.lang.Object

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

Field Detail

VERSION_FILE

protected static final String VERSION_FILE

See Also:

Constant Field Values

SEPARATOR_KEY

protected static final String SEPARATOR_KEY

See Also:

Constant Field Values

ZERO_VERSION

public static final String ZERO_VERSION

See Also:

Constant Field Values

config

protected org.nuiton.config.ApplicationConfig config

Constructor Detail

ApplicationUpdater

public ApplicationUpdater()

Utilise le fichier de configuration par defaut: ApplicationUpdater.properties

ApplicationUpdater

public ApplicationUpdater(org.nuiton.config.ApplicationConfig config)

Parameters:

config - La configuration a utiliser pour rechercher le proxy (http_proxy) et os.name, os.arch

Method Detail

getVersionFile

public static File getVersionFile(File dir)

createVersionFile

public static void createVersionFile(File dir,
                     String version)
                              throws IOException

Throws:

IOException

loadVersionFile

public static String loadVersionFile(String appName,
                     File dir)

storeVersionFile

public static void storeVersionFile(File dir,
                    String version)
                             throws IOException

Throws:

IOException

update

public void update(String url,
          File currentDir,
          File destDir,
          boolean async,
          ApplicationUpdaterCallback callback)

Parameters:

url - url where properties file is downloadable. This properties must contains information on application release

currentDir - directory where application is currently

destDir - default directory to put new application version, can be null if you used callback

async - if true, check is done in background mode

callback - callback used to interact with updater, can be null

update

public void update(String url,
          File currentDir,
          File destDir,
          boolean async,
          ApplicationUpdaterCallback callback,
          DownloadMonitor downloadMonitor)

Parameters:

url - url where properties file is downloadable. This properties must contains information on application release

currentDir - directory where application is currently

destDir - default directory to put new application version, can be null if you used callback

async - if true, check is done in background mode

callback - callback used to interact with updater, can be null

downloadMonitor - optinal download monitor

getVersions

public Map<String,ApplicationInfo> getVersions(String url,
                                      File currentDir)

Parameters:

url - url where properties file is downloadable. This properties must contains information on application release

currentDir - directory where application is currently

Returns:

application infos for each application found in configuration