====== Downloads ======
{{indexmenu_n>2}}

<hi #ffd700>~~SP~~~~SP~~</hi> Each JWare/AntXtras Foundation release consists of three packages: binaries, documents, and source. Every package has an associated hash value and a GPG-generated signature so you can verify its integrity. To authenticate a package with any PGP or GnuPG application, download [[:general:JWare-GnuPG.KEYS|our KEYS file]] and import it into your public keyring.  

== Stable Releases ==
//<color #ff0000>You should use the newest AntXtras v2 or v3 series if possible!</color>// For older releases or a full download inventory, visit the AntXtras [[http://sourceforge.net/project/showfiles.php?group_id=112448&package_id=121674|SF.net release area]]. Typical contents of a package are described in the included [[/wiki-include/antxtras/latest/README-FIRST.txt|readme-first]] file. Read our [[:antxtras:ourplans|Future Plans]] section to learn the differences between the v1, v2, and v3 series.

^ Package Type~~SP~~~~SP~~   ^ v1 Series [for Ant 1.6]  ^ v2 Series [for Ant 1.7]  ^ v3 Series [for Ant 1.8]  ^
| Binaries    | [[http://downloads.sourceforge.net/antxtras/antxtras_0.5.1-build33_bin.zip|antxtras_binaries_0.5.1.zip]]  | [[http://sourceforge.net/projects/antxtras/files/antxtras/2.0.1/antxtras_2.0.1-build1123.8_bin.zip/download|antxtras_2.0.1_bin.zip]] ([[http://downloads.sourceforge.net/project/antxtras/antxtras/2.0.1/antxtras_2.0.1-build1123.8_bin.zip.sig|sig]])  | [[http://sourceforge.net/projects/antxtras/files/antxtras/3.0.0/antxtras_3.0.0-build1225.39_bin.zip/download|antxtras_3.0.0_bin.zip]] ([[http://downloads.sourceforge.net/project/antxtras/antxtras/3.0.0/antxtras_3.0.0-build1225.39_bin.zip.sig|sig]])  |
| Documents | [[http://downloads.sourceforge.net/antxtras/antxtras_0.5.1-build33_api.zip|antxtras_apidocs_0.5.1.zip]]  | [[http://sourceforge.net/projects/antxtras/files/antxtras/2.0.1/antxtras_2.0.1-build1123.8_doc.zip/download|antxtras_2.0.1_doc.zip]] ([[http://downloads.sourceforge.net/project/antxtras/antxtras/2.0.1/antxtras_2.0.1-build1123.8_doc.zip.sha1|sha]])  | [[http://sourceforge.net/projects/antxtras/files/antxtras/3.0.0/antxtras_3.0.0-build1225.39_doc.zip/download|antxtras_3.0.0_doc.zip]]  |
| Sources | [[http://downloads.sourceforge.net/antxtras/antxtras_0.5.1-build33_src.zip|antxtras_sources_0.5.1.zip]]  | [[http://sourceforge.net/projects/antxtras/files/antxtras/2.0.1/antxtras_2.0.1-build1123.8_src.zip/download|antxtras_2.0.1_src.zip]] ([[http://downloads.sourceforge.net/project/antxtras/antxtras/2.0.1/antxtras_2.0.1-build1123.8_src.zip.sig|sig]])  | [[http://sourceforge.net/projects/antxtras/files/antxtras/3.0.0/antxtras_3.0.0-build1225.39_src.zip/download|antxtras_3.0.0_src.zip]] ([[http://downloads.sourceforge.net/project/antxtras/antxtras/3.0.0/antxtras_3.0.0-build1225.39_src.zip.sig|sig]])  |
| ChangeLogs | [[/wiki-include/antxtras/0.5.1/WHATSNEW.txt|changelog_0.5.1]]  | [[/wiki-include/antxtras/2.0.1/WHATSNEW.txt|changelog_2.0.1]]  | [[/wiki-include/antxtras/3.0.0/WHATSNEW.txt|changelog_3.0.0]]  |

== Compatibility ==
  * v2 series: Sun JaveSE 1.4 and JaveSE 1.5 platforms, Ant 1.7 only, [[/wiki-include/antxtras/2.0.1/WHATSNEW.txt|Release Notes]].
  * v3 series: Sun JaveSE 1.5 and JaveSE 1.6 platforms, Ant 1.8 only, [[/wiki-include/antxtras/latest/WHATSNEW.txt|Release Notes]], [[/wiki-include/antxtras/latest/LICENSE.txt|Licenses]].

== Dependencies ==
AntXtras only depends on standard JavaSE and Ant packages. However, if you want to use a regular expression implementation other than the builtin JRE one, you will need to download the required third-party package for that implementation. (Read [[http://ant.apache.org/manual/CoreTypes/regexp.html|Ant regular expressions]] for more information on what other implementations Ant supports.) 
\\
\\

===== Installing AntXtras =====

AntXtras’s installation is similar to any optional Ant package. The following instructions describe how to install and verify AntXtras v2 or v3 in your run-time environment. For older series, see the installation instructions that comes with the distribution.

  - **Download, verify, and install an [[http://ant.apache.org/bindownload.cgi|Ant distribution]]— version 1.7.1[v2] or 1.8.2[v3]**. Verify that Ant is properly installed. AntXtras only uses components of the standard Ant distribution; optional tasks are not required.\\ \\
  - **Download, verify, and install an AntXtras distribution**. We suggest you download the binary distribution that contains everything you need to use AntXtras immediately. There is also a sample Ant script you can use to verify the installation is working properly. In the remaining steps we use ''<ANTXTRAS_DIR>'' to refer to the directory into which you extracted the AntXtras distribution.
     * If you must manually generate all binaries for your environment, download the source-only distribution. Be sure you also download the [[#AntXtras Dependencies|required third-party libraries]]. You must use JDK 1.5 or later to compile the v3 sources.\\ \\
  - **Update your Ant run-time environment to include the AntXtras jar file** ''<ANTXTRAS_DIR>/lib/jw-antxtras.jar'' in its classpath. There are several ways of telling Ant about third-party jar files; the easiest method is to copy the files into your Ant distribution’s ''lib'' directory. A safer approach is to install AntXtras in its own location and update the ''CLASSPATH'' used when you run Ant (for example, by using the ''-lib'' option; see “[[/apis/thirdparty/ant/manual/running.html#libs|Running Ant]]” for details). You can also specify a classpath directly to the ''<taskdef>'' instruction you use to load AntXtras.\\ \\
  - **Verify the AntXtras tasks are accessible from Ant**. The easiest way to do this is to run Ant against this [[:antxtras:documents:checkinstall|starter script]]. From within the ''<ANTXTRAS_DIR>/etc'' directory, run ''`ant -f antxtras-install-check.xml`''. This Ant script doesn’t actually do anything except load the AntXtras antlib and print out its version information. If Ant is unable to locate the AntXtras antlib or its dependencies, even this simple script will fail. In the [[#loading_AntXtras_Antlib|next section]], we describe in detail what this starter script is doing.\\ \\
  - **Read the [[:antxtras:overview|Overview]] page to get an idea of what AntXtras can do for you.** This overview includes a list of the AntXtras main components and many examples. Download the “[[/wiki-include/antxtras/latest/doc/AntXtras_UserGuide.pdf|JWare/AntXtras Foundation User Guide]]” as a thorough off line reference for every AntXtras component and additional examples.\\ \\
  - **Start using AntXtras!**

{{tag>install}}
~~UP~~

===== Loading AntXtras Antlib =====
Below are the steps you must follow to use AntXtras //after// you download and expand the AntXtras ‘_bin’ (binaries-only) distribution. If you downloaded the source distribution, you must adjust the first step below to include the location of your local build of AntXtras.

<box 75% round green|First-Time User Tip!>
All of these steps are reproduced in the [[:antxtras:documents:checkinstall|starter script]] that comes with the AntXtras binaries package (‘xxx_bin.zip’). Be sure you use the script that comes with your specific AntXtras download!
</box>

== 1. Defining path to AntXtras ==

Define where you’ve installed AntXtras using Ant’s <path> components. In this snippet we assume the project′s ''basedir'' is the <ANTXTRAS_DIR>/etc directory.

<code xml 1>
<dirname property="root.d" file="${basedir}"/>
<path id="jware.path">
  <fileset dir="${root.d}/lib">
    <include name="jw-antxtras.jar"/>
  </fileset>
</path>
</code>

== 2. Loading AntXtras into Ant ==

Load the AntXtras antlib into your Ant script using the path previously defined in step 1.

<code xml 1>
<taskdef onerror="failall"
    resource="org/jwaresoftware/antxtras/install/antlib.xml"
    classpathref="jware.path"/>
</code>

== 3. Displaying AntXtras version information ==

Verify you can access AntXtras components from your Ant script. The simplest way to do this is to load the AntXtras version information from a core component and display the information on the Ant console.

<code xml 1>
<target name="about-antxtras">
  <vendorinfo name="antxtras"/>
  <show message="RELEASE: ${antxtras.build.label}"/>
</target>
</code>

~~UP~~

===== Loading Advanced Antlibs =====
AntXtras comes with three (3) distinct antlibs to improve maintainability and to partition less-used or test-only functionality from the most-common. To load the whole AntXtras universe (core, advanced, etc.) use the following steps instead of the steps described above which load the core jw-antxtras.jar package only.


== 1. Defining path to AntXtras ==

Define where you’ve installed AntXtras using Ant’s <path> components. In this snippet we assume the project’s ''basedir'' is the <ANTXTRAS_HOME>/etc directory.

<code xml 1>
<dirname property="root.d" file="${basedir}"/>
<path id="jware.path">
  <fileset dir="${root.d}/lib">
    <include name="*.jar"/>
  </fileset>
</path>
</code>

== 2. Loading all of AntXtras into Ant ==

Load all of the AntXtras antlibs into your Ant script using the paths previously defined in step 1. We also tell Ant in the first call to <taskdef> to cache the classloader that it constructs to load classes from our “jware.path” under a reference “jware.classloader”. Our subsequent <taskdef> calls can reuse this classloader by using the standard ‘loaderref’ parameter. You can use the same technique to load additional AntXtras-based extensions like Svn4Ant or Log4Ant.

<code xml 1>
<taskdef onerror="failall" 
    resource="org/jwaresoftware/antxtras/install/antlib-advanced.xml"
    classpathref="jware.path" loaderref="jware.classloader"/>
</code>

== 3. Displaying AntXtras version information ==

Verify you can access the full suite of AntXtras components from your Ant script. One way you can do this is to load the AntXtras version information defined by a core component via a function shortcut that is defined in an advanced antlib.

<code xml 1>
<target name="about-antxtras">
  <show message="RELEASE: ${$vendorinfo:antxtras?label}"/>
</target>
</code>

~~UP~~

===== Linking to Custom Namespace =====
We recommend you put the foundation AntXtras components into the default Ant namespace (the ‘empty’ namespace that requires no prefix) as it lets you integrate the various AntXtras components seamlessly with standard Ant components. However, it’s simple to allocate AntXtras to its own namespace if you want. The recommended namespace URI and prefix for AntXtras Foundation is “jwaresoftware.antxtras” and “oja:” respectively. This section shows you how to setup such a configuration in your Ant script.

== 1. Defining AntXtras XML namespace ==

Define the namespace prefix for the AntXtras antlib as part of your main script’s root <project> XML element. By default, we use the “oja:” prefix for the “jwaresoftware.antxtras” namespace to refer to AntXtras Foundation components.

<code xml 1>
<project name="antxtras:check" basedir="." xmlns:oja="jwaresoftware.antxtras">
</code>

== 2. Defining path to AntXtras ==

Define where you’ve installed AntXtras using Ant’s <path> components. See the step 2 from either the “Loading Advanced Antlibs” or “Loading AntXtras Antlib” sections above. Let’s assume you’re loading just the core antlib.

<code xml 1>
<dirname property="root.d" file="${basedir}"/>
<path id="jware.path">
  <fileset dir="${root.d}/lib">
    <include name="jw-antxtras.jar"/>
  </fileset>
</path>
</code>

== 3. Loading AntXtras into Ant ==

Load the AntXtras antlib into your Ant scripts using the path we defined in step 2. Note that we specify the URI of our declared “oja” namespace using the <taskdef>’s uri parameter.

<code xml 1>
<taskdef onerror="failall"
      uri="jwaresoftware.antxtras"
      resource="org/jwaresoftware/antxtras/install/antlib.xml"
      classpathref="jware.path"/>
</code>

== 4. Displaying AntXtras version information ==

Verify you can access AntXtras components from your Ant script by using the <oja:vendorinfo> task to get the antlib’s version information.

<code xml 1>
<target name="about-antxtras">
  <oja:vendorinfo name="antxtras"/>
  <oja:show message="RELEASE: ${antxtras.build.label}"/>
</target>
</code>

~~UP~~

===== Compiling AntXtras =====

8-O If you would like to compile the source distribution, AntXtras is dependent on a few other open-source products that you must download and install before trying to compile your own AntXtras binaries. If you want to compile and run the AntXtras programmer tests you will need to download the third-party distributions that contains test support files, typically the source distributions.

== ==
**Main Dependencies:**
  * v2 series: [[http://ant.apache.org/|Apache's Ant 1.7.0 or 1.7.1]] (ant.apache.org/), JDK 1.4.x
  * v3 series: [[http://ant.apache.org/|Apache's Ant 1.8.0 or later]], JDK 1.5.x

**For Programmer Tests:**
  * [[http://www.junit.org/|JUnit 3.8.3]] (junit.org/)
  * v2 series: [[http://ant.apache.org/manual/CoreTypes/regexp.html|A regular expression provider like Jarkarta RegExp]] (jakarta.apache.org/)

**As Maven2 POM:**
  * v2 series: [[/repo/m2/org/jwaresoftware/antxtras/jw-antxtras/2.0.1/jw-antxtras-2.0.1.pom|jw-antxtras-2.0.1.pom]]
  * v3 series: [[/repo/m2/org/jwaresoftware/antxtras/jw-antxtras/3.0.0/jw-antxtras-3.0.0.pom|jw-antxtras-3.0.0.pom]]

Compiling AntXtras source is straightforward from any IDE. The AntXtras source distribution also includes an ''ez-build.xml'' Ant script in the ''/etc'' directory that can generate a complete release (antlibs, javadocs, sources). You can update the ''ez-build.properties'' file with details from your environment before doing the Ant build. Read the [[/wiki-include/antxtras/latest/etc/ez-build-README.txt|ez-build-README]] file for details.
~~UP~~