Advanced features

Apache Ant integration

IzPack can be easily integrated inside an Ant build process. To do so you first need to tell Ant that you would like to use IzPack:

<!-- Allows us to use the IzPack Ant task -->
<taskdef name="IzPack" classpath="${basedir}/lib/compiler.jar"
         classname="com.izforge.izpack.ant.IzPackTask"/>

If you want to use the standalone compiler (and therefore don't need an IzPack installation for building), the task needs to be defined as follows:

<!-- Allows us to use the IzPack Ant task -->
<taskdef name="IzPack" classpath="${basedir}/lib/standalone-compiler.jar"
         classname="com.izforge.izpack.ant.IzPackTask"/>
Don't forget to add compiler.jar or standalone-compiler.jar to the classpath of the Ant process.

Then you can invoke IzPack with the IzPack task which takes the following parameters:

Here is a sample of the task invocation:

<!-- We call IzPack -->
<echo message="Makes the installer using IzPack"/>
<IzPack input="${dist.dir}/IzPack-install.xml"
        output="${dist.dir}/IzPack-install.jar"
        installerType="standard"
        basedir="${dist.dir}"
        IzPackDir="${dist.dir}/"/>

Embedding the installation file using a config element

Instead of using the 'input' attribute to specify an external installation document, you can embed the installation config as a child of the IzPack task using a config child element with a CDATA section. For example:

<property name="jboss.home.url" value="http://www.jboss.com/" />
...

<!-- Call IzPack with an embedded install using the config element -->
<IzPack output="${dist.dir}/IzPack-install.jar"
        installerType="standard"
        basedir="${dist.dir}"
        IzPackDir="${dist.dir}/">
        <config><![CDATA[
<installation version="1.0">
   <info>
      <appname>JBossAS</appname>
      <appversion>4.0.2</appversion>
      <appsubpath>jboss-4.0.2</appsubpath>
      <authors>
         <author name="JBoss Inc." email="sales@jboss.com"/>
      </authors>
      <url>@{jboss.home.url}</url>
      <javaversion>1.4</javaversion>
   </info>
...
        ]]></config>
</IzPack>

Property references of the form

@{x}

are replaced by the associated x ant property if it is defined.

A few variables are made available by both Ant and IzPack:

System properties as variables

All system properties are available as '$SYSTEM_<variable>' where '<variable>' is the actual name but with all separators replaced by '_'. Properties with null values are never stored.

Examples:

'$SYSTEM_java_version' or '$SYSTEM_os_name'

Unattended installations

Installations using saved records of user inputs

When you conclude your installation with a FinishPanel, the user can save the data for an automatic installation. With this data, he will be able to run the same installation on another similar machine. In an environment where many computers need to be supported this can save a lot of time.

So run once the installation on a machine and save your automatic installation data in auto-install.xml (that's just a sample). Then put this file in the same directory as the installer on another machine. Run it with:

java -jar installer.jar auto-install.xml

It reproduced the same installation.

Installations using properties

IzPack installers can be executed replacing possible user inputs from properties, which can be overgiven either in property files or directly specified on the command line.

Examples:

java -jar myinstaller.jar \
     -options-template myinstaller.properties

Generates a properties file myinstaller.properties with all user-changeable variables provided by my myinstaller. The property INSTALL_PATH is always exported. There will be only the property keys, the names are left empty and must be added manually.

java -jar myinstaller.jar \
     -options myinstaller.properties

Executes an unattended installation replacing possible user inputs by the property values defined in the file myinstaller.properties. An empty template of the property file can be created for each compiled installer using -options-template.

java -DINSTALL_PATH=/opt/myplace \
     -jar myinstaller.jar \
     -options-system

Executes myinstaller in unattended mode in a UNIX console and forces the main installation path to be set to /opt/myplace.

Console installations

An IzPack installer can be run in a full headless mode, i.e., without needing a graphical user interface. This is useful, e.g., in the case of remotely accessed servers through SSH or similar means.

It differs from automated installers in the sense that a console installer is not "just" a replay of a previous installation but a true console-based installation. It shares a common feature though: it can be automated as well.

To launch an installer in console mode rather than in GUI mode (the default), you can specify one of the following parameters on the command line:

Example:

To launch an interactive console installation, just type in a console:

java -jar installer.jar -console

Picture on the Language Selection Dialog

You can add a picture on the language selection dialog by adding the following resource : 'installer.langsel.img'. GIF, JPEG and PNG pictures are supported starting from J2SE 1.3.

Picture in the installer

It is possible to specify an optional picture to display on the left side of the installer. To do this, you just have to define a resource whose id is 'Installer.image'. For instance

<res id="Installer.image" src="nice-image.png" />

will do that. If the resource isn't specified, no picture will be displayed at all. GIF, JPEG and PNG pictures are supported starting from J2SE 1.3.

You can also give a specific picture for a specific panel by using the 'Installer.image.n' resource names where is the panel index. For instance if you want a specific picture for the third panel, use 'Installer.image.2' since the indexes start from 0.

Modifying the GUI

There are some options to modify the graphic user interface. Most of them are managed with key/value pairs of the element '<modifier>' which will be located in the element '<guiprefs>' in the installation description file.

Modifying Language Selection Dialog

Additional to the picture in the language selection dialog it is possible to modify flags and the type of showing the language name. Following different views (without an images to reduce space).

Modifying IzPack Panels

There are some graphic elements and behavior which are preferred by some people and deprecate by other. The following keys are related to the whole installation (all panels).

It is possible to use an alternatively frame title. Normally the title has the aspect "IzPack - Installation of " + '$APP_NAME'. If the langpack key 'installer.reversetitle' is defined, the value of that key will be used instead of the key 'installer.title'. There is no string added, but it is possible to use IzPack variables. The third heading example contains such a alternatively frame title. It is only possible to use predefined variables like '$APP_NAME' because the title will be created before the frame will be shown. It is common to use the name of the installation toolkit in the frame title.

Using a Separated Heading Panel

Some standard panels have headings (e.g. ShortcutPanel). These headings are integrated in the IzPanel. In opposite to this following heading will be displayed in a separated panel potential for all panels with the same design. There is no need to modify existent java classes else declaration of some key/value pairs are enough.

There can be one real head and zero or more info lines. The headline will be written bold, the font size can be changed. Info lines will be indented and written with the normal used font. The heading message has to be written into the langpack (or custom langpack) file with the key '<panel class name>.headline'. Examples can be seen in eng.xml. May be the entries for standard panels are not present in other languages. Messages for info lines have the key '<panel class name>.headinfo<info line number>'. First info line has number zero. If no or empty headline messages will be declared in the chosen language no heading panel will be shown. This behavior can be used to suppress heading for special panels.

It is also possible to declare head and info lines additional dependent on the 'panelid'. The result is, that it is possible to declare different messages for panels which are shown more than one time (e.g. the UserInputPanel. In this case the key for heading is

<panel class name>.headline.<panelid>

and for info lines

<panel class name>.headinfo<info line number>.<panelid>

Panelids are declared in 'ELEMENT %lt;panel>'. See The Panels Element '<panels>' . The standard strings are declared in the standard langpack file. For customized panels it is common to write the string into the custom langpack (see The Internationalization of custom panels. If (as example) in install.xml was following written:

<panels>
    ...
    <panel classname="UserInputPanel" id="one"/>
    <panel classname="UserInputPanel"id="two"/>
    ...
</panels>

Then the messages can be declared in 'CustomLangpack.xml_eng' like

<langpack>
    ...
    <str id="UserInputPanel.headline.one" txt="User Data one"/>
    <str id="UserInputPanel.headline.two" txt="User Data two"/>
    <str id="UserInputPanel.headinfo0.one" txt="Info 1 one"/>
    <str id="UserInputPanel.headinfo1.one" txt="Info 2 one"/>
    <str id="UserInputPanel.headinfo0.two" txt="Info 1 two"/>
    <str id="UserInputPanel.headinfo1.two" txt="Info 2 two"/>
    ...
<langpack>

It is possible to place an icon on the right side of the heading (see below to display on left side). To do this a simple resource entry will be needed:

<resources>
  ...
  <res id="Heading.image" src="[my path in the source tree]"/>
  ...
</resources>

There are some guiprefs modifier keys to use and modify heading (see above). Additionally it is possible to count the general not hidden panels in the heading or navigation panel.

Key/value pairs to create IzPack installation with heading, no button and label icons and a panel text counter in the heading panel.

<guiprefs width="600" height="480" resizable="no">
  <modifier key="useButtonIcons" value="no"/>
  <modifier key="useLabelIcons" value="no"/>
  <modifier key="labelGap" value="2"/>
  <modifier key="layoutAnchor" value="NORTHWEST"/>
  <modifier key="useHeadingPanel" value="yes"/>
  <modifier key="headingImageOnLeft" value="yes"/>
  <modifier key="headingLineCount" value="1"/>
  <modifier key="headingFontSize" value="1.5"/>
  <modifier key="headingBackgroundColor" value="0x00ffffff"/>
  <modifier key="headingPanelCounter" value="text"/>
  <modifier key="headingPanelCounterPos" value="inHeading"/>
</guiprefs>

Changed resources and langpack keys to create IzPack installation with alternatively frame title, heading, no button and label icons and a text counter in the heading panel.

In install.xml

<installation version="1.0">
  ...
  <resources>
    ...
    <res src="border4.png" id="Installer.image.3"/> REMOVED
    ...
  </resources>
</installation>

Add in '<ISO3>.xml' or 'CustomLangpack.xml_<ISO3>'

<langpack>
  ...
  <str id="installer.reversetitle" txt="$APP_NAME $APP_VER - IzPack Wizard "/>
  ...
</langpack>

Changed key/value pairs to create IzPack installation with heading, no button and label icons and a panel progressbar counter in the navigation panel.

Key/value pairs for modifying IzPack GUI (references for panel images removed):

<guiprefs width="640" height="480" resizable="no">
  <modifier key="useButtonIcons" value="no"/>
  <modifier key="useLabelIcons" value="no"/>
  <modifier key="layoutAnchor" value="NORTHWEST"/>
  <modifier key="labelGap" value="2"/>
  <modifier key="useHeadingPanel" value="yes"/>
  <modifier key="headingLineCount" value="1"/>
  <modifier key="headingFontSize" value="1.5"/>
  <modifier key="headingBackgroundColor" value="0x00ffffff"/>
  <modifier key="headingPanelCounter" value="progressbar"/>
  <modifier key="headingPanelCounterPos" value="inNavigationPanel"/>
</guiprefs>

Don't show pack size in PacksPanel

The PacksPanel dialog supports the modifier doNotShowPackSizeColumn which hides the third column showing the size of each pack. With doNotShowPackSizeColumn set to true, the third column will not be shown. The required size of all packs is still shown with this setting. The required size can be hidden by setting the doNotShowRequiredSize to true.

Example :

<guiprefs width="640" height="480" resizable="no">
   ...
   <modifier key="doNotShowPackSizeColumn" value="true"/>
   <modifier key="doNotShowRequiredSize" value="yes"/>
   ...
 </guiprefs>

The PacksPanel will not show the column with the sizes of each pack, but will show the total required space.

Alternative Cancel Dialog

The cancel dialog will be shown if the cancel button or the close button of the frame was pushed. In the standard dialog the title contains the question and the message an affirmation. In other dialogs often the title is a common heading and the question will be called in the dialog as message. The standard behavior will be modified if the messages 'installer.quit.reversemessage' and 'installer.quit.reversetitleare' declared.

Add in '<ISO3>.xml' or 'CustomLangpack.xml_<ISO3>'

<langpack>
  ...
  <str id="installer.quit.reversemessage" txt="Are you sure you want to cancel installation?"/>
  <str id="installer.quit.reversetitle" txt="$APP_NAME $APP_VER"/>
  ...
</langpack>

Logging the Installation

Logging was made as co-product at implementing other features. There was no common design for it. Therefor there is no one way to made logging of any kind else for each group a different logging stuff exist. Not nice, but reality.

  1. Debug Information
    There is a rudimentary debug capability in IzPack. The class 'com.izforge.IzPack.util.Debug' is used by some other classes to write debug information on 'stdout'. The class can be used by custom panels or actions or other custom classes. To activate it, add '-DTRACE=TRUE' in front of '-jar' of the installer call.
  2. Summary of Panels
    There is a summary panel which shows some information of previous shown panels. The same contents can be written to a summary log file.
  3. Logging of Installed File Set
    The files which are installed are logged into the uninstaller jar file to be used at uninstallation. The contents can be also duplicated into a logfile.
  4. Logging of the Process Panel
    The process panel logs information of each performed process in a scrollable text area. The contents can be duplicated into a logfile where the used directory can be selected (but not the logfile name).
  5. Logging of Ant Actions
    It is possible to perform ant actions with the 'AntActionInstallerListener'. The grade of logging and the path of a logfile can by determined.

Web Installers

The web installers allow your users to download a small installer that does not contain the files to install. These files will be downloaded from an HTTP server such as Apache HTTPD. If you have many optional packs, this can save people's resources. Its very easy: people download a small Jar file containing the installer, they launch it and choose their packages. Then the installer will get the required packages from individual Jar files located on a server, only downloading those required. It's that simple.

To create a web installer, add the '<webdir>' element to the <info> element. The text must be a valid, fully qualified URL for a directory on the web server.

<info>
  <appname>Super extractor</appname>
  <appversion>2.1 beta 6</appversion>
  <url>http://www.superextractor.com/</url>
  <webdir>http://www.superextractor.com/download</url>
</info>

By default, the compiler will create a standard installer even if 'webdir' is specified. You can generate your web installer with the 'web' option like this :

compile installer.xml -k web

It will generate a jar for each pack and an installer jar. For instance, the sample installation will generate those 4 jars.

install.jar
install.pack-Base.jar
install.pack-Docs.jar
install.pack-Sources.jar

The pack jars must be copied in the webdir. The installer generated is configured as a web installer and will download those packs if necessary.

When installing, if the user is behind a firewall, attempting download the jar files may fail. If this happens, the user will be prompted to enter the name host name and port of their firewall.

You may password protect the files using mechanisms provided by your web server, IzPack will prompt for a password at install time, when required.

More Internationalization

Special resources

IzPack is available in several languages. However you might want to internationalize some additional parts of your installer. In particular you might want this for the 'InfoPanel' and 'LicencePanel'. This is actually pretty easy to do. You just have to add one resource per localization, suffixed with the ISO3 language code. At runtime these panels will try to load a localized version.

For instance let's suppose that we use a 'HtmlInfoPanel'. Suppose that we have it in English, French and German. We want to have a French text for french users. Here we add a resource pointing to the French text whose name is 'HtmlInfoPanel.info_fra'. And that's it! English and German users (or anywhere other than in France) will get the default text (denoted by 'HtmlInfoPanel.info') and the French users will get the French version. Same thing for the other Licence and Info panels.

To sum up: add '_<iso3 code>' to the resource name for 'InfoPanel', 'HtmlInfoPanel', 'LicencePanel' and 'HtmlLicencePanel'.

Packs

Thanks to Thorsten Kamann, it is possible to translate the packs names and descriptions. To do that, you have to define a special identifier in the elements of the XML installation file and add the related entries in the suitable langpacks. For instance if you have the following XML snippet:

<pack name="core" id="core.package" ...>
  <description/>
</pack>

then the related entries of the langpacks will look like this:

<str id="core.package" txt="Core Package"/>
<str id="core.package.description" txt="The core package provides

Validators for Packs

It's possible to create custom java validators (as you may know from Panels (http://{{SERVERNAME}}/installation-files.html#validator-optional-validation-on-idata)). To do that, add the validator element to your packs definition like this:

<pack name="foo" id="foo.package" ...>
  <validator>my.Validatorclass</validator>
</pack>

Now you have to create and include a class implementing the 'PackValidator' interface:

package my;
import com.izforge.izpack.installer.InstallData;
import com.izforge.izpack.panels.treepacks.PackValidator;
import com.izforge.izpack.api.handler.AbstractUIHandler;
public class Validatorclass implements PackValidator {
  public boolean validate(AbstractUIHandler handler,
      InstallData idata, String packsId, boolean isSelected) {
    [ your validation code here ]
    return false; // returns to the pack selection without further notice
    return true; // passes on to the next defined validator for this pack
  }
}

Automatic privileges elevation on Windows

As an alternative to using the <run-privileged> element, a Java launcher EXE with the name setup.exe or install.exe can be used (see http://msdn.microsoft.com/en-us/library/bb530410.aspx).

Windows Vista has a feature called "installer detection". When an EXE file name contains one of the words install, setup or update, the operating system automatically prompts the user for UAC privilege elevation when the program is started. This automatic privilege elevation can be overridden using a manifest file for the EXE and setting the requestedExecutionLevel in the manifest.

Replacing blocked files after reboot on Windows

All Windows systems block executable files that are currently in use, as device drivers, EXE, DLL and even JAR files. Normally, a running application is to be shut down before such files can be overwritten, for instance by an IzPack installer. This might fit most of the use cases IzPack is used with.

There can be situations where the application cannot be shut down at the installation time, but has to be updated anyway. This is where this new feature comes into the game.

Microsoft offers a Windows API for handling such cases: Setup API. From the view of the pure interface it has been quiet stable over the different Windows distributions. Although Microsoft recommends using it only for installing device drivers Setup API can be used for any kind of file to be installed. Several independent installers which are not based on Windows Installer make usage of it. For example, the native NSIS installer uses a /rebootok flag for copying files which might be potentially in use.

Here is how blockable file handling is integrated into IzPack:

Lets start with an example of install.xml:

<installation version="1.0">

  <info>
    ...
    <rebootaction>ask</rebootaction>
    ...
  </info>

  ...

  <native type="izpack" name="WinSetupAPI.dll">
    <os family="windows"/>
  </native>

  ...

  <packs>
    <pack name="Core files" required="yes">
      <description>The core files needed for this test</description>
      <singlefile
       src="plain/my_exefile_v1.exe"
       target="${INSTALL_PATH}/my_exefile.exe"
       override="true" blockable="auto"/>
    </pack>
  </packs>

</installation>

Explanation:

The file ${INSTALL_PATH}/my_exefile.exe on the target system is assumed to be potentially running and therefore blocked at installation time, for instance as a system service. It might be not convenient to shut it down before installation. Instead, we intend to replace it after the next system reboot.

For this purpose we mark the according file as blockable. The value auto means that the OS recognizes automatically whether the file is blocked or not, instead of forcing marking it blocked (using force). If it is blocked it will be internally enqueued by Windows to be replaced after a system reboot. Otherwise the file is overwritten directly due to the override=true. If we had override=false and the file would be blocked during installation time copying of the file would be skipped as expected.

With <rebootaction>ask</rebootaction> we force IzPack to ask the user in case of using interactive installers whether the system should be rebooted immediately. The user has the chance to confirm or deny the reboot action. Anyway, if there are pending file operations the system has to be rebooted sooner or later to apply the changes that came with the installation.

The blockable attribute applies also on the packs elements file and fileset. For using it there must be included the WinSetupAPI.dll as can be seen above. This library is built-in into IzPack natively.

Note that if there no explicit constraint for the OS family = windows defined on the according parent element file, singlefile or fileset copying a file with a valid blockable value different to none there is a compiler warning given to the user:

"blockable" will implicitely apply only on Windows target systems

Anyway, it is possible to mark files as blockable even for multi-platform installations, for instance in case of blockable jar files. The blockable attribute will be simply ignored on non-Windows platforms, resulting in a "classic" behaviour for copying files.

For a complete specification of the according elements and attributes see the documentation of <rebootaction> and blockable in the chapter Writing Installation XML Files.