[exo-jcr-commits] exo-jcr SVN: r5810 - in jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules: core and 10 other directories.
do-not-reply at jboss.org
do-not-reply at jboss.org
Tue Mar 6 04:57:24 EST 2012
Author: dkuleshov
Date: 2012-03-06 04:57:22 -0500 (Tue, 06 Mar 2012)
New Revision: 5810
Modified:
jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/core.xml
jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/core/core.xml
jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/core/db-creator-service.xml
jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/core/digest-auth.xml
jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/core/ldap-configuration.xml
jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/core/organization-service-listener.xml
jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/core/organization-service-tck-tests-config.xml
jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/core/organization-service.xml
jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/core/security-service.xml
jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/core/spring-security-integration.xml
jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/core/tika-document-reader-service.xml
jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/faq.xml
jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr-with-gtn/how-to-extend-my-gatein-instance.xml
jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr-with-gtn/managed-datasources-under-jboss-as.xml
jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr.xml
jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/api-extensions.xml
jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/backup/backup-client.xml
jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/backup/use-external-backup-tool.xml
jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/cluster-config.xml
jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/concepts/jcr-advantages.xml
jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/concepts/jcr-compatibility-levels.xml
jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/concepts/jcr-exo-implementation.xml
jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/concepts/jcr-extensions.xml
jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/concepts/jcr-usage.xml
jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/concepts/nodetype-registration.xml
jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/concepts/nodetypes-and-namespaces.xml
jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/configuration/configuration-persister.xml
jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/configuration/exo-jcr-configuration.xml
jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/configuration/external-value-storages.xml
jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/configuration/jdbc-data-container-config.xml
jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/configuration/multi-db-schema-support.xml
jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/configuration/multilanguage-support.xml
jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/configuration/rest-services-on-groovy.xml
jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/configuration/search-configuration.xml
jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/data-container-howto.xml
jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/data-container.xml
jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/db-cleaner-service.xml
jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/intro.xml
jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/jbosscache-configuration-templates.xml
jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/jbossts-transaction-service.xml
jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/jca.xml
jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/lock-manager-config.xml
jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/other/acl-ext.xml
jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/other/binary-values-processing.xml
jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/performance-tuning-guide.xml
jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/protocols/ftp.xml
jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/protocols/webdav.xml
jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/query-handler-config.xml
jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/repository-check-controller.xml
jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/repository-creation-service.xml
jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/searching/fulltext-search-and-settings.xml
jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/searching/jcr-query-usecases.xml
jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/searching/searching-repository-content.xml
jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/statistics.xml
jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/transaction-manager-lookup.xml
jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/kernel.xml
jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/kernel/cache.xml
jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/kernel/container-configuration.xml
jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/kernel/data-source-provider.xml
jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/kernel/inversion-of-control.xml
jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/kernel/jndi-naming.xml
jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/kernel/job-scheduler-service.xml
jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/kernel/kernel.xml
jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/kernel/listener-service.xml
jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/kernel/logging.xml
jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/kernel/manageability.xml
jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/kernel/rpc-service.xml
jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/kernel/service-configuration-for-beginners.xml
jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/kernel/service-configuration-in-detail.xml
jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/kernel/services-wiring.xml
jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/kernel/transaction-service.xml
jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/kernel/understanding-listnerservice.xml
jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/ws.xml
jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/ws/framework-for-cross-domain-ajax.xml
jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/ws/groovy-scripts-as-rest-services.xml
jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/ws/introduction-to-rest.xml
jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/ws/overwrite-default-providers.xml
jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/ws/restservicelist-service.xml
jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/ws/ws.xml
Log:
EXOJCR-1782: some ref guide fixes and minor rearrangement
Modified: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/core/core.xml
===================================================================
--- jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/core/core.xml 2012-03-06 08:54:13 UTC (rev 5809)
+++ jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/core/core.xml 2012-03-06 09:57:22 UTC (rev 5810)
@@ -1,18 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
-"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
-<chapter id="Core">
- <?dbhtml filename="ch-core.html"?>
-
- <title>eXo Core</title>
-
- <section>
- <title>eXo Core introduction</title>
-
- <para>The eXo Core is a set of common services that are used by eXo
- products and modules, it also can be used in the business logic.</para>
-
- <para>It's Authentication and Security, Organization, Database, Logging,
- JNDI, LDAP, Document reader and other services.</para>
- </section>
-</chapter>
Modified: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/core/db-creator-service.xml
===================================================================
--- jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/core/db-creator-service.xml 2012-03-06 08:54:13 UTC (rev 5809)
+++ jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/core/db-creator-service.xml 2012-03-06 09:57:22 UTC (rev 5810)
@@ -6,9 +6,6 @@
<title>Database Creator</title>
- <section>
- <title>About</title>
-
<para>Database creator<envar> DBCreator</envar> is responsible for
execution DDL script in runtime. A DDL script may contain templates for
database name, user name and password which will be replaced by real
@@ -29,7 +26,6 @@
<para><envar>${password}</envar> for user's password;</para>
</listitem>
</itemizedlist>
- </section>
<section>
<title>API</title>
Modified: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/core/digest-auth.xml
===================================================================
--- jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/core/digest-auth.xml 2012-03-06 08:54:13 UTC (rev 5809)
+++ jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/core/digest-auth.xml 2012-03-06 09:57:22 UTC (rev 5810)
@@ -4,9 +4,6 @@
<chapter>
<title>Digest Authentication</title>
- <section>
- <title>Overview</title>
-
<para>Digest access authentication is one of the agreed methods a web
server can use to negotiate credentials with a web user's browser. It uses
encryption to send the password over the network which is safer than the
@@ -15,7 +12,6 @@
<para>Technically digest authentication is an application of MD5
cryptographic hashing with usage of nonce values to discourage
cryptanalysis. It uses the HTTP protocol.</para>
- </section>
<section>
<title>Server configuration</title>
Modified: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/core/ldap-configuration.xml
===================================================================
--- jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/core/ldap-configuration.xml 2012-03-06 08:54:13 UTC (rev 5809)
+++ jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/core/ldap-configuration.xml 2012-03-06 09:57:22 UTC (rev 5810)
@@ -6,16 +6,12 @@
<title>LDAP Configuration</title>
- <section>
- <title>Overview</title>
-
- <para>You may decide that you want eXo users to be mapped to an existing
+ <para>You may decide to make eXo users to be mapped to an existing
directory. eXo provides a flexible implementation of its
OrganizationService on top of LDAP. It can be used on any LDAP compliant
directory and even Active Directory. This page will guide you how to
configure eXo Platform to work with your directory.</para>
- </section>
-
+
<section>
<title>Quickstart</title>
@@ -23,7 +19,7 @@
comes with a predefined ldap configuration. You just need to activate it
and eXo will create all it needs to work at startup.</para>
- <para>You need to have a working ldap server and a user with write
+ <para>You need to have a working LDAP server and a user with write
permissions.</para>
<itemizedlist>
Modified: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/core/organization-service-listener.xml
===================================================================
--- jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/core/organization-service-listener.xml 2012-03-06 08:54:13 UTC (rev 5809)
+++ jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/core/organization-service-listener.xml 2012-03-06 09:57:22 UTC (rev 5810)
@@ -6,11 +6,8 @@
<title>Organization Listener</title>
- <section>
- <title>Overview</title>
-
<para>The <link linkend="Core.OrganizationService">Organization
- Service</link> provides a mechanism to receive notifications when :</para>
+ Service</link> provides a mechanism to receive notifications when:</para>
<itemizedlist>
<listitem>
@@ -44,8 +41,7 @@
<para>Create drives and personal areas in ECM.</para>
</listitem>
</itemizedlist>
- </section>
-
+
<section>
<title>Writing your own listeners</title>
@@ -84,8 +80,8 @@
<section>
<title>GroupEventListener</title>
- <para>To listen to group changes, you need to extend
- <>org.exoplatform.services.organization.GroupEventListener</>
+ <para>To listen group changes, you need to extend
+ org.exoplatform.services.organization.GroupEventListener
:</para>
<programlisting language="java">public class MyGroupListener extends GroupEventListener {
@@ -112,7 +108,7 @@
<title>MembershipEventListener</title>
<para>To listen to membership changes, you need to extend
- <>org.exoplatform.services.organization.MembershipEventListener</>
+ org.exoplatform.services.organization.MembershipEventListener
:</para>
<programlisting language="java">public class MyMembershipListener extends MembershipEventListener {
@@ -145,7 +141,7 @@
for Beginners</link> article.</para>
<para>To effectively register organization service's listeners you simply
- need to use the <>addListenerPlugin</> seer injector.</para>
+ need to use the addListenerPlugin seer injector.</para>
<para>So, the easiest way to register your listeners is to pack them into
a .jar and create a configuration file into it under <emphasis
Modified: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/core/organization-service-tck-tests-config.xml
===================================================================
--- jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/core/organization-service-tck-tests-config.xml 2012-03-06 08:54:13 UTC (rev 5809)
+++ jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/core/organization-service-tck-tests-config.xml 2012-03-06 09:57:22 UTC (rev 5810)
@@ -6,9 +6,6 @@
<title>Organization Service TCK tests configuration</title>
- <section>
- <title>Introduction</title>
-
<para>The process of launching the Organization Service TCK tests against
your Organization Service is quite easy. For instance you may add TCK
tests to your maven project and launch them during unit testing phase. To
@@ -23,13 +20,12 @@
<para>Configure standalone container and Organization Service</para>
<note>
- <para>If you need deeper investigation you can find Organization
+ <para>If you need more profound information you can find Organization
Service TCK test sources at <ulink
url="https://anonsvn.jboss.org/repos/exo-jcr/core/trunk/exo.core.component.organization.tests/">svn</ulink></para>
</note>
</listitem>
</itemizedlist>
- </section>
<section>
<title>Maven pom.xml file configuration</title>
Modified: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/core/organization-service.xml
===================================================================
--- jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/core/organization-service.xml 2012-03-06 08:54:13 UTC (rev 5809)
+++ jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/core/organization-service.xml 2012-03-06 09:57:22 UTC (rev 5810)
@@ -6,11 +6,8 @@
<title>Organization Service</title>
- <section id="Overview">
- <title>Overview</title>
-
<para>OrganizationService is the service that allows to access the
- Organization model. This model is composed of :</para>
+ Organization model. This model is composed of:</para>
<itemizedlist>
<listitem>
@@ -28,23 +25,22 @@
<para>It is the basis of eXo personalization and authorizations in eXo and
is used to all over the platform. The model is abstract and does not rely
- on any specific storage. Multiple implementations exist in eXo :</para>
+ on any specific storage. Multiple implementations exist in eXo:</para>
<itemizedlist>
<listitem>
- <para>Hibernate : for storage into a RDBMS</para>
+ <para>Hibernate: for storage into a RDBMS</para>
</listitem>
<listitem>
- <para>Jndi : for storage into a directory such as an LDAP or MS Active
+ <para>Jndi: for storage into a directory such as an LDAP or MS Active
Directory</para>
</listitem>
<listitem>
- <para>Jcr : for storage inside a Java Content Repository</para>
+ <para>Jcr: for storage inside a Java Content Repository</para>
</listitem>
</itemizedlist>
- </section>
<section>
<title>Organizational Model</title>
Modified: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/core/security-service.xml
===================================================================
--- jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/core/security-service.xml 2012-03-06 08:54:13 UTC (rev 5809)
+++ jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/core/security-service.xml 2012-03-06 09:57:22 UTC (rev 5810)
@@ -6,9 +6,6 @@
<title>Security Service</title>
- <section>
- <title>1 Overview</title>
-
<para>The purpose is to make a simple, unified way for the authentication
and the storing/propagation of user sessions through all the eXo
components and J2EE containers. JAAS is supposed to be the primary login
@@ -17,10 +14,9 @@
JAAS in the <ulink
url="http://java.sun.com/j2se/1.5.0/docs/guide/security/jaas/tutorials/GeneralAcnAndAzn.html">Java
Tutorial</ulink></para>
- </section>
<section>
- <title>1 Framework</title>
+ <title>Framework</title>
<para>The central point of this framework is the <emphasis
role="bold">ConversationState</emphasis> object which stores all
@@ -36,7 +32,7 @@
logout() methods respectively.</para>
<section>
- <title>1.1 ConversationState and ConversationRegistry</title>
+ <title>ConversationState and ConversationRegistry</title>
<para>The ConversationState can be stored</para>
@@ -88,9 +84,9 @@
</section>
<section>
- <title>1.1 Authenticator</title>
+ <title>Authenticator</title>
- <para>An Authenticator is responsible for Identity creating, it contains
+ <para>An Authenticator is responsible for Identity creation, it consists of
two methods:</para>
<itemizedlist>
@@ -245,7 +241,7 @@
</section>
<section>
- <title>1.1 Predefinded JAAS login modules</title>
+ <title>Predefinded JAAS login modules</title>
<para>There are several JAAS Login modules included in eXo Platform
sources:</para>
@@ -277,7 +273,7 @@
</section>
<section>
- <title>1.1 J2EE container authentication</title>
+ <title>J2EE container authentication</title>
<para>As you know, when a user in JAAS is authenticated, a Subject is
created as a result. This Subject represents the authenticated user. It
Modified: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/core/spring-security-integration.xml
===================================================================
--- jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/core/spring-security-integration.xml 2012-03-06 08:54:13 UTC (rev 5809)
+++ jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/core/spring-security-integration.xml 2012-03-06 09:57:22 UTC (rev 5810)
@@ -6,12 +6,6 @@
<title>Spring Security Integration</title>
- <section>
- <title>Introduction</title>
-
- <para>How to Integrate the spring security framework in the eXo
- portal?</para>
-
<para>This tutorial will guide you through a few steps and show you how
easy it is to integrate spring security (or the Spring framework in
general) in eXo portal. We will create a login portlet example as a
@@ -23,7 +17,6 @@
1.2, the JBoss portlet bridge and Spring and can serve as a example
project from where you can start your own portlet development targeting
the eXo platform.</para>
- </section>
<section>
<title>Installation</title>
@@ -32,10 +25,10 @@
running under JBoss 4.2.x.</para>
<para>Download the spring framework: <ulink
- url="http://s3.amazonaws.com/dist.springframework.org/release/SPR/spring-framework-2.5.6-with-dependencies.zip">http://s3.amazonaws.com/dist.springframework.org/release/SPR/spring-framework-2.5.6-with-dependencies.zip</ulink></para>
+ url="http://s3.amazonaws.com/dist.springframework.org/release/SPR/spring-framework-2.5.6-with-dependencies.zip">spring-framework-2.5.6-with-dependencies.zip</ulink>.</para>
- <para>Download spring-security: <ulink
- url="http://sourceforge.net/project/showfiles.php?group_id=73357&package_id=270072&release_id=630203">http://sourceforge.net/project/showfiles.php?group_id=73357&package_id=270072&release_id=630203</ulink></para>
+ <para>Download spring-security using <ulink
+ url="http://sourceforge.net/project/showfiles.php?group_id=73357&package_id=270072&release_id=630203">this</ulink>link.</para>
<para>Unzip the 02portal.war file in the jboss
server/default/deploy/exoplatform.sar directory and copy the following
@@ -389,19 +382,22 @@
<para>Until now we haven't discussed about any integration strategies
concerning a potential existing security realm outside of the eXo
platform. To address this problem we have the choice between at least two
- different strategies:</para>
+ different strategies.</para>
- <para>1.1.1 <emphasis role="bold">Direct integration</emphasis> We can
- directly integrate eXo with the external realm. Everything related to
- organisation and user management in exo is cleanly separated in its own
- abstraction accessible through the OrganisationService. The authentication
- process itself is encapsulated in the Authenticator abstraction which sits
- on top of the organization service. eXo provides several implementations
- of both. So whether your realm is based on LDAP or JDBC and because the
- default implementations are generic enough, you will be able to use them
- and fits them to your needs with a matter of a little configuration. You
- can even develop a custom implementation to meet your more specific
- needs.</para>
+ <section>
+ <title>Direct integration</title>
+ <para>We can
+ directly integrate eXo with the external realm. Everything related to
+ organisation and user management in exo is cleanly separated in its own
+ abstraction accessible through the OrganisationService. The authentication
+ process itself is encapsulated in the Authenticator abstraction which sits
+ on top of the organization service. eXo provides several implementations
+ of both. So whether your realm is based on LDAP or JDBC and because the
+ default implementations are generic enough, you will be able to use them
+ and fits them to your needs with a matter of a little configuration. You
+ can even develop a custom implementation to meet your more specific
+ needs.</para>
+ </section>
<section>
<title>Replication</title>
@@ -496,7 +492,7 @@
}</programlisting>
- <para>Basically the bean retrieves user login and password from the
+ <para>Basically, the bean retrieves user login and password from the
InteractiveAuthenticationSuccessEvent object and tries to get the user
from the organization service. In case he cannot find it in the
repository, he simply creates it on the fly. In this example the user is
@@ -635,8 +631,8 @@
}</programlisting>
<para>The PortletSideSecurityContextFilter retrieves the security
- context from the request and proceeds to a serialization
- de-serialization of it to avoid a potential class cast exception that
+ context from the request and proceeds to a serialization/de-serialization
+ of it to avoid a potential class cast exception that
may occur when propagating an object across webapps. Then the context is
simply set or cleared whether the context is null or not.</para>
Modified: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/core/tika-document-reader-service.xml
===================================================================
--- jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/core/tika-document-reader-service.xml 2012-03-06 08:54:13 UTC (rev 5809)
+++ jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/core/tika-document-reader-service.xml 2012-03-06 09:57:22 UTC (rev 5810)
@@ -6,16 +6,12 @@
<title>Tika Document Reader Service</title>
- <section>
- <title>Intro</title>
-
<para>DocumentReaderService provides API to retrieve DocumentReader by
mimetype.</para>
<para>DocumentReader lets the user fetch content of document as String or,
in case of TikaDocumentReader, as Reader.</para>
- </section>
-
+
<section>
<title>Architecture</title>
Modified: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/core.xml
===================================================================
--- jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/core.xml 2012-03-06 08:54:13 UTC (rev 5809)
+++ jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/core.xml 2012-03-06 09:57:22 UTC (rev 5810)
@@ -6,7 +6,10 @@
<title>eXoCore</title>
- <xi:include href="core/core.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <para>The eXo Core is a set of common services, such as Authentication and Security, Organization, Database, Logging,
+ JNDI, LDAP, Document reader, and other services, that are used by eXo
+ products and modules. It also can be used in the business logic.
+ </para>
<xi:include href="core/db-creator-service.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
Modified: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/faq.xml
===================================================================
--- jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/faq.xml 2012-03-06 08:54:13 UTC (rev 5809)
+++ jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/faq.xml 2012-03-06 09:57:22 UTC (rev 5810)
@@ -5,6 +5,7 @@
<?dbhtml filename="part-faq.html"?>
<title>Frequently Asked Question</title>
+ <para>This part provides you all FAQs related to the contents mentioned above.</para>
<xi:include href="faq/jcr-faq.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
Modified: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/api-extensions.xml
===================================================================
--- jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/api-extensions.xml 2012-03-06 08:54:13 UTC (rev 5809)
+++ jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/api-extensions.xml 2012-03-06 09:57:22 UTC (rev 5810)
@@ -6,22 +6,15 @@
<title>JCR API Extensions</title>
- <section>
- <title>"Lazy" child nodes iteration</title>
-
- <section>
- <title>Concept</title>
-
<para>eXo JCR implementation offers new extended feature beyond JCR
- specification. Sometimes it happens that one JCR Node has hundreds or
+ specification. Sometimes one JCR Node has hundreds or
even thousands of child nodes. This situation is highly not recommended
- for content repository data storage, but some times it occurs. JCR Team
+ for content repository data storage, but sometimes it occurs. JCR Team
is pleased to announce new feature that will help to have a deal with
huge child lists. They can be iterated in a "lazy" manner now giving
improvement in term of performance and RAM usage.</para>
- </section>
- <section>
+ <section id="JCR.APIExtensions.API_and_Usage">
<title>API and usage</title>
<para>Lazy child nodes iteration feature is accessible via extended
@@ -60,7 +53,7 @@
to be used as a production solution.</para>
</section>
- <section>
+ <section id="JCR.APIExtensions.Configuration">
<title>Configuration</title>
<para>In order to enable add the
@@ -87,7 +80,7 @@
size.</para>
</section>
- <section>
+ <section id="JCR.APIExtensions.Implementation_notices">
<title>Implementation notices</title>
<para>Current "lazy" child nodes iterator supports caching, when pages
@@ -102,5 +95,4 @@
numerous conditions and should not be used as a feature, it more likely
implementation specific issue typical for "lazy-pattern".</para>
</section>
- </section>
</chapter>
Modified: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/backup/backup-client.xml
===================================================================
--- jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/backup/backup-client.xml 2012-03-06 08:54:13 UTC (rev 5809)
+++ jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/backup/backup-client.xml 2012-03-06 09:57:22 UTC (rev 5810)
@@ -25,9 +25,6 @@
requests.</para>
</highlights>
- <section>
- <title>Introduction</title>
-
<para>The service
org.exoplatform.services.jcr.ext.backup.server.HTTPBackupAgent is
REST-based front-end to service
@@ -36,7 +33,6 @@
of current or completed backup/restore, etc.</para>
<para>The backup client is http client for HTTPBackupAgent.</para>
- </section>
<section>
<title>HTTPBackupAgent</title>
Modified: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/backup/use-external-backup-tool.xml
===================================================================
--- jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/backup/use-external-backup-tool.xml 2012-03-06 08:54:13 UTC (rev 5809)
+++ jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/backup/use-external-backup-tool.xml 2012-03-06 09:57:22 UTC (rev 5810)
@@ -4,13 +4,11 @@
<chapter id="JCR.SearchIndexBackup">
<?dbhtml filename="ch-search-index-backup.html"?>
- <title>Use external backup tool</title>
-
- <section>
+ <section id="JCR.SearchIndexBackup.Repository_suspending">
<title>Repository suspending</title>
<para>To have the repository content consistent with the search index and
- value storate, the repository should be suspened. It means all working
+ value storage, the repository should be suspended. It means all working
threads are suspended until resume operation performed. Index will be
flushed.</para>
@@ -36,7 +34,7 @@
suspended, check console to see stacktraces.</para>
</section>
- <section>
+ <section id="JCR.SearchIndexBackup.Backup">
<title>Backup</title>
<para>Now we can backup content manually or using third part software. We
@@ -57,7 +55,7 @@
</itemizedlist>
</section>
- <section>
+ <section id="JCR.SearchIndexBackup.Repository_resuming">
<title>Repository resuming</title>
<para>Once backup is done need to invoke resume() operation to switch
Modified: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/cluster-config.xml
===================================================================
--- jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/cluster-config.xml 2012-03-06 08:54:13 UTC (rev 5809)
+++ jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/cluster-config.xml 2012-03-06 09:57:22 UTC (rev 5810)
@@ -7,7 +7,7 @@
<title>Configuring JBoss AS with eXo JCR in cluster</title>
- <section>
+ <section id="JCR.ClusterConfig.Launching_Cluster">
<title>Launching Cluster</title>
<section>
@@ -166,7 +166,7 @@
</section>
</section>
- <section>
+ <section id="JCR.ClusterConfig.Requirements">
<title>Requirements</title>
<section>
@@ -273,8 +273,8 @@
</section>
</section>
- <section>
- <title>How properly stop the node</title>
+ <section id="JCR.ClusterConfig.How_to_stop_the_node_properly">
+ <title>How to stop the node properly</title>
<para>To be sure that all transactions are over and JCR is in consistent
state after stopping node, you need to follow next steps:</para>
Modified: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/concepts/jcr-advantages.xml
===================================================================
--- jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/concepts/jcr-advantages.xml 2012-03-06 08:54:13 UTC (rev 5809)
+++ jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/concepts/jcr-advantages.xml 2012-03-06 09:57:22 UTC (rev 5810)
@@ -6,8 +6,8 @@
<title>Advantages of eXo JCR</title>
- <section>
- <title>Advantages for application developers:</title>
+ <section id="JCR.AdvantagesOfeXoJCR.Advantages_for_application_developers">
+ <title>Advantages for application developers</title>
<itemizedlist>
<listitem>
@@ -40,7 +40,7 @@
</mediaobject>
</section>
- <section>
+ <section id="JCR.AdvantagesOfeXoJCR.Advantages_for_managers">
<title>Advantages for managers</title>
<itemizedlist>
Modified: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/concepts/jcr-compatibility-levels.xml
===================================================================
--- jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/concepts/jcr-compatibility-levels.xml 2012-03-06 08:54:13 UTC (rev 5809)
+++ jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/concepts/jcr-compatibility-levels.xml 2012-03-06 09:57:22 UTC (rev 5810)
@@ -6,17 +6,14 @@
<title>Compatibility Levels</title>
- <section>
- <title>Introduction</title>
-
<para>The Java Content Repository specification JSR-170 has been split
- into two compliance levels as well as a set of optional features. Level 1
- defines a read-only repository, level 2 defines methods for writing
+ into two compliance levels as well as a set of optional features.</para>
+ <para>Level 1 defines a read-only repository.</para>
+ <para>Level 2 defines methods for writing
content and bidirectional interaction with the repository.</para>
<para>eXo JCR supports JSR-170 level 1 and level 2 and all optional
features. The recent JSR-283 is not yet supported.</para>
- </section>
<section>
<title>Level 1</title>
Modified: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/concepts/jcr-exo-implementation.xml
===================================================================
--- jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/concepts/jcr-exo-implementation.xml 2012-03-06 08:54:13 UTC (rev 5809)
+++ jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/concepts/jcr-exo-implementation.xml 2012-03-06 09:57:22 UTC (rev 5810)
@@ -1,7 +1,8 @@
<?xml version='1.0' encoding='UTF-8'?>
<!-- This document was created with Syntext Serna Free. --><!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" []>
<chapter id="JCR.eXoImplementation">
-<?dbhtml filename="ch-jcr-exo-implementation.html"?> <title>eXo JCR Implementation</title>
+<?dbhtml filename="ch-jcr-exo-implementation.html"?>
+ <title>eXo JCR Implementation</title>
<section>
<title>Related Documents</title>
<para>Access Control Configuration, Export Import Implementation, External
@@ -10,7 +11,7 @@
Repository container life cycle, Workspace, Persistence Storage Workspace,
SimpleDB storage</para>
</section>
- <section>
+ <section id="JCR.eXoImplementation.How_it_works">
<title>How it works</title>
<para>eXo Repository Service is a standard eXo service and is a registered
IoC component, i.e. can be deployed in some eXo Containers (see <link linkend="JCR.eXoJCRconfiguration.RepositoryConfiguration">Service configuration</link> for details). The relationships between components
@@ -56,7 +57,7 @@
</listitem>
</itemizedlist>
</section>
- <section>
+ <section id="JCR.eXoImplementation.Workspace_Data_Model">
<title>Workspace Data Model</title>
<para>The following diagram explains which components of eXo JCR
implementation are used in a data flow to perform operations specified in
Modified: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/concepts/jcr-extensions.xml
===================================================================
--- jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/concepts/jcr-extensions.xml 2012-03-06 08:54:13 UTC (rev 5809)
+++ jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/concepts/jcr-extensions.xml 2012-03-06 09:57:22 UTC (rev 5810)
@@ -4,9 +4,6 @@
<chapter id="JCR.Extensions">
<?dbhtml filename="ch-jcr-extensions.html"?>
- <title>JCR Extensions</title>
-
- <section>
<title>JCR Service Extensions</title>
<section>
@@ -107,15 +104,12 @@
already assigned NodeType(s) of the current node (can be both primary
and mixin).</para>
- <para><emphasis role="bold">NOTE:</emphasis> the list of fields can be
- extended.</para>
+ <note><para> The list of fields can be extended.</para></note>
- <para><emphasis role="bold">NOTE2:</emphasis> no spaces between list
- elements.</para>
+ <note><para> No spaces between list elements.</para></note>
- <para><emphasis role="bold">NOTE3:</emphasis> <emphasis
- role="bold">isDeep=false</emphasis> means <emphasis role="bold">node,
- node properties and child nodes</emphasis>.</para>
+ <note><para> <emphasis role="bold">isDeep=false</emphasis> means <emphasis role="bold">node,
+ node properties and child nodes</emphasis>.</para></note>
<para>The list of supported Event names: <emphasis role="bold">addNode,
addProperty, changeProperty, removeProperty, removeNode, addMixin,
@@ -154,7 +148,6 @@
</component-plugins>
</component></programlisting>
</section>
- </section>
<section>
<title>Related Pages</title>
Modified: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/concepts/jcr-usage.xml
===================================================================
--- jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/concepts/jcr-usage.xml 2012-03-06 08:54:13 UTC (rev 5809)
+++ jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/concepts/jcr-usage.xml 2012-03-06 09:57:22 UTC (rev 5810)
@@ -6,9 +6,6 @@
<title>Using JCR</title>
- <section>
- <title>1 Using eXo JCR in an application</title>
-
<section>
<title>Obtaining a Repository object</title>
@@ -94,7 +91,6 @@
</listitem>
</itemizedlist></para>
</section>
- </section>
<section>
<title>JCR Application practices</title>
Modified: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/concepts/nodetype-registration.xml
===================================================================
--- jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/concepts/nodetype-registration.xml 2012-03-06 08:54:13 UTC (rev 5809)
+++ jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/concepts/nodetype-registration.xml 2012-03-06 09:57:22 UTC (rev 5810)
@@ -383,8 +383,8 @@
<section>
<title>Removing node type</title>
<note>
- <para>Node type is only possibly removed when the repository does not
- contain this node type.</para>
+ <para>Node type is possible to remove only when the repository does not
+ contain nodes of this type.</para>
</note>
<programlisting language="java">nodeTypeManager.unregisterNodeType("myNodeType");</programlisting>
</section>
Modified: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/concepts/nodetypes-and-namespaces.xml
===================================================================
--- jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/concepts/nodetypes-and-namespaces.xml 2012-03-06 08:54:13 UTC (rev 5809)
+++ jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/concepts/nodetypes-and-namespaces.xml 2012-03-06 09:57:22 UTC (rev 5810)
@@ -6,16 +6,12 @@
<title>Node Types and Namespaces</title>
- <section>
- <title>Introduction</title>
-
<para>Support of node types and namespaces is required by the JSR-170
specification. Beyond the methods required by the specification, eXo JCR
has its own API extension for the <link
linkend="JCR.NodeTypeRegistration">Node type registration</link> as well
as the ability to declaratively define node types in the Repository at the
start-up time.</para>
- </section>
<section>
<title>Node Types definition</title>
Modified: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/configuration/configuration-persister.xml
===================================================================
--- jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/configuration/configuration-persister.xml 2012-03-06 08:54:13 UTC (rev 5809)
+++ jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/configuration/configuration-persister.xml 2012-03-06 09:57:22 UTC (rev 5810)
@@ -5,8 +5,10 @@
<?dbhtml filename="ch-jcr-configuration-persister.html"?>
<title>JCR Configuration persister</title>
+ <para>eXo JCR allows using <emphasis>persister</emphasis> to store configuration. In this chapter, you will understand how to use and configure
+ eXo JCR persister.</para>
- <section>
+ <section id="JCR.ConfigurationPersister.Idea">
<title>Idea</title>
<para>JCR Repository Service uses
@@ -36,7 +38,7 @@
which allows to store the configuration in different locations.</para>
</section>
- <section>
+ <section id="JCR.ConfigurationPersister.Usage">
<title>Usage</title>
<para>On startup <classname>RepositoryServiceConfiguration</classname>
Modified: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/configuration/exo-jcr-configuration.xml
===================================================================
--- jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/configuration/exo-jcr-configuration.xml 2012-03-06 08:54:13 UTC (rev 5809)
+++ jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/configuration/exo-jcr-configuration.xml 2012-03-06 09:57:22 UTC (rev 5810)
@@ -6,6 +6,8 @@
<title>eXo JCR configuration</title>
+ <para>This chapter provides you the knowledge about eXo JCR configuration in details, including the basic and advanced configuration.</para>
+
<section>
<title>Related documents</title>
Modified: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/configuration/external-value-storages.xml
===================================================================
--- jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/configuration/external-value-storages.xml 2012-03-06 08:54:13 UTC (rev 5809)
+++ jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/configuration/external-value-storages.xml 2012-03-06 09:57:22 UTC (rev 5810)
@@ -6,9 +6,6 @@
<title>External Value Storages</title>
- <section>
- <title>Introduction</title>
-
<para>By default JCR Values are stored in the Workspace Data container
along with the JCR structure (i.e. Nodes and Properties). eXo JCR offers
an additional option of storing JCR Values separately from Workspace Data
@@ -23,7 +20,6 @@
application on Amazon EC2 - the S3 option may be interesting for
architecture. Simple 'flat' storage is good in speed of creation/deletion
of values, it might be a compromise for a small storages.</para>
- </section>
<section>
<title>Tree File Value Storage</title>
Modified: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/configuration/jdbc-data-container-config.xml
===================================================================
--- jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/configuration/jdbc-data-container-config.xml 2012-03-06 08:54:13 UTC (rev 5809)
+++ jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/configuration/jdbc-data-container-config.xml 2012-03-06 09:57:22 UTC (rev 5810)
@@ -6,10 +6,7 @@
<title>JDBC Data Container Config</title>
- <section>
- <title>Introduction</title>
-
- <para>eXo JCR persistent data container can work in two configuration
+ <para>eXo JCR persistent data container can work in two configuration
modes:<itemizedlist>
<listitem>
<para><phrase>Multi-database</phrase>: One database for each
@@ -248,7 +245,6 @@
<para>Read more about <link linkend="JCR.eXoJCRconfiguration">Repository
configuration</link>.</para>
- </section>
<section>
<title>General recommendations for database configuration</title>
Modified: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/configuration/multi-db-schema-support.xml
===================================================================
--- jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/configuration/multi-db-schema-support.xml 2012-03-06 08:54:13 UTC (rev 5809)
+++ jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/configuration/multi-db-schema-support.xml 2012-03-06 09:57:22 UTC (rev 5810)
@@ -7,19 +7,15 @@
<title>How to host several JCR instances on the same database
instance?</title>
- <section>
- <title>Concepts</title>
-
- <para>Frequently a single database instance must be shared by several
+ <para>Frequently, a single database instance must be shared by several
other applications. But some of our customers have also asked for a way to
host several JCR instances in the same database instance. To fulfill this
need, we had to review our queries and scope them to the current schema;
- it’s now possible to have one JCR instance per DB schema instead of per DB
+ it is now possible to have one JCR instance per DB schema instead of per DB
instance. To benefit of the work done for this feature you will need to
- apply the configuration changes described in the next sections. </para>
- </section>
+ apply the configuration changes described below.</para>
- <section>
+ <section id="JCR.MultiDBSchemaSupport.LockManager_Config">
<title>LockManager configuration</title>
<para>To enable this feature you need to replace
@@ -70,7 +66,7 @@
url="http://svn.jboss.org/repos/exo-jcr/jcr/trunk/exo.jcr.component.core/src/test/resources/conf/standalone/cluster/test-jbosscache-lock.xml">svn</ulink>.</para>
</section>
- <section>
+ <section id="JCR.MultiDBSchemaSupport.HibernateService_Configuration">
<title>HibernateService configuration</title>
<para>If you use HibernateService for JDBC connections management you will
Modified: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/configuration/multilanguage-support.xml
===================================================================
--- jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/configuration/multilanguage-support.xml 2012-03-06 08:54:13 UTC (rev 5809)
+++ jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/configuration/multilanguage-support.xml 2012-03-06 09:57:22 UTC (rev 5810)
@@ -4,13 +4,11 @@
<chapter id="JCRMultilanguageSupport">
<?dbhtml filename="ch-multilanguage-support.html"?>
- <title>Multilanguage support in eXo JCR RDB backend</title>
+ <title>Multi-language support in eXo JCR RDB backend</title>
- <section>
- <title>Introduction</title>
<para>Whenever relational database is used to store multilingual text data
- of eXo Java Content Repository, we need to adapt configuration in order to
+ of eXo Java Content Repository, it is necessary to adapt configuration in order to
support UTF-8 encoding. Here is a short HOWTO instruction for several
supported RDBMS with examples.</para>
@@ -22,7 +20,6 @@
configured via <classname>InitialContextInitializer</classname>
component.</para>
</note>
- </section>
<section>
<title>Oracle</title>
Modified: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/configuration/rest-services-on-groovy.xml
===================================================================
--- jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/configuration/rest-services-on-groovy.xml 2012-03-06 08:54:13 UTC (rev 5809)
+++ jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/configuration/rest-services-on-groovy.xml 2012-03-06 09:57:22 UTC (rev 5810)
@@ -6,16 +6,12 @@
<title>REST Services on Groovy</title>
- <section>
- <title>Concept</title>
-
<para>Starting from version 1.9, JCR Service supports REST services
creation on <ulink url="http://groovy.codehaus.org">Groovy
script</ulink>.</para>
<para>The feature bases on <link linkend="WS.RestFramework">RESTful
framework</link> and uses ResourceContainer concept.</para>
- </section>
<section>
<title>Usage</title>
Modified: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/configuration/search-configuration.xml
===================================================================
--- jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/configuration/search-configuration.xml 2012-03-06 08:54:13 UTC (rev 5809)
+++ jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/configuration/search-configuration.xml 2012-03-06 09:57:22 UTC (rev 5810)
@@ -5,8 +5,9 @@
<?dbhtml filename="ch-search-configuration.html"?>
<title>Search Configuration</title>
+ <para>Search is an important function in eXo JCR, so it is very necessary for you to know how to configure the eXo JCR Search tool.</para>
- <section>
+ <section id="JCR.SearchConfiguration.XMLConfig">
<title>XML Configuration</title>
<para>JCR index configuration. You can find this file here:
@@ -36,7 +37,7 @@
</repository-service></programlisting>
</section>
- <section>
+ <section id="JCR.SearchConfiguration.Config_Parameters">
<title>Configuration parameters</title>
<table>
@@ -371,7 +372,7 @@
</table>
</section>
- <section>
+ <section id="JCR.SearchConfiguration.Global_Search_Index">
<title>Global Search Index</title>
<section>
@@ -518,7 +519,7 @@
</section>
</section>
- <section>
+ <section id="JCR.SearchConfiguration.Indexing_Adjustments">
<title>Indexing Adjustments</title>
<section>
Modified: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/data-container-howto.xml
===================================================================
--- jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/data-container-howto.xml 2012-03-06 08:54:13 UTC (rev 5809)
+++ jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/data-container-howto.xml 2012-03-06 09:57:22 UTC (rev 5810)
@@ -6,9 +6,8 @@
<?dbhtml filename="ch-data-container-howto.html"?>
- <section id="ShortintrointoWorkspacedatacontainerimplementationpractices">
- <title>Short intro about Workspace data container implementation
- practices:</title>
+ <para>To implement Workspace data container, you need to do the following:
+ </para>
<orderedlist>
<listitem>
@@ -17,9 +16,8 @@
</listitem>
<listitem>
- <para>Start new implementation project pom.xml with
- org.exoplatform.jcr parent. (optional, but will makes the development
- easy)</para>
+ <para>Start a new implementation project pom.xml with
+ <emphasis>org.exoplatform.jcr</emphasis> parent. It is not required, but will ease the development.</para>
</listitem>
<listitem>
@@ -110,7 +108,6 @@
</programlisting>
<para>Container can be configured by using set properties.</para>
- </section>
<section id="Valuestorageusagenotes">
<title>Notes on Value storage usage:</title>
Modified: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/data-container.xml
===================================================================
--- jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/data-container.xml 2012-03-06 08:54:13 UTC (rev 5809)
+++ jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/data-container.xml 2012-03-06 09:57:22 UTC (rev 5810)
@@ -6,25 +6,23 @@
<title>JCR Workspace Data Container (architecture contract)</title>
- <section>
- <title>Goals</title>
+ <para>The goals of this chapter are:</para>
<itemizedlist>
<listitem>
- <para>Cover the requirements on Workspace Data Container
+ <para>Coverage of the requirements of Workspace Data Container
implementation</para>
</listitem>
<listitem>
- <para>Describe container life cycle</para>
+ <para>Description of container life cycle</para>
</listitem>
<listitem>
- <para>Describe relations between container and high-level
+ <para>Description relations between container and high-level
DataManagers</para>
</listitem>
</itemizedlist>
- </section>
<section>
<title>Concepts</title>
Modified: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/db-cleaner-service.xml
===================================================================
--- jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/db-cleaner-service.xml 2012-03-06 08:54:13 UTC (rev 5809)
+++ jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/db-cleaner-service.xml 2012-03-06 09:57:22 UTC (rev 5810)
@@ -6,19 +6,22 @@
<title>DBCleanService</title>
- <section>
- <title>Description</title>
+ <para>It is a special service for data removal from database. The chapter
+ shortly describes the principles of work <emphasis>DBCleaner</emphasis> under all
+ databases.</para>
<para>It is special service for data removal from database. The article
shortly describes the principles of work DBCleaner under all
databases</para>
- <note>
- <para>Code that invokes methods of DBCleanService must have
- JCRRuntimePermissions.MANAGE_REPOSITORY_PERMISSION permission;</para>
+ <section id="JCR.DBCleanerService.Methods_of_DBCleanerService">
+ <title>Methods of DBCleanerService </title>
+ <note>
+ <para>Code that invokes the methods of DBCleanService must have
+ JCRRuntimePermissions.MANAGE_REPOSITORY_PERMISSION permission.</para>
</note>
- <para>There are several methods of DBCleanerService:</para>
+ <para>There are several methods of <emphasis>DBCleanerService</emphasis> :</para>
<table>
<title>API</title>
Modified: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/intro.xml
===================================================================
--- jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/intro.xml 2012-03-06 08:54:13 UTC (rev 5809)
+++ jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/intro.xml 2012-03-06 09:57:22 UTC (rev 5810)
@@ -6,9 +6,6 @@
<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. It is
@@ -67,5 +64,4 @@
repository configuration, rather than part of the application
programming task.</para>
</section>
- </section>
</chapter>
Modified: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/jbosscache-configuration-templates.xml
===================================================================
--- jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/jbosscache-configuration-templates.xml 2012-03-06 08:54:13 UTC (rev 5809)
+++ jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/jbosscache-configuration-templates.xml 2012-03-06 09:57:22 UTC (rev 5810)
@@ -6,12 +6,15 @@
<title>JBoss Cache configuration</title>
- <section>
+ <para>This chapter will show you how to use and configure Jboss Cache in the clustered environment.
+ Also, you will know how to use a template-based configuration offered by eXo JCR for JBoss Cache instances.</para>
+
+ <section id="JCR.JBossCacheConfigurationTemplates.JBoss_Cache_Config_for_Indexer">
<title>JBoss cache configuration for indexer, lock manager and data
container</title>
<para>Each mentioned components uses instances of JBoss Cache product for
- caching in clustered environment. So every element has it's own transport
+ caching in clustered environment. So every element has its own transport
and has to be configured in a proper way. As usual, workspaces have
similar configuration but with different cluster-names and may-be some
other parameters. The simplest way to configure them is to define their
@@ -43,7 +46,7 @@
...</programlisting>
</section>
- <section>
+ <section id="JCR.JBossCacheConfigurationTemplates.Jboss_Configuration">
<title>JGroups configuration</title>
<para>JGroups is used by JBoss Cache for network communications and
@@ -78,7 +81,7 @@
<property name="jgroups-multiplexer-stack" value="false" /></programlisting>
</section>
- <section>
+ <section id="JCR.JBossCacheConfigurationTemplates.Allow_to_share_JBOSS_Cache_Instances">
<title>Allow to share JBoss Cache instances</title>
<para>A JBoss Cache instance is quite resource consuming and by default we
@@ -108,7 +111,7 @@
defined.</para>
</section>
- <section>
+ <section id="JCR.JBossCacheConfigurationTemplates.Shipped_Jboss_Cache_Config_template">
<title>Shipped JBoss Cache configuration templates</title>
<para>eXo JCR implementation is shipped with ready-to-use JBoss Cache
Modified: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/jbossts-transaction-service.xml
===================================================================
--- jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/jbossts-transaction-service.xml 2012-03-06 08:54:13 UTC (rev 5809)
+++ jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/jbossts-transaction-service.xml 2012-03-06 09:57:22 UTC (rev 5810)
@@ -6,20 +6,16 @@
<title>JBossTransactionsService</title>
- <section>
- <title>Introduction</title>
-
<para>JBossTransactionsService implements eXo <link
linkend="Kernel.TransactionService">TransactionService</link> and provides
access to <ulink url="http://www.jboss.org/jbosstm/">JBoss Transaction
Service (JBossTS)</ulink> JTA implementation via eXo container
dependency.</para>
- <para>TransactionService used in JCR cache
+ <para>TransactionService is used in JCR cache
<emphasis>org.exoplatform.services.jcr.impl.dataflow.persistent.jbosscache.JBossCacheWorkspaceStorageCache</emphasis>
implementaion. See <link linkend="JCR.ClusterConfig">Cluster
configuration</link> for example.</para>
- </section>
<section>
<title>Configuration</title>
Modified: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/jca.xml
===================================================================
--- jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/jca.xml 2012-03-06 08:54:13 UTC (rev 5809)
+++ jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/jca.xml 2012-03-06 09:57:22 UTC (rev 5810)
@@ -6,9 +6,6 @@
<title>The <emphasis>JCA</emphasis> Resource Adapter</title>
- <section>
- <title>Overview</title>
-
<para>eXo JCR supports <emphasis>J2EE Connector Architecture</emphasis>
1.5, thus If you would like to delegate the JCR Session lifecycle to your
application server, you can use the JCA Resource Adapter for eXo JCR if
@@ -16,7 +13,6 @@
Transaction, in other words you cannot use it for local transactions.
Since the JCR Sessions have not been designed to be shareable, the session
pooling is simply not covered by the adapter.</para>
- </section>
<section>
<title>The <emphasis>SessionFactory</emphasis></title>
Modified: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/lock-manager-config.xml
===================================================================
--- jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/lock-manager-config.xml 2012-03-06 08:54:13 UTC (rev 5809)
+++ jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/lock-manager-config.xml 2012-03-06 09:57:22 UTC (rev 5810)
@@ -7,13 +7,10 @@
<title>LockManager configuration</title>
- <section>
- <title>Introduction</title>
-
<para>What LockManager does?</para>
<para>In general, LockManager stores Lock objects, so it can give a Lock
- object or can release it, etc.</para>
+ object or can release it.</para>
<para>Also, LockManager is responsible for removing Locks that live too
long. This parameter may be configured with "time-out" property.</para>
@@ -48,7 +45,6 @@
</lock-manager>
...
</workspace></programlisting>
- </section>
<section>
<title>LockManagerImpl</title>
Modified: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/other/acl-ext.xml
===================================================================
--- jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/other/acl-ext.xml 2012-03-06 08:54:13 UTC (rev 5809)
+++ jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/other/acl-ext.xml 2012-03-06 09:57:22 UTC (rev 5810)
@@ -6,19 +6,8 @@
<title>Access Control Extension</title>
- <section>
- <title>Prerequisites</title>
+ <para>An extended Access Control system consists of:</para>
- <para>This is an extension of eXo JCR Access Control features. Please read
- <link linkend="JCR.AccessControl">Access Control</link> and <link
- linkend="JCR.Extensions">JCR Extensions</link> topics first.</para>
- </section>
-
- <section>
- <title>Overview</title>
-
- <para>An extended Access Control system consists of:</para>
-
<itemizedlist>
<listitem>
<para>Specifically configured custom <emphasis
@@ -42,6 +31,13 @@
performed and the current eXo Container</para>
</listitem>
</itemizedlist>
+
+ <section>
+ <title>Prerequisites</title>
+
+ <para>This is an extension of eXo JCR Access Control features. Please read
+ <link linkend="JCR.AccessControl">Access Control</link> and <link
+ linkend="JCR.Extensions">JCR Extensions</link> topics first.</para>
</section>
<section>
Modified: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/other/binary-values-processing.xml
===================================================================
--- jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/other/binary-values-processing.xml 2012-03-06 08:54:13 UTC (rev 5809)
+++ jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/other/binary-values-processing.xml 2012-03-06 09:57:22 UTC (rev 5810)
@@ -5,8 +5,11 @@
<?dbhtml filename="ch-binary-values-processing.html"?>
<title>Binary Values Processing</title>
+ <para>Processing binary large object (BLOB) is very important in eXo JCR, so this chapter focuses on explaining how to
+ do it.
+ </para>
- <section>
+ <section id="JCR.BinaryValuesProcessing.Configuration">
<title>Configuration</title>
<para>Binary large object (BLOB) properties can be stored in two ways in
@@ -41,7 +44,7 @@
</note>
</section>
- <section>
+ <section id="JCR.BinaryValuesProcessing.Usage">
<title>Usage</title>
<para>In both of the cases, a developer can set/update the binary Property
@@ -139,7 +142,7 @@
node.setProperty("BinData", extValue);</programlisting>
</section>
- <section>
+ <section id="JCR.BinaryValuesProcessing.Value_implementations">
<title>Value implementations</title>
<mediaobject>
Modified: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/performance-tuning-guide.xml
===================================================================
--- jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/performance-tuning-guide.xml 2012-03-06 08:54:13 UTC (rev 5809)
+++ jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/performance-tuning-guide.xml 2012-03-06 09:57:22 UTC (rev 5810)
@@ -6,15 +6,10 @@
<title>JCR Performance Tuning Guide</title>
- <section>
- <title>Introduction</title>
+ <para>This chapter will show you possible ways of improving JCR</para>
- <para>This guide will show you possible ways of improving JCR
- performance.</para>
-
<para>It is intended to GateIn Administrators and those who wants to use
JCR features.</para>
- </section>
<section>
<title>JCR Performance and Scalability</title>
Modified: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/protocols/ftp.xml
===================================================================
--- jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/protocols/ftp.xml 2012-03-06 08:54:13 UTC (rev 5809)
+++ jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/protocols/ftp.xml 2012-03-06 09:57:22 UTC (rev 5810)
@@ -6,17 +6,13 @@
<title>FTP</title>
- <section>
- <title>Introdution</title>
-
<para>The JCR-FTP Server represents the standard eXo service, operates as
an FTP server with an access to a content stored in JCR repositories in
the form of <emphasis role="bold">nt:file/nt:folder</emphasis> nodes or
their successors. The client of an executed Server can be any FTP client.
The FTP server is supported by a standard configuration which can be
changed as required.</para>
- </section>
-
+
<section>
<title>Configuration Parameters</title>
Modified: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/protocols/webdav.xml
===================================================================
--- jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/protocols/webdav.xml 2012-03-06 08:54:13 UTC (rev 5809)
+++ jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/protocols/webdav.xml 2012-03-06 09:57:22 UTC (rev 5810)
@@ -7,20 +7,6 @@
<title>WebDAV</title>
- <section>
- <title>Related documents</title>
-
- <itemizedlist>
- <listitem>
- <para><link linkend="JCR.LinkProducerService">Link
- Producer</link></para>
- </listitem>
- </itemizedlist>
- </section>
-
- <section>
- <title>Introduction</title>
-
<para>The WebDAV protocol enables you to use the third party tools to
communicate with hierarchical content servers via HTTP. It is possible to
add and remove documents or a set of documents from a path on the server.
@@ -69,8 +55,21 @@
org.exoplatform.services.security.jaas.BasicLoginModule required domain=ecm;
};</programlisting>
</note>
- </section>
+ <para>
+ <emphasis role="bold">Related documents</emphasis>
+ </para>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ <link linkend="JCR.LinkProducerService">Link
+ Producer
+ </link>
+ </para>
+ </listitem>
+ </itemizedlist>
+
<section>
<title>Configuration</title>
Modified: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/query-handler-config.xml
===================================================================
--- jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/query-handler-config.xml 2012-03-06 08:54:13 UTC (rev 5809)
+++ jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/query-handler-config.xml 2012-03-06 09:57:22 UTC (rev 5810)
@@ -5,8 +5,9 @@
<?dbhtml filename="ch-query-handler-config.html"?>
<title>QueryHandler configuration</title>
+ <para>This chapter shows you how to configure <emphasis>QueryHandler</emphasis>: <link linkend="JCR.QueryHandlerConfiguration.Indexing_in_clustered_environment">Indexing in clustered environment</link>.</para>
- <section>
+ <section id="JCR.QueryHandlerConfiguration.Indexing_in_clustered_environment">
<title>Indexing in clustered environment</title>
<para>JCR offers multiple indexing strategies. They include both for
@@ -85,7 +86,7 @@
Configuration</link>.</para>
</section>
- <section>
+ <section id="JCR.QueryHandlerConfiguration.Configuration">
<title>Configuration</title>
<section>
@@ -422,7 +423,7 @@
</section>
</section>
- <section>
+ <section id="JCR.QueryHandlerConfiguration.Asynchronous_reindexing">
<title>Asynchronous reindexing</title>
<para>Managing a big set of data using JCR in production environment
@@ -538,7 +539,7 @@
</section>
</section>
- <section>
+ <section id="JCR.QueryHandlerConfiguration.Advanced_tuning">
<title>Advanced tuning</title>
<section>
Modified: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/repository-check-controller.xml
===================================================================
--- jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/repository-check-controller.xml 2012-03-06 08:54:13 UTC (rev 5809)
+++ jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/repository-check-controller.xml 2012-03-06 09:57:22 UTC (rev 5810)
@@ -6,9 +6,6 @@
<title>Checking repository integrity and consistency</title>
- <section>
- <title>JMX-based consistency tool</title>
-
<para>Production and any other system may have faults some day. They may
be caused by hardware problems, human faults, software errors during
updates and many other circumstances. It is important to check integrity
@@ -136,7 +133,6 @@
<para>All tool activities are stored in file, which can be found in app
directory by name <code>report-<repository
name>-dd-MMM-yy-HH-mm.txt</code>.</para>
- </section>
<section>
<title>Recommendations on how to fix corrupted JCR</title>
Modified: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/repository-creation-service.xml
===================================================================
--- jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/repository-creation-service.xml 2012-03-06 08:54:13 UTC (rev 5809)
+++ jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/repository-creation-service.xml 2012-03-06 09:57:22 UTC (rev 5810)
@@ -6,13 +6,9 @@
<title>RepositoryCreationService</title>
- <section>
- <title>Intro</title>
-
- <para>RepositoryCreationService is the service for creation repositories
- in runtime. The service can be used in standalone or cluster
+ <para><emphasis>RepositoryCreationService</emphasis> is the service which is used to create repositories
+ in runtime. The service can be used in a standalone or cluster
environment.</para>
- </section>
<section>
<title>Dependencies</title>
Modified: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/searching/fulltext-search-and-settings.xml
===================================================================
--- jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/searching/fulltext-search-and-settings.xml 2012-03-06 08:54:13 UTC (rev 5809)
+++ jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/searching/fulltext-search-and-settings.xml 2012-03-06 09:57:22 UTC (rev 5810)
@@ -6,7 +6,7 @@
<title>Fulltext Search And Affecting Settings</title>
- <section>
+ <section id="JCR.FulltextSearchAndSettings.Property_content_indexing">
<title>Property content indexing</title>
<para>Each property of a node (if it is indexable) is processed with
@@ -15,7 +15,7 @@
properties.</para>
</section>
- <section>
+ <section id="JCR.FulltextSearchAndSettings.Lucene_Analyzers">
<title>Lucene Analyzers</title>
<para>The sense of analyzers is to transform all strings stored in the
@@ -146,7 +146,7 @@
linkend="JCR.SearchConfiguration">Search Configuration</link></para>
</section>
- <section>
+ <section id="JCR.FulltextSearchAndSettings.How_different_properties_indexed">
<title>How are different properties indexed?</title>
<para>Different properties are indexed in different ways, this affects to
@@ -203,7 +203,7 @@
<programlisting>SELECT * FROM nt:resource WHERE CONTAINS( * , 'some string')</programlisting>
</section>
- <section>
+ <section id="JCR.FulltextSearchAndSettings.Fulltext_search_query_examples">
<title>Fulltext search query examples</title>
<itemizedlist>
@@ -229,7 +229,7 @@
</itemizedlist>
</section>
- <section>
+ <section id="JCR.FulltextSearchAndSettings.Different_analyzers_in_action">
<title>Different analyzers in action</title>
<para>First of all, we will fill repository by nodes with mixin type
Modified: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/searching/jcr-query-usecases.xml
===================================================================
--- jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/searching/jcr-query-usecases.xml 2012-03-06 08:54:13 UTC (rev 5809)
+++ jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/searching/jcr-query-usecases.xml 2012-03-06 09:57:22 UTC (rev 5810)
@@ -6,14 +6,10 @@
<title>JCR Query Usecases</title>
- <section>
- <title>Intro</title>
-
<para>JCR supports two query languages - JCR and XPath. A query, whether
XPath or SQL, specifies a subset of nodes within a workspace, called the
result set. The result set constitutes all the nodes in the workspace that
meet the constraints stated in the query.</para>
- </section>
<section>
<title>Query Lifecycle</title>
Modified: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/searching/searching-repository-content.xml
===================================================================
--- jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/searching/searching-repository-content.xml 2012-03-06 08:54:13 UTC (rev 5809)
+++ jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/searching/searching-repository-content.xml 2012-03-06 09:57:22 UTC (rev 5810)
@@ -6,14 +6,10 @@
<title>Searching Repository Content</title>
- <section>
- <title>Introduction</title>
-
- <para>You can find the JCR configuration file here:
- .../portal/WEB-INF/conf/jcr/repository-configuration.xml. Please read also
+ <para>You can find the JCR configuration file at
+ <emphasis>.../portal/WEB-INF/conf/jcr/repository-configuration.xml</emphasis>. Please read also
<link linkend="JCR.SearchConfiguration">Search Configuration</link> for
more information about index configuration.</para>
- </section>
<section>
<title>Bi-directional RangeIterator (since 1.9)</title>
Modified: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/statistics.xml
===================================================================
--- jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/statistics.xml 2012-03-06 08:54:13 UTC (rev 5809)
+++ jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/statistics.xml 2012-03-06 09:57:22 UTC (rev 5810)
@@ -5,8 +5,9 @@
<?dbhtml filename="ch-statistics.html"?>
<title>eXo JCR statistics</title>
-
- <section>
+ <para>This chapter will show you how to get and manage all statistics provided by eXo JCR.</para>
+
+ <section id="JCR.Statistics.Database_access_layer">
<title>Statistics on the Database Access Layer</title>
<para>In order to have a better idea of the time spent into the database
@@ -49,7 +50,7 @@
</listitem>
</itemizedlist>
- <para>Those figures are also available globaly for all the methods which
+ <para>Those figures are also available globally for all the methods which
gives us the global behavior of this layer.</para>
<para>If you want to enable the statistics, you just need to set the JVM
@@ -221,7 +222,7 @@
your eXo JCR to better fit your requirements.</para>
<para>In order to allow you to specify the configuration which part of eXo
- JCR needs to be monitored whithout applying any changes in your code
+ JCR needs to be monitored without applying any changes in your code
and/or building anything, we choose to rely on the Load-time Weaving
proposed by AspectJ.</para>
@@ -252,7 +253,7 @@
command line, for more details please refer to <ulink
url="http://www.eclipse.org/aspectj/doc/released/devguide/ltw-configuration.html">http://www.eclipse.org/aspectj/doc/released/devguide/ltw-configuration.html</ulink>.</para>
- <para>By default, the configuration will collect statistcs on all the
+ <para>By default, the configuration will collect statistics on all the
methods of the internal interfaces
<emphasis>org.exoplatform.services.jcr.core.ExtendedSession</emphasis> and
<emphasis>org.exoplatform.services.jcr.core.ExtendedNode</emphasis>, and
@@ -286,7 +287,7 @@
</configuration></programlisting>
<para>The file content below is the content of
- <emphasis>META-INF/aop.xml</emphasis> that you will to need to modify to
+ <emphasis>META-INF/aop.xml</emphasis> that you will need to modify to
add and/or remove the full qualified name of the interfaces to monitor,
into the expression filter of the pointcut called
<emphasis>JCRAPIPointcut</emphasis>. As you can see below, by default only
@@ -326,7 +327,7 @@
JCR so it must be used with caution.</remark>
</section>
- <section>
+ <section id="JCR.Statistics.Statistics_Manager">
<title>Statistics Manager</title>
<para>The statistics manager manages all the statistics provided by eXo
Modified: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/transaction-manager-lookup.xml
===================================================================
--- jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/transaction-manager-lookup.xml 2012-03-06 08:54:13 UTC (rev 5809)
+++ jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/transaction-manager-lookup.xml 2012-03-06 09:57:22 UTC (rev 5810)
@@ -6,19 +6,16 @@
<title>TransactionManagerLookup</title>
- <section>
- <title>Configuration</title>
+ <para>JBossCache class is registered as an eXo container component in the
+ <emphasis>configuration.xml</emphasis> file. </para>
- <para>It's JBossCache class registered as eXo container component in
- configuration.xml file. </para>
-
<programlisting language="xml"> <component>
<key>org.jboss.cache.transaction.TransactionManagerLookup</key>
<type>org.jboss.cache.transaction.JBossStandaloneJTAManagerLookup</type>
</component></programlisting>
- <para>JBossStandaloneJTAManagerLookup used in standalone environment. Bur
- for Application Server environment use GenericTransactionManagerLookup.
+ <para><emphasis>JBossStandaloneJTAManagerLookup</emphasis> is used in a standalone environment, but
+ <emphasis>GenericTransactionManagerLookup</emphasis> is used in the Application Server environment.
</para>
- </section>
+
</chapter>
Modified: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr-with-gtn/how-to-extend-my-gatein-instance.xml
===================================================================
--- jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr-with-gtn/how-to-extend-my-gatein-instance.xml 2012-03-06 08:54:13 UTC (rev 5809)
+++ jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr-with-gtn/how-to-extend-my-gatein-instance.xml 2012-03-06 09:57:22 UTC (rev 5810)
@@ -6,19 +6,12 @@
<title>How to extend my GateIn instance?</title>
- <section>
- <title>Introduction</title>
-
- <section>
- <title>Overview</title>
-
- <para>Since GateIn beta 2, we added a set of features in order to
- customize a GateIn instance without modifying the GateIn binary, this
+ <para>Since GateIn beta 2, there are a set of features added to
+ customize a GateIn instance without modifying the GateIn binary. This
usecase will be called <emphasis>portal extension</emphasis> in this
documentation. Those features are also required to be able to launch
several portal instances at the same time, in "eXo terminology" that
means to have several "portal.war".</para>
- </section>
<section>
<title>Motivations</title>
@@ -48,7 +41,6 @@
help/enforce all the GateIn developers to follow the "good
practices".</para>
</section>
- </section>
<section>
<title>Prerequisites</title>
Modified: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr-with-gtn/managed-datasources-under-jboss-as.xml
===================================================================
--- jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr-with-gtn/managed-datasources-under-jboss-as.xml 2012-03-06 08:54:13 UTC (rev 5809)
+++ jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr-with-gtn/managed-datasources-under-jboss-as.xml 2012-03-06 09:57:22 UTC (rev 5810)
@@ -6,8 +6,8 @@
<?dbhtml filename="ch-how-to-use-managed-datasource-under-jboss.html"?>
- <section>
- <title>Configurations Steps</title>
+ <para>This chapter will show you how to use AS Managed DataSource under JBoss AS.
+ </para>
<important>
<para>Checked under Gatein 3.1.0-GA Final</para>
@@ -99,5 +99,4 @@
<para>Running eXo after these configurations goes well.</para>
</section>
- </section>
</chapter>
Modified: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr.xml
===================================================================
--- jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr.xml 2012-03-06 08:54:13 UTC (rev 5809)
+++ jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr.xml 2012-03-06 09:57:22 UTC (rev 5810)
@@ -5,7 +5,9 @@
<?dbhtml filename="part-jcr.html"?>
<title>eXoJCR</title>
-
+ <para>eXo provides JCR implementation called eXo JCR.</para>
+ <para>This part will show you how to configure and use eXo JCR in GateIn and standalone.</para>
+
<xi:include href="jcr/intro.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
@@ -91,7 +93,7 @@
<xi:include href="jcr/transaction-manager-lookup.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
-
+
<xi:include href="jcr/ispn/ispn-integration.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
@@ -109,8 +111,8 @@
xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="jcr/searching/fulltext-search-and-settings.xml"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
-
+ xmlns:xi="http://www.w3.org/2001/XInclude" />
+
<!-- api extensions -->
<xi:include href="jcr/api-extensions.xml"
@@ -145,12 +147,12 @@
- <xi:include href="jcr/jta.xml"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
-
- <xi:include href="jcr/jca.xml"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
-
+ <xi:include href="jcr/jta.xml"
+ xmlns:xi="http://www.w3.org/2001/XInclude" />
+
+ <xi:include href="jcr/jca.xml"
+ xmlns:xi="http://www.w3.org/2001/XInclude" />
+
<xi:include href="jcr/other/acl.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
Modified: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/kernel/cache.xml
===================================================================
--- jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/kernel/cache.xml 2012-03-06 08:54:13 UTC (rev 5809)
+++ jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/kernel/cache.xml 2012-03-06 09:57:22 UTC (rev 5810)
@@ -6,7 +6,10 @@
<title>eXo Cache</title>
- <section>
+ <para>
+ This chapter will provide you all the basic knowledge about eXo Cache, from basic concepts to advanced concepts, sample codes, and more.
+ </para>
+ <section id="Kernel.Cache.Basic_concepts">
<title>Basic concepts</title>
<para>All applications on the top of eXo JCR that need a cache, can rely
@@ -156,7 +159,7 @@
</table>
</section>
- <section>
+ <section id="Kernel.Cache.Advanced_concepts">
<title>Advanced concepts</title>
<section>
@@ -264,7 +267,7 @@
</section>
</section>
- <section>
+ <section id="Kernel.Cache.Extension">
<title>eXo Cache extension</title>
<para>In the previous versions of eXo kernel, it was quite complex to
@@ -314,7 +317,7 @@
</note>
</section>
- <section>
+ <section id="Kernel.Cache.eXo_Cache_based_Jobss_Cache">
<title>eXo Cache based on JBoss Cache</title>
<section>
@@ -1309,7 +1312,7 @@
</section>
</section>
- <section>
+ <section id="Kernel.Cache.Based_Infinispan">
<title>eXo Cache based on Infinispan</title>
<section>
Modified: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/kernel/container-configuration.xml
===================================================================
--- jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/kernel/container-configuration.xml 2012-03-06 08:54:13 UTC (rev 5809)
+++ jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/kernel/container-configuration.xml 2012-03-06 09:57:22 UTC (rev 5810)
@@ -6,9 +6,6 @@
<title>Container Configuration</title>
- <section>
- <title>Intro</title>
-
<para>eXo Portal uses PicoContainer, which implements the Inversion of
Control (IoC) design pattern. All eXo containers inherit from a
PicoContainer. There are mainly two eXo containers used, each of them can
@@ -23,8 +20,7 @@
<para>Confused? - You might be interested in the <link
linkend="Kernel.ServiceConfigurationforBeginners">Service Configuration
- for Beginners</link> article, which explains the basics.</para>
- </section>
+ for Beginners</link> chapter to understand the basics.</para>
<section id="Kernel.ContainerConfiguration.ConfigurationNamespace">
<title>Kernel configuration namespace</title>
Modified: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/kernel/data-source-provider.xml
===================================================================
--- jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/kernel/data-source-provider.xml 2012-03-06 08:54:13 UTC (rev 5809)
+++ jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/kernel/data-source-provider.xml 2012-03-06 09:57:22 UTC (rev 5810)
@@ -6,14 +6,11 @@
<title>The data source provider</title>
- <section>
- <title>Description</title>
-
<para>The <emphasis>DataSourceProvider</emphasis> is a service used to
give access to a data source in an uniform manner in order to be able to
support data sources that are managed by the application server.</para>
- <para><table>
+ <table>
<title>List methods</title>
<tgroup cols="2">
@@ -38,8 +35,7 @@
</row>
</tbody>
</tgroup>
- </table></para>
- </section>
+ </table>
<section>
<title>Configuration</title>
Modified: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/kernel/inversion-of-control.xml
===================================================================
--- jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/kernel/inversion-of-control.xml 2012-03-06 08:54:13 UTC (rev 5809)
+++ jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/kernel/inversion-of-control.xml 2012-03-06 09:57:22 UTC (rev 5810)
@@ -6,9 +6,6 @@
<title>Inversion Of Control</title>
- <section>
- <title>Overview</title>
-
<para>The services are not responsible for the instantiation of the
components on which they depend.</para>
@@ -16,11 +13,11 @@
implementation of dependant services can be transparently
exchanged.</para>
- <para>This pattern has several names :</para>
+ <para>This pattern has several names:</para>
<itemizedlist>
<listitem>
- <para>Hollywood principle : "don't call me, I will call you"</para>
+ <para>Hollywood principle: "don't call me, I will call you"</para>
</listitem>
<listitem>
@@ -31,7 +28,6 @@
<para>Dependency injection</para>
</listitem>
</itemizedlist>
- </section>
<section>
<title>How</title>
@@ -50,7 +46,7 @@
<section>
<title>Injection</title>
- <para>There are two ways to inject a dependency :</para>
+ <para>There are two ways to inject a dependency:</para>
<para>Using a constructor:</para>
Modified: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/kernel/jndi-naming.xml
===================================================================
--- jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/kernel/jndi-naming.xml 2012-03-06 08:54:13 UTC (rev 5809)
+++ jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/kernel/jndi-naming.xml 2012-03-06 09:57:22 UTC (rev 5810)
@@ -5,8 +5,9 @@
<?dbhtml filename="ch-jndi-naming.html"?>
<title>JNDI naming</title>
+ <para>This chapter provides you the basic knowledge about JNDI naming, such as, what it is, how it works and how it is used.</para>
- <section>
+ <section id="Kernel.JNDINaming.Prerequisites">
<title>Prerequisites</title>
<para>We need to configure JNDI environment properties and Reference
@@ -29,7 +30,7 @@
</itemizedlist></para>
</section>
- <section>
+ <section id="Kernel.JNDINaming.How_it_works">
<title>How it works</title>
<para>Make sure you understand the <ulink
@@ -77,7 +78,7 @@
<para>and others (see JNDI docs)</para>
</section>
- <section>
+ <section id="Kernel.JNDINaming.JNDI_ref_binding">
<title>JNDI reference binding</title>
<para>Another responsibility of Context Initializer
@@ -112,7 +113,7 @@
</section>
</section>
- <section>
+ <section id="Kernel.JNDINaming.Configuration_examples">
<title>Configuration examples</title>
<para>The <envar>InitialContextInitializer</envar> configuration
@@ -187,7 +188,7 @@
</component-plugin></programlisting>
</section>
- <section>
+ <section id="Kernel.JNDINaming.Recommendations_for_application_developers">
<title>Recommendations for Application Developers</title>
<para><itemizedlist>
@@ -203,7 +204,7 @@
</itemizedlist></para>
</section>
- <section>
+ <section id="Kernel.JNDINaming.InitialContextInitializer">
<title>InitialContextInitializer API</title>
<para><envar>InitialContextInitalizer</envar> also provides feature of
Modified: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/kernel/job-scheduler-service.xml
===================================================================
--- jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/kernel/job-scheduler-service.xml 2012-03-06 08:54:13 UTC (rev 5809)
+++ jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/kernel/job-scheduler-service.xml 2012-03-06 09:57:22 UTC (rev 5810)
@@ -2,11 +2,8 @@
<!-- This document was created with Syntext Serna Free. --><!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" []>
<chapter id="Kernel.JobSchedulerService">
<?dbhtml filename="ch-job-scheduler-service.html"?> <title>Job Scheduler Service</title>
+ <para><emphasis role="bold">Job scheduler</emphasis> defines a job to execute a given number of times during a given period. It is a service that is in charge of unattended background executions, commonly known for historical reasons as batch processing. It is used to create and run jobs automatically and continuously, to schedule event-driven jobs and reports.</para>
<section>
- <title>What is Job Scheduler?</title>
- <para><emphasis role="bold">Job scheduler</emphasis> defines a job to execute a given number of times during a given period. It is a service that is in charge of unattended background executions, commonly known for historical reasons as batch processing. It is used to create and run jobs automatically and continuously, to schedule event-driven jobs and reports.</para>
- </section>
- <section>
<title>Where is Job Scheduler Service used in eXo Products?</title>
<para>Job Scheduler Service is widely used in many eXo products such as Social, DMS, WCM, eXo Knowledge and eXo Collaboration.</para>
<para>In eXo products, Job Schedulers are used to do some tasks as below:</para>
Modified: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/kernel/kernel.xml
===================================================================
--- jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/kernel/kernel.xml 2012-03-06 08:54:13 UTC (rev 5809)
+++ jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/kernel/kernel.xml 2012-03-06 09:57:22 UTC (rev 5810)
@@ -1,24 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
-"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
-<chapter id="Kernel">
- <?dbhtml filename="ch-kernel.html"?>
-
- <title>eXo Kernel</title>
-
- <section>
- <title>eXo Kernel introduction</title>
-
- <para>eXo Kernel is the basis of all eXo platform products and modules.
- Any component available in eXo Platform is managed by the Exo Container,
- our micro container responsible for gluing the services through dependency
- injection</para>
-
- <para>Therefore, each product is composed of a set of services and plugins
- registered to the container and configured by XML configuration
- files.</para>
-
- <para>The Kernel module also contains a set of very low level
- services.</para>
- </section>
-</chapter>
Modified: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/kernel/listener-service.xml
===================================================================
--- jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/kernel/listener-service.xml 2012-03-06 08:54:13 UTC (rev 5809)
+++ jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/kernel/listener-service.xml 2012-03-06 09:57:22 UTC (rev 5810)
@@ -6,9 +6,6 @@
<title>ListenerService</title>
- <section>
- <title>Asynchronous Event Broadcast</title>
-
<para>Basicaly, ListenerService used to store Listeners and broadcast
events to them.</para>
@@ -16,7 +13,7 @@
destination listeners and executes event on those listeners.</para>
<para>But, some events may take a lot of time, so idea to make event
- processing asynchronous is usefull.</para>
+ processing asynchronous is useful.</para>
<blockquote>
What do I need to make my listener asynchronous?
@@ -53,5 +50,4 @@
</init-params>
</component></programlisting>
- </section>
</chapter>
Modified: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/kernel/logging.xml
===================================================================
--- jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/kernel/logging.xml 2012-03-06 08:54:13 UTC (rev 5809)
+++ jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/kernel/logging.xml 2012-03-06 09:57:22 UTC (rev 5810)
@@ -6,16 +6,13 @@
<title>Logs configuration</title>
- <section>
- <title>Introdution</title>
-
<para>In order to accommodate to the different target runtime where it can
be deployed, eXo is capable of leveraging several logging systems. eXo
lets you choose the underlying logging engine to use and even configure
that engine (as a quick alternative to doing it directly in your runtime
environment).</para>
- <para>The currently supported logging engines are : <itemizedlist>
+ <para>The currently supported logging engines are: <itemizedlist>
<listitem>
<para>Apache Log4J</para>
</listitem>
@@ -29,7 +26,6 @@
abstraction)</para>
</listitem>
</itemizedlist></para>
- </section>
<section>
<title>Logs configuration initializer</title>
Modified: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/kernel/manageability.xml
===================================================================
--- jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/kernel/manageability.xml 2012-03-06 08:54:13 UTC (rev 5809)
+++ jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/kernel/manageability.xml 2012-03-06 09:57:22 UTC (rev 5810)
@@ -6,9 +6,6 @@
<title>Manageability</title>
- <section>
- <title>Introduction</title>
-
<para>The kernel has a framework for exposing a management view of the
various sub systems of the platform. The management view is a lose term
for defining how we can access relevant information about the system and
@@ -20,7 +17,6 @@
framework is still in use but is deprecated in favor of the new framework
as it is less tested and less efficient. It will be removed by
sanitization in the future.</para>
- </section>
<section>
<title>Managed framework API</title>
Modified: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/kernel/rpc-service.xml
===================================================================
--- jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/kernel/rpc-service.xml 2012-03-06 08:54:13 UTC (rev 5809)
+++ jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/kernel/rpc-service.xml 2012-03-06 09:57:22 UTC (rev 5810)
@@ -6,15 +6,12 @@
<title>RPC Service</title>
- <section>
- <title>Description</title>
-
<para>The <emphasis>RPCService</emphasis> is only needed in a cluser
environment, it is used to communicate with the other cluster nodes. It
allows to execute a command on all the cluster nodes or on the coordinator
i.e. the oldest node in the cluster. The <emphasis>RPCService</emphasis>
- has been designed to rely on JGroups capabilites and should not be used
- for heavy load. It can be used for example to notify other nodes that
+ has been designed to rely on JGroups capabilities and should not be used
+ for heavy load. It can be used, for example, to notify other nodes that
something happened or to collect some information from the other
nodes.</para>
@@ -112,7 +109,7 @@
}
}</programlisting>
- <para>In the previous example, We register the command
+ <para>In the previous example, we register the command
<emphasis>sayHelloCommand</emphasis> in the constructor of
<emphasis>MyService</emphasis> and we execute this command in the start
method.</para>
@@ -122,7 +119,6 @@
<emphasis>PortalContainer</emphasis> in a portal mode and only one
<emphasis>RPCService</emphasis> instance in a standalone mode</para>
</note>
- </section>
<section>
<title>Configuration</title>
Modified: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/kernel/service-configuration-for-beginners.xml
===================================================================
--- jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/kernel/service-configuration-for-beginners.xml 2012-03-06 08:54:13 UTC (rev 5809)
+++ jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/kernel/service-configuration-for-beginners.xml 2012-03-06 09:57:22 UTC (rev 5810)
@@ -5,6 +5,13 @@
<?dbhtml filename="ch-service-configuration-for-beginners.html"?>
<title>Service Configuration for Beginners</title>
+ <para>This chapter provides you the basic knowledge
+ about modes, services and containers. You will find out where the service
+ configuration files should be placed, and you will also see the overriding
+ mechanism of configurations. </para>
+ <para>Finally, you will understand how the container
+ creates the services one after the other and what <emphasis>Inversion of
+ Control</emphasis> really means.</para>
<para><emphasis role="bold">Related documents</emphasis></para>
@@ -26,17 +33,6 @@
</itemizedlist>
<section>
- <title>Objective</title>
-
- <para>We are going to talk about service configuration. You will learn
- about modes, services and containers, you will find out where the service
- configuration files have to be placed and you will also see the overriding
- mechanism of configurations. Finally you will understand how the container
- creates the services one after the other and what <emphasis>Inversion of
- Control</emphasis> really means.</para>
- </section>
-
- <section>
<title>Requirements</title>
<para>By reading this article you are already glancing at the heart of eXo
@@ -551,7 +547,7 @@
problems to be expected. That's easy.</para>
<para>But now look at <ulink
- url="https://anonsvn.jboss.org/repos/exo-jcr/core/trunk/exo.core.component.organization.jdbc/src/main/java/org/exoplatform/services/organization/jdbc/OrganizationServiceImpl.java">https://anonsvn.jboss.org/repos/exo-jcr/core/trunk/exo.core.component.organization.jdbc/src/main/java/org/exoplatform/services/organization/jdbc/OrganizationServiceImpl.java</ulink></para>
+ url="https://anonsvn.jboss.org/repos/exo-jcr/core/trunk/exo.core.component.organization.jdbc/src/main/java/org/exoplatform/services/organization/jdbc/OrganizationServiceImpl.java">OrganizationServiceImpl.java</ulink></para>
<para>This JDBC implementation of BaseOrganizationService interface has
only one constructor:</para>
@@ -575,10 +571,10 @@
<note>
<para>What happens if one service has more than one constructor? The
- container always tries first to use the constructor with a maximum of
- arguments, if this is not possible the container continues step by step
+ container always tries first to use the constructor with a maximum number
+ of arguments, if this is not possible the container continues step by step
with constructors that have less arguments until arriving at the
- zero-argument constructor (if there is one).</para>
+ zero-argument constructor (if there is any).</para>
</note>
</section>
@@ -599,7 +595,7 @@
<section>
<title>Inversion of Control</title>
- <para><emphasis role="bold">Retrospection</emphasis> Do you remember
+ <para><emphasis role="bold">Retrospection</emphasis>. Do you remember
your last project where you had some small components and several larger
services? How was this organized? Some services had their own
configuration files, others had static values in the source code. Most
@@ -626,7 +622,7 @@
</listitem>
</itemizedlist>
- <para><emphasis role="bold">New Approach</emphasis> You have seen that
+ <para><emphasis role="bold">New Approach</emphasis>. You have seen that
eXo uses the <emphasis>Inversion of Control</emphasis> (IoC) pattern
which means that the control of the services is given to an independent
outside entity, in this case a <emphasis>container</emphasis>. Now the
@@ -651,7 +647,7 @@
</listitem>
</itemizedlist>
- <para><emphasis role="bold">Dependency Injection</emphasis> You also saw
+ <para><emphasis role="bold">Dependency Injection</emphasis>. You also saw
two types of dependency injections:</para>
<itemizedlist>
@@ -755,7 +751,7 @@
<section>
<title>Further Reading</title>
- <para>Do you feel an expert now? Not yet. Get a deeper look and read this
+ <para>Do you feel yourself to be an expert now? Not yet? Get a deeper look and read this
<link linkend="Kernel.ServicesWiring">Services Wiring</link> article. You
read so much about configuration, that you should wonder what the <link
linkend="Kernel.ContainerConfiguration.ConfigurationNamespace">XML Schema
Modified: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/kernel/service-configuration-in-detail.xml
===================================================================
--- jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/kernel/service-configuration-in-detail.xml 2012-03-06 08:54:13 UTC (rev 5809)
+++ jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/kernel/service-configuration-in-detail.xml 2012-03-06 09:57:22 UTC (rev 5810)
@@ -5,6 +5,15 @@
<?dbhtml filename="ch-service-configuration-in-detail.html"?>
<title>Service Configuration in Detail</title>
+
+ <para>This chapter shows you how to set up a sample service with some
+ configurations and how to access the configuration parameters. The
+ later sections describe all details of the configuration file (parameters,
+ object-params, plugins, imports, and more). It also shows how to access the
+ configuration values. You may consider this document as a <emphasis
+ role="bold">reference</emphasis>, but you can also use this document as a
+ <emphasis role="bold">tutorial</emphasis> and read it from the beginning
+ to the end.</para>
<para><emphasis role="bold">Related documents</emphasis></para>
@@ -27,19 +36,6 @@
</itemizedlist>
<section>
- <title>Objectives</title>
-
- <para>This article shows how to setup a sample service with some
- configurations and how to access to the configuration parameters. The
- later chapters describe all details of the configuration file (parameters,
- object-params, plugins, imports, etc.), it also shows how to access the
- configuration values. You may consider this article as a <emphasis
- role="bold">reference</emphasis>, but you can also use this article as a
- <emphasis role="bold">tutorial</emphasis> and read it from the beginning
- to the end.</para>
- </section>
-
- <section>
<title>Requirements</title>
<para>You should have read and understood <link
@@ -128,7 +124,7 @@
<title>Init Parameters</title>
<para>You see your service has a configuration file, but you wonder how
- the file could possibly access to its configuration. Imagine that you
+ the file can gain access to its configuration. Imagine that you
are asked to implement two different calculation methods: fast and
exact.</para>
@@ -159,7 +155,7 @@
role="bold">totally free</emphasis>. You can provide as many <emphasis
role="bold">value-param</emphasis>, <emphasis
role="bold">property-param</emphasis>, and <emphasis
- role="bold">properties</emphasis> you wish and you can give them any
+ role="bold">properties</emphasis> as you wish, and you can give them any
names or values. You only must respect the xml structure.</para>
</note>
@@ -431,7 +427,7 @@
</itemizedlist>
<para>Have a look on this type test xml file: <ulink
- url="https://anonsvn.jboss.org/repos/exo-jcr/kernel/trunk/exo.kernel.container/src/test/resources/object.xml">https://anonsvn.jboss.org/repos/exo-jcr/kernel/trunk/exo.kernel.container/src/test/resources/object.xml</ulink>.</para>
+ url="https://anonsvn.jboss.org/repos/exo-jcr/kernel/trunk/exo.kernel.container/src/test/resources/object.xml">object.xml</ulink>.</para>
</section>
<section>
Modified: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/kernel/services-wiring.xml
===================================================================
--- jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/kernel/services-wiring.xml 2012-03-06 08:54:13 UTC (rev 5809)
+++ jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/kernel/services-wiring.xml 2012-03-06 09:57:22 UTC (rev 5810)
@@ -6,9 +6,6 @@
<title id="KernelServicesWiring.Title">Services Wiring</title>
- <section>
- <title>Overview</title>
-
<para>The container package is responsible of building a hierarchy of
containers. Each service will then be registered in one container or the
other according to the XML configuration file it is defined in. It is
@@ -34,8 +31,7 @@
There are three configuration.xml files, one for each container type. In
that XML file, we define the list of services and their init parameters
that will be loaded in the corresponding container.</para>
- </section>
-
+
<section>
<title>Portal Instance</title>
Modified: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/kernel/transaction-service.xml
===================================================================
--- jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/kernel/transaction-service.xml 2012-03-06 08:54:13 UTC (rev 5809)
+++ jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/kernel/transaction-service.xml 2012-03-06 09:57:22 UTC (rev 5810)
@@ -6,9 +6,6 @@
<title>TransactionService</title>
- <section>
- <title>Base information</title>
-
<para>TransactionServices provides access to the TransactionManager and
the UserTransaction (See JTA specification for details).</para>
@@ -55,7 +52,6 @@
</tbody>
</tgroup>
</table>
- </section>
<section>
<title>Existing TransactionService implementations</title>
Modified: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/kernel/understanding-listnerservice.xml
===================================================================
--- jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/kernel/understanding-listnerservice.xml 2012-03-06 08:54:13 UTC (rev 5809)
+++ jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/kernel/understanding-listnerservice.xml 2012-03-06 09:57:22 UTC (rev 5810)
@@ -5,6 +5,8 @@
<?dbhtml filename="ch-understanding-listeners-service.html"?>
<title>Understanding the ListenerService</title>
+ <para>This chapter will first describe how the ListenerService works and
+ then it will show you how to configure the ListenerService.</para>
<para><emphasis role="bold">Related documents</emphasis></para>
@@ -26,13 +28,6 @@
</itemizedlist>
<section>
- <title>Objectives</title>
-
- <para>This article will first describe how the ListenerService works and
- then it will show you how to configure the ListenerService.</para>
- </section>
-
- <section>
<title>What is the ListenerService ?</title>
<para>Inside eXo, an event mechanism allows to trigger and listen to
Modified: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/kernel.xml
===================================================================
--- jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/kernel.xml 2012-03-06 08:54:13 UTC (rev 5809)
+++ jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/kernel.xml 2012-03-06 09:57:22 UTC (rev 5810)
@@ -6,9 +6,18 @@
<title>eXoKernel</title>
- <xi:include href="kernel/kernel.xml"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <para>eXo Kernel is the basis of all eXo platform products and modules.
+ Any component available in eXo Platform is managed by the Exo Container,
+ our micro container responsible for gluing the services through dependency
+ injection</para>
+
+ <para>Therefore, each product is composed of a set of services and plugins
+ registered to the container and configured by XML configuration
+ files.</para>
+ <para>The Kernel module also contains a set of very low level
+ services.</para>
+
<xi:include href="kernel/exo-container.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
Modified: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/ws/framework-for-cross-domain-ajax.xml
===================================================================
--- jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/ws/framework-for-cross-domain-ajax.xml 2012-03-06 08:54:13 UTC (rev 5809)
+++ jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/ws/framework-for-cross-domain-ajax.xml 2012-03-06 09:57:22 UTC (rev 5810)
@@ -5,11 +5,12 @@
<?dbhtml filename="ch-framework-for-cross-domain-ajax.html"?>
<title>Framework for cross-domain AJAX</title>
+ <para>eXo Webservice provides a framework to cross-domain AJAX. This chapter shows you how to use this framework.</para>
- <para>(<ulink
- url="https://anonsvn.jboss.org/repos/exo-jcr/ws/trunk/exo.ws.frameworks.javascript.cross-domain-ajax">https://anonsvn.jboss.org/repos/exo-jcr/ws/trunk/exo.ws.frameworks.javascript.cross-domain-ajax</ulink>)</para>
+ <para>You can checkout the source code at <ulink
+ url="https://anonsvn.jboss.org/repos/exo-jcr/ws/trunk/exo.ws.frameworks.javascript.cross-domain-ajax">https://anonsvn.jboss.org/repos/exo-jcr/ws/trunk/exo.ws.frameworks.javascript.cross-domain-ajax</ulink>.</para>
- <section>
+ <section id="WS.CrossDomainAJAX.Motivation">
<title>Motivation</title>
<para>XmlHttpRequest objects are bound by the same origin security policy
@@ -32,7 +33,7 @@
limitation of AJAX.</para>
</section>
- <section>
+ <section id="WS.CrossDomainAJAX.Scheme">
<title>Scheme (how it works)</title>
<para>To describe our method for cross-domain AJAX solution, let's
@@ -57,7 +58,7 @@
</mediaobject>
</section>
- <section>
+ <section id="WS.CrossDomainAJAX.Working_Sequence">
<title>A Working Sequence:</title>
<para>1) A Browser requests the Start page from the ServerA</para>
@@ -83,7 +84,7 @@
information that we want.</para>
</section>
- <section>
+ <section id="WS.CrossDomainAJAX.How_to_Use_it">
<title>How to use it</title>
<para>1). Place the file client.html and xda.js on the serverA.</para>
Modified: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/ws/groovy-scripts-as-rest-services.xml
===================================================================
--- jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/ws/groovy-scripts-as-rest-services.xml 2012-03-06 08:54:13 UTC (rev 5809)
+++ jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/ws/groovy-scripts-as-rest-services.xml 2012-03-06 09:57:22 UTC (rev 5810)
@@ -6,12 +6,9 @@
<title>Groovy Scripts as REST Services</title>
- <section>
- <title>Overview</title>
+ <para>This chapter describes how to use Groovy scripts as REST services.
+ Consider these operations:</para>
- <para>This article describes how to use Groovy scripts as REST services.
- We are going to consider these operations:</para>
-
<itemizedlist>
<listitem>
<para>Load script and save it in JCR.</para>
@@ -22,7 +19,7 @@
</listitem>
<listitem>
- <para>Deploy newly created Class as RESTful service.</para>
+ <para>Deploy a newly created Class as RESTful service.</para>
</listitem>
<listitem>
@@ -30,15 +27,13 @@
</listitem>
<listitem>
- <para>And finally we will discover simple example which can get JCR
+ <para>Finally, we will discover simple example which can get JCR
node UUID</para>
</listitem>
</itemizedlist>
- <para>In this article, we consider RESTful service compatible with JSR-311
- specification. Currently last feature available in version 1.11-SNAPSHOT
- of JCR, 2.0-SNAPSHOT of WS and version 2.1.4-SNAPSHOT of core.</para>
- </section>
+ <para>In this chapter, we consider RESTful service to be compatible with JSR-311
+ specification. The last feature is currently available in version 1.11-SNAPSHOT.</para>
<section>
<title>Loading script and save it in JCR</title>
Modified: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/ws/introduction-to-rest.xml
===================================================================
--- jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/ws/introduction-to-rest.xml 2012-03-06 08:54:13 UTC (rev 5809)
+++ jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/ws/introduction-to-rest.xml 2012-03-06 09:57:22 UTC (rev 5810)
@@ -6,9 +6,6 @@
<title>Introduction to the Representational State Transfer (REST)</title>
- <section>
- <title>Introduction</title>
-
<para><command>Representational State Transfer (REST)</command> is a style
of software architecture for distributed hypermedia systems such as the
World Wide Web. The term was introduced in the doctoral dissertation in
@@ -189,9 +186,9 @@
</listitem>
</itemizedlist>
- <para><command>Note</command>: RESTful architecture is not limited to
+ <note><para>RESTful architecture is not limited to
those methods, one of good examples of extension is the WebDAV
- protocol.</para>
+ protocol.</para></note>
<para>The <command>CRUD</command> (Create, Read, Update and Delete) verbs
are designed to operate with atomic data within the context of a database
@@ -207,6 +204,5 @@
<para>As a result, neither the client nor the server needs to remember any
communication-state between messages. Any state retained by the server
- must be modeled as a resource..</para>
- </section>
+ must be modeled as a resource.</para>
</chapter>
Modified: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/ws/overwrite-default-providers.xml
===================================================================
--- jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/ws/overwrite-default-providers.xml 2012-03-06 08:54:13 UTC (rev 5809)
+++ jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/ws/overwrite-default-providers.xml 2012-03-06 09:57:22 UTC (rev 5810)
@@ -4,9 +4,10 @@
<chapter id="WS.OverwriteDefaultProviders">
<?dbhtml filename="overwrite-default-providers.html"?>
- <title>OverwriteDefaultProviders</title>
+ <title>Overwrite default providers</title>
+ <para>This chapter will show you how to overwrite the default providers in eXo JAX-RS implementation.</para>
- <section>
+ <section id="WS.OverwriteDefaultProviders.Motivation">
<title>Motivation</title>
<para>There is set of providers embedded in eXo JAX-RS
@@ -136,7 +137,7 @@
services.</para>
</section>
- <section>
+ <section id="WS.OverwriteDefaultProviders.Usage">
<title>Usage</title>
<para>To be able overwrite default JAX-RS provider(s) developer
@@ -167,7 +168,7 @@
</orderedlist>
</section>
- <section>
+ <section id="WS.OverwriteDefaultProviders.Example">
<title>Example</title>
<para>In example below see how to use Jackson JSON provider instead of
Modified: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/ws/restservicelist-service.xml
===================================================================
--- jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/ws/restservicelist-service.xml 2012-03-06 08:54:13 UTC (rev 5809)
+++ jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/ws/restservicelist-service.xml 2012-03-06 09:57:22 UTC (rev 5810)
@@ -6,12 +6,9 @@
<title>RestServicesList Service</title>
- <section>
- <title>Overview.</title>
+ <para>RestServicesList service provides information about
+ REST services deployed to the application server.</para>
- <para>RestServicesList service is intendet to provide information about
- rest services deployed to the application server.</para>
-
<itemizedlist>
<listitem>
<para>Path - path to service</para>
@@ -27,7 +24,6 @@
</itemizedlist>
<para>The list can be provided in two formats: HTML and JSON.</para>
- </section>
<section>
<title>Usage</title>
@@ -55,8 +51,9 @@
<para>To do this, perform a simple GET request to the RestServicesList
link.</para>
- <para>f.e. curl -u root:exo http://localhost:8080/rest/ will return such
- HTML code:</para>
+ <para>f.e. curl -u root:exo http://localhost:8080/rest/ will return such
+ HTML code:
+ </para>
<programlisting language="xml"><?xml version="1.0" encoding="UTF-8"?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
Modified: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/ws/ws.xml
===================================================================
--- jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/ws/ws.xml 2012-03-06 08:54:13 UTC (rev 5809)
+++ jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/ws/ws.xml 2012-03-06 09:57:22 UTC (rev 5810)
@@ -1,19 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
-"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
-<chapter id = "WS">
- <?dbhtml filename="ch-ws.html"?>
-
- <title>eXo Web Services</title>
-
- <section>
- <title>eXo Web Services introduction</title>
-
- <para>The Web Services module allows eXo technology to integrate with
- external products and services.</para>
-
- <para>It's implementaion of API for RESTful Web Services with extensions,
- Servlet and cross-domain AJAX web-frameworks and JavaBean-JSON
- transformer.</para>
- </section>
-</chapter>
Modified: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/ws.xml
===================================================================
--- jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/ws.xml 2012-03-06 08:54:13 UTC (rev 5809)
+++ jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/ws.xml 2012-03-06 09:57:22 UTC (rev 5810)
@@ -6,15 +6,19 @@
<title>eXoWS</title>
- <xi:include href="ws/ws.xml"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <para>The Web Services module allows eXo technology to integrate with
+ external products and services.</para>
+
+ <para>It is implementation of API for RESTful Web Services with extensions,
+ Servlet and cross-domain AJAX web-frameworks and JavaBean-JSON
+ transformer.</para>
<xi:include href="ws/introduction-to-rest.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="ws/overwrite-default-providers.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
-
+
<xi:include href="ws/restservicelist-service.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
More information about the exo-jcr-commits
mailing list