AntZip
An Apache Ant Distribution Package
Overview
AntZip:
An Apache Ant Distribution Package
This type allows for the installation of Ant. Typically this is attached to an AntBuilder or subtype as a dependency to be used in the build process. Refer to objects/sample.xml for example package definitions to use in ProjectBuilder.
Design
- Super Type
- PlatformZip
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
| Notification | false |
| Template Directory | ${modules.dir}/AntZip/templates |
| Data View | Children, proximity: 1 |
| Logger Name | AntZip |
Constraints
Allowed Child Dependencies
- Package
Allowed Parent Dependencies
- Assembly
Allowed Property Values
| Property | Allowed Values | Default | Enforced |
|---|---|---|---|
| package-install-root |
|
|
false |
| package-arch |
|
|
false |
Attributes
Exported Attributes
| Name | Property | Description |
|---|---|---|
| ant_home | package-install-root |
attribute used as Ant's ANT_HOME environment variable |
| ant_version | package-version |
attribute mapped to the version of the apache ant package |
Commands
Note
Commandline options displayed in square brackets "[]" are optional. If an option expects arguments, then angle brackets are shown after the option "<>". Any default value is shown within the brackets.
assertPackageIsInstalled
Confirm the package process is installed.
Checks that bin/ant is available; if so, returns true.
- Usage
- assertPackageIsInstalled [-basedir <>] [-depot <>] [-executable <>] [-installroot <>] [-name <>] [-nodeps] [-nodir] [-nomodule] [-nopackageinstall] [-noproperties] [-script <>] [-subdirs <>] [-type <>]
Options
| Option | Description |
|---|---|
| basedir | instance directory |
| depot | project depot |
| executable | executable to run |
| installroot | package installroot |
| name | object name |
| nodeps | do not install dependencies |
| nodir | do not create directories |
| nomodule | do not update module |
| nopackageinstall | do not install package |
| noproperties | do not update properties |
| script | script to execute |
| subdirs | directory list |
| type | object type |
extract
Extract the package archive.
Checks that the basename of the installroot is the same as the package base name; if not, fails.
- Usage
- extract [-base <>] -filename <> [-filtersfile <>] -installroot <> -url <>
Options
| Option | Description |
|---|---|
| base | package base name |
| filename | the filename |
| filtersfile | filtersfile |
| installroot | the install root |
| url | the repo url |
finish
finishes the installation
Sets the files in the bin directory executable.
- Usage
- finish -filename <> [-filtersfile <>] [-filtersfile <>] -installroot <> [-script <>] -url <>
Options
| Option | Description |
|---|---|
| filename | the filename |
| filtersfile | filtersfile |
| filtersfile | property file |
| installroot | the install root |
| script | script to execute |
| url | the repo url |