We need you!

Icon

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

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 22 Next »

IzPack provides support to execute Ant tasks during installation and uninstallation.

For example:

In the above:

  • the AntActionsSpec.xml resource determines the Ant tasks to be executed. The base path of src is the installation project path.
  • the <jar/> element specifies jar dependencies required to execute the Ant tasks. At a minimum, this must include the ant jar and ant-launcher.jar.
  • the <listeners> element is used to hook execution of the Ant tasks into the installer and uninstaller
 

Note that an "extended" ant use needs more than one jar, for example often xercesImpl.jar. If an obscure "class not found" exception is raised during testing, check first for missing jar files.

The stage attribute of the jar element determines when a jar is required. If an ant uninstaller custom action is used, the uninstaller also needs the jar files. If stage is "both" or "uninstall", the contents of the referenced jar file will be packed into the uninstaller.

Note that not the jar file itself, but the contents of it are required. This implies, that the paths of the contained files are unique and the information in meta-inf/Manifest.mf will be lost.

The AntActionSpec XML Structure

An ant action is defined in the resource with the id "AntActionsSpec.xml". In IzPack 5.0 (as of 5.0.0-beta-11), an XML-Schema is provided, which may be declared as follows:

 

Prior to processing the packs a substitution is performed using all defined IzPack variables on the spec file. This is a common way of loading spec files into custom actions.

For more information see method com.izforge.izpack.util.SpecHelper.readSpec. If you want to substitute a value in the file, simply add a variable via installData.setVariable in a custom panel before InstallPanel. The given variable name (id) should be written into the xml file in the common variable notation.

The following outlines the sections available in the AntActionsSpec.xml:

antactions

The top level XML section is called <antactions>. The antactions element may contain zero or more pack elements described below:

pack

The pack element is used to tie the action(s) to be performed to the packs selected in the installation. The pack element may have the following attribute:

Name

Description

name

The name of the pack that this pack element maps to.  This should correspond to the name of a pack defined in install.xml

The pack element must contain 1 or more antcall elements.

antcall

The antcall element has the following attributes:

Name

Required

Description

Allowed Values

order

yes

Determine at what point of installation the antcalls defined by element target should be performed. Be aware that with beforepack(s) there are no installed files and also no installed build file. With this order only preexistent build files are useable.

beforepack, afterpack, beforepacks or afterpacks.

uninstall_order

no

Determine at what point of uninstallation the antcalls defined by element uninstall_target should be performed. As opposed to the behaviour of order the referenced files are also accessible in the order afterdeletion. The uninstaller action copies the files into tempfiles before deletion which are marked as deleteOnExit.

beforedeletion,afterdeletion

quiet

no

Whether to log just warnings and errors, be quiet otherwise.
Maps to Ant log level "warning". 

yes or no, default: no

verbose

no

Whether to log verbose information.
Maps to Ant log level "verbose". 

yes or no, default: no

loglevelno

Straight Ant log priority level mapping to the according log levels in Ant projects.
The attributes verbose and quiet have higher priority, if they are used, and "win" over loglevel.
If none of the attributes, quiet, verbose nor loglevel is used, the Ant action log level default to "info".

error, warning, info, verbose, debug

logfile

no

Path to the file where logging should be performed. Note: The logfile should be not marked for uninstallation otherwise it will be deleted too.

Any valid file path (TODO: should verify format)

buildfile

yes, if buildresource not specified

Path to the file which contains the antcall. This is the file you normally use as -buildfile during an ant call via the command line. Variables are not substituted in this file. Variables should be set using ANT properties. Note: Never write an IzPack variable in an ant buildfile.

Any valid file path (TODO: should verify format)

buildresource

yes, if buildfile not specified

The value is the id of the resource which contains the antcall. This resource will be extracted out into a temporary file and the path to this file will be passed as if -buildfile were specified during the ant call via the command line. The temporary file is removed after the ant call. In this file variables are not substituted. For substitution there are properties in ant which can be used. Note: Never write an IzPack variable in an ant buildfile.

A resource id.

dirnoThe working directory for executing the Ant build in buildfile or buildresource. If set, it explicitly overrides the basedir set there and serves as base directory for relative path names accessed during the Ant build.Any valid directory path

messageid

no

If it is defined, the message will be displayed in the InstallPanel whilst performing the ant call.

A string ID which refers to bin/langpacks/installer/<lang>.xml.

conditionnoExecute this action only if the condition is fulfilled.A valid condition string.

In addition to the possible attributes there are some elements may be defined within an antcall element. All elements can be defined zero or more times in an <antcall>. Although all elements are optional, no ANT tasks will be performed unless a <target> element is specified. Do not confuse the following: "required"s are related to the attributes of the elements, not to the elements themselfs.

property

Defines a property to be used with all targets and uninstall_targets which are defined for this antcall.  The following attributes may be defined:

Name

Required

Description

Allowed Values

name

yes

The name of the property to set.

Any string value

value

yes

The value to set for the property.

Any string value

propertyfile

Defines properties to be used, read from a property file which are defined for this antcall.  The following attributes may be defined:

Name

Required

Description

Allowed Values

path

yes

The path to the properties file.

A valid file path.

One way to fill specific data into it is to create a new file in a custom panel and fill it with values given by input fields. The file path can be set at installation time, if there is a variable in AntActionSpec.xml and an IzPack variable was defined before InstallPanel. That file can be only created with deleteOnExit, if no <uninstall_target> was defined in this <antcall>. This implies, that other <antcall>}}s can have a {{<uninstall_target>. <target>: target to call at installation h3. Targets to perform with this antcall at installation time. The targets should be defined in the given buildfile or else an ant exception will be raised. This is that what you use, if you don't want to perform the default target. e.g. cleaning the IzPack project with ant clean.

target

The target to execute in the ANT build file during action specified in the order attribute of the antcall (install time).  Note: Multiple targets to execute for the action may be specified by using multiple target elements.  The following attribute must be defined:

Name

Required

Description

Allowed Values

name

yes

Name of the target to execute in the ANT buildfile

Any valid ANT target defined in the build file.

uninstall_target

Targets to perform with this antcall at uninstallation time. Note: Multiple targets to execute for the action may be specified by using multiple target elements.

Name

Required

Description

Allowed Values

name

yes

Name of the target to execute in the ANT buildfile

Any valid ANT target defined in the build file.

  • No labels