Category: apache Ivy

Apache IVY – Shared Repository ”; Previous Next A shared repository is a team level shared repository of a team. It is very common to be overridden in organizations. Default Location By default, shared repository is present in ${ivy.default.ivy.user.dir}/shared folder. If you want to change it, the use the ivy.shared.default.root variable in ant file. build.xml <target name=”resolve”> <property name=”ivy.shared.default.root” value=”/opt/ivy/repository/shared”/> <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.shared.default.root” value=”/opt/ivy/repository/shared”/> <property name=”ivy.shared.default.ivy.pattern” value=”[organisation]/[module]/[revision]/ivy.xml”/> <property name=”ivy.shared.default.artifact.pattern” value=”[organisation]/[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 shared repository setting, update the contents of ivysettings-shared.xml. ivysettings-shared.xml <ivysettings> <property name=”ivy.shared.default.root” value=”${ivy.default.ivy.user.dir}/shared” override=”false”/> <property name=”ivy.shared.default.ivy.pattern” value=”[organisation]/[module]/[revision]/[type]s/[artifact].[ext]” override=”false”/> <property name=”ivy.shared.default.artifact.pattern” value=”[organisation]/[module]/[revision]/[type]s/[artifact].[ext]” override=”false”/> <resolvers> <filesystem name=”shared”> <ivy pattern=”${ivy.shared.default.root}/${ivy.shared.default.ivy.pattern}” /> <artifact pattern=”${ivy.shared.default.root}/${ivy.shared.default.artifact.pattern}” /> </filesystem> </resolvers> </ivysettings> Print Page Previous Next Advertisements ”;

Apache IVY – Info Task ”; Previous Next info task is used to set ivy specific information in a file and can be used without any dependency resolution. 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. Before publish task, we”ve set the required ivy information using info task. 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:info file=”ivy.xml” /> <ivy:publish resolver=”local” pubrevision=”1.0″ overwrite=”true”> <artifacts pattern=”${build.dir}/lib/[artifact].[ext]” /> </ivy:publish> </target> </project> Here publish task first build the jar, then set the information using ivy:info task 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. Buildfile: E:ivybuild.xml jar: publish: [ivy:info] :: Apache Ivy 2.5.0 – 20191020104435 :: https://ant.apache.org/ivy/ :: [ivy:info] :: loading settings :: url = jar:file:/E:/Apache/apache-ant-1.9.14/l ib/ivy-2.5.0.jar!/org/apache/ivy/core/settings/ivysettings.xml [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: 0 seconds If we do not put the info task then publish task will not work. Use the below modified build.xml and see the error for missing organization attribute and so on. 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:publish resolver=”local” pubrevision=”1.0″ overwrite=”true”> <artifacts pattern=”${build.dir}/lib/[artifact].[ext]” /> </ivy:publish> </target> </project> 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. Buildfile: E:ivybuild.xml jar: publish: [ivy:publish] :: Apache Ivy 2.5.0 – 20191020104435 :: https://ant.apache.org/ivy / :: [ivy:publish] :: 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 BUILD FAILED E:ivybuild.xml:28: no organisation provided for ivy publish task: It can eithe r be set explicitly via the attribute ”organisation” or via ”ivy.organisation” p roperty or a prior call to <resolve/> Total time: 3 seconds Print Page Previous Next Advertisements ”;

Apache IVY – Cachepath Task ”; Previous Next cachepath task is used to create an ANT classpath with resolved artifacts present in the cache. As ANT needs jars to be classpath to compile java files, Ivy cachepath builds the classpath. 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:cachepath pathid=”new.classpath” /> </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> Following are the important terms. pathid − id of the classpath where cached jars are present. 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 compile 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 2314ms :: artifacts dl 15ms ——————————————————————— | | modules || artifacts | | conf | number| search|dwnlded|evicted|| number|dwnlded| ——————————————————————— | default | 2 | 2 | 0 | 0 || 4 | 0 | ——————————————————————— compile: [javac] E:ivybuild.xml:13: warning: ”includeantruntime” was not set, defau lting to build.sysclasspath=last; set to false for repeatable builds [javac] Compiling 1 source file to E:ivybuildclasses BUILD SUCCESSFUL Total time: 3 seconds You can verify the compiled class file in project build directory. Print Page Previous Next Advertisements ”;

Apache IVY – Quick Guide ”; Previous Next Apache IVY – Overview Apache Ivy is a very popular and very powerful dependency management tool used to manage dependencies in ANT based projects in the same fashion, how Apache Maven manages dependencies. Apache Ivy is Apache ANT based, follows same design principles, is a subproject of Apache ANT and is actively managed and supported by Apache ANT Community. Features Following are the important features of Apache Ivy. ANT Based − Apache Ivy provides a dependencies management capability to ANT based projects. It is very simple to use as well. Dependency Reports − Apache Ivy provides options to print dependencies graph in html as well as in reports format. Non-intrusive − Apache Ivy don”t impose any restrictions as to be part of distribution. Even build files are not dependent on Apache Ivy. Highly Flexible − Apache Ivy provides lots of default configurations and can be configured as per the requirement very easily. Extendible − Apache Ivy can be extended easily. You can define your own repository, conflict resolvers and latest strategy. Performance − Apache Ivy is built towards performance. It keeps a cache of library already downloaded. Looks into local repositories first to resolve dependencies than look into other repositories. Transitive Dependencies − Apache Ivy automatically manages transitive dependencies if one project or library depends upon other library which may need another library. Maven Repository − Apache Ivy follows conventions similar to Maven repository conventions. Apache Ivy can resolve dependencies using maven global repository. Maven 2 POMs − Apache Ivy can read Maven 2 POMs as module descriptors, can set ivy as module descriptor. Thus it makes easy to migrate existing projects to IVY managed projects. Publishing − Apache Ivy provides supports to publish your project and simplifies the multi-project environment deployment process. Free to Use − Apache Ivy is open source and is free to use. Documentation − Apache Ivy has a very detailed documentation and tutorials available to learn. Apache IVY – Environment Setup 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 Apache IVY – Terminology 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 continous

Apache IVY – Overview ”; Previous Next Apache Ivy is a very popular and very powerful dependency management tool used to manage dependencies in ANT based projects in the same fashion, how Apache Maven manages dependencies. Apache Ivy is Apache ANT based, follows same design principles, is a subproject of Apache ANT and is actively managed and supported by Apache ANT Community. Features Following are the important features of Apache Ivy. ANT Based − Apache Ivy provides a dependencies management capability to ANT based projects. It is very simple to use as well. Dependency Reports − Apache Ivy provides options to print dependencies graph in html as well as in reports format. Non-intrusive − Apache Ivy don”t impose any restrictions as to be part of distribution. Even build files are not dependent on Apache Ivy. Highly Flexible − Apache Ivy provides lots of default configurations and can be configured as per the requirement very easily. Extendible − Apache Ivy can be extended easily. You can define your own repository, conflict resolvers and latest strategy. Performance − Apache Ivy is built towards performance. It keeps a cache of library already downloaded. Looks into local repositories first to resolve dependencies than look into other repositories. Transitive Dependencies − Apache Ivy automatically manages transitive dependencies if one project or library depends upon other library which may need another library. Maven Repository − Apache Ivy follows conventions similar to Maven repository conventions. Apache Ivy can resolve dependencies using maven global repository. Maven 2 POMs − Apache Ivy can read Maven 2 POMs as module descriptors, can set ivy as module descriptor. Thus it makes easy to migrate existing projects to IVY managed projects. Publishing − Apache Ivy provides supports to publish your project and simplifies the multi-project environment deployment process. Free to Use − Apache Ivy is open source and is free to use. Documentation − Apache Ivy has a very detailed documentation and tutorials available to learn. Print Page Previous Next Advertisements ”;

Apache IVY Tutorial PDF Version Quick Guide Resources Job Search Discussion Apache IVY is a dependencies management tool similar to Maven but is ANT based. It is highly flexible and configurable similar to ANT and easy to use as Maven. Audience This tutorial has been prepared for the beginners to help them understand the basic functionality of Apache IVY to automate the build and deployment process. Prerequisites For this tutorial, we assume the readers to have prior knowledge of basic software development using Java or any other programming language. It will help if you had some exposure to the software build and deployment process. Print Page Previous Next Advertisements ”;

Apache IVY – Public Repository ”; Previous Next A public repository is a repository accessible using internet and have third party modules. By default ibiblio in m2 compatible mode is the public repository. It is also referred as maven 2 public repository. 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 public repository setting, update the contents of ivysettings-public.xml or create the ivysettings.xml in setting folder of your project. ivysettings.xml <ivysettings> <settings defaultResolver=”default”/> <include url=”http://customserver/ivy/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> Update the default ivysetting-public.xml contents. Original – ivysetting-public.xml <ivysettings> <resolvers> <ibiblio name=”public” m2compatible=”true”/> </resolvers> </ivysettings> Updated – ivysetting-public.xml <ivysettings> <resolvers> <filesystem name=”public”> <ivy pattern=”/path/to/my/public/rep/[organisation]/[module]/ivy-[revision].xml” /> <artifact pattern=”/path/to/my/public/rep/[organisation]/[module]/[artifact]-[revision].[ext]” /> </filesystem> </resolvers> </ivysettings> Print Page Previous Next Advertisements ”;

Discuss Apache IVY ”; Previous Next Apache IVY is a dependencies management tool similar to Maven but is ANT based. It is highly flexible and configurable similar to ANT and easy to use as Maven. Print Page Previous Next Advertisements ”;

Apache IVY – Useful Resources ”; Previous Next The following resources contain additional information on Apache IVY. Please use them to get more in-depth knowledge on this. Useful Links on Apache IVY Apache IVY – Apache IVY official home page Useful Books on Apache IVY To enlist your site on this page, please drop an email to [email protected] Print Page Previous Next Advertisements ”;

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 ”;