Release Notes for ModeShape 3.3.0.Final

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

What's new

3.3.0.Final provides a fast, elastic, distributed hierarchical database that clients work with via the standard JCR 2.0 (JSR-283) API. ModeShape 3 is a major upgrade over 2.x and offers significant improvements in performance and scalability, while retaining all of ModeShape 2's JCR-related features. ModeShape 3 has complete integration with JBoss EAP 6.1, allowing deployed components to simply lookup and use repositories managed by ModeShape's service.

This release addesses 47 issues, most of which are bug fixes in lots of areas. Overall, clustering and indexing has been improved, and a new chained binary store is available to allow client applications to dictate in which of several stores a particular binary value should be stored.

This release also upgrades to EAP 6.1.0.GA. As with 3.2, the artifact name for BOM for use in applications has been renamed from 'modeshape-bom-jbossas' (used in 3.0 and 3.1) to 'modeshape-bom-jbosseap' (in 3.2 and 3.3). This is to remain consistent and to help reinforce that ModeShape 3.2 works on EAP 6.1 now and not on JBoss AS7.1.1.

Features

ModeShape 3.3.0.Final has these features:

• ModeShape uses Infinispan for all caching and storage, giving a powerful and flexible foundation for creating JCR repositories that are fast, scalable, and highly available. Infinispan offers a great deal of storage options (via cache loaders), but using Infinispan as a distributed, mulit-site, in-memory data grid provides incredible scalability and performance.
• Strongly consistent. ModeShape is atomic, consistent, isolated and durable (ACID), so writing applications is very natural. Applications can even use JTA transactions.
• Fast. ModeShape 3 is just plain seriously fast, and performance is all-around faster than 2.x - most operations are at least one if not several orders of magnitude faster! We'll publish performance and benchmarking results soon.
• Larger content. ModeShape 3 has been designed to store and access the content so that a node can have hundreds of thousands (or more!) of child nodes (even with same-name-siblings) yet still be incredibly fast. Additionally, repositories can scale to many millions of nodes and be deployed across many processes.
• Simplified configuration. There is no more global configuration of the engine; instead, each repository is configured with a separate JSON file, which must conform to a ModeShape-specific JSON Schema and can be validated by ModeShape prior to use. Repository configurations can even be changed while the repository is running (some restrictions apply), making it possible to add/change/remove sequencers, authorization providers, and many other configuration options while the repository is in use.
• Elastic. Add processes to scale out, without having to have a single coordinator.
• Deploy, start, stop and undeploy repositories while the engine is running and while and other repositories are still in use.
• Sessions immediately see all changes persisted/committed by other sessions, although transient changes made by the session always take precedence.
• Monitoring API with over a dozen metrics.
• Sequencing SPI that uses the JCR API to get at the content being processed and create/update the derived content. Sequencers can also dynamically register namespaces and node types. Now it's easy to create custom sequencers.
• Connector SPI that defines how external systems are accessed and optionally updated to project the external information into the repository as regular nodes.
• Simple API for implementing custom MIME type detectors. ModeShape still has a built-in Tika-based detector that determines MIME types using the filename extensions and binary content.
• Simple API for implementing custom text extractors, which extracts from binary values searchable text used in full-text searches and queries.
• Ability to store binary values of any sizes, with a separate facility for storing these on the file system, in Infinispan caches, in relational DBMSes (via JDBC), and in MongoDB. Custom stores are also possible.
• Public API interfaces and methods that were deprecated in 2.7.0.Final (or later) have been removed. There weren't many of these; most of the ModeShape API remains the same as 2.x.
• Integration with JBoss AS 7. ModeShape runs as an integrated subsystem within AS7, and the AS7 tooling can be used to define and manage repositories independently of each other and while the server is running.
• Local and remote JDBC drivers for issuing JCR-SQL2 queries and getting database metadata via the JDBC API
• Use the RESTful API to talk to ModeShape repositories from non-Java and non-local applications
• Use the CMIS API to talk to ModeShape repositories
• Use WebDAV to mount ModeShape repositories as file servers

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

Accessing the Repository

• RepositoryFactory access
• JNDI registration of Repository
• JAAS Authentication
• Servlet Authentication
• Custom Authentication

Namespaces

• Session Remapping
• Permanent Addition/Deletion

Reading Repository Content

• Traversal Access
• Direct Access
• Same-Name Siblings
• Multi-Value Properties
• All Property Types Supported
• Property Type Conversion

Writing Repository Content

• Create/Update/Delete Nodes
• Create/Update/Delete Properties (Through Parent Nodes)
• Moving, Copying, Cloning
• Adding/Removing Mixins
• Referential integrity enforcement

Query / Search

• XPath
• JCR-SQL
• JCR-SQL2
• JCR-QOM
• Full-Text Search

Importing/Exporting Repository Content

• System View Import/Export
• Document View Import/Export

Node Types

• Inheritance Among Node Types
• Discovering available Node Types
• Discovering the Node Types of a Node
• Discovering the Definition of a Node Type
• Property Constraints
• Automatic Item Creation
• Predefined standard Node Types
• Custom Node Type Registration (CND-Based and and JCR 2.0 API Template-Based)

Repository Metadata under System Node

• Permanent Namespace Mappings
• Node Types (Built-In and User-Registered)
• Active Locks

Other JCR Optional Features

• Observation
• Locking
• Versioning
• Shareable nodes

Content Storage Options

• In-memory (local, replicated, and distributed)
• BerkleyDB
• Relational databases (via JDBC), including in-memory, file-based, or remote
• File system
• Cassandra
• Cloud storage (e.g., Amazon's S3, Rackspace's Cloudfiles, or any other provider supported by JClouds)
• Remote Infinispan

Binary Storage Options

• File system
• JDBC database
• Infinispan
• MongoDB
• Chained binary stores

ModeShape also has features that go beyond the JCR API:

ModeShape Federation Connectors

• File system connector (read and write)
• Git repository connector (read-only)
• CMIS reposiotry connector (read and write, tech preview)

ModeShape Sequencers

• Compact Node Definition (CND) Sequencer
• DDL Sequencer
• Image Sequencer
• Java Source Sequencer
• Java Class Sequencer
• MP3 Sequencer
• MS Office Sequencer
• Text Sequencers (Delimited and Fixed Width)
• XML Sequencer
• XML Schema Document (XSD) Sequencer
• Web Service Definition Lanaguage (WSDL) 1.1 Sequencer
• Zip File Sequencer (also WARs, JARs, and EARs)
• Teiid Relational Model Sequencer
• Teiid VDB Sequencer

ModeShape Deployment/Access Models

• JNDI-Based Deployment
• Deploy as a subsystem in JBoss AS7, with access to repositories via @Resource injection
• Deploy to other containers using ModeShape's JCA adapter
• Access through two RESTful Services (the 2.x-compatible API and a new improved API)
• Access through WebDAV Service
• Access through CMIS Service
• Local and remote JDBC drivers for accessing ModeShape content through JDBC API and JCR-SQL2 queries
• Embedded (in Server or JEE Archive) Deployment
• JTA support, allowing Sessions to participate in XA and container-managed transactions
• OSGi-Compatible Archives

Other ModeShape features

• Repository-wide backup and restoration
• Automatic MIME type detection of binary content
• Asynchronous sequencing operations, within completion notified via events

Bug Fixes, Features, and other Issues

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

Bug

• MODE-1938 - Potentially uninitialized workspace caches can be leaked from repository cache
• MODE-1939 - Oracle DDL Parser Errors When It Parses Database Objects With A Name Containing An Allowed Symbol
• MODE-1930 - DDL Parser Should Use JCR Substitution Characters When Creating A Node With A Name Containing Illegal JCR Characters
• MODE-1932 - and from the EAP kit, incorrectly resolve "path" and "source-path" attributes
• MODE-1933 - ModeShape EAP kit cannot use JMS for storing indexes
• MODE-1934 - Remove/Downgrade Apache POI libraries from MS Office Sequencer and Tika text extractor
• MODE-1935 - JMS support for indexing is incomplete
• MODE-1950 - Mixins cannot be properly removed via the REST Service
• MODE-1937 - Java sequencers do not properly handle methods with same name and parameter names
• MODE-1912 - Unable to remove mixin mix:versionable
• MODE-1913 - CMIS web application fails to restart in EAP 6.1.0.Alpha1
• MODE-1910 - Update InfinispanBinaryStore to use getBestBufferSize to calculate buffer size
• MODE-1911 - Fix ipv4 and ipv6 profiles
• MODE-1916 - Can't use Session.importXML with protected definitions
• MODE-1917 - ModeShape EAP kit is missing JAAS dependency
• MODE-1919 - Workspace Publish Areas Should Be Created When Node Is Created By Publishing Operation
• MODE-1651 - WebDAV: Convert JCR Exceptions to proper WebDAV-Exception to provide correct HTTP status
• MODE-1954 - Removing property definition from registered node type using templates results in exception
• MODE-1949 - Mixin removal should be prevented for a node which still has properties defined in a parent of that mixin
• MODE-1948 - Resource adapter does not properly shut down modeshape engine
• MODE-1945 - Null-Pointer on Import
• MODE-1947 - Excel sequencer throws NPE with empty cells
• MODE-1940 - move of node from /a/b to /a/c does not update query index
• MODE-1953 - The org.modeshape.jcr.JcrNode.getNodes(String) method returns an invalid iterator when the session is not saved yet
• MODE-1926 - Oracle DDL Parsing Of Create Index Statement Is Incomplete
• MODE-1925 - Examples in the release packaging won't start
• MODE-1923 - Cannot start ModeShape with clustered EAP configuration
• MODE-1922 - EAP kit contains typo in XSD
• MODE-1909 - Incompatible with MySQL 5.5 (CONTENT_STORE.LARGEBLOB)
• MODE-1951 - FileSystemConnector inclusionPattern is set incorrectly
• MODE-1929 - ModeShape EAP subsystem ignores the "cluster-name" attribute, making the repository non-clusterable

Enhancement

• MODE-1931 - DdlParsers Parse Improvements
• MODE-1936 - Fix JCA adapter to better comply with the specification
• MODE-1942 - Remove support for storing indexes in ISPN
• MODE-1952 - Implement getAllBinaryKeys() on InfinispanBinaryStore
• MODE-1943 - Simpler clustered indexing
• MODE-1901 - Add ability to retrieve query plan via REST api
• MODE-1902 - Additional rebuild-on-startup mode of "FAILIFMISSING"
• MODE-1921 - Add current+previous value to property-related observation events
• MODE-1924 - Include Session object in AuthorizationProvider API

Feature Request

• MODE-1710 - Connectors should be able to propagate changes in external systems via events
• MODE-1908 - Chaining multiple Modeshape BinaryStore sources

Task

• MODE-1914 - Fix modeshape-connector-cmis test failure
• MODE-1915 - Update ModeShape EAP kit to use EAP 6.1.0.Beta
• MODE-1695 - ModeShape should have EAP-deployable quickstarts
• MODE-1944 - Update ModeShape EAP kit to use EAP 6.1.0.Final
• MODE-1941 - Add EAP security integration test