Ant-contrib.unkrig.de: Difference between revisions

From unkrig.de
Jump to navigation Jump to search
No edit summary
 
(83 intermediate revisions by the same user not shown)
Line 1: Line 1:
== Abstract ==
<meta name="keywords" content="apache, ant, antlib, library, extension, tasks, types, filters"></meta>
Some contributions to APACHE ANT, e.g. the 'de.unkrig.ant-contrib.swingdialog' task which significantly enhances ANT's <input> task.
<meta name="description" content="A library for APACHE ANT that contributes many useful, resource collections, and other types"></meta>
This project was renamed to "[[Antology]]" to get rid of the constant confusion with the (related, but otherwise independent) "[http://ant-contrib.sourceforge.net/ ant-contrib]" project on SOURCEFORGE.


== Tasks ==
As a consequence, in all your ANT build scripts, you have to change


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


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


This task will fail iff the CANCEL button is pressed or the dialog is closed, except if '<ifCancelTask>'s (or '<ifClosedTask>'s, respectively) are configured.
  <taskdef resource="de/unkrig/antology/ant.xml" classpath="path/to/antology-x.y.z-jar-with-dependencies.jar" />


[[File:swing-dialog.png]]
. That's all, folks!
 
==== '''Attributes''' ====
;title="FTP upload of update site" (optional): The text to be displayed in the title bar of the dialog.
;optionType="..." (optional): DEFAULT (an 'OK' button), YES_NO, YES_NO_CANCEL, OK_CANCEL (the default): Determines which buttons are displayed in the dialog.
;messageType="..." (optional): ERROR, INFORMATION, WARNING, QUESTION, PLAIN (the default): If not set to PLAIN, then a respective icon is displayed in the dialog.
;property="..." (optional): The named property will be set to YES, NO, CANCEL, OK or CLOSED when the task completes.
 
==== '''Subelements''' ====
;<label text="User ID"/> (zero or more)
: Displays the given text.
 
;<text property="ftp.userid" defaultvalue="www.unkrig.de"/> (zero or more)
: A one-line text input field with an (optional) default value. On return, the named property is set to the text of the field. Iff 'secure="true"' is given, then characters entered into the field are not echoed.
 
;<checkbox text="Use passive FTP" property="ftp.passive" defaultvalue="true"/> (zero or more)
: A checkbox with a label. On return, the named property is set to 'true' iff the box is checked. Iff 'defaultvalue="true"' is given, then the checkbox is pre-selected.
 
;<ifYes>, <ifNo>, <ifCancel>, <ifOk>, <ifClosed> (at most one of each)
:These can have task subelements, which are executed iff the respective dialog button is pressed (<ifYes>, <ifNo>, <ifCancel>, <ifOk>) or the dialog is closed (<ifClosed>).
 
=== <de.unkrig.ant-contrib.jsonproperty> ===
 
Parses a JSON document into a set of properties, in analogy with the standard ANT '<xmlproperty>' task.
 
==== '''Attributes''' ====
;file="..." (mandatory)
:The file from which to read the JSON document.
 
;encoding="..." (optional)
:The encoding of the JSON document. The default is 'UTF-8'.
 
;name="..." (mandatory)
:The prefix of the names of the properties to set.
 
=== <de.unkrig.ant-contrib.setauthenticator> ===
 
This task configures the authentication for all following URLConnections, e.g. those created by [<de.unkrig.ant-contrib.urlconnection>]. It does this by matching a request against the configured '<credentials>' subelements and using password authentication as configured by the first matching '<credentials>' element.
 
==== '''Subelements''' ====
;<credentials requestingHost="localhost" requestingSite="127\.0\.0\.1" requestingPort="80" requestingProtocol="http" requestingPrompt="The Realm" requestingScheme="http" requestingUrl="http://acme\.com" requestorType="SERVER-or-PROXY" userName="..." password="..." /> (zero or more)
:If the request matches all the 'requesting...' and 'requestor...' attributes (all of which are regular expressions), then
* If both 'userName' and 'password' are given, then these determine the 'PasswordAuthentication'
* If none of 'userName' and 'password' are given, then the user is prompted to enter the user name and password
* If only one of 'userName' and 'password' is given, the it is displayed to the user, and the user is prompted to enter the other
 
== 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="lib/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]]".

Latest revision as of 09:58, 17 November 2016

<meta name="keywords" content="apache, ant, antlib, library, extension, tasks, types, filters"></meta> <meta name="description" content="A library for APACHE ANT that contributes many useful, resource collections, and other types"></meta> This project was renamed to "Antology" to get rid of the constant confusion with the (related, but otherwise independent) "ant-contrib" project on SOURCEFORGE.

As a consequence, in all your ANT build scripts, you have to change 

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

to 

 <taskdef resource="de/unkrig/antology/ant.xml" classpath="path/to/antology-x.y.z-jar-with-dependencies.jar" />

. That's all, folks!

Retrieved from "https://unkrig.de/STRATO-apps/mediawiki_03/app/index.php?title=Ant-contrib.unkrig.de&oldid=910"