2006-09-11 04:19:00 +00:00
|
|
|
<!--
|
|
|
|
|
Licensed to the Apache Software Foundation (ASF) under one or more
|
|
|
|
|
contributor license agreements. See the NOTICE file distributed with
|
|
|
|
|
this work for additional information regarding copyright ownership.
|
|
|
|
|
The ASF licenses this file to You under the Apache License, Version 2.0
|
|
|
|
|
(the "License"); you may not use this file except in compliance with
|
|
|
|
|
the License. You may obtain a copy of the License at
|
|
|
|
|
|
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
|
|
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
|
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
|
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
|
|
See the License for the specific language governing permissions and
|
|
|
|
|
limitations under the License.
|
|
|
|
|
-->
|
2002-06-22 23:38:38 +00:00
|
|
|
<html>
|
|
|
|
|
|
|
|
|
|
<head>
|
|
|
|
|
<meta http-equiv="Content-Language" content="en-us">
|
2005-04-29 18:58:16 +00:00
|
|
|
<link rel="stylesheet" type="text/css" href="../stylesheets/style.css">
|
2002-06-22 23:38:38 +00:00
|
|
|
<title>jarlib-resolve Task</title>
|
|
|
|
|
</head>
|
|
|
|
|
|
|
|
|
|
<body>
|
|
|
|
|
|
|
|
|
|
<h2><a name="jarlib-resolve">jarlib-resolve</a></h2>
|
|
|
|
|
<h3>Description</h3>
|
|
|
|
|
<p>Try to locate a jar to satisfy an extension and place
|
|
|
|
|
location of jar into property. The task allows you to
|
|
|
|
|
add a number of resolvers that are capable of locating a
|
2004-11-12 10:36:29 +00:00
|
|
|
library for a specific extension. Each resolver will be attempted
|
2002-06-22 23:38:38 +00:00
|
|
|
in specified order until library is found or no resolvers are left.
|
|
|
|
|
If no resolvers are left and failOnError is true then a BuildException
|
|
|
|
|
will be thrown.</p>
|
|
|
|
|
|
|
|
|
|
<p>Note that this task
|
|
|
|
|
works with extensions as defined by the "Optional Package" specification.
|
|
|
|
|
For more information about optional packages, see the document
|
|
|
|
|
<em>Optional Package Versioning</em> in the documentation bundle for your
|
|
|
|
|
Java2 Standard Edition package, in file
|
|
|
|
|
<code>guide/extensions/versioning.html</code> or online at
|
|
|
|
|
<a href="http://java.sun.com/j2se/1.3/docs/guide/extensions/versioning.html">
|
|
|
|
|
http://java.sun.com/j2se/1.3/docs/guide/extensions/versioning.html</a>.</p>
|
|
|
|
|
<p>See the Extension and ExtensionSet documentation for further details</p>
|
|
|
|
|
|
|
|
|
|
<h3>Parameters</h3>
|
|
|
|
|
<table border="1" cellpadding="2" cellspacing="0">
|
|
|
|
|
<tr>
|
|
|
|
|
<td valign="top"><b>Attribute</b></td>
|
|
|
|
|
<td valign="top"><b>Description</b></td>
|
|
|
|
|
<td align="center" valign="top"><b>Required</b></td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td valign="top">property</td>
|
|
|
|
|
<td valign="top">The name of property to set to library location.</td>
|
|
|
|
|
<td valign="top" align="center">Yes</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td valign="top">failOnError</td>
|
|
|
|
|
<td valign="top">True if failure to locate library should result in build exception.</td>
|
|
|
|
|
<td valign="top" align="center">No, defaults to true.</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td valign="top">checkExtension</td>
|
2004-11-12 10:36:29 +00:00
|
|
|
<td valign="top">True if libraries returned by nested resolvers should be checked to see if
|
2002-06-22 23:38:38 +00:00
|
|
|
they supply extension.</td>
|
|
|
|
|
<td valign="top" align="center">No, defaults to true.</td>
|
|
|
|
|
</tr>
|
|
|
|
|
</table>
|
|
|
|
|
<h3>Parameters specified as nested elements</h3>
|
|
|
|
|
|
|
|
|
|
<h4>extension</h4>
|
|
|
|
|
<p><a href="../OptionalTypes/extension.html">Extension</a> the extension
|
|
|
|
|
to resolve. Must be present</p>
|
|
|
|
|
|
|
|
|
|
<h4>location</h4>
|
|
|
|
|
<p>The location sub element allows you to look for a library in a
|
|
|
|
|
location relative to project directory.</p>
|
|
|
|
|
<table border="1" cellpadding="2" cellspacing="0">
|
|
|
|
|
<tr>
|
|
|
|
|
<td valign="top"><b>Attribute</b></td>
|
|
|
|
|
<td valign="top"><b>Description</b></td>
|
|
|
|
|
<td align="center" valign="top"><b>Required</b></td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td valign="top">location</td>
|
|
|
|
|
<td valign="top">The pathname of library.</td>
|
|
|
|
|
<td valign="top" align="center">Yes</td>
|
|
|
|
|
</tr>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
<h4>url</h4>
|
|
|
|
|
<p>The url resolver allows you to download a library from a URL to a
|
|
|
|
|
local file.</p>
|
|
|
|
|
<table border="1" cellpadding="2" cellspacing="0">
|
|
|
|
|
<tr>
|
|
|
|
|
<td valign="top"><b>Attribute</b></td>
|
|
|
|
|
<td valign="top"><b>Description</b></td>
|
|
|
|
|
<td align="center" valign="top"><b>Required</b></td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td valign="top">url</td>
|
|
|
|
|
<td valign="top">The URL to download.</td>
|
|
|
|
|
<td valign="top" align="center">Yes</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td valign="top">destfile</td>
|
|
|
|
|
<td valign="top">The file to download URL into.</td>
|
|
|
|
|
<td valign="top" align="center">No, But one of destfile or
|
|
|
|
|
destdir must be present</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td valign="top">destdir</td>
|
|
|
|
|
<td valign="top">The directory in which to place downloaded file.</td>
|
|
|
|
|
<td valign="top" align="center">No, But one of destfile or
|
|
|
|
|
destdir must be present</td>
|
|
|
|
|
</tr>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
<h4>ant</h4>
|
|
|
|
|
<p>The ant resolver allows you to run a ant build file to generate a library.</p>
|
|
|
|
|
<table border="1" cellpadding="2" cellspacing="0">
|
|
|
|
|
<tr>
|
|
|
|
|
<td valign="top"><b>Attribute</b></td>
|
|
|
|
|
<td valign="top"><b>Description</b></td>
|
|
|
|
|
<td align="center" valign="top"><b>Required</b></td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td valign="top">antfile</td>
|
|
|
|
|
<td valign="top">The build file.</td>
|
|
|
|
|
<td valign="top" align="center">Yes</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td valign="top">destfile</td>
|
|
|
|
|
<td valign="top">The file that the ant build creates.</td>
|
|
|
|
|
<td valign="top" align="center">Yes</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td valign="top">target</td>
|
|
|
|
|
<td valign="top">The target to run in build file.</td>
|
|
|
|
|
<td valign="top" align="center">No</td>
|
|
|
|
|
</tr>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
<h3>Examples</h3>
|
|
|
|
|
<p><b>Resolve Extension to file.</b> If file does not exist or file
|
|
|
|
|
does not implement extension then throw an exception.</p>
|
|
|
|
|
<pre>
|
|
|
|
|
<extension id="dve.ext"
|
|
|
|
|
extensionName="org.realityforge.dve"
|
|
|
|
|
specificationVersion="1.2"
|
|
|
|
|
specificationVendor="Peter Donald"/>
|
|
|
|
|
|
|
|
|
|
<jarlib-resolve property="dve.library">
|
|
|
|
|
<extension refid="dve.ext"/>
|
|
|
|
|
<location location="/opt/jars/dve.jar"/>
|
|
|
|
|
</jarlib-resolve>
|
|
|
|
|
</pre>
|
|
|
|
|
|
|
|
|
|
<p><b>Resolve Extension to url.</b> If url does not exist or can not write
|
|
|
|
|
to destfile or files does not implement extension then throw an exception.</p>
|
|
|
|
|
<pre>
|
|
|
|
|
<extension id="dve.ext"
|
|
|
|
|
extensionName="org.realityforge.dve"
|
|
|
|
|
specificationVersion="1.2"
|
|
|
|
|
specificationVendor="Peter Donald"/>
|
|
|
|
|
|
|
|
|
|
<jarlib-resolve property="dve.library">
|
|
|
|
|
<extension refid="dve.ext"/>
|
|
|
|
|
<url url="http://www.realityforge.net/jars/dve.jar" destfile="lib/dve.jar"/>
|
|
|
|
|
</jarlib-resolve>
|
|
|
|
|
</pre>
|
|
|
|
|
|
|
|
|
|
<p><b>Resolve Extension to file produce by ant build.</b> If file does not get produced
|
|
|
|
|
or ant file is missing or build fails then throw an exception (Note does not check
|
|
|
|
|
that library implements extension).</p>
|
|
|
|
|
<pre>
|
|
|
|
|
<extension id="dve.ext"
|
|
|
|
|
extensionName="org.realityforge.dve"
|
|
|
|
|
specificationVersion="1.2"
|
|
|
|
|
specificationVendor="Peter Donald"/>
|
|
|
|
|
|
|
|
|
|
<jarlib-resolve property="dve.library" checkExtension="false">
|
|
|
|
|
<extension refid="dve.ext"/>
|
|
|
|
|
<ant antfile="../dve/build.xml" target="main" destfile="lib/dve.jar"/>
|
|
|
|
|
</jarlib-resolve>
|
|
|
|
|
</pre>
|
|
|
|
|
|
|
|
|
|
<p><b>Resolve Extension via multiple methods.</b> First check local file to see if it implements
|
2004-11-12 10:36:29 +00:00
|
|
|
extension. If it does not then try to build it from source in parallel directory. If that
|
2002-06-22 23:38:38 +00:00
|
|
|
fails then finally try to download it from a website. If all steps fail then throw a build
|
|
|
|
|
exception.</p>
|
|
|
|
|
<pre>
|
|
|
|
|
<extension id="dve.ext"
|
|
|
|
|
extensionName="org.realityforge.dve"
|
|
|
|
|
specificationVersion="1.2"
|
|
|
|
|
specificationVendor="Peter Donald"/>
|
|
|
|
|
|
|
|
|
|
<jarlib-resolve property="dve.library">
|
|
|
|
|
<extension refid="dve.ext"/>
|
|
|
|
|
<location location="/opt/jars/dve.jar"/>
|
|
|
|
|
<ant antfile="../dve/build.xml" target="main" destfile="lib/dve.jar"/>
|
|
|
|
|
<url url="http://www.realityforge.net/jars/dve.jar" destfile="lib/dve.jar"/>
|
|
|
|
|
</jarlib-resolve>
|
|
|
|
|
</pre>
|
|
|
|
|
|
2006-09-11 20:22:51 +00:00
|
|
|
|
2002-06-22 23:38:38 +00:00
|
|
|
|
|
|
|
|
</body>
|
|
|
|
|
</html>
|
|
|
|
|
|
