jcr-modeshape.xml

<?xml version="1.0" encoding="UTF-8"?>
<!--
  JBoss, Home of Professional Open Source
  Copyright [2010], Red Hat, Inc., and individual contributors
  by the @authors tag. See the copyright.txt in the distribution for a
  full listing of individual contributors.

  Licensed under the Apache License, Version 2.0 (the "License");
  you may not use this file except in compliance with the License.
  You may obtain a copy of the License at
  http://www.apache.org/licenses/LICENSE-2.0
  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.
  -->
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
<chapter id="jcr-modeshape">
    <title>Seam JCR - JBoss ModeShape Integration</title>
    <section id="jcr-ms-installation">
        <title>ModeShape Integration Installation</title>
        <para> In order to activate ModeShape support within your application, you need to include
            ModeShape on your classpath. At a minimum, the following maven dependencies must be
            satisfied. </para>
        <programlisting role="XML"><![CDATA[<dependency>
    <groupId>org.modeshape</groupId>
    <artifactId>modeshape-jcr</artifactId>
    <version>${modeshape.version}</version>
</dependency>
<dependency>
    <groupId>org.apache.lucene</groupId>
    <artifactId>lucene-core</artifactId>
    <version>${lucene.version}</version>
</dependency>]]>
        </programlisting>
        <tip>
            <para> Substitute ${modeshape.version} for the ModeShape version you are running
                against. Currently, Seam JCR tests against 2.5.0.Final. In addition, Lucene is
                required to run ModeShape. Please consult the <ulink url="http://docs.jboss.org/modeshape/latest/manuals/gettingstarted/html/">ModeShape Getting Started Guide</ulink> 
                for exact versions. </para>
        </tip>
    </section>
    <section id="jcr-ms-usage">
        <title>Usage</title>
        <para> In order to use ModeShape's Repository and Session objects in your application, you
            must define an injection point using the JcrConfiguration annotation based on
            ModeShape's required configuration parameters. Please review the 
            <ulink url="http://docs.jboss.org/modeshape/latest/manuals/gettingstarted/html/">ModeShape Getting Started Guide</ulink>
            for further details. </para>
        <programlisting role="java"><![CDATA[
    @Inject @JcrConfiguration(name="org.modeshape.jcr.URL",value="file:path/to/modeshape.xml?repositoryName=MyRepo")
    Repository repository;

    @Inject @JcrConfiguration(name="org.modeshape.jcr.URL",value="file:path/to/modeshape.xml?repositoryName=MyRepo")
    Session session;]]></programlisting>
    </section>
    <!--
   vim:et:ts=3:sw=3:tw=120
   -->
</chapter>