Switch branches/tags
modeshape-5.4.1.Final modeshape-5.4.0.Final modeshape-5.3.0.Final modeshape-5.2.0.Final modeshape-5.1.0.Final modeshape-5.0.0.Final modeshape-4.6.2.Final modeshape-4.6.1.Final modeshape-4.6.0.Final modeshape-4.5.0.Final modeshape-4.4.0.Final modeshape-4.3.0.Final modeshape-4.2.0.Final modeshape-4.1.0.Final modeshape-4.0.0.Final modeshape-4.0.0.Beta2 modeshape-4.0.0.Beta1 modeshape-4.0.0.Alpha4 modeshape-4.0.0.Alpha3 modeshape-4.0.0.Alpha2 modeshape-4.0.0.Alpha1 modeshape-3.8.1.Final modeshape-3.8.0.Final modeshape-3.7.4.Final modeshape-3.7.3.Final modeshape-3.7.2.Final modeshape-3.7.1.Final modeshape-3.7.0.Final modeshape-3.6.1.Final modeshape-3.6.0.Final modeshape-3.5.0.Final modeshape-3.4.0.Final modeshape-3.3.0.Final modeshape-3.2.0.Final modeshape-3.1.3.Final modeshape-3.1.2.Final modeshape-3.1.1.Final modeshape-3.1.0.Final modeshape-3.0.1.Final modeshape-3.0.0.Final modeshape-3.0.0.CR3 modeshape-3.0.0.CR2 modeshape-3.0.0.CR1 modeshape-3.0.0.Beta4 modeshape-3.0.0.Beta3 modeshape-3.0.0.Beta2 modeshape-3.0.0.Beta1 modeshape-3.0.0.Alpha6 modeshape-3.0.0.Alpha5 modeshape-3.0.0.Alpha4 modeshape-3.0.0.Alpha3 modeshape-3.0.0.Alpha2 modeshape-3.0.0.Alpha1 modeshape-2.8.3.Final modeshape-2.8.2.Final modeshape-2.8.1.GA modeshape-2.8.1.Final modeshape-2.8.0.Final modeshape-2.7.0.Final modeshape-2.6.0.Final modeshape-2.6.0.Beta2 modeshape-2.6.0.Beta1 modeshape-2.5.0.Final modeshape-2.5.0.Beta2 modeshape-2.5.0.Beta1 modeshape-2.4.0.Final modeshape-2.3.0.Final modeshape-2.2.0.Final modeshape-2.1.0.Final modeshape-2.0.0.Final modeshape-1.2.0.Final modeshape-1.1.0.Final modeshape-1.0.0.Final modeshape-1.0.0.Beta1 dna-0.7 dna-0.6 dna-0.5 dna-0.4 dna-0.3 dna-0.2 dna-0.1 EDS_5.3.1_2_2014 3.8.x-prod-ip6.1-ER1
Nothing to show
Find file History
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
..
Failed to load latest commit information.
README.md
pom.xml

README.md

This ModeShape BOM makes it easy for your applications and libraries to embed ModeShape and explicitly manage ModeShape's lifecycle. This is typically what is used in the POM files of Java SE applications, libraries, and even web applications that are deployed to containers other than JBoss EAP6. (There is a special BOM for deployments to JBoss EAP 6 that has ModeShape installed.)

== Usage ==

Include the following in your POM file:

<project>
  ...
  <dependencyManagement>    
    <dependencies>
      <dependency>
        <groupId>org.modeshape.bom</groupId>
        <artifactId>modeshape-bom-embedded</artifactId>
        <version>${version.modeshape}</version>
        <type>pom</type>
        <scope>import</scope>
      </dependency>
    </dependencies>
  </dependencyManagement>
  ...
</project>

Obviously, you'll need to specify the correct ModeShape version. But note that this is the only place you'll need to specify a version, because the BOM provides a completely valid and consistent set of versions.

This works like all other Maven BOMs by adding into the dependencyManagement section all of the dependency defaults for the ModeShape components and dependencies that your module might need. Then, all you have to do is add an explicit dependency to your POM's dependencies section for each of ModeShape's components that your module does use, including any of the optional optional components (e.g., sequencers, MongoDB binary store, JTA implementation, JAAS implementation, etc.) that simply need to be on the classpath for ModeShape to find and use them.

For example, if your module explicitly uses the JCR API and needs to manually set up and manage a ModeShape engine, then simply define these dependencies:

<project>
  ...
  <dependencies>
    ...
    <dependency>
      <groupId>org.modeshape</groupId>
      <artifactId>modeshape-jcr-api</artifactId>
    </dependency>
    <dependency>
      <groupId>org.modeshape</groupId>
      <artifactId>modeshape-jcr</artifactId>
    </dependency>
    ...
  </dependencies>
  ...
</project>

You can also add any sequencers and connectors that ModeShape should find. Here's an example that adds in ModeShape's XSD sequencer:

<project>
  ...
  <dependencies>
    ...
    <dependency>
      <groupId>org.modeshape</groupId>
      <artifactId>modeshape-sequencer-xsd</artifactId>
    </dependency>
    <dependency>
      <groupId>org.modeshape</groupId>
      <artifactId>modeshape-connector-git</artifactId>
    </dependency>
    ...
  </dependencies>
  ...
</project>