Category: apache Ivy

Apache IVY – Local Repository ”; Previous Next A local repository is a private repository of a user. It is very useful in case a user is using a library whose version has been changed on other places and have breaking changes. In case of local repository, ivy will use the library present in the local if found and will not look into public or shared repositories. Default Location By default, local repository is present in ${ivy.default.ivy.user.dir}/local folder. If you want to change it, the use the ivy.local.default.root variable in ant file. build.xml <target name=”resolve”> <property name=”ivy.local.default.root” value=”/opt/ivy/repository/local”/> <ivy:resolve /> </target> Other properties like ivy pattern and artifact pattern can also be customized as follows − build.xml <target name=”resolve”> <property name=”ivy.local.default.root” value=”/opt/ivy/repository/local”/> <property name=”ivy.local.default.ivy.pattern” value=”[module]/[revision]/ivy.xml”/> <property name=”ivy.local.default.artifact.pattern” value=”[module]/[revision]/[artifact].[ext]”/> <ivy:resolve /> </target> Overriding ivysettings defaults By default ivy has its configurations in ivysettings.xml present in ivy.jar. ivysettings.xml <ivysettings> <settings defaultResolver=”default”/> <include url=”${ivy.default.settings.dir}/ivysettings-public.xml”/> <include url=”${ivy.default.settings.dir}/ivysettings-shared.xml”/> <include url=”${ivy.default.settings.dir}/ivysettings-local.xml”/> <include url=”${ivy.default.settings.dir}/ivysettings-main-chain.xml”/> <include url=”${ivy.default.settings.dir}/ivysettings-default-chain.xml”/> </ivysettings> To override local repository setting, update the contents of ivysettings-local.xml. ivysettings-local.xml <ivysettings> <property name=”ivy.local.default.root” value=”${ivy.default.ivy.user.dir}/local” override=”false”/> <property name=”ivy.local.default.ivy.pattern” value=”[organisation]/[module]/[revision]/[type]s/[artifact].[ext]” override=”false”/> <property name=”ivy.local.default.artifact.pattern” value=”[organisation]/[module]/[revision]/[type]s/[artifact].[ext]” override=”false”/> <resolvers> <filesystem name=”local”> <ivy pattern=”${ivy.local.default.root}/${ivy.local.default.ivy.pattern}” /> <artifact pattern=”${ivy.local.default.root}/${ivy.local.default.artifact.pattern}” /> </filesystem> </resolvers> </ivysettings> Print Page Previous Next Advertisements ”;

Apache IVY – Eclipse Ivy Plugin ”; Previous Next IvyDE is an Eclipse plugin provided by Apache. To install IvyDE, start Eclipse and navigate to Help > Install New Software. It displays the Available Softwares window. Enter IvyDE update site http://www.apache.org/dist/ant/ivyde/updatesite/ and press enter key. It displays the following plugins. Click Next and you will see the following screen. If you are facing any error while installing the plugin then just restart the process. After successful installation, you will see the plugin in eclipe. Now you can do the dependency management using Eclipse and Ivy. Print Page Previous Next Advertisements ”;

Apache IVY – Publish Task ”; Previous Next publish task is used to publish current artifacts and its resolved descriptor files to mentioned repository. Let”s create Tester.java, build.xml and ivy.xml as described in IVY – Resolve Task chapter. Update the build.xml to use the ivy publish task. First we”ll create a jar file and then publish it. build.xml <project name=”test” default=”resolve” xmlns:ivy=”antlib:org.apache.ivy.ant”> <property name = “build.dir” value = “build”/> <target name=”resolve” description=”resolve dependencies”> <ivy:resolve /> </target> <target name = “jar”> <jar destfile = “${build.dir}/lib/application.jar” basedir = “${build.dir}/classes”> <manifest> <attribute name = “Main-Class” value = “com.tutorialspoint.Application”/> </manifest> </jar> </target> <target name=”publish” depends=”jar”> <ivy:resolve /> <ivy:publish resolver=”local” pubrevision=”1.0″ overwrite=”true”> <artifacts pattern=”${build.dir}/lib/[artifact].[ext]” /> </ivy:publish> </target> </project> Following are the important terms. resolver − resolver to be used for publication. pattern − pattern to locate the artifact. Here publish task first build the jar, then resolve the dependencies, set the information and then publish the artifact to local repository. Building the project As we”ve all the files ready. Just go the console. Navigate to E: > ivy folder and run the ant command. E:ivy > ant publish Ivy will come into action, resolving the dependencies, you will see the following result. E:ivy > ant publish Buildfile: E:ivybuild.xml jar: publish: [ivy:resolve] :: Apache Ivy 2.5.0 – 20191020104435 :: https://ant.apache.org/ivy / :: [ivy:resolve] :: loading settings :: url = jar:file:/E:/Apache/apache-ant-1.9.14 /lib/ivy-2.5.0.jar!/org/apache/ivy/core/settings/ivysettings.xml [ivy:resolve] :: resolving dependencies :: com.tutorialspoint#test;1.0.0 [ivy:resolve] confs: [default] [ivy:resolve] found commons-lang#commons-lang;2.6 in public [ivy:resolve] found junit#junit;3.8.1 in public [ivy:resolve] :: resolution report :: resolve 121ms :: artifacts dl 15ms ——————————————————————— | | modules || artifacts | | conf | number| search|dwnlded|evicted|| number|dwnlded| ——————————————————————— | default | 2 | 2 | 0 | 0 || 4 | 0 | ——————————————————————— [ivy:publish] :: publishing :: com.tutorialspoint#test [ivy:publish] published application to C:UsersAcer.ivy2localcom.tutorials pointtest1.0jarsapplication.jar [ivy:publish] published ivy to C:UsersAcer.ivy2localcom.tutorialspointte st1.0ivysivy.xml BUILD SUCCESSFUL Total time: 1 second You can verify the publish ivy artifacts in local repository. Print Page Previous Next Advertisements ”;

Apache IVY – Terminology ”; Previous Next Consider the following example ivy.xml to understand Ivy terminology. <?xml version=”1.0″ encoding=”ISO-8859-1″?> <ivy-module version=”2.0″ xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance” xsi:noNamespaceSchemaLocation=”http://ant.apache.org/ivy/schemas/ivy.xsd”> <info organisation=”com.tutorialspoint” module=”ivy-test” status=”integration”> </info> <dependencies> <dependency org=”commons-lang” name=”commons-lang” rev=”2.6″ /> </dependencies> </ivy-module> Ivy Terms Following are the important terms of Ivy Eco-System. Organisation − As name suggests, it refers to the name of the company, individual developer or team name who creates the project or library. For example, com.tutorialspoint. Module − As name suggests, it refers to the reusable unit or module. A module generally have a version attached to it. For example commons-lang, or ivy-test etc. Module Descriptor − Module descriptor refers to ivy.xml file which describes a module. A module descriptor contains the identifier (org, name, branch and version), artifacts published, configurations and dependencies. Artifact − Artifact refers to a single file as deliverable. For example, a jar file. Artifact can be of type: zip, gz etc. Jar, Source Jar, Javadoc Jar are various artifacts of a module. Type − Type identifies the artifact category like jar, war, src, doc etc. Artifact file name extension − Artifact extension like .jar, ,zip, .gz etc. Module Revision − A unique revision number of the module or its version number. Status of Revision − Status of revision indicates the stability of the revision. Following are the important value of status − integration − Represents continuous development, nightly build etc. milestone − Represents a distribution but not finalized. release − Represents tested and completed, a major version. Repository − Similar to Maven repositories, repository represents a distribution site where ivy can search a library, artifacts, modules etc. A repository can be public, private or shared. Ivy Settings − Apache Ivy follows Maven principles and comes with lot of default configurations. Default settings can be overridden by defining a ivysettings.xml file. Print Page Previous Next Advertisements ”;

Apache IVY – Resolve Task ”; Previous Next Resolve task is used to resolve dependencies described in ivy.xml, download and put them in ivy cache. Let”s first create a java file Tester.java in E: > ivy > src > com > tutorialspoint folder which will act as source folder for ant project. Application.java package com.tutorialspoint; import org.apache.commons.lang.StringUtils; public class Application { public static void main(String[] args) { String string = StringUtils.upperCase(“Ivy Beginner Guide”); System.out.println(string); } } Above class is using apache commons lang library to use its class StringUtils. Ivy should download this library and thus it should be defined under dependencies section in ivy.xml. Following is the ivy.xml created in E: > ivy folder. ivy.xml <?xml version=”1.0″ encoding=”ISO-8859-1″?> <ivy-module version=”2.0″ xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance” xsi:noNamespaceSchemaLocation=”http://ant.apache.org/ivy/schemas/ivy.xsd”> <info organisation=”com.tutorialspoint” module=”test” status=”integration”> </info> <dependencies> <dependency org=”org.apache.commons” name=”commons-lang3″ rev=”3.9″/> </dependencies> </ivy-module> Following are the important terms. ivy-module − Root element to identify ivy version, namespace etc. info − element to identify the project as a unique entity. organisation − name of the organization module − name of the module status − status like release, integration or milestone. dependencies − element to contain project dependencies as dependency tags which has following attributes. org − name of the dependency”s organization name − name of the dependency. rev − version of the dependency. build.xml <project name=”test” default=”resolve” xmlns:ivy=”antlib:org.apache.ivy.ant”> <target name=”resolve” description=”resolve dependencies”> <ivy:resolve /> </target> </project< Following are the important terms. project − Root element to identify project name, default task namespace for ivy etc. target − target element to create a new task and its description. This contains an ivy resolve task. When ant builds the project, it runs the ivy resolve task which then resolves the dependencies using ivy. Building the project As we”ve all the files ready. Just go the console. Navigate to E: > ivy folder and run the ant command. E:ivy > ant Ivy will come into action, resolving the dependencies, you will see the following result. Buildfile: E:ivybuild.xml resolve: [ivy:resolve] :: Apache Ivy 2.5.0 – 20191020104435 :: https://ant.apache.org/ivy / :: [ivy:resolve] :: loading settings :: url = jar:file:/E:/Apache/apache-ant-1.9.14 /lib/ivy-2.5.0.jar!/org/apache/ivy/core/settings/ivysettings.xml [ivy:resolve] :: resolving dependencies :: com.tutorialspoint#test;working@Acer- PC [ivy:resolve] confs: [default] [ivy:resolve] found commons-lang#commons-lang;2.6 in public [ivy:resolve] found junit#junit;3.8.1 in public [ivy:resolve] :: resolution report :: resolve 375ms :: artifacts dl 79ms ——————————————————————— | | modules || artifacts | | conf | number| search|dwnlded|evicted|| number|dwnlded| ——————————————————————— | default | 2 | 2 | 0 | 0 || 4 | 0 | ——————————————————————— [ivy:retrieve] :: retrieving :: com.tutorialspoint#test [sync] [ivy:retrieve] confs: [default] [ivy:retrieve] 0 artifacts copied, 2 already retrieved (0kB/101ms) BUILD SUCCESSFUL Total time: 1 second E:ivy> Resolve Output Following are the important terms. conf − configuration, in our case we are using default configuration. modules − indicates the total number of modules, downloaded modules etc. artifacts − indicates the total number of artifacts, downloaded artifacts etc. You can verify the downloaded files in ivy cache”s default location in ${ivy.default.ivy.user.dir} > .ivy2 > cache folder. And ${ivy.default.ivy.user.dir} is by default user home: $HOME. Print Page Previous Next Advertisements ”;

Apache IVY – Settings File ”; Previous Next Apache Ivy follows Maven principles and comes with lot of default configurations. Default settings can be overridden by defining a ivysettings.xml file. <ivysettings> <properties file=”${ivy.settings.dir}/ivysettings-file.properties” /> <settings defaultCache=”${cache.dir}” defaultResolver=”ibiblio” checkUpToDate=”false” /> <resolvers> <ibiblio name=”ibiblio” /> <filesystem name=”internal”> <ivy pattern=”${repository.dir}/[module]/ivy-[revision].xml” /> <artifact pattern=”${repository.dir}/[module]/[artifact]-[revision].[ext]” /> </filesystem> </resolvers> <modules> <module organisation=”tutorialspoint” name=”.*” resolver=”internal” /> </modules> </ivysettings> Tags of Ivy Settings File Following are the important tags of Ivy Setting file. property − To set an ivy variable. Cardinality: 0..n properties − To set an ivy variables using properties file. Cardinality: 0..n settings − To configure ivy with default values. Cardinality: 0..1 include − To include another settings file. Cardinality: 0..n classpath − To add a location in the classpath used to load plugins. Cardinality: 0..n typedef − To define new types in ivy. Cardinality: 0..n lock-strategies − To define lock strategies. Cardinality: 0..1 caches − To define repository cache managers. Cardinality: 0..1 latest-strategies − To define latest strategies. Cardinality: 0..1 parsers − To define module descriptor parsers. Cardinality: 0..1 version-matchers − To define new version matchers. Cardinality: 0..1 triggers − To register triggers on ivy events. Cardinality: 0..1 namespaces − To define new namespaces. Cardinality: 0..1 macrodef − To define a new macro resolver. Cardinality: 0..n resolvers − To define dependency resolvers. Cardinality: 0..1 conflict-managers − To define conflicts managers. Cardinality: 0..1 modules − To define rules between modules and dependency resolvers. Cardinality: 0..1 outputters − To define the list of available report outputters. Cardinality: 0..1 statuses − To define the list of available statuses. Cardinality: 0..1 Print Page Previous Next Advertisements ”;

Apache IVY – Retrieve Task ”; Previous Next retrieve task is used to resolve dependencies to a specified location in project workspace. Let”s create Tester.java, build.xml and ivy.xml as described in IVY – Resolve Task chapter. Update the build.xml to use the ivy retrieve task. build.xml <project name=”test” default=”resolve” xmlns:ivy=”antlib:org.apache.ivy.ant”> <target name=”resolve” description=”resolve dependencies”> <ivy:resolve /> <ivy:retrieve sync=”true” type=”jar” /> </target> </project> Following are the important terms. sync − sync true ensure that lib directory is up-to-date and any extra file gets deleted. type − type directs ivy to copy only specified type of artifacts like jar. Source jar, javadoc jar will be ignored. type for source jar is src or source and doc or bundle for javadoc jar. retrieve tasks copies the resolved dependencies in the lib directory of the project by default and can be changed using pattern attribute. Building the project As we”ve all the files ready. Just go the console. Navigate to E: > ivy folder and run the ant command. E:ivy > ant Ivy will come into action, resolving the dependencies, you will see the following result. Buildfile: E:ivybuild.xml resolve: [ivy:resolve] :: Apache Ivy 2.5.0 – 20191020104435 :: https://ant.apache.org/ivy / :: [ivy:resolve] :: loading settings :: url = jar:file:/E:/Apache/apache-ant-1.9.14 /lib/ivy-2.5.0.jar!/org/apache/ivy/core/settings/ivysettings.xml [ivy:resolve] :: resolving dependencies :: com.tutorialspoint#test;working@Acer- PC [ivy:resolve] confs: [default] [ivy:resolve] found commons-lang#commons-lang;2.6 in public [ivy:resolve] found junit#junit;3.8.1 in public [ivy:resolve] :: resolution report :: resolve 316ms :: artifacts dl 18ms ——————————————————————— | | modules || artifacts | | conf | number| search|dwnlded|evicted|| number|dwnlded| ——————————————————————— | default | 2 | 2 | 0 | 0 || 4 | 0 | ——————————————————————— [ivy:retrieve] :: retrieving :: com.tutorialspoint#test [sync] [ivy:retrieve] confs: [default] [ivy:retrieve] 0 artifacts copied, 2 already retrieved (0kB/2756ms) BUILD SUCCESSFUL Total time: 31 seconds You can verify the downloaded files in project lib directory. Print Page Previous Next Advertisements ”;

Apache IVY – Environment Setup ”; Previous Next Apache Ivy needs Java and ANT installed on your machine as the only requirement. Apache Ant is distributed under the Apache Software License, a fully-fledged open source license certified by the open source initiative. The latest Apache Ant version, including its full-source code, class files, and documentation can be found at http://ant.apache.org Installing Apache Ant It is assumed that you have already downloaded and installed Java Development Kit (JDK) on your computer. If not, please follow the instructions here. Ensure that the JAVA_HOME environment variable is set to the folder where your JDK is installed. Download the binaries from https://ant.apache.org Unzip the zip file to a convenient location c:folder. using Winzip, winRAR, 7-zip or similar tools. Create a new environment variable called ANT_HOME that points to the Ant installation folder, in this case c:apache-ant-1.10.12-bin folder. Append the path to the Apache Ant batch file to the PATH environment variable. In our case this would be the c:apache-ant-1.10.12-binbin folder. Verifying Apache Ant Installation To verify the successful installation of Apache Ant on your computer, type ant on your command prompt. You should see an output similar to − C:>ant -version Apache Ant(TM) version 1.10.12 compiled on October 13 2021 If you do not see the above output, then please verify that you have followed the installation steps properly. Installing Apache Ivy Download the binaries from https://ant.apache.org/ivy Unzip the zip file to a convenient location c:folder. using Winzip, winRAR, 7-zip or similar tools. Copy the ivy-2.5.0.jar to c:apache-ant-1.10.12-bin/lib folder. Verifying Apache Ivy Installation To verify the successful installation of Apache Ivy on your computer, create following build file in a folder E: > ivy. <project name=”test ivy installation” default=”test” xmlns:ivy=”antlib:org.apache.ivy.ant”> <target name=”test” description=”Test ivy installation”> <ivy:settings /> </target> </project> You should see an output similar to − C:>ant Buildfile: E:ivybuild.xml test: BUILD SUCCESSFUL Total time: 2 seconds Installing Eclipse This tutorial also covers integration of Ant with Eclipse IDE. Hence, if you have not installed Eclipse already, please download and install Eclipse. To install Eclipse − Download the latest Eclipse binaries from www.eclipse.org Unzip the Eclipse binaries to a convenient location, say c:folder Run Eclipse from c:eclipseeclipse.exe Print Page Previous Next Advertisements ”;

Apache IVY – Resolvers ”; Previous Next Resolvers are used to find locations from where a library is to be downloaded. A dependency resolver also handles common tasks. Ivy provides two types of Resolvers. Composite − A resolver which uses other resolvers to do its tasks. Standard − A resolver performs the required tasks. Standard Resolvers Following table lists down the standard resolvers and their usage. Sr.No. Name (Type) & Description 1 IvyRep (Standard) Locates Ivy files on ivyrep and artifacts on ibiblio. 2 IBiblio (Standard) Locates artifacts on ibiblio. 3 BinTray (Standard) Locates artifacts on bintray. 4 Packager (Standard) Locates Ivy files and packaging instructions via URLs, creates artifacts using instructions. 5 FileSystem (Standard) Locates Ivy files and artifacts on local file system. 6 URL (Standard) Locates Ivy files and artifacts on repositories which can be accessed using URLs. 7 MirroredURL (Standard) Locates Ivy files and artifacts on repositories which can be accessed using URLs from a mirror list. 8 VFS (Standard) Locates Ivy files and artifacts on repositories which can be accessed using Apache Commons VFS. 9 SSH (Standard) Locates Ivy files and artifacts on repositories which can be accessed using SSH. 10 SFTP (Standard) Locates Ivy files and artifacts on repositories which can be accessed using SFTP. 11 Jar (Standard) Locates Ivy files and artifacts on repositories within a jar. 12 Chain (Composite) Delegates the search to a chain of sub resolvers. 13 Dual (Composite) Delegates the search to a one resolver and artifacts to another. 14 OBR (Standard) Resolve modules as OSGi bundles listed by an OSGi obr.xml. 15 Eclipse updatesite (Standard) Resolve modules as OSGi bundles which are hosted on an Eclipse update site. 16 OSGi-agg (Composite) Delegates the search to a chain of sub resolvers supporting OSGi bundles. Let”s create Tester.java, build.xml and ivy.xml in a new project under E: > ivy2 folder similar to as described in IVY – Resolve Task chapter. Create a settings folder under E: > ivy2. Create the ivysettings.xml in the settings folder. build.xml <project name=”test” default=”resolve” xmlns:ivy=”antlib:org.apache.ivy.ant”> <property name = “build.dir” value = “build”/> <property name = “base.dir” value = “”/> <target name=”resolve” description=”resolve dependencies”> <ivy:resolve /> </target> <target name=”compile” depends=”resolve” description=”Compile”> <mkdir dir=”build/classes” /> <javac srcdir=”src” destdir=”build/classes”> <classpath refid=”new.classpath” /> </javac> </target> </project> ivy.xml <?xml version=”1.0″ encoding=”ISO-8859-1″?> <ivy-module version=”2.0″ xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance” xsi:noNamespaceSchemaLocation=”http://ant.apache.org/ivy/schemas/ivy.xsd”> <info organisation=”org.apache” module=”chained-resolvers”/> <dependencies> <dependency org=”commons-lang” name=”commons-lang” rev=”2.6″ conf=”default”/> <dependency org=”com.tutorialspoint” name=”test” rev=”1.0″/> </dependencies> </ivy-module> Here we”ve added two dependencies,one of commons-lang library and another as test which we published in IVY – Publish Task chapter. ivysettings.xml <ivysettings> <settings defaultResolver=”multiresolver”/> <resolvers> <chain name=”multiresolver”> <filesystem name=”libraries”> <artifact pattern=”${ivy.settings.dir}/repository/[artifact]-[revision].[ext]”/> </filesystem> <ibiblio name=”ibiblio” m2compatible=”true”/> </chain> </resolvers> </ivysettings> Here we”ve added created a composite resolver using chain resolver which has two resolver, one named libraries to locate libaries on local repository and one named ibiblio on maven public repository. Building the project As we”ve all the files ready. Just go the console. Navigate to E: > ivy2 folder and run the ant command. E:ivy > ant Ivy will come into action, resolving the dependencies, you will see the following result. Buildfile: E:ivy2build.xml resolve: [ivy:resolve] :: Apache Ivy 2.5.0 – 20191020104435 :: https://ant.apache.org/ivy / :: [ivy:resolve] :: loading settings :: url = jar:file:/E:/Apache/apache-ant-1.9.14 /lib/ivy-2.5.0.jar!/org/apache/ivy/core/settings/ivysettings.xml [ivy:resolve] :: resolving dependencies :: org.apache#chained-resolvers;working@ Acer-PC [ivy:resolve] confs: [default] [ivy:resolve] found commons-lang#commons-lang;2.6 in public [ivy:resolve] found com.tutorialspoint#test;1.0 in local [ivy:resolve] found junit#junit;3.8.1 in public [ivy:resolve] downloading C:UsersAcer.ivy2localcom.tutorialspointtest1.0 jarsapplication.jar … [ivy:resolve] .. (1kB) [ivy:resolve] .. (0kB) [ivy:resolve] [SUCCESSFUL ] com.tutorialspoint#test;1.0!application.jar (13ms) [ivy:resolve] :: resolution report :: resolve 1085ms :: artifacts dl 22ms ——————————————————————— | | modules || artifacts | | conf | number| search|dwnlded|evicted|| number|dwnlded| ——————————————————————— | default | 3 | 3 | 1 | 0 || 5 | 1 | ——————————————————————— BUILD SUCCESSFUL Total time: 9 seconds In the logs you can verify that we have used both local and public repository resolvers. Print Page Previous Next Advertisements ”;