com.izforge.izpack.installer.automation
Interface PanelAutomation

public interface PanelAutomation

Defines the Interface that must be implemented for running Panels in automated (or "silent", "headless") install mode.

Implementing classes MUST NOT link against awt/swing classes. Thus the Panels cannot implement this interface directly, they should use e.g. helper classes instead.

Author:

Jonathan Halliday, Julien Ponge

See Also:

AutomatedInstaller

Method Summary

void	createInstallationRecord(InstallData installData, IXMLElement rootElement) Creates an installation record for unattended installations and adds it to a XML root element.
void	processOptions(InstallData installData, Overrides overrides) Process options delivered to the installer from outside.
void	runAutomated(InstallData installData, IXMLElement panelRoot) Makes the panel work in automated mode.

Method Detail

createInstallationRecord

void createInstallationRecord(InstallData installData,
                              IXMLElement rootElement)

Creates an installation record for unattended installations and adds it to a XML root element.

Parameters:

installData - The installation data

rootElement - The root element to add panel-specific child elements to

runAutomated

void runAutomated(InstallData installData,
                  IXMLElement panelRoot)
                  throws InstallerException

Makes the panel work in automated mode. Default is to do nothing, but any panel doing something 'effective' during the installation process should implement this method.

Parameters:

installData - The installation data

panelRoot - The XML root element of the panels blackbox tree.

Throws:

InstallerException - if the automated work failed critically.

processOptions

void processOptions(InstallData installData,
                    Overrides overrides)

Process options delivered to the installer from outside.

These options are additionally helt as variables overrides, there is no need to explicitely set installer variables of the same name.

This method is not called if an installation record exists for this panel in an auto-install.xml (e.g. in this case @(see runAutomated) is launched).

Parameters:

installData - the runtime data of the installer session

overrides - the variable overrides