Release Notes for ModeShape 4.1.0.Final

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

What's new

4.1.0.Final 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.

ModeShape 4.1.0.Final is licensed under the Apache Software License, 2.0.

This release addresses 36 issues and 6 enhancements, including several related to the new indexing & query functionality and some significant ones around the Repository Explorer application. Our Teiid VDB sequencer now supports dynamic VDB parsing and Text Extraction uses Apache Tika 1.6.

Features

ModeShape 4.1.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 4 is just plain seriously fast, and performance is all-around faster than earlier version.
• Larger content. ModeShape 4 can 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 Wildfly 8. ModeShape runs as an integrated subsystem within Wildfly, and the Wildfly 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
• Even journal

Content Storage Options

• In-memory (local, replicated, and distributed)
• Relational databases (via JDBC), including in-memory, file-based, or remote
• LevelDB
• 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)
• JDBC metadata connector (read-only)

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 Wildfly, 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
• Explicitly-defined indexes
• 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 4.1.0.Final release:

Bug

• MODE-2353 - Concurrently creating child nodes for the same parent results in node loss when using Wildfly
• MODE-2379 - Unexpected exception raised when listeners are registered for certain node types and parent nodes are removed
• MODE-2373 - Unable to publish VDB
• MODE-2372 - VersionHistory.addVersionLabel(...) should throw LabelExistsVersionException
• MODE-2371 - Failed login to non-default workspace in 3.8 with JTA
• MODE-2370 - Session scoped locks broken in 3.8.x with JTA
• MODE-2375 - Import referrer node before referenced node should not lose backreference
• MODE-2319 - Repository Explorer should reset navigation path to "root" when changing workspaces
• MODE-2354 - JcrTools authorization issue while create child nodes
• MODE-2357 - Repository Explorer does not display all nodes
• MODE-2339 - Repository Explorer should support the approach for loading repositories
• MODE-2338 - Null pointer error when using Node#getNodes(glob) in a dirty session
• MODE-2337 - Binary file system store not working with absolute path in EAP config
• MODE-2336 - Unstable work event listener monitor changes with user transactions
• MODE-2335 - jcr:name is ignored in initialContent
• MODE-2359 - Import increase referrers count
• MODE-2331 - Querying version histories always returns no results
• MODE-2330 - Exception when trying to remove mix:lastModified
• MODE-2355 - Unexpected behavior with local index provider and mixin properties
• MODE-2383 - Reduce number of artifacts published into Maven repository
• MODE-2380 - The modeshape-unit-test module does not define the modeshape-common:test-jar dependency with the scope "compile"
• MODE-2369 - Setting a STRING property longer than "min-string-size" fails when using InfinispanBinaryStore
• MODE-2364 - ModeShape adds an Infinispan listener per user transaction
• MODE-2366 - Upload via REST results in corrupted file
• MODE-2361 - FilesystemConnector in EAP doesn't store changes to external properties
• MODE-2362 - Teiid Vdb Sequencer cannot by loaded in an OSGI environment
• MODE-2343 - Run-away threads when using the JCR ObservationManager
• MODE-2346 - Indexmanager selecting wrong index
• MODE-2347 - JCR-QOM cannot select from column of subtype
• MODE-2342 - Remove lock tokens from sessions upon logout().
• MODE-2325 - CMIS webapplication contains duplicate jars
• MODE-2340 - Cannot logout from Repository Explorer application
• MODE-2341 - Updates made by reindexing are lost after repository restart
• MODE-2328 - CMIS web application shows incorrect repository information
• MODE-2329 - JQOM doesn't support expanded names
• MODE-2352 - Git Connector exceptions when navigating via the REST service
• MODE-2348 - Unable to configure an index of kind ENUMERATED

Enhancement

• MODE-2365 - Links from modeshape.jboss.org point to old documentation
• MODE-2334 - JcrRepository uses getClass().getClassLoader() to load classes for security providers (among others)
• MODE-2332 - Make methods and properties in JdbcMetadataConnector protected instead of private
• MODE-2231 - Enable navigating in Repository Explorer to content of BINARY property
• MODE-2298 - Sequencers and Text Extractors should only log a warning if an exception occurs after the repository has been shut down
• MODE-2363 - NodeTypeManager gets confused when using case-sensitive nodetypes on SQL storage

Feature Request

• MODE-1652 - Create new and more usable REST client
• MODE-2321 - Upgrade to Tika 1.6 (or latest version)
• MODE-2320 - Repository Explorer should show some sort of "waiting" notification while a repository is being initialized
• MODE-1712 - Allow JCR clients to navigate the nodes exposed by an external source
• MODE-2368 - Modify Teiid Sequencer to support dynamic vdbs
• MODE-2349 - Provide documentation on index configuration

Task

• MODE-2356 - Add examples which show how to embeded the CMIS, WebDAV and REST services into standalone applications
• MODE-2308 - Integrate transitive dependency check plugin
• MODE-2303 - Remove the "queryable" feature of the Git Connector