2009年2月15日 星期日

How to add a third party jar file into local Maven repository

As a beginner of the Appfuse 2.0 programmer (like me) will face a lot of challenges, let's take Maven as an example. Although, the basic operation concept is like Ant, there still have a lot of difference. I think this still very tough. For me to add a third party library would takes me 2 more days to make it work.
To add a third party library into local Maven repository you will need following steps:
1. Install jar file into local repository with following command.

mvn install:install-file -DgroupId=com.google.gdata -DartifactId=gdata-client -Dversion=1.0 -Dpackaging=jar -Dfile=c:\gdata-client-1.0.jar

2. Modify your POM.xml file

<dependency>
<groupid>com.google.gdata</groupid>
<artifactid>gdata-client</artifactid>
<version>${gdata-client.version}</version>
<scope>system</scope>
<systempath>D:\mvn\.m2\repository\com\google\gdata\gdata-client\1.0\gdata-client-1.0.jar</systemPath>
</dependency>

Then, you can use mvn eclipse:eclipse to update your eclipse class path setting.
You should see the following line in your .classpath file.

<classpathentry kind="lib" path="D:/mvn/.m2/repository/com/google/gdata/gdata-client/1.0/gdata-client-1.0.jar"/>

One more thing that we should understand is the definition of depency scope. There are 6 scopes avaliable for us to configure. I list them as following for quick reference[1]:

* compile

This is the default scope, used if none is specified. Compile dependencies are available in all classpaths of a project. Furthermore, those dependencies are propagated to dependent projects.

* provided

This is much like compile, but indicates you expect the JDK or a container to provide the dependency at runtime. For example, when building a web application for the Java Enterprise Edition, you would set the dependency on the Servlet API and related Java EE APIs to scope provided because the web container provides those classes. This scope is only available on the compilation and test classpath, and is not transitive.

* runtime

This scope indicates that the dependency is not required for compilation, but is for execution. It is in the runtime and test classpaths, but not the compile classpath.

* test

This scope indicates that the dependency is not required for normal use of the application, and is only available for the test compilation and execution phases.

* system

This scope is similar to provided except that you have to provide the JAR which contains it explicitly. The artifact is always available and is not looked up in a repository.

* import (only available in Maven 2.0.9 or later)
This scope is only used on a dependency of type pom in the section. It indicates that the specified POM should be replaced with the dependencies in that POM's section. Since they are replaced, dependencies with a scope of import do not actually participate in limiting the transitivity of a dependency.

Reference:

  1. http://maven.apache.org/guides/introduction/introduction-to-dependency-mechanism.html

沒有留言: