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 taskdoes 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 buildmore 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 usingrefid.
+

+

+

Attribute

Description

Required

+

+
+

setid

the id to reference the built fileset

+

Yes

+

conf

a comma separated list of the configurations to put in the created path

+

No. Defaults to the configurations resolved by the last resolve call, or * if no resolve was explicitly called

+

type

comma separated list of artifact types to accept in the path, * for all

No. Defaults to *

+

settingsRef

(since 2.0) A reference to the ivy settings that must be used by this task

cachepath

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

+

+

Attribute

Description

Required

+

+
+

pathid

the id to reference the built path

+

Yes

+

conf

a comma separated list of the configurations to put in the created path

+

No. Defaults to the configurations resolved by the last resolve call, or * if no resolve was explicitly called

+

type

comma 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 task

No, '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.

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.

configure

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

+

+

Attribute

Description

Required

+

+
+

settingsId

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

+

file

path to the settings file to use

+

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

+

url

url of the settings file to use

+

override

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

+

host

http authentication host

No, unless authentication is required

+

realm

http authentication realm

+

username

http authentication user name

+

passwd

http authentication password

+
+

+

HTTP Authentication

+Note: HTTP Authentication can be used only if commons-httpclient.jar is in your classpathIf any of the url you use in ivy (especially in dependency resolvers) need httpauthentication, then you have to provide the host, realm, username and passwdattributes of the configure task. These settings will then be used in anyfurther 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.