Release Notes for ModeShape 3.6.0.Final

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

What's new

3.6.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 54 issues, many of which are bug fixes in lots of areas. The release improves even more the file system connector so that very large files (even dozens of GB) can be effectively accessed (MODE-2061). It is also now possible for clients to programmatically invoke sequencers against transient content, with the output of the sequencers remaining in transient state that will be saved when the session is saved (MODE-1467). The ModeShape kit for EAP now supports both EAP 6.1.0 and 6.1.1, and now supports EAP's domain mode (tech preview, MODE-2026). We also introduced a new Repository Explorer web application that enables using your browser to visually explore the ModeShape content (MODE-1820). This web application is automatically included with the ModeShape kit for EAP and is available for use on other servers.

Features

ModeShape 3.6.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
• 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.6.0.Final release:

Bug

• MODE-1875 - ModeShape should use partial deltas when transferring data in a cluster
• MODE-2030 - Folder children cannot be queried after folder has been renamed/moved
• MODE-2060 - unable to add properties to jcr:content nodes accessed through filesystem connector
• MODE-2049 - NPE on repository shutdown if monitoring is not enabled
• MODE-2031 - Node types from CND file refresh fail
• MODE-2045 - Permission denied exception when access list defined for user name.
• MODE-2047 - Attempting to lock a transient node produces NPE
• MODE-2068 - Child nodes can still be found in their old folder after a folder move
• MODE-2069 - Incorrect regexp parsing when retrieving nodes via the node.getNodes() method
• MODE-2027 - CONTAINS function in JCR-SQL2 should behave as selector.* when first parameter is '.'
• MODE-2022 - Tika extractor fails while attempting to extract metadata from images
• MODE-2034 - Can't do restore while a node has multiple chidren
• MODE-2029 - Sql2 query ISCHILDNODE / ISDESCENDANTNODE after session.move
• MODE-2035 - Can't export to system view while node locked
• MODE-2036 - Missing permission testing inside node's methods
• MODE-2074 - Startup Modeshape got exception: java.lang.IllegalStateException: Current state = CODING_END, new state = CODING
• MODE-2039 - Importing XML continues to throw VersionException for multi-valued properties
• MODE-2075 - The old RHQ plugin for JBoss AS5 in our main Git repo should be removed from the codebase
• MODE-2070 - NPE parsing Teiid DDL in Teiid Designer
• MODE-2071 - javax.jcr.RepositoryException: Error while starting 'KRepository' repository: null
• MODE-2058 - Repository shutdown doesn't complete if unregistering from JNDI fails
• MODE-2073 - Copying external nodes into internal nodes results in incorrect binary values
• MODE-2056 - REST service never clears opened sessions
• MODE-2057 - Union of JOIN and non-JOIN query does not work
• MODE-2055 - Session.getNodeByIdentifier should not return the version history of a node
• MODE-2052 - JMeter test failed
• MODE-2053 - Outer join and two like constrain results NPE
• MODE-2050 - ModeShape configured without client transactions cannot persist data in multi-threaded environment
• MODE-2051 - Binary data is not stored correctly if the Infinispan cache is the same as the repository cache
• MODE-2017 - Move doesn't work with CMIS connector
• MODE-2062 - Problem with full text search and bind variable
• MODE-2076 - Repository explorer web app generates a lot of errors in EAP with "jcr/sample" web app

Enhancement

• MODE-2072 - Repository explorer should work seamlessly with browser URL
• MODE-2061 - Improve performance in getting jcr:content nodes from FileSystemConnector
• MODE-1752 - Improve skip(...) performance in InputStream of InfinispanBinaryStore
• MODE-2024 - Enhance the performance of RepositoryChangeBus
• MODE-2021 - Add EXIF information to sequenced images
• MODE-2033 - Warnings when deploying a repository are only logged but should be available to calling code
• MODE-1576 - WebDav should support Digest authentication
• MODE-1847 - Support sequencing of TIFF images

Feature Request

• MODE-2048 - REST API : Move Node
• MODE-2042 - Extend access manager permissions checking procedure to be able to test privileges for groups or roles
• MODE-2043 - Add capability to run "repository upgrade" operations
• MODE-1820 - Add a web app for viewing/editing repository content
• MODE-2037 - Extended Like Operation
• MODE-1801 - Make content accessible from within AuthenticationProvider
• MODE-2032 - Search for CustomLoggerFactory implementations before slf4j or log4j
• MODE-1467 - Allow Sessions to execute sequencers in-thread and using transient state

Task

• MODE-2044 - Add upgrade operation for 3.6
• MODE-1838 - Use Hibernate Search Kit compatible with AS 7.2
• MODE-2026 - ModeShape's EAP kit should contain a default "domain" configuration
• MODE-2020 - Fix RestEASY warning about non-provider class being registered as a provider
• MODE-2025 - ModeShape's credential files in the EAP kit should be placed in the server config dir
• MODE-2028 - Upgrade the ModeShape EAP kit to be compatible with EAP 6.1.1