com.izforge.izpack.event

Class RegistryInstallerListener

java.lang.Object

com.izforge.izpack.api.event.AbstractInstallerListener

com.izforge.izpack.event.AbstractProgressInstallerListener

com.izforge.izpack.event.RegistryInstallerListener

All Implemented Interfaces:

InstallationListener, InstallerListener, CleanupClient

public class RegistryInstallerListener
extends AbstractProgressInstallerListener
implements CleanupClient

Installer custom action for handling registry entries on Windows. On Unix nothing will be done. The actions which should be performed are defined in a resource file named "RegistrySpec.xml". This resource should be declared in the installation definition file (install.xml), else an exception will be raised during execution of this custom action. The related DTD is appl/install/IzPack/resources/registry.dtd.

Author:

Klaus Bartz

Field Summary

Fields

Modifier and Type	Field and Description
static String	SPEC_FILE_NAME The name of the XML file that specifies the registry entries.

Constructor Summary

Constructors

Constructor and Description
RegistryInstallerListener(IUnpacker unpacker, VariableSubstitutor substitutor, InstallData installData, UninstallData uninstallData, Resources resources, RulesEngine rules, Housekeeper housekeeper, RegistryDefaultHandler handler) Constructs a RegistryInstallerListener.

Method Summary

Modifier and Type	Method and Description
void	afterPacks(List<Pack> packs, ProgressListener listener) Invoked after packs are installed.
void	cleanUp() Remove all registry entries on failed installation.
protected String	getUninstallName() Returns the uninstall name, used to initialise the RegistryHandler.setUninstallName(String).
void	initialise() Initialises the listener.

Methods inherited from class com.izforge.izpack.event.AbstractProgressInstallerListener

getInstallData, getMessage, getProgressNotifierId, getProgressNotifiers, notifyProgress, setProgressNotifier

Methods inherited from class com.izforge.izpack.api.event.AbstractInstallerListener

afterDir, afterFile, afterPack, beforeDir, beforeFile, beforePack, beforePacks, beforePacks, isFileListener

Methods inherited from class java.lang.Object

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

Field Detail

SPEC_FILE_NAME

public static final String SPEC_FILE_NAME

The name of the XML file that specifies the registry entries.

See Also:

Constant Field Values

Constructor Detail

RegistryInstallerListener

public RegistryInstallerListener(IUnpacker unpacker,
                                 VariableSubstitutor substitutor,
                                 InstallData installData,
                                 UninstallData uninstallData,
                                 Resources resources,
                                 RulesEngine rules,
                                 Housekeeper housekeeper,
                                 RegistryDefaultHandler handler)

Constructs a RegistryInstallerListener.

Parameters:

unpacker - the unpacker

substitutor - the variable substituter

installData - the installation data

uninstallData - the uninstallation data

rules - the rules

resources - the resources

housekeeper - the housekeeper

handler - the registry handler reference

Method Detail

initialise

public void initialise()

Initialises the listener.

Specified by:

initialise in interface InstallationListener

Overrides:

initialise in class AbstractInstallerListener

Throws:

IzPackException - for any error

afterPacks

public void afterPacks(List<Pack> packs,
                       ProgressListener listener)

Invoked after packs are installed.

Specified by:

afterPacks in interface InstallerListener

Overrides:

afterPacks in class AbstractInstallerListener

Parameters:

packs - the installed packs

listener - the progress listener

Throws:

IzPackException - for any error

cleanUp

public void cleanUp()

Remove all registry entries on failed installation.

Specified by:

cleanUp in interface CleanupClient

getUninstallName

protected String getUninstallName()

Returns the uninstall name, used to initialise the RegistryHandler.setUninstallName(String).

This implementation returns a concatenation of the APP_NAME and APP_VER variables, separated by a space.

Returns:

the uninstall name