You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@jackrabbit.apache.org by tr...@apache.org on 2015/04/06 07:53:59 UTC
svn commit: r1671485 [4/4] - in /jackrabbit/site/trunk: ./
src/site/markdown/ src/site/markdown/components/
src/site/markdown/concurrency-control/ src/site/markdown/deployment-models/
src/site/markdown/how-jackrabbit-works/ src/site/markdown/index-read...
Copied: jackrabbit/site/trunk/src/site/markdown/ocm/a-simple-ocm-project-with-maven--eclipse.md (from r1670829, jackrabbit/site/trunk/attic/content/a-simple-ocm-project-with-maven-&-eclipse.cwiki)
URL: http://svn.apache.org/viewvc/jackrabbit/site/trunk/src/site/markdown/ocm/a-simple-ocm-project-with-maven--eclipse.md?p2=jackrabbit/site/trunk/src/site/markdown/ocm/a-simple-ocm-project-with-maven--eclipse.md&p1=jackrabbit/site/trunk/attic/content/a-simple-ocm-project-with-maven-%26-eclipse.cwiki&r1=1670829&r2=1671485&rev=1671485&view=diff
==============================================================================
--- jackrabbit/site/trunk/attic/content/a-simple-ocm-project-with-maven-&-eclipse.cwiki (original)
+++ jackrabbit/site/trunk/src/site/markdown/ocm/a-simple-ocm-project-with-maven--eclipse.md Mon Apr 6 05:53:57 2015
@@ -1,34 +1,68 @@
-This tutorial explains how to start a new OCM project with Maven 2 & Eclipse. It is based on the tutorial [5' with Jackrabbit OCM].
+<!--
+ 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.
+-->
+
+A simple OCM Project with Maven and Eclipse
+===========================================
+This tutorial explains how to start a new OCM project with Maven 2 & Eclipse.
+It is based on the tutorial [5' with Jackrabbit OCM](5-with-jackrabbit-ocm.html).
-h2. Install Maven 2 & Eclipse
+Install Maven 2 & Eclipse
+-------------------------
This tutorial assumes that you have installed correctly Maven 2 & Eclipse.
-
If it is not the case, here is the instructions to install both products :
-- Download Maven 2 ([http://maven.apache.org/download.html]). See the installation instructions on this page.
-- Dowload Eclipse from [http://www.eclipse.org]
-- In Eclipse, you have to create a new classpath variable called M2_REPO which references the maven 2 repository (by default, it is the directory _$user home/.m2/repository_).
-h2. Download the OCM project
+* Download Maven 2 (http://maven.apache.org/download.html). See the installation instructions on this page.
+* Download Eclipse from http://www.eclipse.org
+* In Eclipse, you have to create a new classpath variable called M2_REPO
+ which references the maven 2 repository (by default, it is the directory _$user home/.m2/repository_).
+
+Download the OCM project
+------------------------
You can download the OCM project from [here|^5minutes.zip].
-h2. Install the project
-- Extract the project distribution anywhere on your local machine.
-- Open a command terminal and change the current directory to the project root folder.
-- Execute "mvn clean compile". This is an optional step to check if the code can be compiled correctly.
+Install the project
+-------------------
+
+* Extract the project distribution anywhere on your local machine.
+* Open a command terminal and change the current directory to the project root folder.
+* Execute "mvn clean compile". This is an optional step to check if the code can be compiled correctly.
-h2. Get ready for Eclipse
-- Execute "mvn eclipse:eclipse" from the project root folder. By this way, you project can be imported into Eclipse.
-- Start Eclipse and import the project (menu File/import, select general/existing project in the workspace, than select the project root directory).
+Get ready for Eclipse
+---------------------
+* Execute "mvn eclipse:eclipse" from the project root folder. By this way, you project can be imported into Eclipse.
+* Start Eclipse and import the project (menu File/import, select general/existing project in the workspace,
+ than select the project root directory).
Now you are ready to modify the project from Eclipse.
-h2. Review the project
-This project is a standalone java application (see the class org.apache.jackrabbit.ocm.Main) which is creating, retrieving and deleting a PressRelease (see the class org.apache.jackrabbit.ocm.model.PressRelease).For simplicity reason, this application is using a TransientRepository but you can change the repository configuration from the class RepositoryUtil.
+Review the project
+------------------
+This project is a standalone java application (see the
+class org.apache.jackrabbit.ocm.Main) which is creating, retrieving and deleting a
+PressRelease (see the class org.apache.jackrabbit.ocm.model.PressRelease).For simplicity
+reason, this application is using a TransientRepository but you can change the repository
+configuration from the class RepositoryUtil.
-You can read the tutorial [5' with Jackrabbit OCM] to get more information on how to initialize the [Object Content Manager] and how to persist the PressRelease Object.
+You can read the tutorial [5' with Jackrabbit OCM](5-with-jackrabbit-ocm.html) to get more
+information on how to initialize the _Object Content Manager_ and how to persist the
+PressRelease Object.
Copied: jackrabbit/site/trunk/src/site/markdown/ocm/advanced-mapping-strategies.md (from r1670829, jackrabbit/site/trunk/src/site/markdown/advanced-mapping-strategies.md)
URL: http://svn.apache.org/viewvc/jackrabbit/site/trunk/src/site/markdown/ocm/advanced-mapping-strategies.md?p2=jackrabbit/site/trunk/src/site/markdown/ocm/advanced-mapping-strategies.md&p1=jackrabbit/site/trunk/src/site/markdown/advanced-mapping-strategies.md&r1=1670829&r2=1671485&rev=1671485&view=diff
==============================================================================
--- jackrabbit/site/trunk/src/site/markdown/advanced-mapping-strategies.md (original)
+++ jackrabbit/site/trunk/src/site/markdown/ocm/advanced-mapping-strategies.md Mon Apr 6 05:53:57 2015
@@ -1,17 +1,35 @@
-Title: Advanced Mapping Strategies
-<a name="AdvancedMappingStrategies-Inheritance"></a>
-## Inheritance
+<!--
+ 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.
+-->
+Advanced Mapping Strategies
+===========================
+
+Inheritance
+-----------
TODO
-<a name="AdvancedMappingStrategies-Interface"></a>
-## Interface
+Interface
+---------
TODO
-<a name="AdvancedMappingStrategies-Components"></a>
-## Components
+Components
+----------
A component is an entity that cannot live by its own, but has a logical
meaning. Take for example an Address. It may live alone, but doesn't make
much sense in some systems. Once associated with an User it starts making
@@ -23,14 +41,14 @@ Now, returning to JCR, the component is
A mixin cannot live by its own in the repository. It is associated with
some node. It's properties are added to the set of original node.
-<a name="AdvancedMappingStrategies-Groupsomebeanattributesintoasubnode"></a>
-## Group some bean attributes into a subnode
+Group some bean attributes into a subnode
+-----------------------------------------
TODO
-<a name="AdvancedMappingStrategies-Maptoanothernodestructure"></a>
-## Map to another node structure
+Map to another node structure
+-----------------------------
Sometime, it should be interesting to map to a different jcr node
structure. Here is an example, for a class "File", we can have:
Copied: jackrabbit/site/trunk/src/site/markdown/ocm/basic-ocm-operations.md (from r1670829, jackrabbit/site/trunk/src/site/markdown/basic-ocm-operations.md)
URL: http://svn.apache.org/viewvc/jackrabbit/site/trunk/src/site/markdown/ocm/basic-ocm-operations.md?p2=jackrabbit/site/trunk/src/site/markdown/ocm/basic-ocm-operations.md&p1=jackrabbit/site/trunk/src/site/markdown/basic-ocm-operations.md&r1=1670829&r2=1671485&rev=1671485&view=diff
==============================================================================
--- jackrabbit/site/trunk/src/site/markdown/basic-ocm-operations.md (original)
+++ jackrabbit/site/trunk/src/site/markdown/ocm/basic-ocm-operations.md Mon Apr 6 05:53:57 2015
@@ -1,18 +1,35 @@
-Title: Basic OCM operations
+<!--
+ 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.
+-->
+
+Basic OCM operations
+--------------------
When you have created a new [Object Content Manager](object-content-manager.html)
- in your application, you can use this component to insert, update, delete
+in your application, you can use this component to insert, update, delete
and retrieve objects. The class 'Folder' used in the following sections has
-to be annoted or defined in a xml file class descriptor.
+to be annotated or defined in a xml file class descriptor.
This page describes only the main [Object Content Manager](object-content-manager.html)
- methods. You can see the javadoc to get more information on the API.
-You can also read the tutorial [5' with Jackrabbit OCM](5'-with-jackrabbit-ocm.html)
- to get more information on how to initialize the [Object Content Manager]
- (ocm).
+methods. You can see the javadoc to get more information on the API.
+You can also read the tutorial [5' with Jackrabbit OCM](5-with-jackrabbit-ocm.html)
+to get more information on how to initialize the [Object Content Manager](ocm).
-<a name="BasicOCMoperations-Insert"></a>
-## Insert
+Insert
+------
Folder folder = new Folder();
folder.setPath("/myfolder");
@@ -21,26 +38,22 @@ You can also read the tutorial [5' with
ocm.insert(myFolder);
-<a name="BasicOCMoperations-Retrieveandupdateanobject"></a>
-## Retrieve and update an object
-
+Retrieve and update an object
+-----------------------------
- Folder folder = (Folder) persistenceManager.getObject(Folder.class,
-"/myfolder");
+ Folder folder = (Folder) persistenceManager.getObject(Folder.class, "/myfolder");
folder.set...(); // call the setter methods
ocm.update(myFolder);
-<a name="BasicOCMoperations-Delete"></a>
-## Delete
-
+Delete
+------
ocm.remove("/test");
-<a name="BasicOCMoperations-Savelastchanges"></a>
-## Save last changes
-
+Save last changes
+-----------------
After some inserts, deletes and/or updates, you can call the method
-*ocm.save()* to apply your changes into the JCR repository.
+`ocm.save()` to apply your changes into the JCR repository.
Copied: jackrabbit/site/trunk/src/site/markdown/ocm/how-to-map-associations-between-objects.md (from r1670829, jackrabbit/site/trunk/src/site/markdown/how-to-map-associations-between-objects.md)
URL: http://svn.apache.org/viewvc/jackrabbit/site/trunk/src/site/markdown/ocm/how-to-map-associations-between-objects.md?p2=jackrabbit/site/trunk/src/site/markdown/ocm/how-to-map-associations-between-objects.md&p1=jackrabbit/site/trunk/src/site/markdown/how-to-map-associations-between-objects.md&r1=1670829&r2=1671485&rev=1671485&view=diff
==============================================================================
--- jackrabbit/site/trunk/src/site/markdown/how-to-map-associations-between-objects.md (original)
+++ jackrabbit/site/trunk/src/site/markdown/ocm/how-to-map-associations-between-objects.md Mon Apr 6 05:53:57 2015
@@ -1,23 +1,41 @@
-Title: How to map associations between objects
-<a name="Howtomapassociationsbetweenobjects-Overview"></a>
-## Overview
+<!--
+ 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.
+-->
+How to map associations between objects
+=======================================
+
+Overview
+--------
This tutorial explains how to map associations between objects (1:1 and
1:n). You can find the tutorial code sample from [here](^beans_and_collections.zip.html)
. It is based on Maven and ready to be used inside Eclipse. If you have
some configuration issues, please review the tutorial "[A simple OCM
project with Maven & Eclipse]".
-<a name="Howtomapassociationsbetweenobjects-TheContentModel"></a>
-## The Content Model
-
-We will extend the content model created in the previous tutorial [5' with Jackrabbit OCM](5'-with-jackrabbit-ocm.html)
-. Each PressRelease is made by an Author and it is possible to add some
+The Content Model
+-----------------
+We will extend the content model created in the previous tutorial [5' with Jackrabbit OCM](5-with-jackrabbit-ocm.html).
+Each PressRelease is made by an Author and it is possible to add some
references (URL).
So, we have to add 2 new associations in our model :
-- An 1:1 association between a PressRelease and an Author.
-- An 1:n association between PresseRelease and Url.
+
+* An 1:1 association between a PressRelease and an Author.
+* An 1:n association between PresseRelease and Url.
Here is the main java class, the PressRelease :
@@ -41,9 +59,9 @@ Here is the main java class, the PressRe
}
-Since the tutorial [5' with Jackrabbit OCM](5'-with-jackrabbit-ocm.html)
-, we can understand the goal of the annotations @Node and @Field.
-An association 1:1 can be specified with the annotation @Bean like
+Since the tutorial [5' with Jackrabbit OCM](5-with-jackrabbit-ocm.html),
+we can understand the goal of the annotations `@Node` and `@Field`.
+An association 1:1 can be specified with the annotation `@Bean` like
@Bean private Author author;
@@ -51,10 +69,10 @@ An association 1:1 can be specified with
It is possible to set extra settings with this annotation but it is out of
the scope of this tutorial.You can review the code of the Author class
which is very simple. As you will see, it is not mandatory to add
-annotation @Field(path=true) in the Author class because it is an
+annotation `@Field(path=true)` in the Author class because it is an
aggregation of a PressRelease.
-An 1:n association can be specified with the annotation @Collection like
+An 1:n association can be specified with the annotation `@Collection` like
@Collection List<Url> urls;
@@ -70,22 +88,20 @@ Right now, the support of Map is limited
because the map key will be used as the Node name.
-<a name="Howtomapassociationsbetweenobjects-Howarethoseobjectsstoredintherepository?"></a>
-## How are those objects stored in the repository ?
-
-
+How are those objects stored in the repository ?
+------------------------------------------------
For this tutorial each java class is mapped into the "nt:unstructured" node
type. Making this kind of mapping is quite flexible because it does not
imply specific repository configuration. There is no constraints in the JCR
repository. All constrains are defined in the java code.
-{info}
-Note : It is possible to associate a specific node type to each java class
-but this imply more repository configurations.
- It is also possible to change the corresponding JCR node structure
-by using specific Bean or Collection converters.
- Later, we will add more tutorials on OCM converters.
-{info}
+
+> Note : It is possible to associate a specific node type to each java class
+> but this imply more repository configurations.
+> It is also possible to change the corresponding JCR node structure
+> by using specific Bean or Collection converters.
+> Later, we will add more tutorials on OCM converters.
+
Following our example, the Author and Urls nodes will be created as
subnodes of a press release.
@@ -122,9 +138,7 @@ Here is an example of the correspoding J
* description : "..."
-
-<a name="Howtomapassociationsbetweenobjects-Downloadthetutorialcode"></a>
-## Download the tutorial code
-
+Download the tutorial code
+--------------------------
You can download the OCM project from [here](^beans_and_collections.zip.html)
Copied: jackrabbit/site/trunk/src/site/markdown/ocm/mapping-atomic-fields.md (from r1670829, jackrabbit/site/trunk/src/site/markdown/mapping-atomic-fields.md)
URL: http://svn.apache.org/viewvc/jackrabbit/site/trunk/src/site/markdown/ocm/mapping-atomic-fields.md?p2=jackrabbit/site/trunk/src/site/markdown/ocm/mapping-atomic-fields.md&p1=jackrabbit/site/trunk/src/site/markdown/mapping-atomic-fields.md&r1=1670829&r2=1671485&rev=1671485&view=diff
==============================================================================
--- jackrabbit/site/trunk/src/site/markdown/mapping-atomic-fields.md (original)
+++ jackrabbit/site/trunk/src/site/markdown/ocm/mapping-atomic-fields.md Mon Apr 6 05:53:57 2015
@@ -1,42 +1,60 @@
-Title: Mapping Atomic Fields
+<!--
+ 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.
+-->
+
+Mapping Atomic Fields
+=====================
The field-descriptor maps a bean attribute based on a Java primitive
- type into a JCR property. By default, the persistence manager uses
- the correct mapping in function of the attribute type (see below
- the section "Supported Types").
+type into a JCR property. By default, the persistence manager uses
+the correct mapping in function of the attribute type (see below
+the section "Supported Types").
Based on our model defined here, the following field-descriptor
maps the bean field "title" (String type) into the JCR property
"my:title".
-<a name="MappingAtomicFields-SupportedTypes"></a>
-## Supported Types
+Supported Types
+---------------
It is not necessary to specify the type in the field-descriptor.
The Persistence Manager uses the java introspection to get
information on each atomic field.
- <table>
- <tr><th> Java Type </th><th> Jcr Type </th></tr>
- <tr><td> String </td><td> STRING </td></tr>
- <tr><td> Boolean, boolean </td><td> BOOLEAN </td></tr>
- <tr><td> Double, double </td><td> DOUBLE </td></tr>
- <tr><td> Integer, int </td><td> DOUBLE </td></tr>
- <tr><td> Long, long </td><td> LONG </td></tr>
- <tr><td> byte\[\](\.html)
- </td><td> BINARY </td></tr>
- <tr><td> java.io.InputStream </td><td> BINARY </td></tr>
- <tr><td> java.util.Calendar </td><td> LONG (corresponding to Calendar.getTimeInMillis() </td></tr>
- <tr><td> java.sql.Timestamp </td><td> LONG (corresponding to Timestamp.getTime() </td></tr>
- <tr><td> java.util.Date </td><td> LONG (corresponding to java.util.Date.getTime() </td></tr>
- </table>
+<table>
+<tr><th> Java Type </th><th> Jcr Type </th></tr>
+<tr><td> String </td><td> STRING </td></tr>
+<tr><td> Boolean, boolean </td><td> BOOLEAN </td></tr>
+<tr><td> Double, double </td><td> DOUBLE </td></tr>
+<tr><td> Integer, int </td><td> DOUBLE </td></tr>
+<tr><td> Long, long </td><td> LONG </td></tr>
+<tr><td> byte\[\](\.html)
+ </td><td> BINARY </td></tr>
+<tr><td> java.io.InputStream </td><td> BINARY </td></tr>
+<tr><td> java.util.Calendar </td><td> LONG (corresponding to Calendar.getTimeInMillis() </td></tr>
+<tr><td> java.sql.Timestamp </td><td> LONG (corresponding to Timestamp.getTime() </td></tr>
+<tr><td> java.util.Date </td><td> LONG (corresponding to java.util.Date.getTime() </td></tr>
+</table>
Due to some issues with Jackrabbit (mainly with xpath queries),
Calendar, Timestamp and date are converted into JCR LONG. We plan
to add other converters for those types in the next release.
-<a name="MappingAtomicFields-UsingAnotherAtomicTypeConverter"></a>
-## Using Another Atomic Type Converter
+Using Another Atomic Type Converter
+-----------------------------------
The OCM framework gives you the freedom to choose another kind of
mapping for atomic fields. For example, you can convert
java.util.Date bean field into a JCR Date type instead of a JCR
@@ -47,7 +65,7 @@ Let's start with a simple example. If yo
strategy which convert a boolean bean field into a JCR Long type,
you have to make the following steps:
-<a name="MappingAtomicFields-Specifytheconverterclassinthefielddescriptor"></a>
+
### Specify the converter class in the field descriptor
@@ -62,7 +80,6 @@ you have to make the following steps:
</class-descriptor>
-<a name="MappingAtomicFields-Implementtheconverterclass"></a>
### Implement the converter class
Use the interface org.apache.jackrabbit.ocm.persistence.atomic.AtomicTypeConverter
Copied: jackrabbit/site/trunk/src/site/markdown/ocm/mapping-bean-fields.md (from r1670829, jackrabbit/site/trunk/src/site/markdown/mapping-bean-fields.md)
URL: http://svn.apache.org/viewvc/jackrabbit/site/trunk/src/site/markdown/ocm/mapping-bean-fields.md?p2=jackrabbit/site/trunk/src/site/markdown/ocm/mapping-bean-fields.md&p1=jackrabbit/site/trunk/src/site/markdown/mapping-bean-fields.md&r1=1670829&r2=1671485&rev=1671485&view=diff
==============================================================================
--- jackrabbit/site/trunk/src/site/markdown/mapping-bean-fields.md (original)
+++ jackrabbit/site/trunk/src/site/markdown/ocm/mapping-bean-fields.md Mon Apr 6 05:53:57 2015
@@ -1,4 +1,22 @@
-Title: Mapping Bean Fields
+<!--
+ 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.
+-->
+
+Mapping Bean Fields
+===================
The bean-descriptor maps a bean attribute into one JCR node (or
a set of properties). Generally, this attribute is an object
based on a custom class.
@@ -13,9 +31,9 @@ PageInfo attributes. It is not necessary
the bean-descriptor. The Persistence Manager uses the Java
introspection to get information on the each bean fields.
-<a name="MappingBeanFields-TheJCRStructure"></a>
-## The JCR Structure
+The JCR Structure
+-----------------
Following our example, the resulting JCR structure is:
@@ -29,9 +47,9 @@ Following our example, the resulting JCR
By default, the persistence manager will create a subnode
(/mysite/page1/pageInfo) for the bean-descriptor pageInfo.
-<a name="MappingBeanFields-UsingAnotherBeanConverter"></a>
-## Using Another Bean Converter
+Using Another Bean Converter
+----------------------------
The OCM framework gives you the freedom to choose another kind
of mapping for bean fields. For example, you can use a custom
bean converter to access to the parent node (see the next
@@ -40,24 +58,24 @@ section below).
This can be done by writing your own bean converter class and
reference this class in the bean-descriptor.
-<a name="MappingBeanFields-PredefinedBeanConverters"></a>
+
### Predefined Bean Converters
Here is the list of existing custom bean converters:
- <table>
- <tr><th> Custom Bean Converter Class </th><th> Description </th></tr>
- <tr><td>
- org.apache.jackrabbit.ocm.persistence.beanconverter.impl.ParentBeanConverterImpl
- </td><td> Map a bean field to the parent node. it is used to access to the
- parent object in read-only mode. See below the example based on
- a Folder object. </td></tr>
- <tr><td>
- org.apache.jackrabbit.ocm.persistence.beanconverter.impl.InlineBeanConverterImpl
- </td><td> Bean converter used to map some node properties into one nested
- bean field. The corresponding bean field is not associated to a
- subnode. </td></tr>
- </table>
+<table>
+<tr><th> Custom Bean Converter Class </th><th> Description </th></tr>
+<tr><td>
+org.apache.jackrabbit.ocm.persistence.beanconverter.impl.ParentBeanConverterImpl
+</td><td> Map a bean field to the parent node. it is used to access to the
+ parent object in read-only mode. See below the example based on
+ a Folder object. </td></tr>
+<tr><td>
+org.apache.jackrabbit.ocm.persistence.beanconverter.impl.InlineBeanConverterImpl
+</td><td> Bean converter used to map some node properties into one nested
+ bean field. The corresponding bean field is not associated to a
+ subnode. </td></tr>
+</table>
If you want to use one of this bean converter, you have to
reference it into a bean-field descriptor.
@@ -80,7 +98,6 @@ to the parent node.
</class-descriptor>
-<a name="MappingBeanFields-BuildingyourownBeanConverters"></a>
### Building your own Bean Converters
Here is the different steps used to create a new bean converter :
Copied: jackrabbit/site/trunk/src/site/markdown/ocm/mapping-collection-fields.md (from r1670829, jackrabbit/site/trunk/src/site/markdown/mapping-collection-fields.md)
URL: http://svn.apache.org/viewvc/jackrabbit/site/trunk/src/site/markdown/ocm/mapping-collection-fields.md?p2=jackrabbit/site/trunk/src/site/markdown/ocm/mapping-collection-fields.md&p1=jackrabbit/site/trunk/src/site/markdown/mapping-collection-fields.md&r1=1670829&r2=1671485&rev=1671485&view=diff
==============================================================================
--- jackrabbit/site/trunk/src/site/markdown/mapping-collection-fields.md (original)
+++ jackrabbit/site/trunk/src/site/markdown/ocm/mapping-collection-fields.md Mon Apr 6 05:53:57 2015
@@ -1,4 +1,22 @@
-Title: Mapping Collection Fields
+<!--
+ 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.
+-->
+
+Mapping Collection Fields
+=========================
The collection-descriptor maps a collection attribute into JCR nodes or in
a multivalue property.
@@ -27,9 +45,9 @@ The collection-descriptor contains the e
specify the collection element class. A class descriptor for the element
class has also to be defined.
-<a name="MappingCollectionFields-TheJCRStructure"></a>
-## The JCR Structure
+The JCR Structure
+-----------------
Following our example, the resulting JCR structure is:
@@ -50,31 +68,31 @@ As explained in the following sections,
JCR structure. It is also possible to use another name for the jcr node
names (see above).
-<a name="MappingCollectionFields-SupportedCollectionandMapTypes"></a>
-## Supported Collection and Map Types
+Supported Collection and Map Types
+----------------------------------
The OCM framework is supporting the following java types:
* *Collections* Collection, List, Set, ArrayList, Vector, HashSet
* *Maps* Map, HashMap
-<a name="MappingCollectionFields-UsingAnotherCollectionorMap"></a>
-## Using Another Collection or Map
+Using Another Collection or Map
+-------------------------------
It is possible to support other Collection or Map types with the
ManageableCollection interface.
-<a name="MappingCollectionFields-UsingAnotherCollectionConverter"></a>
-## Using Another Collection Converter
+Using Another Collection Converter
+----------------------------------
TODO
-<a name="MappingCollectionFields-PredefinedCollectionConverters"></a>
-## Predefined Collection Converters
+Predefined Collection Converters
+--------------------------------
TODO
-<a name="MappingCollectionFields-BuildingyourownCollectionConverters"></a>
-## Building your own Collection Converters
+Building your own Collection Converters
+---------------------------------------
TODO
Copied: jackrabbit/site/trunk/src/site/markdown/ocm/mapping-stategies.md (from r1670829, jackrabbit/site/trunk/src/site/markdown/mapping-stategies.md)
URL: http://svn.apache.org/viewvc/jackrabbit/site/trunk/src/site/markdown/ocm/mapping-stategies.md?p2=jackrabbit/site/trunk/src/site/markdown/ocm/mapping-stategies.md&p1=jackrabbit/site/trunk/src/site/markdown/mapping-stategies.md&r1=1670829&r2=1671485&rev=1671485&view=diff
==============================================================================
--- jackrabbit/site/trunk/src/site/markdown/mapping-stategies.md (original)
+++ jackrabbit/site/trunk/src/site/markdown/ocm/mapping-stategies.md Mon Apr 6 05:53:57 2015
@@ -1,18 +1,35 @@
-Title: Mapping Stategies
+<!--
+ 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.
+-->
+
+Mapping Strategies
+=================
We are calling "Mapping strategy" the algorithm used by the Persistence
Manager to map a Java class into JCR nodes and/or properties.
-<a name="MappingStategies-TheObjectModel"></a>
-## The Object Model
+The Object Model
+----------------
In order to explain the basic mapping strategies, we will use the following
simple object model :
-* A page contains a path (of course), a pageInfo and a collection of
-paragraphs.
+* A page contains a path (of course), a pageInfo and a collection of paragraphs.
* The PageInfo class contains the title and the page description. We are
-using the pageInfo here to see all mapping features (see the
-bean-descriptors). In real application, this class is not necessary :-)
+ using the pageInfo here to see all mapping features (see the
+ bean-descriptors). In real application, this class is not necessary :-)
* Each paragraph contains a path and a text field.
{center}!sample-model-doc.png!{center}
@@ -20,9 +37,9 @@ bean-descriptors). In real application,
This object model could be too simple for real applications and it is just
used here to simplify the description of the different mapping strategies.
-<a name="MappingStategies-TheJavaClasses"></a>
-## The Java Classes
+The Java Classes
+----------------
Based on that object model, we can define the following Java classes:
**Page.java**
@@ -71,9 +88,9 @@ Based on that object model, we can defin
}
-<a name="MappingStategies-TheJCRStructure"></a>
-## The JCR Structure
+The JCR Structure
+-----------------
Here is the resulting JCR structure if the page is stored on the path
"/mysite/mypage1" and contains 2 paragraphs:
@@ -95,9 +112,9 @@ strategies. See the sections [Mapping At
, [Mapping Collection Fields]
to get more information on that.
-<a name="MappingStategies-TheClassDescriptors"></a>
-## The Class Descriptors
+The Class Descriptors
+---------------------
When you decide to map a bean class, you have to create a new class
descriptor entry in the Persistence Manager descriptor file. Let's start
with the simplest class-descriptor:
@@ -110,8 +127,7 @@ property. For example, the first field d
field-descriptor is a specific case because it maps the jcr node path into
a bean field called "path" (see below the section "The Path Field").
-You can find more information on the field-descriptors in the page [Mapping Atomic Fields](mapping-atomic-fields.html)
-.
+You can find more information on the field-descriptors in the page [Mapping Atomic Fields](mapping-atomic-fields.html).
It is also possible to map a bean class to a particular JCR node type by
specifying the desired type in the attribute jcrType. The following
@@ -130,9 +146,9 @@ Of course, node types "my:Page" and "my:
We are currently building a node type management tools which can import the
node types from the class-descriptors.
-<a name="MappingStategies-ThePathField"></a>
-## The Path Field
+The Path Field
+--------------
Each mapped class contains a mandatory field called the "path field". It
contains the JCR path associated to the object. For example, the following
descriptor specify the bean field "myPath" as the path field.
Copied: jackrabbit/site/trunk/src/site/markdown/ocm/object-content-manager.md (from r1670829, jackrabbit/site/trunk/src/site/markdown/object-content-manager.md)
URL: http://svn.apache.org/viewvc/jackrabbit/site/trunk/src/site/markdown/ocm/object-content-manager.md?p2=jackrabbit/site/trunk/src/site/markdown/ocm/object-content-manager.md&p1=jackrabbit/site/trunk/src/site/markdown/object-content-manager.md&r1=1670829&r2=1671485&rev=1671485&view=diff
==============================================================================
--- jackrabbit/site/trunk/src/site/markdown/object-content-manager.md (original)
+++ jackrabbit/site/trunk/src/site/markdown/ocm/object-content-manager.md Mon Apr 6 05:53:57 2015
@@ -1,4 +1,22 @@
-Title: Object Content Manager
+<!--
+ 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.
+-->
+
+Object Content Manager
+======================
The main component in the OCM framework is the ObjectContentManager. It
converts an object graph into JCR nodes and properties and vice versa. The
ObjectContentManager is always associated with a JCR Session. It is used to
@@ -8,9 +26,9 @@ Usually there is one ObjectContentManage
This page describes how an ObjectContentManager is working and how it can
be initialised in your applications.
-<a name="ObjectContentManager-HowdoestheObjectContentManagerwork?"></a>
-## How does the Object Content Manager work ?
+How does the Object Content Manager work ?
+------------------------------------------
Thanks to a Mapping Descriptor, the ObjectContentManager is able to use the
appropriate mapping strategy for each persistent object (pojo). The Mapping
Descriptor contains one Class Descriptor per persistent class. Each Class
@@ -22,48 +40,49 @@ object injected into the ObjectContentMa
org.apache.jackrabbit.ocm.mapper.Mapper). Right now, there are 2 different
Mapping Descriptor implementations:
- * Annotation : each persistent object is annoted in order to provide to
-the ObjectContentManager all the required information on its mapping
-strategy (see the class
-org.apache.jackrabbit.ocm.mapper.impl.annotation.AnnotationMapperImpl).
- * XML configuration file : the class descriptors are defined in one or
-more XML config files used by the ObjectContentManager when it is
-instantiated (see the class
-org.apache.jackrabbit.ocm.mapper.impl.digester.DigesterMapperImpl).
+* Annotation : each persistent object is annoted in order to provide to
+ the ObjectContentManager all the required information on its mapping
+ strategy (see the class
+ org.apache.jackrabbit.ocm.mapper.impl.annotation.AnnotationMapperImpl).
+* XML configuration file : the class descriptors are defined in one or
+ more XML config files used by the ObjectContentManager when it is
+ instantiated (see the class
+ org.apache.jackrabbit.ocm.mapper.impl.digester.DigesterMapperImpl).
For a business developer, it is not necessary to know how the
ObjectContentManager is using the Class Descriptors. He has to make only a
-choice between annoted classes or XML files. Below, you can see how to
+choice between annotated classes or XML files. Below, you can see how to
setup correctly an ObjectContentManager.
-<a name="ObjectContentManager-HowdoesanobjectispersistedintoaJCRrepository?"></a>
-## How does an object is persisted into a JCR repository ?
+How does an object is persisted into a JCR repository ?
+-------------------------------------------------------
In all cases, a persistent object (a pojo) is mapped into a JCR node and
its fields are mapped into subnodes or properties depending on their types.
There are 3 "field types":
-* Atomic fields
+* Atomic fields
Primitive data types and simple objects (String, Long, Double, ...) .
-Those fields are mapped into JCR properties.
+ Those fields are mapped into JCR properties.
-* Bean fields
+* Bean fields
One class can contain an 1..1 association to another bean. In this
-case, the field is a custom object. Those fields are mapped into JCR
-subnodes or a referenced node.
+ case, the field is a custom object. Those fields are mapped into JCR
+ subnodes or a referenced node.
-* Collection fields
+* Collection fields
One class can contain an 1..n association to a collection of beans (or
-Map). Those fields are mapped into a collection of JCR subnodes or a
-collection of referenced nodes. It is also possible to map a java
-collection into a multivalue property.
+ Map). Those fields are mapped into a collection of JCR subnodes or a
+ collection of referenced nodes. It is also possible to map a java
+ collection into a multivalue property.
The Mapping descriptor contains also information on inheritances, interface
mapping strategy, lazy loading, custom converter, cache strategy, etc.
-<a name="ObjectContentManager-Basicsetup(withannotedpersistentclasses)"></a>
-## Basic setup (with annoted persistent classes)
+
+Basic setup (with annotated persistent classes)
+---------------------------------------------
When you start your application, you need the following code to initialize
correctly the Object Content Manager.
@@ -73,8 +92,7 @@ correctly the Object Content Manager.
import org.apache.jackrabbit.ocm.manager.impl.ObjectContentManagerImpl;
import org.apache.jackrabbit.ocm.mapper.Mapper;
- import
-org.apache.jackrabbit.ocm.mapper.impl.annotation.AnnotationMapperImpl;
+ import org.apache.jackrabbit.ocm.mapper.impl.annotation.AnnotationMapperImpl;
// 1. Instantiate a JCR session
@@ -91,9 +109,8 @@ org.apache.jackrabbit.ocm.mapper.impl.an
ObjectContentManager ocm = new ObjectContentManagerImpl(session, mapper);
-<a name="ObjectContentManager-Basicsetup(withoneormoreXMLMappingDescriptorfiles)"></a>
-## Basic setup (with one or more XML Mapping Descriptor files)
-
+Basic setup (with one or more XML Mapping Descriptor files)
+-----------------------------------------------------------
When you start your application, you need the following code to initialize
correctly the Object Content Manager.
@@ -104,13 +121,10 @@ correctly the Object Content Manager.
import org.apache.jackrabbit.ocm.mapper.impl.digester.DigesterMapperImpl;
import org.apache.jackrabbit.ocm.manager.ObjectContentManager;
import org.apache.jackrabbit.ocm.manager.impl.ObjectContentManagerImpl;
- import
-org.apache.jackrabbit.ocm.manager.atomictypeconverter.AtomicTypeConverterProvider;
- import
-org.apache.jackrabbit.ocm.manager.atomictypeconverter.impl.DefaultAtomicTypeConverterProvider;
+ import org.apache.jackrabbit.ocm.manager.atomictypeconverter.AtomicTypeConverterProvider;
+ import org.apache.jackrabbit.ocm.manager.atomictypeconverter.impl.DefaultAtomicTypeConverterProvider;
import org.apache.jackrabbit.ocm.manager.objectconverter.ObjectConverter;
- import
-org.apache.jackrabbit.ocm.manager.objectconverter.impl.ObjectConverterImpl;
+ import org.apache.jackrabbit.ocm.manager.objectconverter.impl.ObjectConverterImpl;
import org.apache.jackrabbit.ocm.query.QueryManager;
import org.apache.jackrabbit.ocm.query.impl.QueryManagerImpl;
@@ -119,8 +133,7 @@ org.apache.jackrabbit.ocm.manager.object
Session session = repository.login(...);
// 2. Specify the different mapping files
- String[]
- files = {
+ String[] files = {
"./src/test-config/jcrmapping.xml",
"./src/test-config/jcrmapping-atomic.xml",
"./src/test-config/jcrmapping-beandescriptor.xml"
@@ -131,20 +144,13 @@ org.apache.jackrabbit.ocm.manager.object
-
-<a name="ObjectContentManager-APIOverview"></a>
-## API Overview
-
+API Overview
+------------
With the current Object Manager API, it is possible to:
-* Manage the object life cycle (insert, update, delete, retrieve). See [Basic OCM operations](basic-ocm-operations.html)
-.
-* Search single object or collections with criteria. See [OCM Search](ocm-search.html)
-.
-* Lock objects. See [OCM Locking](ocm-locking.html)
-.
-* Manage versions (check int, check out, create a new version, show
-history). See [OCM Version Management](ocm-version-management.html)
-.
+* Manage the object life cycle (insert, update, delete, retrieve). See [Basic OCM operations](basic-ocm-operations.html) .
+* Search single object or collections with criteria. See [OCM Search](ocm-search.html) .
+* Lock objects. See [OCM Locking](ocm-locking.html) .
+* Manage versions (check int, check out, create a new version, show history). See [OCM Version Management](ocm-version-management.html) .
We plan to add other features in a future release.
Copied: jackrabbit/site/trunk/src/site/markdown/ocm/ocm-locking.md (from r1670829, jackrabbit/site/trunk/src/site/markdown/ocm-locking.md)
URL: http://svn.apache.org/viewvc/jackrabbit/site/trunk/src/site/markdown/ocm/ocm-locking.md?p2=jackrabbit/site/trunk/src/site/markdown/ocm/ocm-locking.md&p1=jackrabbit/site/trunk/src/site/markdown/ocm-locking.md&r1=1670829&r2=1671485&rev=1671485&view=diff
==============================================================================
--- jackrabbit/site/trunk/src/site/markdown/ocm-locking.md (original)
+++ jackrabbit/site/trunk/src/site/markdown/ocm/ocm-locking.md Mon Apr 6 05:53:57 2015
@@ -1,19 +1,35 @@
-Title: OCM Locking
+<!--
+ 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.
+-->
+
+OCM Locking
+===========
Following the Jcr specification, it is possible to lock nodes and their
children (see section 8.4). You can see on this page the OCM API used to
lock on the object level. In order to lock an object, its matching node has
to implement the jcr mixin type "mix:lockable". It is possible to specify
this node type in the class descriptor:
-<a name="OCMLocking-Abasicexample"></a>
-## A basic example
+A basic example
+---------------
- //
---------------------------------------------------------------------------------
+ // --------------------------------------------------------------------------------
// Create and store an object graph in the repository
- //
---------------------------------------------------------------------------------
+ // --------------------------------------------------------------------------------
A a = new A();
a.setPath("/test");
a.setA1("a1");
@@ -45,37 +61,29 @@ this node type in the class descriptor:
ocm.save();
- //
---------------------------------------------------------------------------------
+ // --------------------------------------------------------------------------------
// Check if the object is not locked
- //
---------------------------------------------------------------------------------
+ // --------------------------------------------------------------------------------
if (ocm.isLocked("/test"))
{
System.out.println("Error : The object is locked- humm ??");
}
- //
---------------------------------------------------------------------------------
+ // --------------------------------------------------------------------------------
// Lock the object
- //
---------------------------------------------------------------------------------
+ // --------------------------------------------------------------------------------
String lockToken = ocm.lock("/test", true, false);
- //
---------------------------------------------------------------------------------
+ // --------------------------------------------------------------------------------
// Check if the object is not locked
- //
---------------------------------------------------------------------------------
+ // --------------------------------------------------------------------------------
if (! ocm.isLocked("/test"))
{
System.out.println("Error : The object is not locked- humm ??");
}
- //
---------------------------------------------------------------------------------
+ // --------------------------------------------------------------------------------
// Unlock the object
- //
---------------------------------------------------------------------------------
+ // --------------------------------------------------------------------------------
ocm.unlock("/test", lockToken);
Copied: jackrabbit/site/trunk/src/site/markdown/ocm/ocm-search.md (from r1670829, jackrabbit/site/trunk/src/site/markdown/ocm-search.md)
URL: http://svn.apache.org/viewvc/jackrabbit/site/trunk/src/site/markdown/ocm/ocm-search.md?p2=jackrabbit/site/trunk/src/site/markdown/ocm/ocm-search.md&p1=jackrabbit/site/trunk/src/site/markdown/ocm-search.md&r1=1670829&r2=1671485&rev=1671485&view=diff
==============================================================================
--- jackrabbit/site/trunk/src/site/markdown/ocm-search.md (original)
+++ jackrabbit/site/trunk/src/site/markdown/ocm/ocm-search.md Mon Apr 6 05:53:57 2015
@@ -1,24 +1,40 @@
-Title: OCM Search
+<!--
+ 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.
+-->
-<a name="OCMSearch-Searchingasingleobject"></a>
-## Searching a single object
+OCM Search
+==========
+Searching a single object
+-------------------------
+
QueryManager queryManager = ocm.getQueryManager();
// Build the search filter
Filter filter = queryManager.createFilter(Paragraph.class);
- filter.addEqualTo("text", "Para 1"); // Text is an attribute in the class
-Paragraph
+ filter.addEqualTo("text", "Para 1"); // Text is an attribute in the class Paragraph
// Build the query
Query query = queryManager.createQuery(filter);
Paragraph paragraph = (Paragraph) ocm.getObject(query);
-<a name="OCMSearch-Searchingacollection"></a>
-## Searching a collection
-
+Searching a collection
+----------------------
QueryManager queryManager = ocm.getQueryManager();
Filter filter = queryManager.createFilter(Paragraph.class);
@@ -27,9 +43,8 @@ Paragraph
Collection result = ocm.getObjects(query);
-<a name="OCMSearch-Searchingwithaniterator"></a>
-## Searching with an iterator
-
+Searching with an iterator
+--------------------------
QueryManager queryManager = ocm.getQueryManager();
Filter filter = queryManager.createFilter(Paragraph.class);
@@ -38,9 +53,8 @@ Paragraph
Iterator iterator = ocm.getObjectIterator(query);
-<a name="OCMSearch-Removeobjectsbasedonaquery"></a>
-## Remove objects based on a query
-
+Remove objects based on a query
+-------------------------------
QueryManager queryManager = ocm.getQueryManager();
Filter filter = queryManager.createFilter(Paragraph.class);
Copied: jackrabbit/site/trunk/src/site/markdown/ocm/ocm-version-management.md (from r1670829, jackrabbit/site/trunk/src/site/markdown/ocm-version-management.md)
URL: http://svn.apache.org/viewvc/jackrabbit/site/trunk/src/site/markdown/ocm/ocm-version-management.md?p2=jackrabbit/site/trunk/src/site/markdown/ocm/ocm-version-management.md&p1=jackrabbit/site/trunk/src/site/markdown/ocm-version-management.md&r1=1670829&r2=1671485&rev=1671485&view=diff
==============================================================================
--- jackrabbit/site/trunk/src/site/markdown/ocm-version-management.md (original)
+++ jackrabbit/site/trunk/src/site/markdown/ocm/ocm-version-management.md Mon Apr 6 05:53:57 2015
@@ -1,9 +1,26 @@
-Title: OCM Version Management
+<!--
+ 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.
+-->
+
+OCM Version Management
+======================
Right now, the OCM tools provides basic versioning features:
* Check in, check out.
-* Retrieve version history (first version, last version, the complete
-history, ...).
+* Retrieve version history (first version, last version, the complete history, ...).
* Apply labels.
Later, we would like to add more advanced versioning support like version
@@ -11,9 +28,9 @@ compare, replace, revert, ... Each versi
mix:versionable JCR node. It is possible to specify this node type in the
xml class descriptor or with an annotation :
-<a name="OCMVersionManagement-Checkin-Checkout"></a>
-## Check in - Check out
+Check in - Check out
+--------------------
// Create a new page - first version
Page page = new Page();
@@ -39,23 +56,21 @@ xml class descriptor or with an annotati
ocm.checkin("/page");
-<a name="OCMVersionManagement-Retrievetheversionhistory"></a>
-## Retrieve the version history
+Retrieve the version history
+----------------------------
VersionIterator versionIterator = ocm.getAllVersions("/page");
while (versionIterator.hasNext())
{
Version version = (Version) versionIterator.next();
System.out.println("version found : "+ version.getName() + " - " +
- version.getPath() + " - " +
-version.getCreated().getTime());
+ version.getPath() + " - " + version.getCreated().getTime());
}
-<a name="OCMVersionManagement-Retrieveversiondescription"></a>
-## Retrieve version description
-
+Retrieve version description
+----------------------------
// Retrieve the first version description
Version baseVersion = ocm.getBaseVersion("/page");
@@ -66,17 +81,15 @@ version.getCreated().getTime());
System.out.println("Root version : " + rootVersion.getName());
-<a name="OCMVersionManagement-Retrievetheobjectstatematchingtoaspecificversion"></a>
-## Retrieve the object state matching to a specific version
-
+Retrieve the object state matching to a specific version
+--------------------------------------------------------
//Get the object matching to the first version
Page page = (Page) ocm.getObject( "/page", "1.0");
-<a name="OCMVersionManagement-Usingversionlabels"></a>
-## Using version labels
-
+Using version labels
+--------------------
Page page = new Page();
page.setPath("/page");
@@ -91,28 +104,22 @@ version.getCreated().getTime());
ocm.checkout("/page");
ocm.update(page);
ocm.save();
- ocm.checkin("/page", new String[]
- {"A", "B"});
+ ocm.checkin("/page", new String[]{"A", "B"});
// Checkin with some labels
page.addParagraph(new Paragraph("para4"));
ocm.checkout("/page");
ocm.update(page);
ocm.save();
- ocm.checkin("/page", new String[]
- {"C", "D"});
+ ocm.checkin("/page", new String[]{"C", "D"});
// Retrieve all labels
- String[]
- allLabels = ocm.getAllVersionLabels("/page");
+ String[] allLabels = ocm.getAllVersionLabels("/page");
assertTrue("Incorrect number of labels", allLabels.length == 4);
// Retrieve labels assigned to the version 1.1
- String[]
- versionLabels = ocm.getVersionLabels("/page", "1.1");
+ String[] versionLabels = ocm.getVersionLabels("/page", "1.1");
assertTrue("Incorrect number of labels", versionLabels.length == 2);
- assertTrue("Incorrect label", versionLabels[0]
-.equals("C") || versionLabels[0].equals("D"));
- assertTrue("Incorrect label", versionLabels[1]
-.equals("C") || versionLabels[0].equals("D"));
+ assertTrue("Incorrect label", versionLabels[0].equals("C") || versionLabels[0].equals("D"));
+ assertTrue("Incorrect label", versionLabels[1].equals("C") || versionLabels[0].equals("D"));
Modified: jackrabbit/site/trunk/src/site/markdown/privacy-policy.md
URL: http://svn.apache.org/viewvc/jackrabbit/site/trunk/src/site/markdown/privacy-policy.md?rev=1671485&r1=1671484&r2=1671485&view=diff
==============================================================================
--- jackrabbit/site/trunk/src/site/markdown/privacy-policy.md (original)
+++ jackrabbit/site/trunk/src/site/markdown/privacy-policy.md Mon Apr 6 05:53:57 2015
@@ -1,4 +1,22 @@
-Title: Privacy Policy
+<!--
+ 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.
+-->
+
+Privacy Policy
+==============
Information about your use of this website is collected using server access
logs and a tracking cookie. The collected information consists of the
following:
@@ -10,8 +28,8 @@ following:
1. The addresses of pages from where you followed a link to our site.
Part of this information is gathered using a tracking cookie set by the [Google Analytics](http://www.google.com/analytics/)
- service and handled by Google as described in their [privacy policy|http://www.google.com/privacy.html]
-. See your browser documentation for instructions on how to disable the
+service and handled by Google as described in their [privacy policy](http://www.google.com/privacy.html).
+See your browser documentation for instructions on how to disable the
cookie if you prefer not to share this data with Google.
We use the gathered information to help us make our site more useful to
Modified: jackrabbit/site/trunk/src/site/markdown/repository-lifecycle.md
URL: http://svn.apache.org/viewvc/jackrabbit/site/trunk/src/site/markdown/repository-lifecycle.md?rev=1671485&r1=1671484&r2=1671485&view=diff
==============================================================================
--- jackrabbit/site/trunk/src/site/markdown/repository-lifecycle.md (original)
+++ jackrabbit/site/trunk/src/site/markdown/repository-lifecycle.md Mon Apr 6 05:53:57 2015
@@ -1,25 +1,43 @@
-Title: Repository lifecycle
+<!--
+ 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.
+-->
+
+Repository lifecycle
+====================
The lifecycle of any Jackrabbit Content Repository starts with a call to
-one of the RepositoryFactory.create() methods passing optionally the source
+one of the `RepositoryFactory.create()` methods passing optionally the source
of a repository configuration file (which by convention is called
-config.xml) and the RepositoryFactoryHome, which points to a directory from
+`config.xml`) and the `RepositoryFactoryHome`, which points to a directory from
which the Repository will continue reading further information for start-up
and in many cases will store the actual data that is persisted in the
repository and its workspaces.
-Not supplying the RepositoryFactoryHome will default to the users home dir
+Not supplying the `RepositoryFactoryHome` will default to the users home dir
from the System property user.dir.
Not supplying the configuration file parameter will default to the value of
Repository.factory.config System Property and if that is not set it will
default to the config.xml in the RepositoryFactoryHome.
-Calling the create() method will instantiate the RepositoryFactory
-singleton that will then, through the getRepository(String name) method,
+Calling the `create()` method will instantiate the `RepositoryFactory`
+singleton that will then, through the `getRepository(String name)` method,
serve as the factory for Repository instances.
-As per the config.xml a repository are started up with the respectively
-configured RepositoryStore, the RepositoryStore defines where the
+As per the `config.xml` a repository are started up with the respectively
+configured `RepositoryStore`, the `RepositoryStore` defines where the
repository stores information that is visible for the entire Repository
which includes things like the uuid of the root node, repository
properties, the namespace registry, node type definitions or the version
@@ -27,19 +45,19 @@ backing store in a file structure as fol
./meta:
- rep.properties
- rootUUID
+ rep.properties
+ rootUUID
./namespaces:
- ns_reg.properties
+ ns_reg.properties
./nodetypes:
- custom_nodetypes.xml
+ custom_nodetypes.xml
./versions:
-The RepositoryStore normally points to a regular (i.e. local) file system
+The `RepositoryStore` normally points to a regular (i.e. local) file system
but is abstracted through an abstract FileSystem that can be configured to
point to a different FileSystem implementation, in case the above
information should be stored in a different data container.
Modified: jackrabbit/site/trunk/src/site/markdown/repository-server-howto.md
URL: http://svn.apache.org/viewvc/jackrabbit/site/trunk/src/site/markdown/repository-server-howto.md?rev=1671485&r1=1671484&r2=1671485&view=diff
==============================================================================
--- jackrabbit/site/trunk/src/site/markdown/repository-server-howto.md (original)
+++ jackrabbit/site/trunk/src/site/markdown/repository-server-howto.md Mon Apr 6 05:53:57 2015
@@ -1,10 +1,28 @@
-Title: Repository Server HOWTO
+<!--
+ 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.
+-->
+
+Repository Server HOWTO
+=======================
This document describes how to use a Jackrabbit content repository in the
deployment model 3: The Repository Server. In this deployment model, a
separate repository server is running outside the virtual machine the
client application is running in. A repository server can serve multiple
applications running on separate JVMs on separate network hosts. See the [JCR client application HOWTO](jcr-client-application-howto.html)
- for instructions on how to use the configured content repository server.
+for instructions on how to use the configured content repository server.
Note that JCR specification defines no standard communication protocol for
inter-JVM repository access, and that Jackrabbit supports no such protocol
@@ -24,9 +42,8 @@ Warning: The current JCR-RMI library is
performance. You will probably experience major performance issues if you
try running any non-trivial applications on top of JCR-RMI.
-<a name="RepositoryServerHOWTO-Tomcatinstructions"></a>
-## Tomcat instructions
-
+Tomcat instructions
+-------------------
Follow the steps below to setup a model 3 JCR-RMI client deployment for
your web application in Tomcat 4.x or 5.x. Example code for both versions
of Tomcat is included after this overview.
@@ -36,17 +53,13 @@ By making similar changes (change the fa
repository) to the Model 2 HOWTO instructions, you can setup a shared
JCR-RMI client deployment for all applications in the container.
-1. Place the JCR-RMI jar file and its dependencies (including the JCR API
-jar) under _Tomcat folder_/webapps/_your app_/WEB-INF/lib.
-1. Register the JCR-RMI client repository factory in the context scope.
+1. Place the JCR-RMI jar file and its dependencies (including the JCR API jar) under `$CATALINA_HOME/webapps/_your app_/WEB-INF/lib`.
+2. Register the JCR-RMI client repository factory in the context scope.
-<a name="RepositoryServerHOWTO-Step2-Contextconfiguration"></a>
### Step 2 - Context configuration
-
-In Tomcat 4.x and 5.0, add the following snippet in server.xml under the
+In Tomcat 4.x and 5.0, add the following snippet in `server.xml` under the
Context element of your web application.
-
<Resource
name="jcr/repository"
auth="Container"
@@ -67,7 +80,6 @@ Context element of your web application.
In Tomcat 5.5, add the following snippet in your application's context.xml
file (or in the server.xml file if you prefer central configuration).
-
<Resource
name="jcr/repository"
auth="Container"
Modified: jackrabbit/site/trunk/src/site/markdown/search-implementation.md
URL: http://svn.apache.org/viewvc/jackrabbit/site/trunk/src/site/markdown/search-implementation.md?rev=1671485&r1=1671484&r2=1671485&view=diff
==============================================================================
--- jackrabbit/site/trunk/src/site/markdown/search-implementation.md (original)
+++ jackrabbit/site/trunk/src/site/markdown/search-implementation.md Mon Apr 6 05:53:57 2015
@@ -1,4 +1,22 @@
-Title: Search implementation
+<!--
+ 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.
+-->
+
+Search implementation
+=====================
Jackrabbit implements both the mandatory XPath and optional SQL query
syntax. Its design follows the goal of the JSR-170 specification that all
the mandatory query features can be expressed either in XPath or in SQL.
@@ -14,9 +32,9 @@ The major parts of the query implementat
* Query engine
* Utilities
-<a name="Searchimplementation-XPathParser"></a>
-## XPath Parser
+XPath Parser
+------------
The XPath query parser is based on the W3C XQuery grammar definition which
is not yet final but can be downloaded as draft here. The reason why
Jackrabbit uses the XQuery grammar, rather than the XPath grammar, is, that
@@ -27,65 +45,65 @@ with dummy code, to form a valid XQuery
to the XQuery parser. The actual parser is a class generated by JavaCC,
which uses the grammar that can be found in src/grammar/xpath. The parsed
XPath statement is then translated into an Abstract Query Tree. See class:
-org.apache.jackrabbit.core.query.xpath.XPathQueryBuilder
+`org.apache.jackrabbit.core.query.xpath.XPathQueryBuilder`
-<a name="Searchimplementation-SQLParser"></a>
-## SQL Parser
+SQL Parser
+----------
The SQL query parser is generated from a grammar definition located in
src/grammar/sql. After parsing, the Abstract Syntax Tree is translated into
the Jackrabbit internal Abstract Query Tree. See class:
-org.apache.jackrabbit.core.query.sql.JCRSQLQueryBuilder
+`org.apache.jackrabbit.core.query.sql.JCRSQLQueryBuilder`
-<a name="Searchimplementation-AbstractQueryTree"></a>
-## Abstract Query Tree
+Abstract Query Tree
+-------------------
The Abstract Query Tree (AQT) is the common query description format that
allows Jackrabbit to implement a query engine which is (to a certain
extent) independent of the query syntax used (XPath or SQL). The AQT
consists of the classes that are derived from:
-org.apache.jackrabbit.core.query.QueryNode
+`org.apache.jackrabbit.core.query.QueryNode`
Please note that the AQT is Jackrabbit internal and not exposed to a client
using the JCR API!
-<a name="Searchimplementation-QueryEngine"></a>
-## Query Engine
+Query Engine
+------------
Now this is where the meat is. The actual implementation of the query
engine is configurable. One needs to implement the interface:
-org.apache.jackrabbit.core.query.QueryHandler. Jackrabbit comes with an
+`org.apache.jackrabbit.core.query.QueryHandler`. Jackrabbit comes with an
implementation that uses a Lucene index:
-org.apache.jackrabbit.core.query.lucene.SearchIndex This index is
+`org.apache.jackrabbit.core.query.lucene.SearchIndex` This index is
independent of the persistence manager in use. However it is also possible
to write a QueryHandler implementation which is aware of the underlying
storage (e.g. a database) and executes the query on the 'native' storage.
-The class org.apache.core.query.lucene.LuceneQueryBuilder translates the
+The class `org.apache.core.query.lucene.LuceneQueryBuilder` translates the
Abstract Query Tree into a query that can be executed against the Lucene
index. Jackrabbit implements a couple of extensions to the standard Lucene
classes, primarily to improve performance in an environment with
incremental indexing like Jackrabbit. Instead of a single index, Jackrabbit
-uses generations of indexes to circumvent costly IndexReader / IndexWriter
-creation. See: org.apache.jackrabbit.core.query.lucene.MultiIndex. The most
+uses generations of indexes to circumvent costly `IndexReader` / `IndexWriter`
+creation. See: `org.apache.jackrabbit.core.query.lucene.MultiIndex`. The most
recent generation of the search index is held completely in memory. See:
-org.apache.jackrabbit.core.query.lucene.VolatileIndex. It is comparable
+`org.apache.jackrabbit.core.query.lucene.VolatileIndex`. It is comparable
with the garbage collection in Java, where generations are used to move
living objects from the young into the old generation over time. Queries
-are then executed on a MultiReader that spans all the indexes. Every now
-and then (depending on the configuration parameters in workspace.xml)
+are then executed on a `MultiReader` that spans all the indexes. Every now
+and then (depending on the configuration parameters in `workspace.xml`)
indexes are merged and nodes marked as deleted in the index are removed.
This happens similar to how Lucene merges its internal segments.
-<a name="Searchimplementation-Utilities"></a>
-## Utilities
-The class org.apache.jackrabbit.core.query.QueryParser allows you to
+Utilities
+---------
+The class `org.apache.jackrabbit.core.query.QueryParser` allows you to
translate a query statement into an Abstract Query Tree and vice versa.
It's a nice tool to see how a query in XPath looks like in SQL or the other
way round.
-The class org.apache.jackrabbit.core.query.PropertyTypeRegistry provides
+The class `org.apache.jackrabbit.core.query.PropertyTypeRegistry` provides
fast access to the type information based on property names. The Jackrabbit
-QueryHandler implementation uses this class to coerce value literals into
+`QueryHandler` implementation uses this class to coerce value literals into
other value types.
Modified: jackrabbit/site/trunk/src/site/markdown/shared-j2ee-resource-howto.md
URL: http://svn.apache.org/viewvc/jackrabbit/site/trunk/src/site/markdown/shared-j2ee-resource-howto.md?rev=1671485&r1=1671484&r2=1671485&view=diff
==============================================================================
--- jackrabbit/site/trunk/src/site/markdown/shared-j2ee-resource-howto.md (original)
+++ jackrabbit/site/trunk/src/site/markdown/shared-j2ee-resource-howto.md Mon Apr 6 05:53:57 2015
@@ -1,28 +1,43 @@
-Title: Shared J2EE Resource HOWTO
+<!--
+ 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.
+-->
+
+Shared J2EE Resource HOWTO
+==========================
This document describes how to use a Jackrabbit content repository in the
deployment model 2: Shared J2EE Resource. In this deployment model, a
central content repository resource managed by an application server is
used by multiple different applications. See the [JCR client application HOWTO](jcr-client-application-howto.html)
- for instructions on how to use the configured content repository.
+for instructions on how to use the configured content repository.
This how-to contains instructions for Tomcat versions 4.x and 5.x. It
should be easy to modify the instructions for other container environments.
-<a name="SharedJ2EEResourceHOWTO-Tomcatinstructions"></a>
-## Tomcat instructions
+Tomcat instructions
+-------------------
Follow the steps below to setup a model 2 Jackrabbit deployment for your
Tomcat 4.x or 5.x installation. Example code for both versions of Tomcat is
included after this overview.
-1. Place the Jackrabbit jar file and all the dependencies (including the JCR
-API jar file) under _Tomcat folder_/common/lib.
-1. Register the bindable repository factory as a global resource.
-1. Link the global resource to a context scoped JNDI address.
+1. Place the Jackrabbit jar file and all the dependencies (including the JCR API jar file) under `$CATALINA_HOME/common/lib`.
+2. Register the bindable repository factory as a global resource.
+3. Link the global resource to a context scoped JNDI address.
-<a name="SharedJ2EEResourceHOWTO-Step2-Resourceconfiguration"></a>
### Step 2 - Resource configuration
-
Note: This step is essentially the same as step 2 in the Model 1 HOWTO. The
only differences are in the (arbitrary) naming of the resource and placing
of the configuration elements. The difference in the end result is that the
@@ -30,7 +45,6 @@ configured repository is bound to the gl
local one. In Tomcat 4.x and 5.0, add the following snippet in server.xml
under the GlobalNamingResources element.
-
<Resource name="jcr/globalRepository"
auth="Container"
type="javax.jcr.Repository"/>
@@ -54,26 +68,22 @@ under the GlobalNamingResources element.
In Tomcat 5.5, add the following snippet in server.xml under the
GlobalNamingResources element.
-
<Resource name="jcr/globalRepository"
auth="Container"
type="javax.jcr.Repository"
factory="org.apache.jackrabbit.core.jndi.BindableRepositoryFactory"
configFilePath="[full path to repository.xml"
- repHomeDir="[full path to the repository home folder]
- "/>
+ repHomeDir="[full path to the repository home folder]"
+ />
-<a name="SharedJ2EEResourceHOWTO-Step3-Resourcelink"></a>
### Step 3 - Resource link
-
In Tomcat versions 4.x and 5.0, add the following snippet in server.xml
under the Context element of your web application. In Tomcat version 5.5,
add the snippet in your application's context.xml or
-$CATALINA_HOME/conf/_enginename_/_hostname_/_webappname_.xml. If you prefer
+`$CATALINA_HOME/conf/_enginename_/_hostname_/_webappname_.xml`. If you prefer
central configuration, you can add the configuration to
-$CATALINA_HOME/conf/context.xml.
-
+`$CATALINA_HOME/conf/context.xml`.
<ResourceLink
name="jcr/repository"
Modified: jackrabbit/site/trunk/src/site/markdown/source-repository.md
URL: http://svn.apache.org/viewvc/jackrabbit/site/trunk/src/site/markdown/source-repository.md?rev=1671485&r1=1671484&r2=1671485&view=diff
==============================================================================
--- jackrabbit/site/trunk/src/site/markdown/source-repository.md (original)
+++ jackrabbit/site/trunk/src/site/markdown/source-repository.md Mon Apr 6 05:53:57 2015
@@ -1,10 +1,28 @@
-Title: Source Repository
+<!--
+ 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.
+-->
+
+Source Repository
+=================
Apache Jackrabbit uses [Subversion](http://subversion.tigris.org/)
- to manage source code. See the [Subversion book|http://svnbook.red-bean.com/]
- and the Apache [instructions|http://www.apache.org/dev/version-control.html]
- for using Subversion.
+to manage source code. See the [Subversion book](http://svnbook.red-bean.com/)
+and the Apache [instructions](http://www.apache.org/dev/version-control.html)
+for using Subversion.
The Jackrabbit source code is available at
http://svn.apache.org/repos/asf/jackrabbit/ and can also be browsed using
-the [ViewVC](http://viewvc.tigris.org/)
- interface at http://svn.apache.org/viewvc/jackrabbit/.
+the [ViewVC]((http://viewvc.tigris.org/)
+interface at http://svn.apache.org/viewvc/jackrabbit/.
Copied: jackrabbit/site/trunk/src/site/markdown/status/apache-jackrabbit-resolution.md (from r1670829, jackrabbit/site/trunk/src/site/markdown/apache-jackrabbit-resolution.md)
URL: http://svn.apache.org/viewvc/jackrabbit/site/trunk/src/site/markdown/status/apache-jackrabbit-resolution.md?p2=jackrabbit/site/trunk/src/site/markdown/status/apache-jackrabbit-resolution.md&p1=jackrabbit/site/trunk/src/site/markdown/apache-jackrabbit-resolution.md&r1=1670829&r2=1671485&rev=1671485&view=diff
==============================================================================
--- jackrabbit/site/trunk/src/site/markdown/apache-jackrabbit-resolution.md (original)
+++ jackrabbit/site/trunk/src/site/markdown/status/apache-jackrabbit-resolution.md Mon Apr 6 05:53:57 2015
@@ -1,6 +1,23 @@
-Title: Apache Jackrabbit Resolution
-From the [minutes](http://www.apache.org/foundation/records/minutes/2006/board_minutes_2006_03_15.txt)
- of the Apache board meeting on March 15th, 2006:
+<!--
+ 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.
+-->
+
+Apache Jackrabbit Resolution
+============================
+From the [minutes](http://www.apache.org/foundation/records/minutes/2006/board_minutes_2006_03_15.txt) of the Apache board meeting on March 15th, 2006:
6. Special Orders
Modified: jackrabbit/site/trunk/src/site/markdown/supporting-software-attribution.md
URL: http://svn.apache.org/viewvc/jackrabbit/site/trunk/src/site/markdown/supporting-software-attribution.md?rev=1671485&r1=1671484&r2=1671485&view=diff
==============================================================================
--- jackrabbit/site/trunk/src/site/markdown/supporting-software-attribution.md (original)
+++ jackrabbit/site/trunk/src/site/markdown/supporting-software-attribution.md Mon Apr 6 05:53:57 2015
@@ -1,5 +1,22 @@
-Title: Supporting software attribution
-Developers use various tools to assist with their work, such as [IntelliJ IDEA](http://www.jetbrains.com/idea/opensource/)
- or [Eclipse|http://www.eclipse.org/]
-. Most tools do not require attribution, but some do ([YourKit Java
-Profiler|http://www.yourkit.com/]).
+<!--
+ 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.
+-->
+
+Supporting software attribution
+===============================
+Developers use various tools to assist with their work,
+such as [IntelliJ IDEA](http://www.jetbrains.com/idea/opensource/) or [Eclipse](http://www.eclipse.org/).
+Most tools do not require attribution, but some do ([YourKit Java Profiler](http://www.yourkit.com/)).
Modified: jackrabbit/site/trunk/src/site/markdown/website.md
URL: http://svn.apache.org/viewvc/jackrabbit/site/trunk/src/site/markdown/website.md?rev=1671485&r1=1671484&r2=1671485&view=diff
==============================================================================
--- jackrabbit/site/trunk/src/site/markdown/website.md (original)
+++ jackrabbit/site/trunk/src/site/markdown/website.md Mon Apr 6 05:53:57 2015
@@ -1,23 +1,30 @@
-Title: Website
+<!--
+ 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.
+-->
+
+Website
+=======
+TODO: Explain new pubsub mechanism
+
+
The [Apache Jackrabbit website](http://jackrabbit.apache.org/)
- is managed using the [JCR space|http://cwiki.apache.org/confluence/display/JCR]
- in the [Confluence wiki|http://cwiki.apache.org/CWIKI/]
- at Apache.
-
-Only [Jackrabbit committers](jackrabbit-team.html)
- are allowed to modify the site content. To edit the site content you need
-to register for a Confluence account and ask one of the Confluence admins
-(currently Jukka and Felix) to add you to the Jackrabbit group.
-
-The contents of the wiki are automatically exported and synchronized to the
-public web server every few hours. The auto-export configuration (including
-the site template) is available in the "Administration" section of
-Confluence. See the [CWIKI page](http://cwiki.apache.org/CWIKI/)
- for more details about the auto-export process.
-
-In addition to the wiki pages and their attachments the Jackrabbit site
-also contains static content like API documentation and stylesheets. This
-content is managed using the [site tree](https://svn.apache.org/repos/asf/jackrabbit/site/)
- in Subversion. The static site content is automatically updated along with
-the auto-exported wiki content.
+is managed using svnpubsub.
+
+Only [Jackrabbit committers](jackrabbit-team.html) are allowed to modify the site content.
+
+This content is managed using the [site tree](https://svn.apache.org/repos/asf/jackrabbit/site/)
+in Subversion.