Release Notes for ModeShape 3.8.1.Final

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

What's new

3.8.1.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 patch release addresses 44 issues, most of which are bug fixes. We've improved performance when getting the path of a node and when adding children under a parent with lots of children. The Repository Explorer web app has been completely rewritten, and is the same as what is in 4.x. The release also upgrades to EAP 6.3 Beta for the ModeShape subsystem.

Community support

The ModeShape community has moved on to support the 4.x releases. Therefore, we anticipate that this will be the last 3.x release.

Features

ModeShape 3.8.1.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
• Visual repository explorer web application

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
• Access controls

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
• Access through visual repository explorer web application
• 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.8.1.Final release:

Bug

• MODE-2322 - Setting a STRING property longer than "min-string-size" fails
• MODE-2200 - decrementBinaryReferenceCount() fails when InfinispanBinaryStore and Federation are enabled
• MODE-2228 - ModeShape subsystem for Wildfly (EAP) should default to "readonly" for anonymous roles
• MODE-2221 - ModeShape 3.8.0 not releasing JDBC connections to the pool
• MODE-2220 - using uppercase() on transformwithSQL.transformselectSQL generates error
• MODE-2223 - ModeShape's EAP kit incorrectly formats logging messages with arguments
• MODE-2261 - Can't execute queries with multiple selectors via REST API
• MODE-2263 - Trying to import metadata using TeiidDesigner, and getting permission denied
• MODE-2288 - can't add a custom sequencer in EAP without specifying a path-expresssion/s
• MODE-2243 - Accessing WebDAV as network drive via the Windows client does not work
• MODE-2267 - Query constraints on node name and local name are swapped
• MODE-2240 - Getting binary store errors on Windows (s-ramp integration tests)
• MODE-2283 - Losing backreferences after modify property reference value
• MODE-2218 - Importing metadata via JDBC driver doesn't return all columns
• MODE-2315 - Cannot build 3.x branch using Java 6
• MODE-2317 - JsonReader should support parsing regular characters if they begin with \u
• MODE-2284 - After import node tree all imported nodes lose backreferences
• MODE-2289 - Incorrect OSGI manifest generated for the modeshape-jcr artifact
• MODE-2258 - Incorrect encoding of non-ASCII characters in REST API URLs
• MODE-2259 - The ModeShape subsystem cannot be added via CLI to multiple profiles in domain mode
• MODE-2216 - Move operation on cluster causes InvalidItemStateException exception
• MODE-2309 - Backup and restore problems with CR / LF / CRLF
• MODE-2250 - Only one SNS node is shown when using items REST API with depth=-1
• MODE-2252 - Creating 22 files in a directory in a filesystem projection fails
• MODE-2253 - Backup/Restore does not work in JBoss EAP
• MODE-2254 - DefaultValueFactory.createDate() throws StringIndexOutOfBoundsException for 20 or 21 character strings
• MODE-2219 - errors when publishing teiid models
• MODE-2270 - Unable to defined publishing area when publishing Teiid Model in JBDS
• MODE-2271 - Improve performance of getting path of node that is below a large ancestor
• MODE-2325 - CMIS webapplication contains duplicate jars
• MODE-2275 - javax.jcr.query.InvalidQueryException: Table does not exist. when adding multiple nodetypes
• MODE-2302 - The FileSystemBinaryStore incorrectly handles the binary unused / used cycle
• MODE-2278 - Registering unsupported namespaces should result in NamespaceException
• MODE-2268 - The JcrObservationManager doesn't filter local/nonLocal events correctly

Enhancement

• MODE-2244 - Backport new Repository Explorer web application
• MODE-2265 - Evaluate whether to replace transient Infinispan as the workspace cache
• MODE-2277 - Improve performance of isCheckedOut
• MODE-2276 - Improve performance of adding node under parent
• MODE-2266 - Create simple scalability and performance tests

Feature Request

• MODE-2168 - Add support for EAP 6.2/6.3
• MODE-888 - Deprecate the IRestClient interface

Task

• MODE-2299 - ModeShape should not use httpclient versions lower than 4.3.5
• MODE-2227 - Updated ModeShape's EAP kit to 6.3.0.Beta
• MODE-2305 - Update/Remove Apache POI library to avoid security vulnerabilty