Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Mirror of Apache Jackrabbit Oak
Java Other
Failed to load latest commit information.
oak-auth-external move duplicate 'DebugTimer' utility to oak-commons
oak-auth-ldap OAK-2783 Make LDAP connection pool 'testOnBorrow' configurable
oak-authorization-cug Update trunk version to 1.4-SNAPSHOT
oak-blob-cloud Update trunk version to 1.4-SNAPSHOT
oak-blob Update trunk version to 1.4-SNAPSHOT
oak-commons move duplicate 'DebugTimer' utility to oak-commons
oak-core OAK-2674 : Fix FindBug Issues
oak-doc OAK-301 Document Oak
oak-http Update trunk version to 1.4-SNAPSHOT
oak-it OAK-2700 : Cleanup usages of mk-api
oak-jcr OAK-2755: Consolidated JMX view of all EventListener related statistics
oak-js OAK-103: JavaScript bindings for Oak
oak-lucene OAK-2782 Tika not able to load class in case of custom config
oak-parent OAK-2662: SegmentOverflowException in HeavyWriteIT on Jenkins
oak-pojosr Update trunk version to 1.4-SNAPSHOT
oak-run OAK-2674 : Fix FindBug Issues
oak-solr-core OAK-2765 - fixed high prio issues as reported by FB
oak-solr-osgi Update trunk version to 1.4-SNAPSHOT
oak-tarmk-standby OAK-2764: ExternalSharedStoreIT occasionally fails on travis
oak-upgrade OAK-2737: RepositoryUpgrade.copy() should allow custom commit hooks
.gitignore Ignore IntelliJ project and workspace files
.travis.yml OAK-2696: Maven build on travis too verbose
LICENSE.txt OAK-1: Setup basic build structure
NOTICE.txt Update trunk version to 1.1-SNAPSHOT
README.md OAK-2697 : Retire oak-mk-api and oak-mk (add issue reference to READM…
RELEASE-NOTES.txt Update release notes for Oak 1.2
analyze-hprof.pl OAK-641: Improved benchmark tooling
assembly.xml OAK-42: Prepare for first release
pom.xml OAK-2700 : Cleanup usages of mk-api

README.md

Jackrabbit Oak - the next generation content repository

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.

Getting Started

To get started with Oak, build the latest sources with Maven 3 and Java 6 (or higher) like this:

mvn clean install

To enable all integration tests, including the JCR TCK, use:

mvn clean install -PintegrationTesting

Before committing changes or submitting a patch, please make sure that the above integration testing build passes without errors. If you like, you can enable integration tests by default by setting the OAK_INTEGRATION_TESTING environment variable.

MongoDB integration

Parts of the Oak build expects a MongoDB instance to be available for testing. By default a MongoDB instance running on localhost is expected, and the relevant tests are simply skipped if such an instance is not found. You can also configure the build to use custom MongoDB settings with the following properties (shown with their default values):

-Dmongo.host=127.0.0.1
-Dmongo.port=27017
-Dmongo.db=MongoMKDB
-Dmongo.db2=MongoMKDB2

Note that the configured test databases will be dropped by the test cases.

Components

The build consists of the following main components:

  • oak-parent - parent POM
  • oak-doc - Oak documentation
  • oak-commons - shared utility code
  • oak-core - Oak repository API and implementation
  • oak-jcr - JCR binding for the Oak repository
  • oak-sling - integration with Apache Sling
  • oak-solr-core - Apache Solr indexing and search
  • oak-solr-embedded - Apache Solr on an embedded Solr instance
  • oak-solr-remote - Apache Solr on an remote (HTTP) Solr instance
  • oak-http - HTTP binding for Oak
  • oak-lucene - Lucene-based query index
  • oak-run - runnable jar packaging
  • oak-pojosr - integration with PojoSR
  • oak-upgrade - tooling for upgrading Jackrabbit repositories to Oak
  • oak-it - integration tests
    • oak-it/osgi - integration tests for OSGi

Archive

The following components have been moved to the Jackrabbit Attic:

  • oak-mk-api - MicroKernel API (deprecated, see OAK-2701)
  • oak-mk - MicroKernel implementation (see OAK-2702)
  • oak-mk-remote - MicroKernel remoting (see OAK-2693)
  • oak-it/mk - integration tests for MicroKernel

License

(see LICENSE.txt for full license details)

Collective work: Copyright 2014 The Apache Software Foundation.

Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to You under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

 http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Something went wrong with that request. Please try again.