Return-Path: X-Original-To: apmail-jackrabbit-commits-archive@www.apache.org Delivered-To: apmail-jackrabbit-commits-archive@www.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id B208B10BA8 for ; Thu, 1 Aug 2013 12:22:40 +0000 (UTC) Received: (qmail 10626 invoked by uid 500); 1 Aug 2013 12:22:40 -0000 Delivered-To: apmail-jackrabbit-commits-archive@jackrabbit.apache.org Received: (qmail 10588 invoked by uid 500); 1 Aug 2013 12:22:40 -0000 Mailing-List: contact commits-help@jackrabbit.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@jackrabbit.apache.org Delivered-To: mailing list commits@jackrabbit.apache.org Received: (qmail 10581 invoked by uid 99); 1 Aug 2013 12:22:40 -0000 Received: from athena.apache.org (HELO athena.apache.org) (140.211.11.136) by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 01 Aug 2013 12:22:40 +0000 X-ASF-Spam-Status: No, hits=-2000.0 required=5.0 tests=ALL_TRUSTED X-Spam-Check-By: apache.org Received: from [140.211.11.4] (HELO eris.apache.org) (140.211.11.4) by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 01 Aug 2013 12:22:37 +0000 Received: from eris.apache.org (localhost [127.0.0.1]) by eris.apache.org (Postfix) with ESMTP id CF70B238888A; Thu, 1 Aug 2013 12:22:16 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r1509200 [1/8] - in /jackrabbit/site/live/oak/docs: ./ css/ images/ images/logos/ images/profiles/ img/ js/ Date: Thu, 01 Aug 2013 12:22:15 -0000 To: commits@jackrabbit.apache.org From: mduerig@apache.org X-Mailer: svnmailer-1.0.9 Message-Id: <20130801122216.CF70B238888A@eris.apache.org> X-Virus-Checked: Checked by ClamAV on apache.org Author: mduerig Date: Thu Aug 1 12:22:13 2013 New Revision: 1509200 URL: http://svn.apache.org/r1509200 Log: OAK-936: Site checkin for project Oak Documentation Added: jackrabbit/site/live/oak/docs/construct.html (with props) jackrabbit/site/live/oak/docs/css/ jackrabbit/site/live/oak/docs/css/apache-maven-fluido-1.3.0.min.css (with props) jackrabbit/site/live/oak/docs/css/print.css (with props) jackrabbit/site/live/oak/docs/css/site.css (with props) jackrabbit/site/live/oak/docs/dependencies.html (with props) jackrabbit/site/live/oak/docs/dependency-convergence.html (with props) jackrabbit/site/live/oak/docs/dependency-management.html (with props) jackrabbit/site/live/oak/docs/dev_getting_started.html (with props) jackrabbit/site/live/oak/docs/differences.html (with props) jackrabbit/site/live/oak/docs/distribution-management.html (with props) jackrabbit/site/live/oak/docs/dos_and_donts.html (with props) jackrabbit/site/live/oak/docs/downloads.html (with props) jackrabbit/site/live/oak/docs/from_here.html (with props) jackrabbit/site/live/oak/docs/images/ jackrabbit/site/live/oak/docs/images/accessories-text-editor.png (with props) jackrabbit/site/live/oak/docs/images/add.gif (with props) jackrabbit/site/live/oak/docs/images/apache-maven-project-2.png (with props) jackrabbit/site/live/oak/docs/images/application-certificate.png (with props) jackrabbit/site/live/oak/docs/images/close.gif (with props) jackrabbit/site/live/oak/docs/images/contact-new.png (with props) jackrabbit/site/live/oak/docs/images/document-properties.png (with props) jackrabbit/site/live/oak/docs/images/drive-harddisk.png (with props) jackrabbit/site/live/oak/docs/images/fix.gif (with props) jackrabbit/site/live/oak/docs/images/icon_error_sml.gif (with props) jackrabbit/site/live/oak/docs/images/icon_help_sml.gif (with props) jackrabbit/site/live/oak/docs/images/icon_info_sml.gif (with props) jackrabbit/site/live/oak/docs/images/icon_success_sml.gif (with props) jackrabbit/site/live/oak/docs/images/icon_warning_sml.gif (with props) jackrabbit/site/live/oak/docs/images/image-x-generic.png (with props) jackrabbit/site/live/oak/docs/images/internet-web-browser.png (with props) jackrabbit/site/live/oak/docs/images/logos/ jackrabbit/site/live/oak/docs/images/logos/build-by-maven-black.png (with props) jackrabbit/site/live/oak/docs/images/logos/build-by-maven-white.png (with props) jackrabbit/site/live/oak/docs/images/logos/maven-feather.png (with props) jackrabbit/site/live/oak/docs/images/network-server.png (with props) jackrabbit/site/live/oak/docs/images/package-x-generic.png (with props) jackrabbit/site/live/oak/docs/images/profiles/ jackrabbit/site/live/oak/docs/images/profiles/pre-release.png (with props) jackrabbit/site/live/oak/docs/images/profiles/retired.png (with props) jackrabbit/site/live/oak/docs/images/profiles/sandbox.png (with props) jackrabbit/site/live/oak/docs/images/remove.gif (with props) jackrabbit/site/live/oak/docs/images/rss.png (with props) jackrabbit/site/live/oak/docs/images/update.gif (with props) jackrabbit/site/live/oak/docs/images/window-new.png (with props) jackrabbit/site/live/oak/docs/img/ jackrabbit/site/live/oak/docs/img/glyphicons-halflings-white.png (with props) jackrabbit/site/live/oak/docs/img/glyphicons-halflings.png (with props) jackrabbit/site/live/oak/docs/index.html (with props) jackrabbit/site/live/oak/docs/integration.html (with props) jackrabbit/site/live/oak/docs/issue-tracking.html (with props) jackrabbit/site/live/oak/docs/js/ jackrabbit/site/live/oak/docs/js/apache-maven-fluido-1.3.0.min.js (with props) jackrabbit/site/live/oak/docs/jsop-diff.html (with props) jackrabbit/site/live/oak/docs/license.html (with props) jackrabbit/site/live/oak/docs/mail-lists.html (with props) jackrabbit/site/live/oak/docs/microkernel.html (with props) jackrabbit/site/live/oak/docs/mongomk.html (with props) jackrabbit/site/live/oak/docs/nodestate-r1.png (with props) jackrabbit/site/live/oak/docs/nodestate-r1.uxf jackrabbit/site/live/oak/docs/nodestate-r2.png (with props) jackrabbit/site/live/oak/docs/nodestate-r2.uxf jackrabbit/site/live/oak/docs/nodestate.html (with props) jackrabbit/site/live/oak/docs/overview.html (with props) jackrabbit/site/live/oak/docs/participating.html (with props) jackrabbit/site/live/oak/docs/plugin-management.html (with props) jackrabbit/site/live/oak/docs/plugins.html (with props) jackrabbit/site/live/oak/docs/project-info.html (with props) jackrabbit/site/live/oak/docs/project-summary.html (with props) jackrabbit/site/live/oak/docs/segmentmk.html (with props) jackrabbit/site/live/oak/docs/source-repository.html (with props) jackrabbit/site/live/oak/docs/team-list.html (with props) jackrabbit/site/live/oak/docs/use_getting_started.html (with props) jackrabbit/site/live/oak/docs/when_things_go_wrong.html (with props) Added: jackrabbit/site/live/oak/docs/construct.html URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/construct.html?rev=1509200&view=auto ============================================================================== --- jackrabbit/site/live/oak/docs/construct.html (added) +++ jackrabbit/site/live/oak/docs/construct.html Thu Aug 1 12:22:13 2013 @@ -0,0 +1,360 @@ + + + + + + + + + Jackrabbit Oak - + + + + + + + + + + + + + + + + + + Fork me on GitHub + + + + + + +
+
+
+ + + + + + + + + + + +
+ +
+
+ + +
+ + + + + +
+
+
+ + + + + + +
+ +
+ + + + +
+ +
+
+
+ + Built by Maven + +
+
+
+ + +
+ +

Repository construction

+

Oak comes with a simple mechanism for constructing content repositories for use in embedded deployments and test cases. This article describes this mechanism. Deployments in managed environments like OSGi should use the native construction/configuration mechanism of the environment.

+

The core class to use is called Oak and can be found in the org.apache.jackrabbit.oak package inside oak-core. It takes a MicroKernel instance and wraps it into a ContentRepository:

+ +
+
MicroKernel kernel = ...;
+ContentRepository repository = new Oak(kernel).createContentRepository();
+
+

For test purposes you can use the default constructor that automatically instantiates an in-memory MicroKernel for use with the repository. And if you’re only using the test repository for a single ContentSession or just a singe Root, then you can shortcut the login steps by using either of the last two statements below:

+ +
+
ContentRepository repository = new Oak().createContentRepository();
+ContentSession session = new Oak().createContentSession();
+Root root = new Oak().createRoot();
+
+

By default no pluggable components are associated with the created repository, so all login attempts will work and result in full write access. There’s also no need to close the sessions or otherwise release acquired resources, as normal garbage collection will take care of everything.

+

To add extra functionality like type validation or indexing support, use the with() method. The method takes all kinds of Oak plugins and adds them to the repository to be created. The method returns the Oak instance being used, so you can chain method calls like this:

+ +
+
ContentRepository repository = new Oak(kernel)
+    .with(new InitialContent())        // add initial content
+    .with(new DefaultTypeEditor())     // automatically set default types
+    .with(new NameValidatorProvider()) // allow only valid JCR names
+    .with(new SecurityProviderImpl())  // use the default security
+    .with(new PropertyIndexHook())     // simple indexing support
+    .with(new PropertyIndexProvider()) // search support for the indexes
+    .createContentRepository();
+
+

As you can see, constructing a fully featured JCR repository like this will require quite a few plugins. To avoid having to specify them all whenever constructing a new repository, we also have a class called Jcr in the org.apache.jackrabbit.oak.jcr package in oak-jcr. That class works much like the Oak class, but it constructs javax.jcr.Repository instances instead of ContentRepositories and automatically includes all the plugin components needed for proper JCR functionality:

+ +
+
MicroKernel kernel = ...;
+Repository repository = new Jcr(kernel).createRepository();
+
+

The Jcr class supports all the same with() methods as the Oak class does, so you can easily extend the constructed JCR repository with custom functionality if you like. For test purposes the Jcr class also has an empty default constructor that works like the one in the Oak class.

+
+
+
+ +
+ + + + \ No newline at end of file Propchange: jackrabbit/site/live/oak/docs/construct.html ------------------------------------------------------------------------------ svn:eol-style = native Added: jackrabbit/site/live/oak/docs/css/apache-maven-fluido-1.3.0.min.css URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/css/apache-maven-fluido-1.3.0.min.css?rev=1509200&view=auto ============================================================================== --- jackrabbit/site/live/oak/docs/css/apache-maven-fluido-1.3.0.min.css (added) +++ jackrabbit/site/live/oak/docs/css/apache-maven-fluido-1.3.0.min.css Thu Aug 1 12:22:13 2013 @@ -0,0 +1,9 @@ +/*! + * Bootstrap v2.1.0 + * + * Copyright 2012 Twitter, Inc + * Licensed under the Apache License v2.0 + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Designed and built with all the love in the world @twitter by @mdo and @fat. [... 3 lines stripped ...] Propchange: jackrabbit/site/live/oak/docs/css/apache-maven-fluido-1.3.0.min.css ------------------------------------------------------------------------------ svn:eol-style = native Propchange: jackrabbit/site/live/oak/docs/css/apache-maven-fluido-1.3.0.min.css ------------------------------------------------------------------------------ svn:keywords = Author Date Id Revision Rev URL Added: jackrabbit/site/live/oak/docs/css/print.css URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/css/print.css?rev=1509200&view=auto ============================================================================== --- jackrabbit/site/live/oak/docs/css/print.css (added) +++ jackrabbit/site/live/oak/docs/css/print.css Thu Aug 1 12:22:13 2013 @@ -0,0 +1,23 @@ +/* + * 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. + */ + +/* $Id$ */ + +#banner, #footer, #leftcol, #breadcrumbs, .docs #toc, .docs .courtesylinks, #leftColumn, #navColumn {display: none !important;} +#bodyColumn, body.docs div.docs {margin: 0 !important;border: none !important} \ No newline at end of file Propchange: jackrabbit/site/live/oak/docs/css/print.css ------------------------------------------------------------------------------ svn:eol-style = native Propchange: jackrabbit/site/live/oak/docs/css/print.css ------------------------------------------------------------------------------ svn:keywords = Author Date Id Revision Rev URL Added: jackrabbit/site/live/oak/docs/css/site.css URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/css/site.css?rev=1509200&view=auto ============================================================================== --- jackrabbit/site/live/oak/docs/css/site.css (added) +++ jackrabbit/site/live/oak/docs/css/site.css Thu Aug 1 12:22:13 2013 @@ -0,0 +1 @@ +/* You can override this file with your own styles */ \ No newline at end of file Propchange: jackrabbit/site/live/oak/docs/css/site.css ------------------------------------------------------------------------------ svn:eol-style = native Propchange: jackrabbit/site/live/oak/docs/css/site.css ------------------------------------------------------------------------------ svn:keywords = Author Date Id Revision Rev URL Added: jackrabbit/site/live/oak/docs/dependencies.html URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/dependencies.html?rev=1509200&view=auto ============================================================================== --- jackrabbit/site/live/oak/docs/dependencies.html (added) +++ jackrabbit/site/live/oak/docs/dependencies.html Thu Aug 1 12:22:13 2013 @@ -0,0 +1,316 @@ + + + + + + + + + Jackrabbit Oak - Project Dependencies + + + + + + + + + + + + + + + + + + Fork me on GitHub + + + + + + +
+
+
+ + + + + + + + + + + +
+ +
+
+ + +
+ + + + + +
+
+
+ + + + + + +
+ +
+ + + + +
+ +
+
+
+ + Built by Maven + +
+
+
+ + +
+ + +
+

Project Dependencies

+

There are no dependencies for this project. It is a standalone application that does not depend on any other project.

+
+
+
+ +
+ + + + \ No newline at end of file Propchange: jackrabbit/site/live/oak/docs/dependencies.html ------------------------------------------------------------------------------ svn:eol-style = native