com.izforge.izpack.event

Class ConfigurationInstallerListener

java.lang.Object

com.izforge.izpack.api.event.AbstractInstallerListener

com.izforge.izpack.event.AbstractProgressInstallerListener

com.izforge.izpack.event.ConfigurationInstallerListener

All Implemented Interfaces:

InstallationListener, InstallerListener

public class ConfigurationInstallerListener
extends AbstractProgressInstallerListener

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ConfigurationInstallerListener.ConfigType

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONDITION_ATTR
static String	CONFIGURABLE_ATTR
static String	CONFIGURABLESET_ATTR
static String	CONFIGURATIONACTION_ATTR
static String	SPEC_FILE_NAME Name of the specification file

Constructor Summary

Constructors

Constructor and Description
ConfigurationInstallerListener(InstallData installData, Resources resources, VariableSubstitutor replacer, ProgressNotifiers notifiers) Constructs a ConfigurationInstallerListener.

Method Summary

Modifier and Type	Method and Description
void	afterPack(Pack pack) Invoked after a pack is installed.
void	afterPacks(List<Pack> packs, ProgressListener listener) Invoked after packs are installed.
void	beforePack(Pack pack) Invoked before a pack is installed.
void	beforePacks(List<Pack> packs) Invoked before packs are installed.
Map<String,Map<Object,List<ConfigurationAction>>>	getActions() Returns the actions map.
protected List<ConfigurationAction>	getActions(String packName, String order) Returns the defined actions for the given pack in the requested order.
protected String	getAttribute(IXMLElement element, String attribute)
void	initialise() Initialises the listener.
protected void	parseError(IXMLElement parent, String message) Create parse error with consistent messages.
protected void	parseError(String message) Create parse error with consistent messages.
void	readAndAddEntries(IXMLElement parent, SingleConfigurableTask task)
protected List<ConfigurationActionTask>	readConfigurables(IXMLElement parent)
protected List<ConfigurationActionTask>	readConfigurableSets(IXMLElement parent)
protected Properties	readVariables(IXMLElement parent)
protected String	requireAttribute(IXMLElement element, String attribute) Call getAttribute on an element, producing a meaningful error message if not present, or empty.

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, beforeDir, beforeFile, 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

Name of the specification file

See Also:

Constant Field Values

CONFIGURATIONACTION_ATTR

public static final String CONFIGURATIONACTION_ATTR

See Also:

Constant Field Values

CONFIGURABLESET_ATTR

public static final String CONFIGURABLESET_ATTR

See Also:

Constant Field Values

CONFIGURABLE_ATTR

public static final String CONFIGURABLE_ATTR

See Also:

Constant Field Values

CONDITION_ATTR

public static final String CONDITION_ATTR

See Also:

Constant Field Values

Constructor Detail

ConfigurationInstallerListener

public ConfigurationInstallerListener(InstallData installData,
                                      Resources resources,
                                      VariableSubstitutor replacer,
                                      ProgressNotifiers notifiers)

Constructs a ConfigurationInstallerListener.

Parameters:

installData - the installation data

resources - the resources

replacer - the variable replacer

notifiers - the progress notifiers

Method Detail

getActions

public Map<String,Map<Object,List<ConfigurationAction>>> getActions()

Returns the actions map.

Returns:

the actions map

initialise

public void initialise()

Initialises the listener.

Specified by:

initialise in interface InstallationListener

Overrides:

initialise in class AbstractInstallerListener

Throws:

IzPackException - for any error

beforePacks

public void beforePacks(List<Pack> packs)

Invoked before packs are installed.

Specified by:

beforePacks in interface InstallerListener

Overrides:

beforePacks in class AbstractInstallerListener

Parameters:

packs - the packs to be installed

Throws:

IzPackException - for any error

beforePack

public void beforePack(Pack pack)

Invoked before a pack is installed.

Specified by:

beforePack in interface InstallerListener

Overrides:

beforePack in class AbstractInstallerListener

Parameters:

pack - the pack

Throws:

IzPackException - for any error

afterPack

public void afterPack(Pack pack)

Invoked after a pack is installed.

Specified by:

afterPack in interface InstallerListener

Overrides:

afterPack in class AbstractInstallerListener

Parameters:

pack - the pack

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

getActions

protected List<ConfigurationAction> getActions(String packName,
                                               String order)

Returns the defined actions for the given pack in the requested order.

Parameters:

packName - name of the pack for which the actions should be returned

order - order to be used; valid are beforepack and afterpack

Returns:

a list which contains all defined actions for the given pack and order

readConfigurableSets

protected List<ConfigurationActionTask> readConfigurableSets(IXMLElement parent)
                                                      throws InstallerException

Throws:

InstallerException

readConfigurables

protected List<ConfigurationActionTask> readConfigurables(IXMLElement parent)
                                                   throws InstallerException

Throws:

InstallerException

readAndAddEntries

public void readAndAddEntries(IXMLElement parent,
                              SingleConfigurableTask task)
                       throws InstallerException

Throws:

InstallerException

readVariables

protected Properties readVariables(IXMLElement parent)
                            throws InstallerException

Throws:

InstallerException

requireAttribute

protected String requireAttribute(IXMLElement element,
                                  String attribute)
                           throws InstallerException

Call getAttribute on an element, producing a meaningful error message if not present, or empty. It is an error for 'element' or 'attribute' to be null.

Parameters:

element - The element to get the attribute value of

attribute - The name of the attribute to get

Throws:

InstallerException

getAttribute

protected String getAttribute(IXMLElement element,
                              String attribute)
                       throws InstallerException

Throws:

InstallerException

parseError

protected void parseError(String message)
                   throws InstallerException

Create parse error with consistent messages. Includes file name.

Parameters:

message - Brief message explaining error

Throws:

InstallerException

parseError

protected void parseError(IXMLElement parent,
                          String message)
                   throws InstallerException

Create parse error with consistent messages. Includes file name and line # of parent. It is an error for 'parent' to be null. *

Parameters:

parent - The element in which the error occured

message - Brief message explaining error

Throws:

InstallerException