Release Notes for ModeShape 3.4.0.Final
This document outlines the changes that were made in ModeShape 3.4.0.Final.
We hope you enjoy it!
What's new
3.4.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 59 issues, most of which are bug fixes in lots of areas. One feature
added to this release is support for JCR access controls, which has almost no effect on a
repository until the first ACL is added (at which point there is some small overhead).
As with 3.3.0.Final, this release includes a kit that can be installed into EAP 6.1.0.GA.
Features
ModeShape 3.4.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
- 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
- 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.4.0.Final release:
Bug
- MODE-1974 - Exception Obtaining RepositoryStatistics
- MODE-1971 - Copy doesn't work correctly with connector when copy document
- MODE-1972 - Copy & Clone operations between 2 different workspaces fail with NPE if the destination path is root
- MODE-1959 - Initial content not imported if transactionMode=none
- MODE-1957 - Local name escaping does not properly encode whitespace characters
- MODE-1978 - NPE when moving a node
- MODE-2001 - REST web service does not encode URLs
- MODE-2000 - Git Connector fails when trying to compute the differences if a commit has a single parent
- MODE-1998 - JcrValue#equals should support URI properties
- MODE-1999 - Git Connector fails if commit information cannot be retrieved
- MODE-2005 - jcr:mergeFailed cannot be set on a checked-in node, in case of a version merge failure
- MODE-1992 - Binary storage using oracle as backend throws SQLException
- MODE-1993 - org.modeshape.jcr.ClusteredRepositoryTest#shouldPropagateNodeChangesInCluster fails randomly
- MODE-1990 - Git connector is not properly using remote names
- MODE-1996 - FS connector cannot be configured via CLI in EAP 6.1.0
- MODE-1995 - Initial content import fails if non-HTTP URIs are used for namespace values.
- MODE-2003 - JcrDriver Is Missing A No Arg Constructor
- MODE-1963 - NPE on creating successive mixins (with the same name)
- MODE-1961 - Import ignores mixin or applies constraints incorrectly
- MODE-1966 - Registering a repository in a read-only jndi context should not generate an error
- MODE-1965 - mixin types should not be allowed to inherit non-mixin types
- MODE-1964 - Connectors don't get removed properties in changes/delta
- MODE-968 - In the ModeShape JOPR console, the save/cancel buttons should not be enabled
- MODE-2002 - Merge of versioned items fails to work on eventual successor versions
- MODE-1661 - WebDAV: Connect-role is insufficient for webdav-jcr user
- MODE-1980 - BOMs do not exclude dependencies per MODE-1934
- MODE-1985 - Teiid DDL parser throws exception parsing column with object datatype
- MODE-1984 - Calling Node.remove() on shareable node results in NodeSuchElementException when iterating over former parent
Enhancement
- MODE-1979 - Add second past parsing of Teiid DDL to resolve table references for in-line FK constraints when referenced table has not been parsed yet
- MODE-1986 - Enhance DdlParsers to provide access to parser 'scoring'
- MODE-2004 - ACL permission checking should only be engaged when the first ACL is added to a repository
- MODE-1962 - Improve message for error creating Name for namespace
- MODE-1960 - Restore and upgrade Apache POI
- MODE-1968 - Simplify/improve logging for persistence and transaction operations
- MODE-1788 - String properties in initial content xml are always split on commas
- MODE-984 - WebDAV service should support PROPPATCH with any property
- MODE-1719 - AS7/EAP subsystem should expose monitoring information via management layer
Feature Request
- MODE-1956 - Add helper function to (un)escape illegal JCR characters
- MODE-1988 - Provide configuration option to enable background child optimization algorithm
- MODE-1759 - Example of ModeShape - Spring and ModeShape - Tomcat integration
- MODE-1610 - jdbc connector: foreign keys
- MODE-1444 - Store binary files in a Cassandra database
- MODE-1725 - Example/quickstart that show how to project external content
- MODE-1997 - JcrNodeType and JcrItemDefinition should implement Namespaced
- MODE-941 - WebDAV service should support PROPFIND with any property
- MODE-1920 - JCR 2.0 Access Control Management
- MODE-1667 - Improved API for finding repository containers
- MODE-1707 - New connector to JDBC metadata
- MODE-1723 - New RHQ plugin for ModeShape 3 deployed in AS7
- MODE-1982 - Make FileSystemConnector implement Pageable
- MODE-1983 - JcrSession.cachedNode should not use node.getChildReferences(cache).getChild(segment) for ChildReferences with UNKNOWN_SIZE
Task
- MODE-1975 - JCR clone should handle external nodes
- MODE-1976 - JCR copy should handle external nodes
- MODE-1977 - JCR move should handle external nodes
- MODE-1991 - OracleDdlLexicon contains unused type
- MODE-1967 - Add test to verify LocalEnvironment usage for programmatically configuring the Infinispan cache
- MODE-1987 - Enhance the SkipLongRunning tests rule to also work with OS specific information
- MODE-1981 - Build on OS-X creates separate ForkedBooter icons in the doc for each Surefire run
- MODE-1958 - DDL Sequencer should use Jsr283Encoder rather than its own custom code