Release Notes for ModeShape 4.0.0.Alpha1

This document outlines the changes that were made in ModeShape 4.0.0.Alpha1. We hope you enjoy it!

What's new

4.0.0.Alpha1 provides a fast, elastic, distributed hierarchical database that clients work with via the standard JCR 2.0 (JSR-283) API. ModeShape 4 is a major upgrade over 3.x and offers significant improvements in clustering, performance, query, and events. All JCR 2.0 features are supported, and ModeShape 4 has complete integration with Wildfly 8, allowing deployed applications to simply lookup and use repositories managed by ModeShape's service.

As of 4.0.0.Alpha1, ModeShape is licensed under the Apache Software License, 2.0.

This is the first alpha release of the 4.0 stream, and it includes several significant changes. The largest impact is the query engine, which has been completely rewritten so that it can use a variety of indexing technology. As of 4.0.0.Alpha1, all queries work except those that use full text search or outer joins (see MODE-2178 for details); these will be fixed in an upcoming release. Also, version 4.0.0.Alpha1 does not yet have support for defining custom indexes, so queries may be slower than in 3.x. However, you will soon be able to define custom indexes for the queries that you are using in your application, reducing the amount of time and processing required to update the indexes.

Clustering has also been made simpler. ModeShape now automatically piggybacks onto Infinispan's clustering configuration, and events can now be captured in a journal on each machine. Over the next few alpha releases, we'll use this to improve how quickly processes can (re)join the cluster. We'll also add support for JCR's event journaling feature.

What to test

Since this is an alpha release, not all features targeted to 4.0 are complete, and there are likely bugs with some of the newer features. Therefore, please do not put 4.0.0.Alpha1 into production.

However, we would like to get as much feedback as possible, so we do ask that our community do limited testing with 4.0.0.Alpha1 to help us identify problems. Specifically, we ask that you test the following areas:


ModeShape 4.0.0.Alpha1 has these features:

All of the JCR 2.0 features previously supported in 2.x are currently supported:

Accessing the Repository


Reading Repository Content

Writing Repository Content

Query / Search

Importing/Exporting Repository Content

Node Types

Repository Metadata under System Node

Other JCR Optional Features

Content Storage Options

Binary Storage Options

ModeShape also has features that go beyond the JCR API:

ModeShape Federation Connectors

ModeShape Sequencers

ModeShape Deployment/Access Models

Other ModeShape features

Bug Fixes, Features, and other Issues

The following are the bugs, features and other issues that have been fixed in the 4.0.0.Alpha1 release:


Component Upgrade


Feature Request

Quality Risk