RELEASE-NOTES.txt

Release Notes -- Apache Jackrabbit Oak -- Version 1.0.20

Introduction
------------

Jackrabbit Oak is a scalable, high-performance hierarchical content
repository designed for use as the foundation of modern world-class
web sites and other demanding content applications.

Apache Jackrabbit Oak 1.0.20 is a patch release that contains fixes and
improvements over Oak 1.0. Jackrabbit Oak 1.0.x releases are considered
stable and targeted for production use.

The Oak effort is a part of the Apache Jackrabbit project.
Apache Jackrabbit is a project of the Apache Software Foundation.

New configuration options in Oak 1.0.20
---------------------------------------

This release of Oak includes an improvement to the DocumentNodeStore,
which requires a new collection in the DocumentStore. The DocumentStore
implementations in Oak will try to create the new collection if necessary.
However, there may be deployments where the configured backend storage user
for the DocumentStore implementation does not have the require privilege.
In this case it is required to create the table for the RDB backend or 
collection for MongoDB manually before Oak is upgraded to 1.0.20.
See https://issues.apache.org/jira/browse/OAK-2829 for more details.

Node name index support (OAK-1752) - With this queries involving
node name constraint can make use of index and perform better. Refer to
http://jackrabbit.apache.org/oak/docs/query/lucene.html#index-node-name
for usage details.
 

Changes in Oak 1.0.20
---------------------

Sub-tasks

    [OAK-2634] - QueryEngine should expose name query as property restriction
    [OAK-3261] - consider existing locks when creating new ones
    [OAK-3279] - Create StringUtils.estimateMemoryUsage(String)
    [OAK-3338] - Deprecate CIHelper travis methods with profile 
    [OAK-3345] - SessionMBean should provide information about pending refresh

Technical tasks

    [OAK-3385] - Make compress-interval configurable
    [OAK-3391] - RDBBlobStore: speed up testBigBlob(), also improve memory usage

Bugs

    [OAK-2712] - Possible null-dereference when calling ItemImpl#perform
    [OAK-2929] - Parent of unseen children must not be removable
    [OAK-2979] - JournalTest.cleanupTest reliably fails on Windows
    [OAK-3265] - Test failures: NodeLocalNameTest, NodeNameTest
    [OAK-3281] - Test failures on trunk: SolrIndexQueryTestIT.sql2
    [OAK-3282] - DataStoreBlobStore cache ignores key for memory calculation
    [OAK-3283] - Background read does not close StringSort
    [OAK-3310] - Write operations on Property do not check checked-out state of Node
    [OAK-3313] - Many tests leak DocumentNodeStore instances
    [OAK-3324] - Evaluation with restriction is not consistent with parent ACLs
    [OAK-3333] - SplitOperations purges _commitRoot entries too eagerly
    [OAK-3339] - Logging in and out many sessions leads to high memory consumption 
    [OAK-3376] - DocumentNodeStoreTest.dispose() waiting indefinitely on ArrayBlockingQueue.put()
    [OAK-3383] - "The unbindBlobDataSource method has thrown an exception" message on shutdown of the RDBMK

Improvements

    [OAK-1752] - Node name queries should use an index
    [OAK-3146] - ExternalLoginModuleFactory should inject SyncManager and ExternalIdentityProviderManager
    [OAK-3259] - Optimize NodeDocument.getNewestRevision()
    [OAK-3288] - clarify DocumentStore contract with respect to number formats
    [OAK-3365] - Wording in Log statements inconsistent

Tasks

    [OAK-1743] - Cleanup documentation of _modCount

Tests

    [OAK-3312] - [Blob GC] Test case for GC / OAK-3167
    [OAK-3337] - CIHelper methods related to travis outdated 

In addition to the above-mentioned changes, this release contains
all changes included in previous Apache Jackrabbit Oak 1.0.x releases.

Please note, the backported RDB support for the DocumentNodeStore is considered
experimental at this point and is not yet ready for production use. Feel free 
to try it out and report any issues you may see to the Oak developers.

For more detailed information about all the changes in this and other
Oak releases, please see the Oak issue tracker at

  https://issues.apache.org/jira/browse/OAK

Release Contents
----------------

This release consists of a single source archive packaged as a zip file.
The archive can be unpacked with the jar tool from your JDK installation.
See the README.md file for instructions on how to build this release.

The source archive is accompanied by SHA1 and MD5 checksums and a PGP
signature that you can use to verify the authenticity of your download.
The public key used for the PGP signature can be found at
http://www.apache.org/dist/jackrabbit/KEYS.

About Apache Jackrabbit Oak
---------------------------

Jackrabbit Oak is a scalable, high-performance hierarchical content
repository designed for use as the foundation of modern world-class
web sites and other demanding content applications.

The Oak effort is a part of the Apache Jackrabbit project. 
Apache Jackrabbit is a project of the Apache Software Foundation.

For more information, visit http://jackrabbit.apache.org/oak

About The Apache Software Foundation
------------------------------------

Established in 1999, The Apache Software Foundation provides organizational,
legal, and financial support for more than 140 freely-available,
collaboratively-developed Open Source projects. The pragmatic Apache License
enables individual and commercial users to easily deploy Apache software;
the Foundation's intellectual property framework limits the legal exposure
of its 3,800+ contributors.

For more information, visit http://www.apache.org/