Index: b/docs/gettingstarted/src/main/docbook/en-US/content/conclusion.xml =================================================================== --- a/docs/gettingstarted/src/main/docbook/en-US/content/conclusion.xml(revision ) +++ b/docs/gettingstarted/src/main/docbook/en-US/content/conclusion.xml(working copy) @@ -53,12 +53,13 @@ Future directions - What's next for ModeShape? We're very close to passing all of the JCR Technology Compatibility Kit (TCK) Level 1, Level 2 - tests, plus the tests for the optional features including observation and locking. (In fact, there are just a few outstanding - bugs that are preventing us from passing all of these test and becoming fully JCR compliant.) We will soon be implementing - versioning, which is the last optional feature of JCR. - We will also be adding support for clustering multiple ModeShape engines spread across multiple JVM processes. - And each release we continue to introduce more + At this point, ModeShape passes all of the JCR Technology Compatibility Kit (TCK) tests + for Level 1, Level 2, and the optional locking and versioning features (plus almost all of the tests for the + optional observation feature). We'll soon begin the process of attaining JCR certification for ModeShape. + + + We also plan to add support for clustering multiple ModeShape engines spread across multiple JVM processes. + And each expect to introduce more connectors and sequencers to our library. Other items on our long-term roadmap include a web user interface, Seam integration, and integration with even more kinds of information systems and repositories. Index: b/docs/gettingstarted/src/main/docbook/en-US/content/using_modeshape.xml =================================================================== --- a/docs/gettingstarted/src/main/docbook/en-US/content/using_modeshape.xml(revision ) +++ b/docs/gettingstarted/src/main/docbook/en-US/content/using_modeshape.xml(working copy) @@ -521,7 +521,7 @@ try { org.modeshape modeshape-jcr - 1.0.0.Final + 1.1.0.Final ]]> @@ -530,13 +530,13 @@ try { org.modeshape modeshape-connector-store-jpa - 1.0.0.Final + 1.1.0.Final ... org.modeshape modeshape-sequencer-java - 1.0.0.Final + 1.1.0.Final ]]> Index: b/docs/gettingstarted/src/main/docbook/en-US/custom.dtd =================================================================== --- a/docs/gettingstarted/src/main/docbook/en-US/custom.dtd(revision ) +++ b/docs/gettingstarted/src/main/docbook/en-US/custom.dtd(working copy) @@ -1,4 +1,4 @@ - + Index: b/docs/reference/src/main/docbook/en-US/content/core/connector.xml =================================================================== --- a/docs/reference/src/main/docbook/en-US/content/core/connector.xml(revision ) +++ b/docs/reference/src/main/docbook/en-US/content/core/connector.xml(working copy) @@ -86,6 +86,9 @@ a repository that accesses a file system to present its files and directory structure as (updatable) repository content + a repository that accesses the content in another JCR repository + + a repository that accesses an SVN repository to present the files and directory structure as (updatable) repository content @@ -102,9 +105,8 @@ Along with a good library of connectors, which is what we're planning to create. - For instance, we want to build a connector to other JCR repositories, and - another to access existing databases so that some or all of the existing data (in whatever structure) - can be accessed through JCR. For more information, check out our + For instance, we want to build a connector to access existing relational databases so that some + or all of the existing data (in whatever structure) can be accessed through JCR. For more information, check out our roadmap. Of course, if we don't have a connector to suit your needs, you can write your own.
@@ -173,9 +175,8 @@ Of course, before you develop a connector, you should probably check the - list of connectors ModeShape already provides out of the box. - With this latest release, ModeShape already includes this JDBC metadata connector! And we're always interested in new - connectors and new contributors, so please consider developing your custom connector as part of ModeShape. + list of connectors + ModeShape already provides out of the box. And we've been adding new connectors with almost every release. @@ -292,7 +293,7 @@ org.modeshape modeshape-graph - 1.0.0.Final + 1.1.0.Final ]]> @@ -308,14 +309,14 @@ org.modeshape modeshape-graph - 1.0.0.Final + 1.1.0.Final test-jar test org.modeshape modeshape-common - 1.0.0.Final + 1.1.0.Final test-jar test Index: b/docs/reference/src/main/docbook/en-US/content/core/sequencing.xml =================================================================== --- a/docs/reference/src/main/docbook/en-US/content/core/sequencing.xml(revision ) +++ b/docs/reference/src/main/docbook/en-US/content/core/sequencing.xml(working copy) @@ -322,7 +322,7 @@ public interface &SequencerOutput; { org.modeshape modeshape-graph - 1.0.0.Final + 1.1.0.Final ]]> These are minimum dependencies required for compiling a sequencer. Of course, you'll have to add @@ -333,14 +333,14 @@ public interface &SequencerOutput; { org.modeshape modeshape-graph - 1.0.0.Final + 1.1.0.Final test-jar test org.modeshape modeshape-common - 1.0.0.Final + 1.1.0.Final test-jar test @@ -378,7 +378,7 @@ public interface &SequencerOutput; { org.modeshape modeshape-jcr - 1.0.0.Final + 1.1.0.Final test Index: b/docs/reference/src/main/docbook/en-US/content/developers/testing.xml =================================================================== --- a/docs/reference/src/main/docbook/en-US/content/developers/testing.xml(revision ) +++ b/docs/reference/src/main/docbook/en-US/content/developers/testing.xml(working copy) @@ -148,7 +148,8 @@ modeshape-jcr-tck project. - The 1.0.0.Final release passes all of the JCR TCK tests, but still needs to be certified before being considered fully compliant with JCR 1.0. + The &versionNumber; release passes all of the JCR Level 1, Level2, versioning, and locking TCK tests (and almost all of them for observation), + but still needs to be certified before being considered fully compliant with JCR 1.0. The ModeShape project plans to focus on attaining this certification in the very near future. Index: b/docs/reference/src/main/docbook/en-US/content/future.xml =================================================================== --- a/docs/reference/src/main/docbook/en-US/content/future.xml(revision ) +++ b/docs/reference/src/main/docbook/en-US/content/future.xml(working copy) @@ -31,19 +31,23 @@ Looking to the future - ModeShape &version; adds a lot of new features and capabilities. It introduced an initial RESTful server that makes - JCR repositories accessible over HTTP to clients. The JCR implementation was enhanced to support more features, - including the ability to define and register node types using the Compact Node Definition (CND) format. - A new configuration system was added, making it very easy to configure and manage the ModeShape JCR engine. - An observation framework was added to the graph API. The federation connector was rewritten to improve performance - and correct several issues. And quite a few issues were fixed. + ModeShape &versionNumber; provides a very capable JCR implementation with powerful and unique features not matched + by other implementations. This release adds several key features, such as JCR versioning and a JCR connector, + and includes fixes and improvements. - What's next for ModeShape? Passing all of the JCR API compatibility tests for Level 1 and Level 2, - plus some of the optional features, is the primary focus for the next release. Of course, there are a handful of - improvements we'd like to make under the covers, and a few outstanding issues that we'll address. - Farther out on our roadmap are the development of additional connectors and sequencers, - some Eclipse tooling for publishing artifacts to a repository, and quite a few other interesting features. + At this point, ModeShape passes all of the JCR Technology Compatibility Kit (TCK) tests + for Level 1, Level 2, and the optional locking and versioning features (plus almost all of the tests for the + optional observation feature). We'll soon begin the process of attaining JCR certification for ModeShape. + + + What's next for ModeShape? + We also plan to add support for clustering multiple ModeShape engines spread across multiple JVM processes. + And each expect to introduce more + connectors and sequencers to our library. + Other items on our roadmap include a JDBC driver for ModeShape, + a web user interface, Seam integration, and integration with even more kinds of + information systems and repositories. We're always looking for suggestions and contributors. If you'd like to get involved on ModeShape, the first Index: b/docs/reference/src/main/docbook/en-US/content/introduction.xml =================================================================== --- a/docs/reference/src/main/docbook/en-US/content/introduction.xml(revision ) +++ b/docs/reference/src/main/docbook/en-US/content/introduction.xml(working copy) @@ -460,6 +460,22 @@ + modeshape-web-jcr-webdav + provides a WebDAV server for Java Content Repositories. This project provides integration with ModeShape's + JCR implementation (of course) but also contains a service provider interface (SPI) that can be + used to integrate other JCR implementations with these WebDAV services in the future. + For ease of packaging, these classes are provided as a JAR that can be placed in the WEB-INF/lib of a deployed WebDAV server WAR. + + + + + modeshape-web-jcr-webdav-war + wraps the WebDAV services from the modeshape-web-jcr-webdav JAR into a WAR and provides in-container integration tests. This project + can be consulted as a template for how to deploy the WebDAV services in a custom implementation. + + + + modeshape-web-jcr-rest provides a set of JSR-311 (JAX-RS) objects that form the basis of a RESTful server for Java Content Repositories. This project provides integration with ModeShape's JCR implementation (of course) but also contains a service provider interface (SPI) that can be @@ -482,6 +498,13 @@ and unpublish (delete) files from ModeShape repositories. + + + modeshape-web-jcr + provides a reusable library for web applications using JCR, and is used by the modeshape-web-jcr-rest + and modeshape-web-jcr-webdav modules. + + There are also documentation modules (located in the source under the docs/ @@ -546,50 +569,19 @@ What's new? - With version &versionNumber;, ModeShape introduces support for JCR query and search - with a number of query languages, including the JCR XPath language - (required by the 1.0 specification), the JCR-SQL2 dialect - defined by the JCR 2.0 specification, and a full-text search language. - This release also adds support for JCR locking and observation. + With version &versionNumber;, ModeShape adds support for JCR versioning + and introduces a new JCR connector. This means that ModeShape now implements all of the JCR Level 1 and Level 2 features, - along with the optional locking and observation features. - The only optional feature not implemented is versioning, and that will be coming soon. - This version passes more than 95% of the JCR TCK tests, and all of the failures are because of a handful of known issues. - Fortunately, most of these are either less-frequently-used features of JCR or issues that can be worked around. - - - This release also introduces a number of new and improved connectors. Both the file system connector - and SVN connector were reworked to support reads and updates, and they - both offer a preview of an optional caching system. The JPA storage connector - was dramatically improved and is significantly faster, more capable, and more efficient. - The new JDBC metadata connector provides read-only access to the schema - information of relational databases through JDBC. - - - ModeShape &versionNumber; includes a number of new and improved sequencers. The new text sequencer - is able to extract structured data from comma-separated or fixed-width text files. The new DDL sequencer - is capable of parsing a number of DDL dialects to extract the more important DDL statements. The CND sequencer - was rewritten and dramatically simplified to perform better, fix a number of known issues, and eliminate a dependency on a third-party library. - There is also a new Java class file sequencer that operates on Java class - files and produces output that is comparable to the Java source file sequencer, - and that can be used in conjunction with the ZIP file sequencer to extract the Java metadata - from JARs, WARs, and EAR files. + along with the optional locking, versioning, and observation features. + Of all of the JCR TCK tests, the only failures are two from observation (see ) + and those from the optional JCR-SQL query language that ModeShape does not support + (see supported query languages). - This release also brings numerous bug fixes and improvements, and upgrades all third-party dependencies to the latest - versions available at the time of release. The build system now supports - running all of the tests against a variety - of databases, making it very easy to test against DBMSes that ModeShape doesn't directly test against. - A new DDL generation utility was also introduced that produces the DDL for the database used by the JPA connector. - And JCR repositories now support the use of anonymous users - this is - enabled by default but can easily be changed for production purposes. + This release also brings several bug fixes and improvements, including + several issues with using MySQL as a content store. + The release also upgrades all third-party dependencies to the latest versions available at the time of release. - - - If you're migrating from JBoss DNA 0.7, please see the migration section - for a straightforward recipe. - - Index: b/docs/reference/src/main/docbook/en-US/content/jcr/configuration.xml =================================================================== --- a/docs/reference/src/main/docbook/en-US/content/jcr/configuration.xml(revision ) +++ b/docs/reference/src/main/docbook/en-US/content/jcr/configuration.xml(working copy) @@ -584,7 +584,7 @@ try { org.modeshape modeshape-jcr - 1.0.0.Final + 1.1.0.Final ]]> @@ -593,13 +593,13 @@ try { org.modeshape modeshape-connector-store-jpa - 1.0.0.Final + 1.1.0.Final ... org.modeshape modeshape-sequencer-java - 1.0.0.Final + 1.1.0.Final ]]> @@ -614,75 +614,6 @@ try { - - Migrating from JBoss DNA to ModeShape - - If you're currently using JBoss DNA, we highly recommend migrating to ModeShape. The process is actually - pretty straightforward, since most of your code is probably using the JCR API. (Thank goodness for standards!) - - - First, change over to use the ModeShape artifacts in Maven. In your application's POM: - - - - change the group ID from "org.jboss.dna" to "org.modeshape"; - - - - - change the artifact IDs to use the "modeshape-" prefix instead of "dna-"; and - - - - - change the version numbers to "1.0.0.Beta1". - - - - Your Maven dependencies should then look like what is shown in the Maven chapter. - - - - None of the third-party dependencies have changed from JBoss DNA 0.7 to ModeShape 1.0.0.Final. - - - - Second, change your Java code to use the ModeShape classes. - Wherever your code is using JBoss DNA classes, simply replace the "org.jboss.dna..." imports - with "org.modeshape...". All of the method names are the same, and nearly all of the class names are the same. - (The names of some internal classes did begin with "Dna", and these were changed to begin with "ModeShape". But you're not - likely using any of these internal classes anyway.) - - - Third, in your configuration files, change the JBoss DNA namespace URIs to the ModeShape namespace URIs. In other words, - any namespace URI starting with "http://www.jboss.org/dna" should be changed to start with - "http://www.modeshape.org". We also suggest changing the prefixes to "mode", but - this is technically optional. - - - What about persisted data? ModeShape will automatically convert any names or paths that use the old DNA namespaces - to instead use the corresponding ModeShape namespaces. And, when that data is modified and the node updated, the - ModeShape namespaces will be saved in the store. - - - Be aware that any string property values that contain the DNA namespaces and that are treated by your application - as strings will not be changed. The automatic conversion only happens when Name or Path objects are created, - or when string values are converted to Name or Path objects. - - - - - The search indexes are not automatically converted, so the easiest solution is to simply - rebuild the indexes. - - - - - One final note. If you've begun using the "Simple" JPA connector model just recently introduced in JBoss DNA 0.7, please - be aware that we've changed the names of the database tables. We could have kept using the "DNA_" prefix, but we thought - it best to change the name because the "Simple" model is so new and will be with ModeShape for a long time to come. - - What's next Index: b/docs/reference/src/main/docbook/en-US/content/jcr/jcr.xml =================================================================== --- a/docs/reference/src/main/docbook/en-US/content/jcr/jcr.xml(revision ) +++ b/docs/reference/src/main/docbook/en-US/content/jcr/jcr.xml(working copy) @@ -187,7 +187,7 @@ final &LoginContext; loginContext = ...; - + JCR Specification Support We believe that ModeShape JCR implementation is JCR-compliant, but we are awaiting final certification of compliance. @@ -201,7 +201,6 @@ final &LoginContext; loginContext = ...; ModeShape currently supports all Level 1 and Level 2 features defined by the JSR-170 specification. - This release adds support for referential integrity for REFERENCE properties. Index: b/docs/reference/src/main/docbook/en-US/content/preface.xml =================================================================== --- a/docs/reference/src/main/docbook/en-US/content/preface.xml(revision ) +++ b/docs/reference/src/main/docbook/en-US/content/preface.xml(working copy) @@ -31,14 +31,19 @@ Target audience - This reference guide is for the developers of ModeShape and those users that want to have a better understanding of how ModeShape - works or how to extend the functionality. For a higher-level introduction to ModeShape, see the &GettingStarted; document. + This reference guide is for developers using ModeShape in their applications that want a better understanding of how + ModeShape works, how to take advantage of its advanced features, and how to extend the functionality. This document + is also very valuable for community developers because it covers the design and implementation of most of the + components that make up ModeShape. + + + For a higher-level introduction to ModeShape, see the &GettingStarted; document. - If you have any questions or comments, please feel free to contact ModeShape's - user mailing list or use the - user forums. - If you'd like to get involved on the project, join the mailing lists, + If you have any questions or comments, please feel free to use ModeShape's + user mailing list or the + user forums. + We welcome all who want to get involved, so if you do please join the mailing lists, download the code and get it building, and visit our JIRA issue management system. If there's something in particular you're interested in, talk with the community - there may be others interested in the Index: b/docs/reference/src/main/docbook/en-US/custom.dtd =================================================================== --- a/docs/reference/src/main/docbook/en-US/custom.dtd(revision ) +++ b/docs/reference/src/main/docbook/en-US/custom.dtd(working copy) @@ -1,4 +1,4 @@ - + @@ -12,6 +12,7 @@ + @@ -27,8 +28,8 @@ - - + + Getting Started"> Reference Guide">