Ant-contrib.unkrig.de

From unkrig.de
Jump to: navigation, search

This library contributes useful tasks and types to APACHE ANT. It integrates seamlessly with other libraries like ant-contrib (which is not to be confused with this one).

Contents

Tasks

In Alphabetical Order

<break>
<continue>
<follow>
<forEach2>
<jsonProperty>
<log>
<logging>
<nslookup>
<retry2>
<setAuthenticator>
<setCookieHandler>
<simpleLogging>
<swingDialog>
<throughput>
<urlConnection>

By Function Group

Control Flow Tasks

<break>
Terminates the execution of the enclosing <forEach2>.
<continue>
Causes the enclosing <forEach2> task to continue with the next iteration element.
<follow>
Waits until a file grows.
<forEach2>
An enhanced version of the FOR task of ant-contrib.sourceforge.net.
<retry2>
An enhanced version of the standard <retry> task.
<throughput>
Measures expired time and calculates and displays throughput rates and estimated remaining times.

Text Processing Tasks

<jsonProperty>
Parses a JSON document into a set of properties, in analogy with the standard ANT <xmlproperty> task.

Logging Tasks

<log>
Logs one message through java.util.logging.
<logging>
Configures one or more loggers of the java.util.logging logging component.
<simpleLogging>
Configures the de.unkrig.commons.util.logging.SimpleLogging facility.

Networking Tasks

<nslookup>
Resolves a host name or IP address.
<setAuthenticator>
Configures the authentication for all following java.net.URLConnections, including the <urlConnection> task.
<setCookieHandler>
Enables or disables cookie handling for Java's java.net.HttpURLConnection, including the <urlConnection> task.
<urlConnection>
Connects to a resource and writes data to it and/or reads data from it.

UI Tasks

<swingDialog>
Pops up a highly configurable dialog and invites the user to fill in form fields.

Resource Collections

A resource collection represents a group of resources. A resource is an entity that has a name and a value. An often-used example of a resource collection is the <fileSet> type, where each resource is a file with its name and its contents.

<resourceCollectionDelta>
Selects the subset of resources that was added, deleted or modified since the last check.
<resourceNames>
Replaces the resources' values with their names.
<literalResource>
A read-only resource with a name and a literal value - configurable either through value="..." or nested text.

Filter Readers

Filter readers are an ANT concept that mimics the functionality of UNIX' pipes: A stream of bytes is read through a chain of filter readers, where each filter reader modifies the byte stream and/or performs some additional actions.

<progress>
Prints dots (".") to STDERR as data is read through it. This implements a kind of 'progress monitoring' for slow tasks that read some data.
<tee>
Passes data through unmodified, and copies it to a second filter chain.

Conditions

Conditions are nested elements of the <condition>, <waitfor> and several other tasks.

<true>, <false>
Always evaluate to true resp. false.
<every>
Evaluates to true when it is evaluated for the first time, and when the last evaluation to true has been more than a configured interval ago.
<successful>
Executes the tasks configured as subelements sequentially and evaluates to whether all subtasks have completed successfully.

Download and installation

The JAR file can be downloaded from http://ant-contrib.unkrig.de/download/. A change log is also available.

To make the contributions available in your ANT scripts, write

<taskdef resource="de/unkrig/antcontrib/ant.xml" classpath="path/to/de.unkrig.ant-contrib.jar" />

, or, if you put the JAR file on ANT's default classpath, just

<taskdef resource="de/unkrig/antcontrib/ant.xml" />

Source code

The source code is available in the SUBVERSION repository. The repository URL is

https://svn.code.sf.net/p/loggifier/code

License

ANT-CONTRIB is published under the "New BSD License".

Personal tools
Namespaces

Variants
Actions
Navigation
Toolbox