Download and Install

-The Jackrabbit source code is available via Subversion at -https://svn.apache.org/repos/asf/incubator/jackrabbit/trunk -

-and anonymous access is available at -http://svn.apache.org/repos/asf/incubator/jackrabbit/trunk -

or with viewcvs at -http://svn.apache.org/viewcvs/incubator/jackrabbit/trunk/ -

The Jackrabbit main project is located in the "jackrabbit" subdirectory -and the "contrib" subdirectory contains various additional modules and -contributed projects.

- -

To checkout the main Jackrabbit source tree, run - - svn checkout http://svn.apache.org/repos/asf/incubator/jackrabbit/trunk/jackrabbit - -

-Once you have a copy of the source code tree, you can use Apache Maven - - http://maven.apache.org/ - -to build the project. After installing Maven 1.0, be sure to download the -latest release of the Ant plugin (1.8.1 or later) using a command like - - maven plugin:download -DgroupId=maven \ - -DartifactId=maven-ant-plugin -Dversion=1.8.1 - - -before running one of the maven commands listed at - - http://maven.apache.org/start/use.html - -to build the Jackrabbit project and/or documentation. -

-NOTE: Java 5 users need to download the xalan.jar and serializer.jar -libraries from the Xalan-Java binary distribution at -http://xml.apache.org/xalan-j/downloads.html and place them in -$MAVEN_HOME/lib/endorsed (or $JRE/lib/endorsed if using Maven 1.1) -to build the Jackrabbit sources. The reason for this workaround is -explained in - http://issues.apache.org/jira/browse/JCR-46 -

+ As the Jackrabbit project has yet to make its first binary releases, + you need to build Jackrabbit from sources to install it. The + Maven build environment + makes it very easy to build Jackrabbit. +

+ The first step in building Jackrabbit is to check out the Jackrabbit + sources from the Subversion + source repository at + http://svn.apache.org/repos/af/incubator/jackrabbit/. + The trunk of the source repository is divided in two parts: +

trunk/jackrabbit: + This is the main Jackrabbit source tree that contains everything you + need for a fully functional Jackrabbit installation. This source tree + is often referred to as "the Jackrabbit core". In addition to the + main Jackrabbit jar library, this source tree is also used for the + "jackrabbit-commons" utility library used also in other JCR tools + and implementations. +
trunk/contrib: + This is a collection of additional Jackrabbit modules and other + contributed subprojects like the RMI and WebDAV network layers for + the JCR API. See the individual contrib projects for installation + and usage instructions. +

+ + +

+ You need a Subversion + client to access the Jackrabbit source repository. Take a look at the + Subversion client list + unless you already have a one installed. Once you have the Subversion + client installed you can checkout the main Jackrabbit source tree + with the following command or its equivalent in the client you are using: +

+ svn checkout http://svn.apache.org/repos/asf/incubator/jackrabbit/trunk/jackrabbit +

+ The above checkout will create a subdirectory named + jackrabbit that contains the latest Jackrabbit sources. + See the Subversion book or + the documentation of your Subversion client for more information on + how to manage your source tree and keep it up to date with latest + development. +

+ + + +

+ Jackrabbit uses Maven + version 1.x as the build system and the source tree is mostly + organized according to the Maven + Standard Directory Layout. + The Maven version 1.0.2 and Java Development Kit (JDK) version 1.4 + are the standard build environment, but you should be quite fine also + with Maven 1.1 and Java 5. +

+ Note for Java 5 users: + As discussed in + JCR-46, you + need to download + the Xalan-Java files + xalan.jar and serializer.jar and place them + in $MAVEN_HOME/lib/endorsed (or $JAVA_HOME/jre/lib/endorsed + if you use Maven 1.1) to avoid problems in generating the JavaCC + grammar files used by Jackrabbit. +

+ See the Maven 1.x + installation + and quick-start + guides for instructions on how to use Maven with Jackrabbit. You + may also want to check for + Maven integration + with your favourite Integrated Development Environment (IDE). + Common operations to run within the checked out + jackrabbit directory are: +

maven jar: + Compiles the Jackrabbit source files, runs all unit tests and + packages the Jackrabbit classes into a jar library. This is the + standard "build all" operation for Jackrabbit. The resulting + jar package is located in target/jackrabbit-*.jar. + This operation also generates the jackrabbit-commons + jar package within the modules/commons subdirectory. +
maven jar:install: + Executes the jar goal and installs the resulting jar + packages into the local Maven repository. This operation is used + when you want to make Jackrabbit available as a dependency for + other local Maven projects. The Maven groupId for Jackrabbit is + org.apache.jackrabbit and the artifactId is + jackrabbit. +
maven clean: + Removes the target directory that contains all + compiled classes and other files generated by the Maven builds. + This operation is used to clean up the build environment. The + Maven build system is quite good in keeping all the classes + and other generated files up to date but every now and then + you may want to run maven clean jar to do a fresh + build of the entire project. +
maven copy-deps: + Copies all the Jackrabbit dependencies into the + target/lib directory. This operation is used as a + convenient way to get all the Jackrabbit dependencies instead of + downloading them from the net or looking for them in the local + Maven repository. Note however that the copied dependencies will + contain the compile and unit test dependencies in addition to the + real runtime dependencies of Jackrabbit. +

+ The Jackrabbit test suite is quite extensive, so running + maven jar may take a while due to the unit tests being + run. Use maven jar -Dmaven.test.skip=true to skip + running the unit tests. Note that skipping the unit tests is not + recommended in general. +

+ +