We need you!

Icon

The IzPack documentation needs work, and you are invited to edit it!

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Warning

This documentation applies from version 5.0.0-beta11, which is not yet released.

Note
titleUsing IzPack 5.0-beta10 and below

ConfigurationInstallerListener is new to IzPack 5.0, and since beta10 has been completely refactored. See the original documentation for all IzPack releases before beta11, and consider upgrading to the latest release/pre-release version as soon as possible. Following the final release of 5.0.0, the old documentation will be removed.

ConfigurationInstallerListener

Create, update, patch, and merge application configuration settings during installation. Supported configuration types are:

  • property/option files
  • INI files
  • XML files
  • Windows registry (and 'registry editor' files) 

Conditional execution and dynamic variables are supported in the specification of configuration actions. Add the ConfigurationInstallerListener to your installer by adding the following tag inside the <listeners> element.

Code Block
languagehtml/xml
<listener classname="ConfigurationInstallerListener" stage="install"/>

This listener does not currently support either the uninstall or compile listener stages.

Required Configuration

The following are required in addition to the listener declaration in install.xml.

ConfigurationActionsSpec.xml 

Required XML resource file defining all configuration actions and variables. The resource ID for the default spec file in ConfigurationActionsSpec.xml. For details of configuration spec options, see Configuration Actions Specification.

Code Block
languagehtml/xml
<res id="ConfigurationActionsSpec.xml" src="resources/configurationSpec.xml"/>

This tag should be defined in the <resources> element in install.xml