com.izforge.izpack.api.data

Class AutomatedInstallData

java.lang.Object

com.izforge.izpack.api.data.AutomatedInstallData

All Implemented Interfaces:

InstallData

public class AutomatedInstallData
extends Object
implements InstallData

Encloses information about the install process. This implementation is not thread safe.

Author:

Julien Ponge , Johannes Lehtinen

Field Summary

Fields

Modifier and Type	Field and Description
static String	AUTOINSTALL_PANELROOT_ATTR_ID The attribute for a panel ID in the auto-install.xml record
static String	DEFAULT_INSTALL_DRIVE The default install drive (Windows only, otherwise not set)
static String	DEFAULT_INSTALL_PATH The default install path
static String	INSTALL_DRIVE The install drive (Windows only, otherwise not set)

Fields inherited from interface com.izforge.izpack.api.data.InstallData

ESTIMATED_SIZE, INSTALL_PATH, INSTALLATION_INFORMATION, INSTALLER_MODE, INSTALLER_MODE_AUTO, INSTALLER_MODE_CONSOLE, INSTALLER_MODE_GUI, MEDIA_PATH, MODIFY_INSTALLATION

Constructor Summary

Constructors

Constructor and Description
AutomatedInstallData(Variables variables, Platform platform) Constructs an AutomatedInstallData.

Method Summary

Modifier and Type	Method and Description
List<Pack>	getAllPacks() Returns all packs.
Object	getAttribute(String name) Returns the value of the named attribute.
Map<String,Object>	getAttributes()
List<Pack>	getAvailablePacks() Returns the packs available to be installed on the current platform.
String	getDefaultInstallPath() Returns the default install path.
List<DynamicInstallerRequirementValidator>	getDynamicInstallerRequirements() Returns the dynamic installer requirement validators.
Info	getInfo() Returns the installation information.
IXMLElement	getInstallationRecord() Returns the XML data for automated installation.
IXMLElement	getInstallationRecordPanelRoot(String panelId)
List<InstallerRequirement>	getInstallerRequirements() Returns the installer requirements.
String	getInstallPath() Returns the install path.
Locale	getLocale() Returns the current locale.
String	getLocaleISO2() Returns the current locale's ISO2 language code.
String	getLocaleISO3() Returns the current locale's ISO3 language code.
String	getMediaPath() Returns the media path for multi-volume installation.
Messages	getMessages() Returns the localised messages.
List<Panel>	getPanelsOrder() Returns the panels.
Platform	getPlatform() Returns the current platform.
RulesEngine	getRules() Returns the rules.
List<Pack>	getSelectedPacks() Returns the selected packs.
String	getVariable(String name) Returns the current value of the specified variable.
Variables	getVariables() Returns the variables.
boolean	isCanClose() Determines if the installer can close.
boolean	isInstallSuccess() Determines if the installation was successful.
boolean	isRebootNecessary() Determines if a reboot is required after installation.
void	refreshVariables() Refreshes dynamic variables.
void	setAllPacks(List<Pack> allPacks)
void	setAttribute(String name, Object value) Sets a named attribute.
void	setAttributes(Map<String,Object> attributes)
void	setAvailablePacks(List<Pack> availablePacks)
void	setCanClose(boolean canClose)
void	setDefaultInstallPath(String path) Sets the default install path.
void	setDynamicInstallerRequirements(List<DynamicInstallerRequirementValidator> requirements)
void	setInfo(Info info)
void	setInstallationRecord(IXMLElement xmlData)
void	setInstallerRequirements(List<InstallerRequirement> requirements)
void	setInstallPath(String path) Sets the install path.
void	setInstallSuccess(boolean installSuccess) Determines if the installation was successful.
void	setLocale(Locale locale, String code) Sets the locale.
void	setMediaPath(String path) Sets the media path for multi-volume installation.
void	setMessages(Messages messages) Sets the localised messages.
void	setPanelsOrder(List<Panel> panelsOrder)
void	setRebootNecessary(boolean rebootNecessary) Determines if a reboot is required after installation.
void	setRules(RulesEngine rules)
void	setSelectedPacks(List<Pack> selectedPacks) Sets the selected packs.
void	setVariable(String name, String value) Sets a variable to the specified value.

Methods inherited from class java.lang.Object

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

Field Detail

AUTOINSTALL_PANELROOT_ATTR_ID

public static final String AUTOINSTALL_PANELROOT_ATTR_ID

The attribute for a panel ID in the auto-install.xml record

See Also:

Constant Field Values

DEFAULT_INSTALL_PATH

public static final String DEFAULT_INSTALL_PATH

The default install path

See Also:

Constant Field Values

INSTALL_DRIVE

public static final String INSTALL_DRIVE

The install drive (Windows only, otherwise not set)

See Also:

Constant Field Values

DEFAULT_INSTALL_DRIVE

public static final String DEFAULT_INSTALL_DRIVE

The default install drive (Windows only, otherwise not set)

See Also:

Constant Field Values

Constructor Detail

AutomatedInstallData

public AutomatedInstallData(Variables variables,
                            Platform platform)

Constructs an AutomatedInstallData.

Parameters:

variables - the variables

platform - the platform

Method Detail

getVariables

public Variables getVariables()

Returns the variables.

Specified by:

getVariables in interface InstallData

Returns:

the variables

setVariable

public void setVariable(String name,
                        String value)

Sets a variable to the specified value. This is short hand for getVariables().set(name, value).

Specified by:

setVariable in interface InstallData

Parameters:

name - the name of the variable

value - the new value of the variable

See Also:

getVariable(java.lang.String)

getVariable

public String getVariable(String name)

Returns the current value of the specified variable. This is short hand for getVariables().get(name).

Specified by:

getVariable in interface InstallData

Parameters:

name - the name of the variable

Returns:

the value of the variable or null if not set

See Also:

setVariable(java.lang.String, java.lang.String)

refreshVariables

public void refreshVariables()

Refreshes dynamic variables. This is short hand for getVariables().refresh().

Specified by:

refreshVariables in interface InstallData

setInstallPath

public void setInstallPath(String path)

Sets the install path.

Specified by:

setInstallPath in interface InstallData

Parameters:

path - the new install path

See Also:

getInstallPath()

getInstallPath

public String getInstallPath()

Returns the install path.

Specified by:

getInstallPath in interface InstallData

Returns:

the current install path or null if none set yet

See Also:

setInstallPath(java.lang.String)

setDefaultInstallPath

public void setDefaultInstallPath(String path)

Sets the default install path.

Specified by:

setDefaultInstallPath in interface InstallData

Parameters:

path - the default install path

See Also:

getDefaultInstallPath()

getDefaultInstallPath

public String getDefaultInstallPath()

Returns the default install path.

Specified by:

getDefaultInstallPath in interface InstallData

Returns:

the default install path or null if none set yet

See Also:

setDefaultInstallPath(java.lang.String)

setMediaPath

public void setMediaPath(String path)

Sets the media path for multi-volume installation.

Specified by:

setMediaPath in interface InstallData

Parameters:

path - the media path. May be null

getMediaPath

public String getMediaPath()

Returns the media path for multi-volume installation.

Specified by:

getMediaPath in interface InstallData

Returns:

the media path. May be null

getAttribute

public Object getAttribute(String name)

Returns the value of the named attribute.

Specified by:

getAttribute in interface InstallData

Parameters:

name - the name of the attribute

Returns:

the value of the attribute or null if not set

See Also:

setAttribute(java.lang.String, java.lang.Object)

setAttribute

public void setAttribute(String name,
                         Object value)

Sets a named attribute. The panels and other IzPack components can attach custom attributes to InstallData to communicate with each other. For example, a set of co-operating custom panels do not need to implement a common data storage but can use InstallData singleton. The name of the attribute should include the package and class name to prevent name space collisions.

Specified by:

setAttribute in interface InstallData

Parameters:

name - the name of the attribute to set

value - the value of the attribute or null to unset the attribute

See Also:

getAttribute(java.lang.String)

getRules

public RulesEngine getRules()

Description copied from interface: InstallData

Returns the rules.

Specified by:

getRules in interface InstallData

Returns:

the rules

setRules

public void setRules(RulesEngine rules)

getLocaleISO3

public String getLocaleISO3()

Description copied from interface: InstallData

Returns the current locale's ISO3 language code.

Specified by:

getLocaleISO3 in interface InstallData

Returns:

the current locale's ISO3 language code. May be null

getLocaleISO2

public String getLocaleISO2()

Description copied from interface: InstallData

Returns the current locale's ISO2 language code.

Specified by:

getLocaleISO2 in interface InstallData

Returns:

the current locale's ISO2 language code. May be null

getLocale

public Locale getLocale()

Description copied from interface: InstallData

Returns the current locale.

Specified by:

getLocale in interface InstallData

Returns:

the current locale. May be null

setLocale

public void setLocale(Locale locale,
                      String code)

Sets the locale.

NOTE: for backwards compatibility, this sets the ISO3 variable to be the the lowercase version of the supplied ISO code.

Parameters:

locale - the locale

code - the 3 character ISO code used to select the locale. May be an ISO country code or an ISO language code

setMessages

public void setMessages(Messages messages)

Sets the localised messages.

Parameters:

messages - the localised messages

getMessages

public Messages getMessages()

Returns the localised messages.

Specified by:

getMessages in interface InstallData

Returns:

the localised messages

getInfo

public Info getInfo()

Description copied from interface: InstallData

Returns the installation information.

Specified by:

getInfo in interface InstallData

Returns:

the installation information

setInfo

public void setInfo(Info info)

getPlatform

public Platform getPlatform()

Returns the current platform.

Specified by:

getPlatform in interface InstallData

Returns:

the current platform

getAllPacks

public List<Pack> getAllPacks()

Description copied from interface: InstallData

Returns all packs.

Specified by:

getAllPacks in interface InstallData

Returns:

the packs

setAllPacks

public void setAllPacks(List<Pack> allPacks)

getAvailablePacks

public List<Pack> getAvailablePacks()

Description copied from interface: InstallData

Returns the packs available to be installed on the current platform.

Specified by:

getAvailablePacks in interface InstallData

Returns:

the available packs

setAvailablePacks

public void setAvailablePacks(List<Pack> availablePacks)

getSelectedPacks

public List<Pack> getSelectedPacks()

Description copied from interface: InstallData

Returns the selected packs.

Specified by:

getSelectedPacks in interface InstallData

Returns:

the selected packs

setSelectedPacks

public void setSelectedPacks(List<Pack> selectedPacks)

Description copied from interface: InstallData

Sets the selected packs.

Specified by:

setSelectedPacks in interface InstallData

Parameters:

selectedPacks - the selected packs

getPanelsOrder

public List<Panel> getPanelsOrder()

Description copied from interface: InstallData

Returns the panels.

Specified by:

getPanelsOrder in interface InstallData

Returns:

the panels

setPanelsOrder

public void setPanelsOrder(List<Panel> panelsOrder)

isCanClose

public boolean isCanClose()

Description copied from interface: InstallData

Determines if the installer can close.

Specified by:

isCanClose in interface InstallData

Returns:

true if the installer can close; otherwise false

setCanClose

public void setCanClose(boolean canClose)

isInstallSuccess

public boolean isInstallSuccess()

Description copied from interface: InstallData

Determines if the installation was successful.

NOTE: the result of this method is undefined until the panels have completed or failed.

Specified by:

isInstallSuccess in interface InstallData

Returns:

true if the installation was successful

setInstallSuccess

public void setInstallSuccess(boolean installSuccess)

Description copied from interface: InstallData

Determines if the installation was successful.

Specified by:

setInstallSuccess in interface InstallData

Parameters:

installSuccess - if true indicates installation was successful

isRebootNecessary

public boolean isRebootNecessary()

Description copied from interface: InstallData

Determines if a reboot is required after installation.

Specified by:

isRebootNecessary in interface InstallData

Returns:

true if a reboot is required

setRebootNecessary

public void setRebootNecessary(boolean rebootNecessary)

Description copied from interface: InstallData

Determines if a reboot is required after installation.

Specified by:

setRebootNecessary in interface InstallData

Parameters:

rebootNecessary - if true indicates a reboot is required

getInstallationRecord

public IXMLElement getInstallationRecord()

Description copied from interface: InstallData

Returns the XML data for automated installation.

Specified by:

getInstallationRecord in interface InstallData

Returns:

the XML data

getInstallationRecordPanelRoot

public IXMLElement getInstallationRecordPanelRoot(String panelId)

setInstallationRecord

public void setInstallationRecord(IXMLElement xmlData)

getAttributes

public Map<String,Object> getAttributes()

setAttributes

public void setAttributes(Map<String,Object> attributes)

getDynamicInstallerRequirements

public List<DynamicInstallerRequirementValidator> getDynamicInstallerRequirements()

Description copied from interface: InstallData

Returns the dynamic installer requirement validators.

These are evaluated on each panel change.

Specified by:

getDynamicInstallerRequirements in interface InstallData

Returns:

the dynamic installer requirement validators

setDynamicInstallerRequirements

public void setDynamicInstallerRequirements(List<DynamicInstallerRequirementValidator> requirements)

setInstallerRequirements

public void setInstallerRequirements(List<InstallerRequirement> requirements)

getInstallerRequirements

public List<InstallerRequirement> getInstallerRequirements()

Description copied from interface: InstallData

Returns the installer requirements.

These are evaluated prior to installation, to ensure all prerequisites are met.

Specified by:

getInstallerRequirements in interface InstallData

Returns:

the installer requirements