Author: dkatayev Date: 2010-08-04 08:10:15 -0400 (Wed, 04 Aug 2010) New Revision: 2872 Removed: jcr/branches/1.12.x/docs/reference/en/src/main/docbook/en-US/modules/jcr/architecture.xml Modified: jcr/branches/1.12.x/docs/reference/en/src/main/docbook/en-US/modules/jcr.xml jcr/branches/1.12.x/docs/reference/en/src/main/docbook/en-US/modules/jcr/concepts/jcr-advantages.xml jcr/branches/1.12.x/docs/reference/en/src/main/docbook/en-US/modules/jcr/concepts/jcr-compatibility-levels.xml jcr/branches/1.12.x/docs/reference/en/src/main/docbook/en-US/modules/jcr/concepts/jcr-extensions.xml jcr/branches/1.12.x/docs/reference/en/src/main/docbook/en-US/modules/jcr/concepts/jcr-usage.xml jcr/branches/1.12.x/docs/reference/en/src/main/docbook/en-US/modules/jcr/concepts/why-jcr.xml jcr/branches/1.12.x/docs/reference/en/src/main/docbook/en-US/modules/jcr/intro.xml Log: EXOJCR-869 documentation updated Deleted: jcr/branches/1.12.x/docs/reference/en/src/main/docbook/en-US/modules/jcr/architecture.xml =================================================================== --- jcr/branches/1.12.x/docs/reference/en/src/main/docbook/en-US/modules/jcr/architecture.xml 2010-08-04 10:49:39 UTC (rev 2871) +++ jcr/branches/1.12.x/docs/reference/en/src/main/docbook/en-US/modules/jcr/architecture.xml 2010-08-04 12:10:15 UTC (rev 2872) @@ -1,14 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" -"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> -<chapter id="architecture" xreflabel="architectural"> - <?dbhtml filename="ch-architecture.html"?> - <chapterinfo> - <keywordset> - <keyword>JCR</keyword> - <keyword>eXoJCR</keyword> - <keyword>etc</keyword> - </keywordset> - </chapterinfo> - <title>Basic concepts of eXoJCR</title> -</chapter> Modified: jcr/branches/1.12.x/docs/reference/en/src/main/docbook/en-US/modules/jcr/concepts/jcr-advantages.xml =================================================================== --- jcr/branches/1.12.x/docs/reference/en/src/main/docbook/en-US/modules/jcr/concepts/jcr-advantages.xml 2010-08-04 10:49:39 UTC (rev 2871) +++ jcr/branches/1.12.x/docs/reference/en/src/main/docbook/en-US/modules/jcr/concepts/jcr-advantages.xml 2010-08-04 12:10:15 UTC (rev 2872) @@ -3,26 +3,35 @@ "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <chapter id="JCR.AdvantagesOfeXoJCR"> <?dbhtml filename="ch-jcr-advantages.html"?> + <title>Advantages of eXo JCR</title> <section> <title>Advantages for application developers:</title> - <para>* Data repository and application are isolated from each other so an - application developer should not learn the details of particular data - storage's interfaces and can concentrate on business logic of a particular - application built on top of JCR</para> + <itemizedlist> + <listitem> + <para>Data repository and application are isolated from each other so + an application developer should not learn the details of particular + data storage's interfaces and can concentrate on business logic of a + particular application built on top of JCR.</para> + </listitem> - <para>* Repositories can be simply exchanged between different - applications without changing the applications themselves. This is the - matter of the repository configuration</para> + <listitem> + <para>Repositories can be simply exchanged between different + applications without changing the applications themselves. This is the + matter of the repository configuration.</para> + </listitem> - <para>* Data storage types/versions can be changed and moreover different - types of data storages can be combined in one repository data model (of - course the complexity and work of building interfaces between the - repository and its data storage don't disappear but these changes are - isolated in the repository and thus manageable from the point of view of - the customer)</para> + <listitem> + <para>Data storage types/versions can be changed and moreover + different types of data storages can be combined in one repository + data model (of course the complexity and work of building interfaces + between the repository and its data storage don't disappear but these + changes are isolated in the repository and thus manageable from the + point of view of the customer).</para> + </listitem> + </itemizedlist> <mediaobject> <imageobject> @@ -34,19 +43,31 @@ <section> <title>Advantages for managers</title> - <para>* Using a standardized repository for content management reduces the - risk of being dependent on a particular software vendor and proprietary - API.</para> + <itemizedlist> + <listitem> + <para>Using a standardized repository for content management reduces + the risk of being dependent on a particular software vendor and + proprietary API.</para> + </listitem> + </itemizedlist> - <para>* Costs for maintaining and developing a content repository based - custom application is significantly lower than developing and supporting - your own interfaces and maintaining your own data repository applications - (staff can be trained once, it is possible to take help from community and - third party consulters).</para> + <itemizedlist> + <listitem> + <para>Costs for maintaining and developing a content repository based + custom application is significantly lower than developing and + supporting your own interfaces and maintaining your own data + repository applications (staff can be trained once, it is possible to + take help from community and third party consulters).</para> + </listitem> + </itemizedlist> - <para>* Thanks to flexible layered JCR API (see below) it is possible to - fit the legacy storage subsystem into new interfaces and again decrease - the costs and risk of losing data.</para> + <itemizedlist> + <listitem> + <para>Thanks to flexible layered JCR API (see below) it is possible to + fit the legacy storage subsystem into new interfaces and again + decrease the costs and risk of losing data.</para> + </listitem> + </itemizedlist> <para>An extension to the API exists as we can see in the following layer schema.</para> Modified: jcr/branches/1.12.x/docs/reference/en/src/main/docbook/en-US/modules/jcr/concepts/jcr-compatibility-levels.xml =================================================================== --- jcr/branches/1.12.x/docs/reference/en/src/main/docbook/en-US/modules/jcr/concepts/jcr-compatibility-levels.xml 2010-08-04 10:49:39 UTC (rev 2871) +++ jcr/branches/1.12.x/docs/reference/en/src/main/docbook/en-US/modules/jcr/concepts/jcr-compatibility-levels.xml 2010-08-04 12:10:15 UTC (rev 2872) @@ -3,6 +3,7 @@ "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <chapter id="JCR.CompatibilityLevels"> <?dbhtml filename="ch-jcr-compatibility-levels.html"?> + <title>Compatibility Levels</title> <section> @@ -28,49 +29,66 @@ <para>Level 1 features:</para> - <para>* Initiating a session calling login method with the name of desired - workspace and client credentials. Involves some security mechanisms (JAAS) - to authenticate the client and in case the client is authorized to use the - data from a particular workspace, he retrieves the session with a - workspace tied to it.</para> + <itemizedlist> + <listitem> + <para>Initiating a session calling login method with the name of + desired workspace and client credentials. Involves some security + mechanisms (JAAS) to authenticate the client and in case the client is + authorized to use the data from a particular workspace, he retrieves + the session with a workspace tied to it.</para> + </listitem> - <para>* Using the obtained session the client can retrieve data (items) - using: traversing the tree, directly accessing a particular item - (requesting path or UUID) or traversing the query result. So an - application developer can choose the "best" form depending on the content - structure and desired operation.</para> + <listitem> + <para>Using the obtained session the client can retrieve data (items) + using: traversing the tree, directly accessing a particular item + (requesting path or UUID) or traversing the query result. So an + application developer can choose the "best" form depending on the + content structure and desired operation.</para> + </listitem> - <para>* Reading property values. All content of a repository is ultimately - accessed through properties and stored in property values of predefined - types (Boolean, Binary Data, Double, Long, String) and special types Name, - Reference, and Path. It is possible to read property value without knowing - its real name as a primary item.</para> + <listitem> + <para>Reading property values. All content of a repository is + ultimately accessed through properties and stored in property values + of predefined types (Boolean, Binary Data, Double, Long, String) and + special types Name, Reference, and Path. It is possible to read + property value without knowing its real name as a primary item.</para> + </listitem> - <para>* Export to XML. Repository supports two XML/JCR data model - mappings: system and doc view. The ~~system view~~ provides complete XML - serialization without loss of information and is somewhat difficult for a - human to read. In contrast, the ~~document view~~ is well readable but - does not completely reflect the state of repository, it is used for Xpath - queries.</para> + <listitem> + <para>Export to XML. Repository supports two XML/JCR data model + mappings: system and doc view. The system view provides complete XML + serialization without loss of information and is somewhat difficult + for a human to read. In contrast, the document view is well readable + but does not completely reflect the state of repository, it is used + for Xpath queries.</para> + </listitem> - <para>* Query facility with Xpath syntax. Xpath, originally developed for - XML, suits the JCR data model as well because the JCR data model is very - close to XML's one. It is applied to JCR as it would be applied to the - document view of the serialized repository content, returning a table of - property names and content matching the query.</para> + <listitem> + <para>Query facility with Xpath syntax. Xpath, originally developed + for XML, suits the JCR data model as well because the JCR data model + is very close to XML's one. It is applied to JCR as it would be + applied to the document view of the serialized repository content, + returning a table of property names and content matching the + query.</para> + </listitem> - <para>* Discovery of available node types. Every node should have only one - ~~primary node~~ type that defines names, types and other characteristics - of child nodes and properties. It also can have one or more mixin data - types that defines additional characteristics. Level 1 provides methods - for discovering available in repository node types and node types of a - concrete node.</para> + <listitem> + <para>Discovery of available node types. Every node should have only + one primary node type that defines names, types and other + characteristics of child nodes and properties. It also can have one or + more mixin data types that defines additional characteristics. Level 1 + provides methods for discovering available in repository node types + and node types of a concrete node.</para> + </listitem> - <para>* Transient namespace remapping. Item name can have prefix delimited - by a single colon ":" character indicating the namespace of this name. It - is patterned after XML namespaces, prefix is mapped to URI to minimize - names collisions. In Level 1 a prefix can be temporary overridden by - another prefix in the scope of a session.</para> + <listitem> + <para>ransient namespace remapping. Item name can have prefix + delimited by a single colon ":" character indicating the namespace of + this name. It is patterned after XML namespaces, prefix is mapped to + URI to minimize names collisions. In Level 1 a prefix can be temporary + overridden by another prefix in the scope of a session.</para> + </listitem> + </itemizedlist> <mediaobject> <imageobject> @@ -89,28 +107,40 @@ <para>In addition to the Level 1 it must support the following major features:</para> - <para>* Adding, moving, copying and removing items inside workspace and - moving, copying and cloning items between workspaces. The client can also - compare the persisted state of an item with its unsaved states and either - save the new state or discard it.</para> + <itemizedlist> + <listitem> + <para>Adding, moving, copying and removing items inside workspace and + moving, copying and cloning items between workspaces. The client can + also compare the persisted state of an item with its unsaved states + and either save the new state or discard it.</para> + </listitem> - <para>* Modifying and writing value of properties. Property types are - checked and can be converted to the defined format.</para> + <listitem> + <para>Modifying and writing value of properties. Property types are + checked and can be converted to the defined format.</para> + </listitem> - <para>* Import from XML document into the repository as a tree of nodes - and properties. If the XML document is an export of JCR system view the - content of repository can be completely restored. If this is not the case, - the document is interpreted as a document view and the import procedure - builds a tree of JCR nodes and properties that matches the tree structure - of the XML document.</para> + <listitem> + <para>Import from XML document into the repository as a tree of nodes + and properties. If the XML document is an export of JCR system view + the content of repository can be completely restored. If this is not + the case, the document is interpreted as a document view and the + import procedure builds a tree of JCR nodes and properties that + matches the tree structure of the XML document.</para> + </listitem> - <para>* Assigning node types to nodes. The primary node type is assigned - when adding a node. This can be done automatically based on the parent - node type definition and mixin node types.</para> + <listitem> + <para>Assigning node types to nodes. The primary node type is assigned + when adding a node. This can be done automatically based on the parent + node type definition and mixin node types.</para> + </listitem> - <para>* Persistent namespaces changes. Add, change and remove namespaces - stored in the namespace registry, excluding built-in namespaces required - by JCR.</para> + <listitem> + <para>Persistent namespaces changes. Add, change and remove namespaces + stored in the namespace registry, excluding built-in namespaces + required by JCR.</para> + </listitem> + </itemizedlist> <mediaobject> <imageobject> @@ -120,7 +150,7 @@ </section> <section> - <title>1 Optional features</title> + <title>Optional features</title> <para>On top of Level 1 or Level 2 a number of optional features are defined for a more advanced repository functionality. This includes Modified: jcr/branches/1.12.x/docs/reference/en/src/main/docbook/en-US/modules/jcr/concepts/jcr-extensions.xml =================================================================== --- jcr/branches/1.12.x/docs/reference/en/src/main/docbook/en-US/modules/jcr/concepts/jcr-extensions.xml 2010-08-04 10:49:39 UTC (rev 2871) +++ jcr/branches/1.12.x/docs/reference/en/src/main/docbook/en-US/modules/jcr/concepts/jcr-extensions.xml 2010-08-04 12:10:15 UTC (rev 2872) @@ -3,6 +3,7 @@ "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <chapter id="JCR.Extensions"> <?dbhtml filename="ch-jcr-extensions.html"?> + <title>JCR Extensions</title> <section> @@ -158,18 +159,15 @@ <section> <title>Related Pages</title> - <para>Access Control extension</para> + <para><link linkend="JCR.AccessControlExtension">Access Control + extension</link></para> - <para>Auditing Backup service CIFS(SMB)</para> + <para><link linkend="JCR.Organizationservice">Organization + Service</link></para> - <para>Clustering Groovy REST Services </para> + <para><link linkend="JCR.RegistryService">Registry Service</link></para> - <para>Metadata Extensions </para> - - <para>Organization Service </para> - - <para>Registry Service </para> - - <para>REST Groovy services</para> + <para><link linkend="JCR.RESTServicesOnGroovy">REST Groovy + services</link></para> </section> </chapter> Modified: jcr/branches/1.12.x/docs/reference/en/src/main/docbook/en-US/modules/jcr/concepts/jcr-usage.xml =================================================================== --- jcr/branches/1.12.x/docs/reference/en/src/main/docbook/en-US/modules/jcr/concepts/jcr-usage.xml 2010-08-04 10:49:39 UTC (rev 2871) +++ jcr/branches/1.12.x/docs/reference/en/src/main/docbook/en-US/modules/jcr/concepts/jcr-usage.xml 2010-08-04 12:10:15 UTC (rev 2872) @@ -3,6 +3,7 @@ "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <chapter id="JCR.UsingJCR"> <?dbhtml filename="ch-jcr-usage.html"?> + <title>Using JCR</title> <section> @@ -31,9 +32,8 @@ Repository repository = repositoryService.getCurrentRepository();</programlisting> <para>* Using JNDI as specified in JSR-170. This way you have to - configure the reference (see eXo <ulink - url="JNDI Naming configuration&gt;Core.JNDI Naming">JNDI Naming - configuration&gt;Core.JNDI Naming</ulink> )</para> + configure the reference (see eXo <link linkend="Kernel.JNDINaming"> JNDI + Naming configuration </link> )</para> <programlisting> Context ctx = new InitialContext(); Repository repository =(Repository) ctx.lookup("repositoryName");</programlisting> Modified: jcr/branches/1.12.x/docs/reference/en/src/main/docbook/en-US/modules/jcr/concepts/why-jcr.xml =================================================================== --- jcr/branches/1.12.x/docs/reference/en/src/main/docbook/en-US/modules/jcr/concepts/why-jcr.xml 2010-08-04 10:49:39 UTC (rev 2871) +++ jcr/branches/1.12.x/docs/reference/en/src/main/docbook/en-US/modules/jcr/concepts/why-jcr.xml 2010-08-04 12:10:15 UTC (rev 2872) @@ -3,6 +3,7 @@ "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <chapter id="JCR.WhyuseJCR"> <?dbhtml filename="ch-why-jcr.html"?> + <title>Why use JCR?</title> <section> @@ -79,23 +80,21 @@ <para>In order to understand the theory of JCR and the API please read some external documents about this standard:</para> - <para>* Tom Wheeler, <ulink - url="http://www.tomwheeler.com/java_content_repository_tomwheeler_20... - Java Content Repository</ulink> (2007)</para> + <itemizedlist> + <listitem> + <para>Roy T. Fielding, <ulink + url="http://www.day.com/content/dam/day/whitepapers/JSR_170_White_Pa... + 170 Overview: Standardizing the Content Repository Interface</ulink> + (March 13, 2005)</para> + </listitem> - <para>* Roy T. Fielding, <ulink - url="http://www.day.com/content/dam/day/whitepapers/JSR_170_White_Pa... - 170 Overview: Standardizing the Content Repository Interface</ulink> - (March 13, 2005)</para> - - <para>* David Nuescheler and Janus Boye, <ulink - url="http://www.cmswatch.com/Feature/123">JSR-170 What's in it for - me?</ulink> (April 20, 2005)</para> - - <para>* Benjamin Mestrallet, Tuan Nguyen, Gennady Azarenkov, Francois - Moron and Brice Revenant <ulink - url="http://www.theserverside.com/tt/articles/article.tss?l=eXoPlatf... - Platform v2, Portal, JCR, ECM, Groupware and Business - Intelligence.</ulink> (January 2006)</para> + <listitem> + <para>Benjamin Mestrallet, Tuan Nguyen, Gennady Azarenkov, Francois + Moron and Brice Revenant <ulink + url="http://www.theserverside.com/tt/articles/article.tss?l=eXoPlatf... + Platform v2, Portal, JCR, ECM, Groupware and Business + Intelligence.</ulink> (January 2006)</para> + </listitem> + </itemizedlist> </section> </chapter> Modified: jcr/branches/1.12.x/docs/reference/en/src/main/docbook/en-US/modules/jcr/intro.xml =================================================================== --- jcr/branches/1.12.x/docs/reference/en/src/main/docbook/en-US/modules/jcr/intro.xml 2010-08-04 10:49:39 UTC (rev 2871) +++ jcr/branches/1.12.x/docs/reference/en/src/main/docbook/en-US/modules/jcr/intro.xml 2010-08-04 12:10:15 UTC (rev 2872) @@ -1,70 +1,71 @@ -<?xml version="1.0" encoding="UTF-8"?> -<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" -"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> -<chapter id = "JCR.Introduction"> - <?dbhtml filename="ch-intro.html"?> - - <title>Introduction in eXoJCR</title> - - <section> - <title>JCR (JSR-170) API main concepts</title> - - <para>Java Content Repository API as well as other Java language related - standards is created within the Java Community Process http://jcp.org/ as - a result of collaboration of an expert group and the Java community and - known as JSR-170 (Java Specification Request) - http://www.jcp.org/en/jsr/detail?id=170.</para> - - <section> - <title>Data model</title> - - <para>As the main purpose of content repository is to maintain the data - - the heart of CR is the data model:</para> - - <para><itemizedlist> - <listitem> - <para>The main data storage abstraction of JCR's data model is a - workspace</para> - </listitem> - - <listitem> - <para>Each repository should have one or more workspaces</para> - </listitem> - - <listitem> - <para>The content is stored in a workspace as a hierarchy of - items</para> - </listitem> - - <listitem> - <para>Each workspace has its own hierarchy of items</para> - </listitem> - </itemizedlist></para> - - <figure> - <title>Item hierarchy</title> - - <mediaobject> - <imageobject> - <imagedata fileref="images/item-hierarchy.gif" /> - </imageobject> - </mediaobject> - </figure> - - <para>Node is intended to support the data hierarchy. They are typed - using namespaced names which allows the content to be structured - according to standardized constraints. A node may be versioned through - an associated version graph (optional feature)</para> - - <para>Property stored data are values of predefined types (String, - Binary, Long, Boolean, Double, Date, Reference, Path).</para> - - <para>It is important to note that the data model for the interface (the - repository model) is rarely the same as the data models used by the - repository's underlying storage subsystems. The repository knows how to - make the client's changes persistent because that is part of the - repository configuration, rather than part of the application - programming task.</para> - </section> - </section> -</chapter> +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" +"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> +<chapter id="JCR.Introduction"> + <?dbhtml filename="ch-intro.html"?> + + <title>Introduction in eXoJCR</title> + + <section> + <title>JCR (JSR-170) API main concepts</title> + + <para>Java Content Repository API as well as other Java language related + standards is created within the Java Community Process http://jcp.org/ as + a result of collaboration of an expert group and the Java community and + known as <ulink + url="http://www.jcp.org/en/jsr/detail?id=170">JSR-170</ul... (Java + Specification Request).</para> + + <section> + <title>Data model</title> + + <para>As the main purpose of content repository is to maintain the data + - the heart of CR is the data model:</para> + + <para><itemizedlist> + <listitem> + <para>The main data storage abstraction of JCR's data model is a + workspace</para> + </listitem> + + <listitem> + <para>Each repository should have one or more workspaces</para> + </listitem> + + <listitem> + <para>The content is stored in a workspace as a hierarchy of + items</para> + </listitem> + + <listitem> + <para>Each workspace has its own hierarchy of items</para> + </listitem> + </itemizedlist></para> + + <figure> + <title>Item hierarchy</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/item-hierarchy.gif" /> + </imageobject> + </mediaobject> + </figure> + + <para>Node is intended to support the data hierarchy. They are typed + using namespaced names which allows the content to be structured + according to standardized constraints. A node may be versioned through + an associated version graph (optional feature)</para> + + <para>Property stored data are values of predefined types (String, + Binary, Long, Boolean, Double, Date, Reference, Path).</para> + + <para>It is important to note that the data model for the interface (the + repository model) is rarely the same as the data models used by the + repository's underlying storage subsystems. The repository knows how to + make the client's changes persistent because that is part of the + repository configuration, rather than part of the application + programming task.</para> + </section> + </section> +</chapter> Modified: jcr/branches/1.12.x/docs/reference/en/src/main/docbook/en-US/modules/jcr.xml =================================================================== --- jcr/branches/1.12.x/docs/reference/en/src/main/docbook/en-US/modules/jcr.xml 2010-08-04 10:49:39 UTC (rev 2871) +++ jcr/branches/1.12.x/docs/reference/en/src/main/docbook/en-US/modules/jcr.xml 2010-08-04 12:10:15 UTC (rev 2872) @@ -9,9 +9,6 @@ <xi:include href="jcr/intro.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="jcr/architecture.xml" - xmlns:xi="http://www.w3.org/2001/XInclude" /> - <!-- concepts --> <xi:include href="jcr/concepts/why-jcr.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />