There are still many Java libraries that are not support for Maven, or may be you want to create a custom library which is required to include it into your Maven local repository.

Fortunately, Maven comes with command to let you include your “non-maven-support” library into your Maven local repository easily.

Case study

For example, “kaptcha” is a third party library which is used to generate “captcha” image to stop spamming, but it did not support Maven.

Here’s a guide to show you how to install the “kaptcha” jar into your Maven’s local repository.

1. Install library – mvn install

Download the “kaptcha” jar file and put it into your “C:” drive, and issue following Maven’s command :

mvn install:install-file -Dfile=c:\kaptcha-2.3.jar -DgroupId=com.google.code 
-DartifactId=kaptcha -Dversion=2.3 -Dpackaging=jar

Result :

D:\>mvn install:install-file -Dfile=c:\kaptcha-2.3.jar -DgroupId=com.google.code 
-DartifactId=kaptcha -Dversion=2.3 -Dpackaging=jar
[INFO] Scanning for projects...
[INFO] Searching repository for plugin with prefix: 'install'.
[INFO] ------------------------------------------------------------------------
[INFO] Building Maven Default Project
[INFO]    task-segment: [install:install-file] (aggregator-style)
[INFO] ------------------------------------------------------------------------
[INFO] [install:install-file]
[INFO] Installing c:\kaptcha-2.3.jar to 
D:\maven_repo\com\google\code\kaptcha\2.3\kaptcha-2.3.jar
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESSFUL
[INFO] ------------------------------------------------------------------------
[INFO] Total time: < 1 second
[INFO] Finished at: Tue May 12 13:41:42 SGT 2009
[INFO] Final Memory: 3M/6M
[INFO] ------------------------------------------------------------------------

Now, the “kaptcha” jar library is included into your Maven local repository.

2. Modify pom.xml file

After installed, you can add the custom library details into your “pom.xml” file like this

<dependency>
      <groupId>com.google.code</groupId>
      <artifactId>kaptcha</artifactId>
      <version>2.3</version>
</dependency>

3. Done

Build it, now the “kaptcha” jar is able to retrieve from your Maven local repository.

Reference

  1. Maven install file documentation
Any Java questions or problems? please post at this JavaNullPointer.com forum, see you there ~
[ Read More ] You can find more similar articles at Maven Tutorials