Added: ant/ivy/site/target/history/2.2.0/use/cachefileset.html URL: http://svn.apache.org/viewvc/ant/ivy/site/target/history/2.2.0/use/cachefileset.html?rev=1005260&view=auto ============================================================================== --- ant/ivy/site/target/history/2.2.0/use/cachefileset.html (added) +++ ant/ivy/site/target/history/2.2.0/use/cachefileset.html Wed Oct 6 21:25:29 2010 @@ -0,0 +1,145 @@ + + + + + + + + +cachefileset | Apache Ivy + + + + + + + + + + +
+ + + + + + + + + + + + + +
+ +
+ +
+ + + + +
+ + +
+ + +
+ + + + + + + +
+
+ +

cachefileset

+
Constructs an ant fileset consisting of artifacts in ivy cache for a configuration (since 1.2).

+This is a post resolve task, with all the behaviour and attributes common to all post resolve tasks. Note that this task
does not rely on retrieve, because built fileset is made of artifacts direcly in ivy cache.

+Please prefer the use of retrieve + standard ant path creation, which make your build
more independent from ivy (once artifacts are properly retrieved, ivy is not required any more).

+Built fileset is registered in ant with a given id, and can thus be used like any other ant fileset using
refid.
+ + + + + + + + + + + + +
AttributeDescriptionRequired
setidthe id to reference the built filesetYes
confa comma separated list of the configurations to put in the created pathNo. Defaults to the configurations resolved by the last resolve call, or * if no resolve was explicitly called
typecomma separated list of artifact types to accept in the path, * for allNo. Defaults to *
settingsRef(since 2.0) A reference to the ivy settings that must be used by this taskNo, 'ivy.instance' is taken by default.
+ + +
+
+ + + + + + + + + + + + +
+ + Added: ant/ivy/site/target/history/2.2.0/use/cachepath.html URL: http://svn.apache.org/viewvc/ant/ivy/site/target/history/2.2.0/use/cachepath.html?rev=1005260&view=auto ============================================================================== --- ant/ivy/site/target/history/2.2.0/use/cachepath.html (added) +++ ant/ivy/site/target/history/2.2.0/use/cachepath.html Wed Oct 6 21:25:29 2010 @@ -0,0 +1,156 @@ + + + + + + + + +cachepath | Apache Ivy + + + + + + + + + + +
+ + + + + + + + + + + + + +
+ +
+ +
+ + + + +
+ + +
+ + +
+ + + + + + + +
+
+ +

cachepath

+
Constructs an ant path consisting of artifacts in ivy cache (or origin location with depending on useOrigin setting) for a resolved module configuration.

This is a post resolve task, with all the behaviour and attributes common to all post resolve tasks.

If you want to make your build more independent from Ivy, you could consider using the retrieve task. Once the artifacts are properly retrieved, you can use standard Ant path creation which makes Ivy not necessary any more.

Built path is registered in ant with a given id, and can thus be used like any other ant path using refid.
+ + + + + + + + + + + + +
AttributeDescriptionRequired
pathidthe id to reference the built pathYes
confa comma separated list of the configurations to put in the created pathNo. Defaults to the configurations resolved by the last resolve call, or * if no resolve was explicitly called
typecomma separated list of artifact types to accept in the path, * for all (since 1.2)No. Defaults to *
settingsRef(since 2.0) A reference to the ivy settings that must be used by this taskNo, 'ivy.instance' is taken by default.
+ +

Examples

+
+<cachepath pathid="default.classpath" conf="default" />
+
+Construct an ant path composed of all artifacts being part of the default configuration obtained through the last resolve call.


+ +
+<cachepath pathid="default.classpath" conf="default" useOrigin="true" />
+
+Same as before but will use the original location for local artifacts, and the cache location for other artifacts.


+ +
+<ivy:cachepath organisation="emma" module="emma" revision="2.0.4217" inline="true" conf="ant" pathid="emma.classpath"/>
<taskdef resource="emma_ant.properties" classpathref="emma.classpath" /> +
+Resolves the emma module in version 2.0.4217, constructs an ant path with the corresponding artifacts, and then define the emma tasks using this path.

+
+
+ + + + + + + + + + + + +
+ + Added: ant/ivy/site/target/history/2.2.0/use/cleancache.html URL: http://svn.apache.org/viewvc/ant/ivy/site/target/history/2.2.0/use/cleancache.html?rev=1005260&view=auto ============================================================================== --- ant/ivy/site/target/history/2.2.0/use/cleancache.html (added) +++ ant/ivy/site/target/history/2.2.0/use/cleancache.html Wed Oct 6 21:25:29 2010 @@ -0,0 +1,149 @@ + + + + + + + + +cleancache | Apache Ivy + + + + + + + + + + +
+ + + + + + + + + + + + + +
+ +
+ +
+ + + + +
+ + +
+ + +
+ + + + + + + +
+
+ +

cleancache

+
since 2.0 +Cleans the Ivy cache.

This task is roughly equivalent to: +
+<delete dir="${ivy.cache.dir}" />
+
+Using the regular Ant delete task is more flexible, since it allows to specify the files to delete. But it requires an Ivy settings to be loaded, and settings scoping is possible only by using suffixed ant property for the cache directory.

This task loads the Ivy settings as any other post settings task, and allows easy scoping with the attribute settingsRef.

Attributes

+ + + + + + + +
AttributeDescriptionRequired
settingsRefA reference to the ivy settings that must be used by this taskNo, 'ivy.instance' is taken by default.
+

Examples

+
+<ivy:cleancache />
+
+Cleans the cache directory as defined in the loaded settings (by default ~/.ivy2/cache)
+
+<ivy:cleancache settingsRef="mysettings"/>
+
+Cleans the cache directory as defined in the loaded settings identified as 'mysettings' +
+
+ + + + + + + + + + + + +
+ + Added: ant/ivy/site/target/history/2.2.0/use/configure.html URL: http://svn.apache.org/viewvc/ant/ivy/site/target/history/2.2.0/use/configure.html?rev=1005260&view=auto ============================================================================== --- ant/ivy/site/target/history/2.2.0/use/configure.html (added) +++ ant/ivy/site/target/history/2.2.0/use/configure.html Wed Oct 6 21:25:29 2010 @@ -0,0 +1,161 @@ + + + + + + + + +configure | Apache Ivy + + + + + + + + + + +
+ + + + + + + + + + + + + +
+ +
+ +
+ + + + +
+ + +
+ + +
+ + + + + + + +
+
+ +

configure

+
The configure task is used to configure ivy with an xml settings file.

+See Settings Files for details about the settings file itself.

+ +since 2.0 The file loaded used to be called configuration file in versions prior to 2.0. The name 'settings' and the use of the ivy.settings.file is new to 2.0.

since 2.0 It is also possible to configure Ivy with the settings declaration. The difference with this task is that when using the settings declaration, the configuration of Ivy will be done when the settings are first needed (for instance when you do a resolve), while the configure task will perform a configuration of Ivy instantly, which makes it easier to see the problem if something goes wrong.
+ + + + + + + + + + + + + + + +
AttributeDescriptionRequired
settingsIdThe settings id useable in the settingsRef attributes of the ivy task that needs a setting. Note that the ivy tasks will search by default for the settings with the id "ivy.instance", which is the default value.No, defaults to "ivy.instance"
filepath to the settings file to useNo. If a file is provided, url is ignored. If none are provided, then it attempts to find a file at ${ivy.settings.file}, and if this file does not exist, it uses a default settings file
urlurl of the settings file to use
overrideSpecify what to do when another settings with the same id has already been loaded.
  • true
  • the current settings will take precedence over any previously defined setting with this id
  • false
  • the current settings will not override a previously defined setting with this id
  • notallowed
  • an error is raised if a settings has already been defined with this id
No, defaults to "notallowed"
hosthttp authentication hostNo, unless authentication is required
realmhttp authentication realm
usernamehttp authentication user name
passwdhttp authentication password
+

HTTP Authentication

+Note: HTTP Authentication can be used only if commons-httpclient.jar is in your classpath
If any of the url you use in ivy (especially in dependency resolvers) need http
authentication, then you have to provide the host, realm, username and passwd
attributes of the configure task. These settings will then be used in any
further call to ivy tasks.

+ +Since 1.4:
It's also possible to configure authentication settings for multiple urls. This can be done with the subelements. See the examples for more details.

Examples

+

Simplest settings

+
<ivy:configure />
+Use either ${ivy.settings.file} if it exists, or the default settings file

Configure with a file

+
<ivy:configure file="myconffile.xml" />
+

Configure with an url

+
<ivy:configure url="http://mysite.com/myconffile.xml" />
+

Configure multiple URLs which require autentication

+
+<ivy:configure file="path/to/my/ivysettings.xml">
<credentials host="myhost.com" realm="My Realm" username="myuser" passwd="mypasswd" />
<credentials host="yourhost.com" realm="Your Realm" username="myuser" passwd="myotherpasswd" />
</ivy:configure> +
+ +
+
+ + + + + + + + + + + + +
+ +