16.2. Core Modules

modeshape-jcr contains ModeShape's implementation of the JCR 2.0 API . If you're using ModeShape as a JCR repository, this is the top-level dependency that you'll want to use. The module defines all required dependencies, except for the repository connector(s) and any sequencer implementations needed by your configuration. As we'll see later on, using ModeShape as a JCR repository is as easy as defining a configuration, obtaining the JCR Repository object for your repository using the RepositoryFactory , and then using the standard JCR API. This module also uses the JCR unit tests from the reference implementation to verify the behavior of the ModeShape implementation. modeshape-jcr also provides two essential connectors: the In-Memory Connector and the Federation Connector.

modeshape-jcr-api is a small module containing ModeShape's public API, which extends the standard JCR API to expose ModeShape-specific functionality. For example, this module defines a Repositories interface, implemented by the ModeShape JcrEngine, that defines a way to look up javax.jcr.Repository instances by name. It also defines several new interfaces that extend the JCR 2.0 API's Query Object Model with additional behavior, including more criteria options (such as BETWEEN, the mode:Depth and jcr:path pseudo-columns, and the REFERENCE function), formal LIMIT and OFFSET clauses, and a set query operator for unions, intersects, and difference queries. Client applications can depend only upon this module without having to depend on the modeshape-jcr interfaces or its dependencies.