Ant-contrib.unkrig.de: Difference between revisions

From unkrig.de
Jump to navigation Jump to search
Line 5: Line 5:
== Tasks ==
== Tasks ==


;[['follow' task|<code><follow></code>]]
;[[Ant-contrib.unkrig.de / Tasks / follow|<code><follow></code>]]
:Waits until a file grows.
:Waits until a file grows.


;[['jsonProperty' task|<code><jsonProperty></code>]]
;[[Ant-contrib.unkrig.de / Tasks / jsonProperty|<code><jsonProperty></code>]]
:Parses a JSON document into a set of properties, in analogy with [http://ant.apache.org/manual/Tasks/xmlproperty.html the standard ANT <code><xmlproperty></code> task].
:Parses a JSON document into a set of properties, in analogy with [http://ant.apache.org/manual/Tasks/xmlproperty.html the standard ANT <code><xmlproperty></code> task].


;[['nslookup' task|<code><nslookup></code>]]
;[[Ant-contrib.unkrig.de / Tasks / nslookup|<code><nslookup></code>]]
:Resolves a host name or IP address.
:Resolves a host name or IP address.


;[['setAuthenticator' task|<code><setAuthenticator></code>]]
;[[Ant-contrib.unkrig.de / Tasks / setAuthenticator|<code><setAuthenticator></code>]]
:Configures the authentication for all following [http://docs.oracle.com/javase/6/docs/api/java/net/HttpURLConnection.html <code>java.net.URLConnection</code>]s, including the [[#<urlConnection>|<code><urlConnection></code>]] task.
:Configures the authentication for all following [http://docs.oracle.com/javase/6/docs/api/java/net/HttpURLConnection.html <code>java.net.URLConnection</code>]s, including the [[#<urlConnection>|<code><urlConnection></code>]] task.


;[['setCookieHandler' task|<code><setCookieHandler></code>]]
;[[Ant-contrib.unkrig.de / Tasks / setCookieHandler|<code><setCookieHandler></code>]]
:Enables or disables cookie handling for Java's [http://docs.oracle.com/javase/6/docs/api/java/net/HttpURLConnection.html <code>java.net.HttpURLConnection</code>], including the [[#<urlConnection>|<code><urlConnection></code>]] task.
:Enables or disables cookie handling for Java's [http://docs.oracle.com/javase/6/docs/api/java/net/HttpURLConnection.html <code>java.net.HttpURLConnection</code>], including the [[#<urlConnection>|<code><urlConnection></code>]] task.


;[['swingDialog' task|<code><swingDialog></code>]]
;[[Ant-contrib.unkrig.de / Tasks / swingDialog|<code><swingDialog></code>]]
:Pops up a highly configurable dialog and invites the user to fill in form fields.
:Pops up a highly configurable dialog and invites the user to fill in form fields.


;[['throughput' task|<code><throughput></code>]]
;[[Ant-contrib.unkrig.de / Tasks / throughput|<code><throughput></code>]]
:Measures expired time and calculates and displays throughput rates and estimated remaining times.
:Measures expired time and calculates and displays throughput rates and estimated remaining times.


;[['urlConnection' task|<code><urlConnection></code>]]
;[[Ant-contrib.unkrig.de / Tasks / urlConnection|<code><urlConnection></code>]]
:Connects to a resource and writes data to it and/or reads data from it.
:Connects to a resource and writes data to it and/or reads data from it.



Revision as of 00:07, 5 March 2014

Abstract

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).

Tasks

<follow>
Waits until a file grows.
<jsonProperty>
Parses a JSON document into a set of properties, in analogy with the standard ANT <xmlproperty> task.
<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.
<swingDialog>
Pops up a highly configurable dialog and invites the user to fill in form fields.
<throughput>
Measures expired time and calculates and displays throughput rates and estimated remaining times.
<urlConnection>
Connects to a resource and writes data to it and/or reads data from it.

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.

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.

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/.

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".