******************************
           IMPORTANT
******************************

The current release is still in a development status, and at the moment it's not
working as you would expect.

We have two blocking issues at the moment, you can find more information about
them in the 'Issues' section.

=== What's this?

Stone is a project created to test how to replace the embedded JCR Repository in Sling with another
implementation (JBoss ModeShape).

The project includes OSGI bundles you need to install into Sling, along with some bundles that
are basically a replacement for existing ones.

The project also includes a patched version of ModeShape, created mainly because we had problems
with dynamic classloading in an OSGI context.

BEWARE: at the moment the project is in an unfinished state, so IT'S NOT READY FOR PRODUCTION

=== How to build the project

To build the project you need maven.
From the 'stone' directory, simply run

mvn install

We suggest you to set maven options with something like this:

export MAVEN_OPTS="-Xmx512M -XX:MaxPermSize=512M"

=== Installation

After you have successfully built the project, you have to manually install the
bundles into Sling.
First of all, replace the bundle
webconsole-security-provider with the one we provide, so that the authentication
won't rely on repository authentication policies; this is needed when you'll
switch-off jackrabbit server and turn-on modeshape.
If you don't do this, after you start the modeshape repository, you won't be
able to log-in anymore.
If you don't need any kind of authentication, you can simply switch-off the
bundle without further operations.

Depending on the source you need to use with modeshape, you have to choose one
amongst the following:

bundles/jcr/modeshape-server/target/com.sourcesense.stone.jcr.modeshape.server-1.0.0-SNAPSHOT-in-memory.jar
bundles/jcr/modeshape-server/target/com.sourcesense.stone.jcr.modeshape.server-1.0.0-SNAPSHOT-h2.jar
bundles/jcr/modeshape-server/target/com.sourcesense.stone.jcr.modeshape.server-1.0.0-SNAPSHOT-postgres.jar

Then you have to install the bundles the server depends on.

bundles/jcr/com.sourcesense.stone.jcr.base/target/com.sourcesense.stone.jcr.base-1.0.0-SNAPSHOT.jar
modeshape-stone/modeshape-common/target/modeshape-common-2.4.0.Final-stone-SNAPSHOT.jar
~/.m2/repository/net/jcip/com.springsource.net.jcip.annotations/1.0.0/com.springsource.net.jcip.annotations-1.0.0.jar
stone/modeshape-stone/modeshape-graph/target/modeshape-graph-2.4.0.Final-stone-SNAPSHOT.jar

Download and install
http://guava-osgi.googlecode.com/svn/trunk/repository/plugins/com.google.guava_9.0.0.jar

~/.m2/repository/joda-time/joda-time/1.6.2/joda-time-1.6.2.jar
stone/modeshape-stone/modeshape-jcr/target/modeshape-jcr-2.4.0.Final-stone-SNAPSHOT.jar

PATCHED VERSION of lucene-core (See 'Patching Lucene' below)
PATCHED VERSION of lucene-analyzer (See 'Patching Lucene' below)

stone/modeshape-stone/modeshape-cnd/target/modeshape-cnd-2.4.0.Final-stone-SNAPSHOT.jar
stone/modeshape-stone/modeshape-jcr-api/target/modeshape-jcr-api-2.4.0.Final-stone-SNAPSHOT.jar
stone/modeshape-stone/modeshape-repository/target/modeshape-repository-2.4.0.Final-stone-SNAPSHOT.jar
stone/modeshape-stone/extensions/modeshape-search-lucene/target/modeshape-search-lucene-2.4.0.Final-stone-SNAPSHOT.jar

PATCHED VERSION of lucene-queryparser (See 'Patching Lucene' below)
PATCHED VERSION of lucene-queries (See 'Patching Lucene' below)

=== About Sandboxes

The sandbox directories contain some experiments we did during the development
process.
Since they are experiments, some of them aren't supposed to properly work; not
all of them, at least.

=== Patching Lucene

Into the sandbox directory you can find some text files you should use to "fix"
the manifest files of lucene.
We suggest you to download the source distribution of lucene from here:

http://svn.apache.org/repos/asf/lucene/dev/branches/branch_3x

After you "packaged" it, for each of the jars whose bundle reference is
specified above you must add osgi bundle information to its manifest file.

Example
lucene-core --> lucene-core-3.2-SNAPSHOT.jar

Run the command:

jar umf lucene-core-manifest <path_to_jar>/lucene-core-3.2-SNAPSHOT.jar

Now you can install the jar in Sling

=== License

This project is licensed with the Apache License, Version 2.0
See the LICENSE file included in this distribution or visit the link
http://www.apache.org/licenses/LICENSE-2.0.html

=== 3rd-parties Licenses

Along the way we came across some libraries the project depends on.
For each of them, here you can read its own license:

JCIP Annotations: Creative Commons 2.5
JCR: Day JCR License
JBoss ModeShape: LGPL version 2.1 or above
Apache Jackrabbit: Apache License, Version 2.0
Apache Lucene: Apache License, Version 2.0
JBoss Hibernate: LGPL version 2.1 or above
PostgreSQL Drivers: BSD License
H2 Drivers: MPL 1.1 or EPL 1.0
Antl: BSD License
Javassist: Mozilla Public License or LGPL
Google Collections: Apache License, Version 2.0
Joda-Time: Apache License, Version 2.0