net.imagej.updater

Class Installer

java.lang.Object

net.imagej.updater.util.AbstractProgressable

net.imagej.updater.util.Downloader

net.imagej.updater.Installer

All Implemented Interfaces:

Progress, Progressable

public class Installer
extends Downloader

A class that updates local files from all available update sites.

An installer wraps a FilesCollection (db.xml.gz) and can be used to stage potential changes to that collection.

The start() method is the key to actually doing the work, downloading new files as needed or creating empty files to signify deletion. These all go in the update sub-directory, but the update can be finalized with moveUpdatedIntoPlace().

NB: the installer will only operate on FileObjects in the collection that have an appropriate FileObject.Status. Thus the first step in updating is typically to use FileObject.stageForUpdate(FilesCollection, boolean) or FileObject.stageForUninstall(FilesCollection) as needed, with the Installer used to activate these staged changes.

Author:

Johannes Schindelin

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	UPDATER_JAR_NAME

Fields inherited from class net.imagej.updater.util.Downloader

cancelled, count, error, itemCount, itemTotal, lastModified, total

Fields inherited from class net.imagej.updater.util.AbstractProgressable

progress

Constructor Summary

Constructors

Constructor and Description
Installer(FilesCollection files, Progress progress)

Method Summary

Modifier and Type	Method and Description
protected static void	deleteOrThrowException(File file)
static Set<FileObject>	getUpdaterFiles(FilesCollection files, org.scijava.command.CommandService commandService, boolean onlyUpdateable)
static boolean	isTheUpdaterUpdateable(FilesCollection files)
static boolean	isTheUpdaterUpdateable(FilesCollection files, org.scijava.command.CommandService commandService)
protected static boolean	moveOutOfTheWay(File file)
void	moveUpdatedIntoPlace()
protected void	moveUpdatedIntoPlace(File sourceDirectory, File targetDirectory)
void	start()
static void	updateTheUpdater(FilesCollection files, Progress progress)
static void	updateTheUpdater(FilesCollection files, Progress progress, org.scijava.command.CommandService commandService)
void	verify(net.imagej.updater.Installer.Download download)

Methods inherited from class net.imagej.updater.util.Downloader

cancel, download, getLastModified, start, start

Methods inherited from class net.imagej.updater.util.AbstractProgressable

addItem, addProgress, done, itemDone, removeProgress, setCount, setItemCount, setTitle

Methods inherited from class java.lang.Object

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

Field Detail

UPDATER_JAR_NAME

protected static final String UPDATER_JAR_NAME

See Also:

Constant Field Values

Constructor Detail

Installer

public Installer(FilesCollection files,
                 Progress progress)

Method Detail

start

public void start()
           throws IOException

Throws:

IOException

getUpdaterFiles

public static Set<FileObject> getUpdaterFiles(FilesCollection files,
                                              org.scijava.command.CommandService commandService,
                                              boolean onlyUpdateable)

isTheUpdaterUpdateable

public static boolean isTheUpdaterUpdateable(FilesCollection files)

isTheUpdaterUpdateable

public static boolean isTheUpdaterUpdateable(FilesCollection files,
                                             org.scijava.command.CommandService commandService)

updateTheUpdater

public static void updateTheUpdater(FilesCollection files,
                                    Progress progress)
                             throws IOException

Throws:

IOException

updateTheUpdater

public static void updateTheUpdater(FilesCollection files,
                                    Progress progress,
                                    org.scijava.command.CommandService commandService)
                             throws IOException

Throws:

IOException

verify

public void verify(net.imagej.updater.Installer.Download download)

moveUpdatedIntoPlace

public void moveUpdatedIntoPlace()
                          throws IOException

Throws:

IOException

moveUpdatedIntoPlace

protected void moveUpdatedIntoPlace(File sourceDirectory,
                                    File targetDirectory)
                             throws IOException

Throws:

IOException

deleteOrThrowException

protected static void deleteOrThrowException(File file)
                                      throws IOException

Throws:

IOException

moveOutOfTheWay

protected static boolean moveOutOfTheWay(File file)