Author: smumford Date: 2010-10-06 19:48:59 -0400 (Wed, 06 Oct 2010) New Revision: 4565 Added: epp/docs/branches/EPP_5_0_Branch/Reference_Guide/en-US/extras/Advanced_Development_JCR_Configuration/orig.xml epp/docs/branches/EPP_5_0_Branch/Reference_Guide/en-US/modules/Advanced/JCR/configuration.bk Modified: epp/docs/branches/EPP_5_0_Branch/Reference_Guide/en-US/modules/Advanced/JCR/configuration.xml epp/docs/branches/EPP_5_0_Branch/Reference_Guide/en-US/modules/Advanced/JCR/external-value-storages.xml Log: JBEPP-517: Corrected errors produced by xml cleanup Added: epp/docs/branches/EPP_5_0_Branch/Reference_Guide/en-US/extras/Advanced_Development_JCR_Configuration/orig.xml =================================================================== --- epp/docs/branches/EPP_5_0_Branch/Reference_Guide/en-US/extras/Advanced_Development_JCR_Configuration/orig.xml (rev 0) +++ epp/docs/branches/EPP_5_0_Branch/Reference_Guide/en-US/extras/Advanced_Development_JCR_Configuration/orig.xml 2010-10-06 23:48:59 UTC (rev 4565) @@ -0,0 +1,96 @@ +<repository-service default-repository="repository"> + <repositories> + <repository name="db1" system-workspace="ws" default-workspace="ws"> + <security-domain>exo-domain</security-domain> + <access-control>optional</access-control> + <session-max-age>1h</session-max-age> + <authentication-policy>org.exoplatform.services.jcr.impl.core.access.JAASAuthenticator</authentication-policy> + <workspaces> + <workspace name="production"> + <!-- for system storage --> + <container class="org.exoplatform.services.jcr.impl.storage.jdbc.optimisation.CQJDBCWorkspaceDataContainer"> + <properties> + <property name="source-name" value="jdbcjcr" /> + <property name="multi-db" value="false" /> + <property name="update-storage" value="false" /> + <property name="max-buffer-size" value="200k" /> + <property name="swap-directory" value="../temp/swap/production" /> + </properties> + <value-storages> + <value-storage id="system" class="org.exoplatform.services.jcr.impl.storage.value.fs.TreeFileValueStorage"> + <properties> + <property name="path" value="../temp/values/production" /> + </properties> + <filters> + <filter property-type="Binary" /> + </filters> + </value-storage> + </value-storages> + </container> + <initializer class="org.exoplatform.services.jcr.impl.core.ScratchWorkspaceInitializer"> + <properties> + <property name="root-nodetype" value="nt:unstructured" /> + </properties> + </initializer> + <cache enabled="true" class="org.exoplatform.services.jcr.impl.dataflow.persistent.LinkedWorkspaceStorageCacheImpl"> + <properties> + <property name="max-size" value="10k" /> + <property name="live-time" value="1h" /> + </properties> + </cache> + <query-handler class="org.exoplatform.services.jcr.impl.core.query.lucene.SearchIndex"> + <properties> + <property name="index-dir" value="../temp/jcrlucenedb/production" /> + </properties> + </query-handler> + <lock-manager> + <time-out>15m</time-out> + <persister class="org.exoplatform.services.jcr.impl.core.lock.FileSystemLockPersister"> + <properties> + <property name="path" value="../temp/lock/system" /> + </properties> + </persister> + </lock-manager> + </workspace> + + <workspace name="backup"> + <container class="org.exoplatform.services.jcr.impl.storage.jdbc.optimisation.CQJDBCWorkspaceDataContainer"> + <properties> + <property name="source-name" value="jdbcjcr" /> + <property name="multi-db" value="false" /> + <property name="update-storage" value="false" /> + <property name="max-buffer-size" value="200k" /> + <property name="swap-directory" value="../temp/swap/backup" /> + </properties> + <value-storages> + <value-storage id="draft" class="org.exoplatform.services.jcr.impl.storage.value.fs.TreeFileValueStorage"> + <properties> + <property name="path" value="../temp/values/backup" /> + </properties> + <filters> + <filter property-type="Binary" /> + </filters> + </value-storage> + </value-storages> + </container> + <initializer class="org.exoplatform.services.jcr.impl.core.ScratchWorkspaceInitializer"> + <properties> + <property name="root-nodetype" value="nt:unstructured" /> + </properties> + </initializer> + <cache enabled="true" class="org.exoplatform.services.jcr.impl.dataflow.persistent.LinkedWorkspaceStorageCacheImpl"> + <properties> + <property name="max-size" value="10k" /> + <property name="live-time" value="1h" /> + </properties> + </cache> + <query-handler class="org.exoplatform.services.jcr.impl.core.query.lucene.SearchIndex"> + <properties> + <property name="index-dir" value="../temp/jcrlucenedb/backup" /> + </properties> + </query-handler> + </workspace> + </workspaces> + </repository> + </repositories> +</repository-service> Added: epp/docs/branches/EPP_5_0_Branch/Reference_Guide/en-US/modules/Advanced/JCR/configuration.bk =================================================================== --- epp/docs/branches/EPP_5_0_Branch/Reference_Guide/en-US/modules/Advanced/JCR/configuration.bk (rev 0) +++ epp/docs/branches/EPP_5_0_Branch/Reference_Guide/en-US/modules/Advanced/JCR/configuration.bk 2010-10-06 23:48:59 UTC (rev 4565) @@ -0,0 +1,522 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent"> +%BOOK_ENTITIES; +]> +<section id="sect-Reference_Guide-JCR_configuration"> + <title>JCR configuration</title> + <para> + The JCR configuration is defined in an XML file which is constructed as per the DTD below: + </para> + +<programlisting language="Java" role="Java"><xi:include href="../../../extras/Advanced_Development_JCR_Configuration/NMTOKEN.java" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> + <para> + To configure the JCR Service; + </para> + <procedure> + <step> + <para> + Familiarize yourself with the DTD file above and the either the example configuration file below or the one in your &PRODUCT; deployment (found at; <filename>/<replaceable>JBOSS_AS</replaceable>/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/02portal.war/WEB-INF/conf/jcr/repository-configuration.xml</filename>). + </para> + </step> + <step> + <para> + Replace the element values marked below with those of your deployment environment. + </para> + </step> + <step> + <para> + The repository configuration supports human-readable values. They are not case-sensitive. + </para> + <para> + Complete the appropriate element fields using the following value formats: + </para> + <variablelist> + <varlistentry> + <term>Number formats:</term> + <listitem> + <para> + <itemizedlist> + <listitem> + <para> + <emphasis role="bold">K</emphasis> or <emphasis role="bold">KB</emphasis> for kiloBytes. + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">M</emphasis> or <emphasis role="bold">MB</emphasis> for megaBytes. + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">G</emphasis> or <emphasis role="bold">GB</emphasis> for gigaBytes. + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">T</emphasis> or <emphasis role="bold">TB</emphasis> for terraBytes. + </para> + </listitem> + <listitem> + <para> + Examples: 200k or 200 KBytes; 4m or 4 MBytes; 1.4G or 1.4 GBytes; 10T or 10 TBytes + </para> + </listitem> + </itemizedlist> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Time formats:</term> + <listitem> + <para> + <itemizedlist> + <listitem> + <para> + <emphasis role="bold">ms</emphasis> for milliseconds. + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">s</emphasis> for seconds. + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">m</emphasis> for minutes. + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">h</emphasis> for hours. + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">d</emphasis> for days. + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">w</emphasis> for weeks. + </para> + </listitem> + <listitem> + <para> + The default time format is seconds if no other format is specified. + </para> + </listitem> + <listitem> + <para> + Examples: 500ms or 500 milliseconds; 20, 20s or 20 seconds; 30m or 30 minutes; 12h or 12 hours; 5d or 5 days; 4w or 4 weeks. + </para> + </listitem> + </itemizedlist> + </para> + </listitem> + </varlistentry> + </variablelist> + </step> + </procedure> + + <section id="sect-Reference_Guide-JCR_configuration-Repository_Service_Configuration"> + <title>Repository Service Configuration</title> + <para> + Below is an example <filename>repository-configuration.xml</filename> file: + </para> + <note> + <title>Code Samples</title> + <para> + For ease of reference the file below has been broken into two separate code samples, however the file itself is continuous. + </para> + </note> + <formalpara id="form-Reference_Guide-Repository_Service_Configuration-repository_configuration.xml_Part_1"> + <title><filename>repository-configuration.xml</filename> Part 1</title> + <para> + <!-- repository-configuration.xml Part 1 --> + <programlistingco> + <areaspec> + <!-- a1 --><area coords="1 60" id="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-default-repository" /> + <!-- a2 --><area coords="2 60" id="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-repositories" /> + <!-- a3 --><area coords="3 80" id="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-name" /> + <!-- a4 --><area coords="3 85" id="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-system-workspace" /> + <!-- a5 --><area coords="3 90" id="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-default-workspace" /> + <!-- a6 --><area coords="4 60" id="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-security-domain" /> + <!-- a7 --><area coords="5 60" id="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-access-control" /> + <!-- a8 --><area coords="6 60" id="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-session-max-age" /> + <!-- a9 --><area coords="7 100" id="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-authentication-policy" /> + <!-- a10 --><area coords="8 60" id="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-workspaces" /> + <!-- a11 --><area coords="9 60" id="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-workspace-name" /> + <!-- a12 --><area coords="11 90" id="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-container" /> + <!-- a13 --><area coords="30 90" id="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_initializer" /> + <!-- a14 --><area coords="35 60" id="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_cache" /> + <!-- a15 --><area coords="41 100" id="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_query-handler" /> + <!-- a16 --><area coords="47 60" id="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_lock-manager-timeout" /> + <!-- a17 --><area coords="48 100" id="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_lock-manager-persister" /> + <!-- a18 --><area coords="50 90" id="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_lock-manager-path" /> + </areaspec> + +<programlisting language="XML" role="XML"><xi:include href="../../../extras/Advanced_Development_JCR_Configuration/default24.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> + <calloutlist id="call-Reference_Guide-repository_configuration.xml_Part_1-Repository_Service_configuration"> + <title>Repository Service configuration:</title> + <!-- a1 --> + <callout arearefs="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-default-repository"> + <para> + The name of a default repository (one returned by RepositoryService.getRepository()) + </para> + </callout> + <!-- a2 --> + <callout arearefs="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-repositories"> + <para> + The list of repositories is configured within the &#60;repositories&#62; element. + </para> + </callout> + </calloutlist> + <calloutlist id="call-Reference_Guide-repository_configuration.xml_Part_1-Repository_configuration"> + <title>Repository configuration:</title> + <!-- a3 --> + <callout arearefs="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-name"> + <para> + The name of the repository being configured. + </para> + </callout> + <!-- a4 --> + <callout arearefs="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-default-workspace"> + <para> + The name of a workspace. This can be obtained using Session&#39;s <literal>login()</literal> or <literal>login(Credentials)</literal> methods for workspaces without an explicit name. + </para> + </callout> + <!-- a5 --> + <callout arearefs="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-system-workspace"> + <para> + The name of workspace where /jcr:system node is placed. + </para> + </callout> + <!-- a6 --> + <callout arearefs="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-security-domain"> + <para> + The name of a security domain for JAAS authentication + </para> + </callout> + <!-- a7 --> + <callout arearefs="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-access-control"> + <para> + The name of an access control policy. There can be three types: + </para> + <variablelist> + <varlistentry> + <term>optional</term> + <listitem> + <para> + AN ACL is created on demand. This is the default policy. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>disable</term> + <listitem> + <para> + Disables access control. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>mandatory</term> + <listitem> + <para> + An ACL is created for each added node. This function is not supported in this release. + </para> + </listitem> + </varlistentry> + </variablelist> + </callout> + <!-- a8 --> + <callout arearefs="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-session-max-age"> + <para> + The amount of time before an idle session will be removed (called logout). If it is not set, the idle session will never be removed. + </para> + </callout> + <!-- a9 --> + <callout arearefs="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-authentication-policy"> + <para> + The name of an authentication policy class. + </para> + </callout> + <!-- a10 --> + <callout arearefs="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-workspaces"> + <para> + The list of workspaces. + </para> + </callout> + </calloutlist> + <calloutlist id="call-Reference_Guide-repository_configuration.xml_Part_1-Workspace_configuration"> + <title>Workspace configuration:</title> + <!-- a11 --> + <callout arearefs="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-workspace-name"> + <para> + The name of the workspace. + </para> + </callout> + <!-- a12 --> + <callout arearefs="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-container"> + <para> + Workspace data container (physical storage) configuration. + </para> + </callout> + <!-- a13 --> + <callout arearefs="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_initializer"> + <para> + Workspace initializer configuration. + </para> + </callout> + <!-- a14 --> + <callout arearefs="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_cache"> + <para> + Workspace storage cache configuration. + </para> + </callout> + <!-- a15 --> + <callout arearefs="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_query-handler"> + <para> + Query handler configuration. + </para> + </callout> + </calloutlist> + <calloutlist id="call-Reference_Guide-repository_configuration.xml_Part_1-Lock_Manager_configuration"> + <title>Lock Manager configuration:</title> + <!-- a16 --> + <callout arearefs="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_lock-manager-timeout"> + <para> + The amount of time before the unused global lock is removed. + </para> + </callout> + <!-- a17 --> + <callout arearefs="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_lock-manager-persister"> + <para> + A class for storing lock information for future use. For example; remove lock after restarting JCR. + </para> + </callout> + <!-- a18 --> + <callout arearefs="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_lock-manager-path"> + <para> + Each workspace has its own lock folder. + </para> + </callout> + </calloutlist> + </programlistingco> + </para> + </formalpara> + <formalpara id="form-Reference_Guide-Repository_Service_Configuration-repository_configuration.xml_Part_2"> + <title><filename>repository-configuration.xml</filename> Part 2</title> + <para> + <!-- repository-configuration.xml Part 2 --> + <programlistingco> + <areaspec> + <!-- b1 --><area coords="2 110" id="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_workspace-container-class" /> + <!-- b2 --><area coords="3 60" id="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_workspace-container-properties" /> + <!-- b3 --><area coords="10 60" id="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_workspace-container-value-storages" /> + <!-- b4 --><area coords="11 90" id="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_workspace-container-value-storage" /> + <!-- b5 --><area coords="11 95" id="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_workspace-container-value-class" /> + <!-- b6 --><area coords="12 60" id="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_workspace-container-value-properties" /> + <!-- b7 --><area coords="15 60" id="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_workspace-container-value-filters" /> + <!-- b8 --><area coords="21 90" id="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_initializer_implementation_class" /> + <!-- b9 --><area coords="22 60" id="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_initializer_implementation_properties" /> + <!-- b10 --><area coords="26 90" id="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_cache_enabled" /> + <!-- b11 --><area coords="26 95" id="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_cache_class" /> + <!-- b12 --><area coords="27 60" id="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_cache_properties" /> + <!-- b13 --><area coords="32 100" id="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_query-handler-class" /> + <!-- b14 --><area coords="33 60" id="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_query-handler-properties" /> + </areaspec> + +<programlisting language="XML" role="XML"><xi:include href="../../../extras/Advanced_Development_JCR_Configuration/default25.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> + <calloutlist id="call-Reference_Guide-repository_configuration.xml_Part_2-Workspace_data_container_configuration"> + <title>Workspace data container configuration:</title> + <!-- b1 --> + <callout arearefs="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_workspace-container-class"> + <para> + A workspace data container class name. + </para> + </callout> + <!-- b2 --> + <callout arearefs="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_workspace-container-properties"> + <para> + The list of properties (in name-value pairs) for the concrete Workspace data container. + </para> + </callout> + <!-- b3 --> + <callout arearefs="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_workspace-container-value-storages"> + <para> + The list of value storage plugins. + </para> + </callout> + </calloutlist> + <calloutlist id="call-Reference_Guide-repository_configuration.xml_Part_2-Value_storage_plugin_configuration_optional_feature"> + <title>Value storage plugin configuration (optional feature):</title> + <!-- b4 --> + <callout arearefs="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_workspace-container-value-storage"> + <para> + <emphasis role="bold">Optional</emphasis>: Value storage plugin definition. If this element is not included, the values will be stored as BLOBs inside the database. + </para> + </callout> + <!-- b5 --> + <callout arearefs="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_workspace-container-value-class"> + <para> + A value storage plugin class name (attribute). + </para> + </callout> + <!-- b6 --> + <callout arearefs="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_workspace-container-value-properties"> + <para> + The list of properties (in name-value pairs) for a concrete value storage plugin. + </para> + </callout> + <!-- b7 --> + <callout arearefs="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_workspace-container-value-filters"> + <para> + The list of filters defining conditions when this plugin is applicable. + </para> + </callout> + </calloutlist> + <calloutlist id="call-Reference_Guide-repository_configuration.xml_Part_2-Initializer_configuration_optional"> + <title>Initializer configuration (optional):</title> + <!-- b8 --> + <callout arearefs="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_initializer_implementation_class"> + <para> + Initializer implementation class. + </para> + </callout> + <!-- b9 --> + <callout arearefs="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_initializer_implementation_properties"> + <para> + The list of properties (in name-value pairs). Properties are supported: + </para> + <variablelist> + <varlistentry> + <term>root-nodetype</term> + <listitem> + <para> + The node type for root node initialization. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>root-permissions</term> + <listitem> + <para> + Default permissions of the root node. It is defined as a set of semicolon-delimited permissions containing a group of space-delimited identities and the type of permission. + </para> + <para> + For example any read;:/admin read;:/admin add_node;:/admin set_property;:/admin remove means that users from group admin have all permissions and other users have only a &#39;read&#39; permission. + </para> + <para> + Configurable initializer adds a capability to override workspace initial startup procedure. + </para> + </listitem> + </varlistentry> + </variablelist> + </callout> + </calloutlist> + <calloutlist id="call-Reference_Guide-repository_configuration.xml_Part_2-Cache_configuration"> + <title>Cache configuration:</title> + <!-- b10 --> + <callout arearefs="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_cache_enabled"> + <para> + Defines if the workspace cache is enabled. + </para> + </callout> + <!-- b11 --> + <callout arearefs="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_cache_class"> + <para> + Cache implementation class. This is optional from JCR version 1.9. + </para> + <para> + The default value is <literal>org.exoplatform.services.jcr.impl.dataflow.persistent.LinkedWorkspaceStorageCacheImpl</literal>. + </para> + <para> + The cache can be configured to use concrete implementations of the <literal>WorkspaceStorageCache</literal> interface. + </para> + <para> + The JCR core has two implementations to use: + </para> + <para> + <emphasis role="bold">LinkedWorkspaceStorageCacheImpl</emphasis> + </para> + <para> + The default implementation, with configurable read behavior and statistics. + </para> + <para> + <emphasis role="bold">WorkspaceStorageCacheImpl</emphasis> + </para> + <para> + This implementation is a legacy from pre 1.9 versions of the JCR. However, it can still be used. + </para> + </callout> + <!-- b12 --> + <callout arearefs="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_cache_properties"> + <para> + The list of properties (in name-value pairs) for the workspace cache: + </para> + <variablelist> + <varlistentry> + <term>max-size</term> + <listitem> + <para> + The maximum size of the cache. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>live-time</term> + <listitem> + <para> + Cached item live time. + </para> + </listitem> + </varlistentry> + </variablelist> + </callout> + </calloutlist> + <calloutlist id="call-Reference_Guide-repository_configuration.xml_Part_2-Query_Handler_configuration"> + <title>Query Handler configuration:</title> + <!-- b13 --> + <callout arearefs="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_query-handler-class"> + <para> + A Query Handler class name. + </para> + </callout> + <!-- b14 --> + <callout arearefs="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_query-handler-properties"> + <para> + The list of properties (name-value pairs) for a Query Handler (<literal>indexDir</literal>) properties and advanced features described in <xref linkend="sect-Reference_Guide-Search_Configuration" />. + </para> + </callout> + </calloutlist> + </programlistingco> + </para> + </formalpara> + </section> + + + <section id="sect-Reference_Guide-JCR_configuration-Related_Sections"> + <title>Related Sections</title> + <itemizedlist> + <listitem> + <para> + <xref linkend="sect-Reference_Guide-Search_Configuration" /> + </para> + </listitem> + <listitem> + <para> + <xref linkend="sect-Reference_Guide-JDBC_Data_Container_Config" /> + </para> + </listitem> + <listitem> + <para> + <xref linkend="sect-Reference_Guide-External_Value_Storages" /> + </para> + </listitem> + </itemizedlist> + </section> + +</section> + Modified: epp/docs/branches/EPP_5_0_Branch/Reference_Guide/en-US/modules/Advanced/JCR/configuration.xml =================================================================== --- epp/docs/branches/EPP_5_0_Branch/Reference_Guide/en-US/modules/Advanced/JCR/configuration.xml 2010-10-06 23:24:30 UTC (rev 4564) +++ epp/docs/branches/EPP_5_0_Branch/Reference_Guide/en-US/modules/Advanced/JCR/configuration.xml 2010-10-06 23:48:59 UTC (rev 4565) @@ -1,439 +1,418 @@ <?xml version='1.0' encoding='utf-8' ?> <!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ -<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent"> +<!ENTITY % BOOK_ENTITIES SYSTEM "../../../Reference_Guide.ent"> %BOOK_ENTITIES; ]> <section id="sect-Reference_Guide-JCR_configuration"> <title>JCR configuration</title> - <para> - The JCR configuration is defined in an XML file which is constructed as per the DTD below: - </para> - -<programlisting language="Java" role="Java"><xi:include href="../../../extras/Advanced_Development_JCR_Configuration/NMTOKEN.java" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> - <para> - To configure the JCR Service; - </para> - <procedure> - <step> - <para> - Familiarize yourself with the DTD file above and the either the example configuration file below or the one in your &PRODUCT; deployment (found at; <filename>/<replaceable>JBOSS_AS</replaceable>/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/02portal.war/WEB-INF/conf/jcr/repository-configuration.xml</filename>). - </para> - </step> - <step> - <para> - Replace the element values marked below with those of your deployment environment. - </para> - </step> - <step> - <para> - The repository configuration supports human-readable values. They are not case-sensitive. - </para> - <para> - Complete the appropriate element fields using the following value formats: - </para> - <variablelist> - <varlistentry> - <term>Number formats:</term> - <listitem> - <para> - <itemizedlist> - <listitem> - <para> - <emphasis role="bold">K</emphasis> or <emphasis role="bold">KB</emphasis> for kiloBytes. - </para> - </listitem> - <listitem> - <para> - <emphasis role="bold">M</emphasis> or <emphasis role="bold">MB</emphasis> for megaBytes. - </para> - </listitem> - <listitem> - <para> - <emphasis role="bold">G</emphasis> or <emphasis role="bold">GB</emphasis> for gigaBytes. - </para> - </listitem> - <listitem> - <para> - <emphasis role="bold">T</emphasis> or <emphasis role="bold">TB</emphasis> for terraBytes. - </para> - </listitem> - <listitem> - <para> - Examples: 200k or 200 KBytes; 4m or 4 MBytes; 1.4G or 1.4 GBytes; 10T or 10 TBytes - </para> - </listitem> - </itemizedlist> - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>Time formats:</term> - <listitem> - <para> - <itemizedlist> - <listitem> - <para> - <emphasis role="bold">ms</emphasis> for milliseconds. - </para> - </listitem> - <listitem> - <para> - <emphasis role="bold">s</emphasis> for seconds. - </para> - </listitem> - <listitem> - <para> - <emphasis role="bold">m</emphasis> for minutes. - </para> - </listitem> - <listitem> - <para> - <emphasis role="bold">h</emphasis> for hours. - </para> - </listitem> - <listitem> - <para> - <emphasis role="bold">d</emphasis> for days. - </para> - </listitem> - <listitem> - <para> - <emphasis role="bold">w</emphasis> for weeks. - </para> - </listitem> - <listitem> - <para> - The default time format is seconds if no other format is specified. - </para> - </listitem> - <listitem> - <para> - Examples: 500ms or 500 milliseconds; 20, 20s or 20 seconds; 30m or 30 minutes; 12h or 12 hours; 5d or 5 days; 4w or 4 weeks. - </para> - </listitem> - </itemizedlist> - </para> - </listitem> - </varlistentry> - </variablelist> - </step> - </procedure> - - <section id="sect-Reference_Guide-JCR_configuration-Repository_Service_Configuration"> - <title>Repository Service Configuration</title> <para> - Below is an example <filename>repository-configuration.xml</filename> file: + The JCR configuration is defined in an XML file which is constructed as per the DTD below: </para> - <note> - <title>Code Samples</title> - <para> - For ease of reference the file below has been broken into two separate code samples, however the file itself is continuous. - </para> - </note> - <formalpara id="form-Reference_Guide-Repository_Service_Configuration-repository_configuration.xml_Part_1"> - <title><filename>repository-configuration.xml</filename> Part 1</title> - <para> - <!-- repository-configuration.xml Part 1 --> - <programlistingco> - <areaspec> - <!-- a1 --><area coords="1 60" id="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-default-repository" /> - <!-- a2 --><area coords="2 60" id="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-repositories" /> - <!-- a3 --><area coords="3 80" id="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-name" /> - <!-- a4 --><area coords="3 85" id="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-system-workspace" /> - <!-- a5 --><area coords="3 90" id="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-default-workspace" /> - <!-- a6 --><area coords="4 60" id="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-security-domain" /> - <!-- a7 --><area coords="5 60" id="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-access-control" /> - <!-- a8 --><area coords="6 60" id="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-session-max-age" /> - <!-- a9 --><area coords="7 100" id="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-authentication-policy" /> - <!-- a10 --><area coords="8 60" id="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-workspaces" /> - <!-- a11 --><area coords="9 60" id="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-workspace-name" /> - <!-- a12 --><area coords="11 90" id="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-container" /> - <!-- a13 --><area coords="30 90" id="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_initializer" /> - <!-- a14 --><area coords="35 60" id="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_cache" /> - <!-- a15 --><area coords="41 100" id="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_query-handler" /> - <!-- a16 --><area coords="47 60" id="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_lock-manager-timeout" /> - <!-- a17 --><area coords="48 100" id="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_lock-manager-persister" /> - <!-- a18 --><area coords="50 90" id="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_lock-manager-path" /> - </areaspec> - -<programlisting language="XML" role="XML"><xi:include href="../../../extras/Advanced_Development_JCR_Configuration/default24.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> - <calloutlist id="call-Reference_Guide-repository_configuration.xml_Part_1-Repository_Service_configuration"> - <title>Repository Service configuration:</title> - <!-- a1 --> - <callout arearefs="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-default-repository"> + +<programlisting language="Java" role="Java"><xi:include parse="text" href="../../../extras/Advanced_Development_JCR_Configuration/NMTOKEN.java" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> + + <para> + To configure the JCR Service; + </para> + <procedure> + <step> + <para> + Familiarize yourself with the DTD file above and the either the example configuration file below or the one in your &PRODUCT; deployment (found at; <filename>/<replaceable>JBOSS_AS</replaceable>/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/02portal.war/WEB-INF/conf/jcr/repository-configuration.xml</filename>). + </para> + </step> + <step> + <para> + Replace the element values marked below with those of your deployment environment. + </para> + </step> + <step> + <para> + The repository configuration supports human-readable values. They are not case-sensitive. + </para> + <para> + Complete the appropriate element fields using the following value formats: + </para> + <variablelist> + <varlistentry> + <term>Number formats:</term> + <listitem> <para> - The name of a default repository (one returned by RepositoryService.getRepository()) + <itemizedlist> + <listitem> + <para> + <emphasis role="bold">K</emphasis> or <emphasis role="bold">KB</emphasis> for kiloBytes. + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">M</emphasis> or <emphasis role="bold">MB</emphasis> for megaBytes. + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">G</emphasis> or <emphasis role="bold">GB</emphasis> for gigaBytes. + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">T</emphasis> or <emphasis role="bold">TB</emphasis> for terraBytes. + </para> + </listitem> + <listitem> + <para> + Examples: 200k or 200 KBytes; 4m or 4 MBytes; 1.4G or 1.4 GBytes; 10T or 10 TBytes + </para> + </listitem> + </itemizedlist> </para> - </callout> - <!-- a2 --> - <callout arearefs="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-repositories"> + </listitem> + </varlistentry> + <varlistentry> + <term>Time formats:</term> + <listitem> <para> - The list of repositories is configured within the &#60;repositories&#62; element. + <itemizedlist> + <listitem> + <para> + <emphasis role="bold">ms</emphasis> for milliseconds. + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">s</emphasis> for seconds. + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">m</emphasis> for minutes. + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">h</emphasis> for hours. + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">d</emphasis> for days. + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">w</emphasis> for weeks. + </para> + </listitem> + <listitem> + <para> + The default time format is seconds if no other format is specified. + </para> + </listitem> + <listitem> + <para> + Examples: 500ms or 500 milliseconds; 20, 20s or 20 seconds; 30m or 30 minutes; 12h or 12 hours; 5d or 5 days; 4w or 4 weeks. + </para> + </listitem> + </itemizedlist> </para> - </callout> - </calloutlist> - <calloutlist id="call-Reference_Guide-repository_configuration.xml_Part_1-Repository_configuration"> - <title>Repository configuration:</title> - <!-- a3 --> - <callout arearefs="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-name"> + </listitem> + </varlistentry> + </variablelist> + </step> + </procedure> + <section id="sect-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration"> + <title>Repository Service Configuration</title> + <programlistingco> + <areaspec> + <!--1--> + <area coords="1 60" id="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-default-repository"/> + <!--2--> + <area coords="2 60" id="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-repositories"/> + <!--3--> + <area coords="3 80" id="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-name"/> + <!--4--> + <area coords="3 85" id="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-system-workspace"/> + <!--5--> + <area coords="3 90" id="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-default-workspace"/> + <!--6--> + <area coords="4 60" id="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-security-domain"/> + <!--7--> + <area coords="5 60" id="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-access-control"/> + <!--8--> + <area coords="6 60" id="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-session-max-age"/> + <!--9--> + <area coords="7 100" id="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-authentication-policy"/> + <!--10--> + <area coords="8 60" id="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-workspaces"/> + <!--11--> + <area coords="9 60" id="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-workspace-name"/> + <!--12--> + <area coords="11 90" id="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-container"/> + <!--13--> + <area coords="30 90" id="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_initializer"/> + <!--14--> + <area coords="35 60" id="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_cache"/> + <!--15--> + <area coords="41 100" id="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_query-handler"/> + <!--16--> + <area coords="47 60" id="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_lock-manager-timeout"/> + <!--17--> + <area coords="48 100" id="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_lock-manager-persister"/> + <!--18--> + <area coords="50 90" id="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_lock-manager-path"/> + <!--19--> + <area coords="57 110" id="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_workspace-container-class"/> + <!--20--> + <area coords="58 60" id="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_workspace-container-properties"/> + <!--21--> + <area coords="65 60" id="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_workspace-container-value-storages"/> + <!--22--> + <area coords="66 90" id="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_workspace-container-value-storage"/> + <!--23--> + <area coords="66 95" id="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_workspace-container-value-class"/> + <!--24--> + <area coords="67 60" id="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_workspace-container-value-properties"/> + <!--25--> + <area coords="70 60" id="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_workspace-container-value-filters"/> + <!--26--> + <area coords="76 90" id="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_initializer_implementation_class"/> + <!--27--> + <area coords="77 60" id="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_initializer_implementation_properties"/> + <!--28--> + <area coords="81 90" id="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_cache_enabled"/> + <!--29--> + <area coords="81 95" id="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_cache_class"/> + <!--30--> + <area coords="82 60" id="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_cache_properties"/> + <!--31--> + <area coords="87 100" id="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_query-handler-class"/> + <!--32--> + <area coords="88 60" id="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_query-handler-properties"/> + </areaspec> + +<programlisting language="XML" role="XML"><xi:include parse="text" href="../../../extras/Advanced_Development_JCR_Configuration/orig.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> + + <calloutlist> + <title>Repository Service configuration:</title> + <callout arearefs="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-default-repository"> + <para> + The name of a default repository (one returned by RepositoryService.getRepository()) + </para> + </callout> + <callout arearefs="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-repositories"> + <para> + The list of repositories is configured within the &lt;repositories&gt; element. + </para> + </callout> + </calloutlist> + <calloutlist> + <title>Repository configuration:</title> + <callout arearefs="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-name"> + <para> + The name of the repository being configured. + </para> + </callout> + <callout arearefs="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-default-workspace"> + <para> + The name of a workspace. This can be obtained using Session's <literal>login()</literal> or <literal>login(Credentials)</literal> methods for workspaces without an explicit name. + </para> + </callout> + <callout arearefs="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-system-workspace"> <para> - The name of the repository being configured. + The name of workspace where /jcr:system node is placed. </para> - </callout> - <!-- a4 --> - <callout arearefs="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-default-workspace"> + </callout> + <callout arearefs="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-security-domain"> <para> - The name of a workspace. This can be obtained using Session&#39;s <literal>login()</literal> or <literal>login(Credentials)</literal> methods for workspaces without an explicit name. + The name of a security domain for JAAS authentication </para> - </callout> - <!-- a5 --> - <callout arearefs="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-system-workspace"> + </callout> + <callout arearefs="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-access-control"> <para> - The name of workspace where /jcr:system node is placed. - </para> - </callout> - <!-- a6 --> - <callout arearefs="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-security-domain"> - <para> - The name of a security domain for JAAS authentication - </para> - </callout> - <!-- a7 --> - <callout arearefs="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-access-control"> - <para> The name of an access control policy. There can be three types: </para> <variablelist> <varlistentry> <term>optional</term> - <listitem> - <para> - AN ACL is created on demand. This is the default policy. - </para> - </listitem> + <listitem> + <para> + AN ACL is created on demand. This is the default policy. + </para> + </listitem> </varlistentry> <varlistentry> <term>disable</term> - <listitem> - <para> - Disables access control. - </para> - </listitem> + <listitem> + <para> + Disables access control. + </para> + </listitem> </varlistentry> <varlistentry> <term>mandatory</term> - <listitem> - <para> - An ACL is created for each added node. This function is not supported in this release. - </para> - </listitem> + <listitem> + <para> + An ACL is created for each added node. This function is not supported in this release. + </para> + </listitem> </varlistentry> </variablelist> - </callout> - <!-- a8 --> - <callout arearefs="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-session-max-age"> + </callout> + <callout arearefs="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-session-max-age"> <para> - The amount of time before an idle session will be removed (called logout). If it is not set, the idle session will never be removed. + The amount of time before an idle session will be removed (called logout). If it is not set, the idle session will never be removed. </para> - </callout> - <!-- a9 --> - <callout arearefs="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-authentication-policy"> + </callout> + <callout arearefs="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-authentication-policy"> <para> - The name of an authentication policy class. + The name of an authentication policy class. </para> - </callout> - <!-- a10 --> - <callout arearefs="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-workspaces"> + </callout> + <callout arearefs="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-workspaces"> <para> - The list of workspaces. + The list of workspaces. </para> - </callout> - </calloutlist> - <calloutlist id="call-Reference_Guide-repository_configuration.xml_Part_1-Workspace_configuration"> - <title>Workspace configuration:</title> - <!-- a11 --> - <callout arearefs="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-workspace-name"> + </callout> + </calloutlist> + <calloutlist> + <title>Workspace configuration:</title> + <callout arearefs="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-workspace-name"> <para> - The name of the workspace. + The name of the workspace. </para> - </callout> - <!-- a12 --> - <callout arearefs="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-container"> + </callout> + <callout arearefs="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-container"> <para> - Workspace data container (physical storage) configuration. + Workspace data container (physical storage) configuration. </para> - </callout> - <!-- a13 --> - <callout arearefs="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_initializer"> + </callout> + <callout arearefs="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_initializer"> <para> - Workspace initializer configuration. + Workspace initializer configuration. </para> - </callout> - <!-- a14 --> - <callout arearefs="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_cache"> + </callout> + <callout arearefs="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_cache"> <para> - Workspace storage cache configuration. + Workspace storage cache configuration. </para> - </callout> - <!-- a15 --> - <callout arearefs="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_query-handler"> + </callout> + <callout arearefs="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_query-handler"> <para> - Query handler configuration. + Query handler configuration. </para> - </callout> - </calloutlist> - <calloutlist id="call-Reference_Guide-repository_configuration.xml_Part_1-Lock_Manager_configuration"> - <title>Lock Manager configuration:</title> - <!-- a16 --> - <callout arearefs="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_lock-manager-timeout"> + </callout> + </calloutlist> + <calloutlist> + <title>Lock Manager configuration:</title> + <callout arearefs="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_lock-manager-timeout"> <para> - The amount of time before the unused global lock is removed. + The amount of time before the unused global lock is removed. </para> - </callout> - <!-- a17 --> - <callout arearefs="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_lock-manager-persister"> + </callout> + <callout arearefs="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_lock-manager-persister"> <para> - A class for storing lock information for future use. For example; remove lock after restarting JCR. + A class for storing lock information for future use. For example; remove lock after restarting JCR. </para> - </callout> - <!-- a18 --> - <callout arearefs="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_lock-manager-path"> + </callout> + <callout arearefs="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_lock-manager-path"> <para> - Each workspace has its own lock folder. + Each workspace has its own lock folder. </para> - </callout> - </calloutlist> - </programlistingco> - </para> - </formalpara> - <formalpara id="form-Reference_Guide-Repository_Service_Configuration-repository_configuration.xml_Part_2"> - <title><filename>repository-configuration.xml</filename> Part 2</title> - <para> - <!-- repository-configuration.xml Part 2 --> - <programlistingco> - <areaspec> - <!-- b1 --><area coords="2 110" id="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_workspace-container-class" /> - <!-- b2 --><area coords="3 60" id="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_workspace-container-properties" /> - <!-- b3 --><area coords="10 60" id="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_workspace-container-value-storages" /> - <!-- b4 --><area coords="11 90" id="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_workspace-container-value-storage" /> - <!-- b5 --><area coords="11 95" id="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_workspace-container-value-class" /> - <!-- b6 --><area coords="12 60" id="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_workspace-container-value-properties" /> - <!-- b7 --><area coords="15 60" id="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_workspace-container-value-filters" /> - <!-- b8 --><area coords="21 90" id="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_initializer_implementation_class" /> - <!-- b9 --><area coords="22 60" id="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_initializer_implementation_properties" /> - <!-- b10 --><area coords="26 90" id="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_cache_enabled" /> - <!-- b11 --><area coords="26 95" id="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_cache_class" /> - <!-- b12 --><area coords="27 60" id="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_cache_properties" /> - <!-- b13 --><area coords="32 100" id="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_query-handler-class" /> - <!-- b14 --><area coords="33 60" id="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_query-handler-properties" /> - </areaspec> - -<programlisting language="XML" role="XML"><xi:include href="../../../extras/Advanced_Development_JCR_Configuration/default25.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> - <calloutlist id="call-Reference_Guide-repository_configuration.xml_Part_2-Workspace_data_container_configuration"> - <title>Workspace data container configuration:</title> - <!-- b1 --> - <callout arearefs="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_workspace-container-class"> + </callout> + </calloutlist> + <calloutlist> + <title>Workspace data container configuration:</title> + <callout arearefs="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_workspace-container-class"> <para> A workspace data container class name. </para> - </callout> - <!-- b2 --> - <callout arearefs="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_workspace-container-properties"> + </callout> + <callout arearefs="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_workspace-container-properties"> <para> - The list of properties (in name-value pairs) for the concrete Workspace data container. + The list of properties (in name-value pairs) for the concrete Workspace data container. </para> - </callout> - <!-- b3 --> - <callout arearefs="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_workspace-container-value-storages"> + </callout> + <callout arearefs="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_workspace-container-value-storages"> <para> - The list of value storage plugins. + The list of value storage plugins. </para> - </callout> - </calloutlist> - <calloutlist id="call-Reference_Guide-repository_configuration.xml_Part_2-Value_storage_plugin_configuration_optional_feature"> - <title>Value storage plugin configuration (optional feature):</title> - <!-- b4 --> - <callout arearefs="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_workspace-container-value-storage"> + </callout> + </calloutlist> + <calloutlist> + <title>Value storage plugin configuration (optional feature):</title> + <callout arearefs="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_workspace-container-value-storage"> <para> <emphasis role="bold">Optional</emphasis>: Value storage plugin definition. If this element is not included, the values will be stored as BLOBs inside the database. </para> - </callout> - <!-- b5 --> - <callout arearefs="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_workspace-container-value-class"> + </callout> + <callout arearefs="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_workspace-container-value-class"> <para> A value storage plugin class name (attribute). </para> - </callout> - <!-- b6 --> - <callout arearefs="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_workspace-container-value-properties"> + </callout> + <callout arearefs="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_workspace-container-value-properties"> <para> - The list of properties (in name-value pairs) for a concrete value storage plugin. + The list of properties (in name-value pairs) for a concrete value storage plugin. </para> - </callout> - <!-- b7 --> - <callout arearefs="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_workspace-container-value-filters"> + </callout> + <callout arearefs="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_workspace-container-value-filters"> <para> - The list of filters defining conditions when this plugin is applicable. + The list of filters defining conditions when this plugin is applicable. </para> - </callout> - </calloutlist> - <calloutlist id="call-Reference_Guide-repository_configuration.xml_Part_2-Initializer_configuration_optional"> - <title>Initializer configuration (optional):</title> - <!-- b8 --> - <callout arearefs="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_initializer_implementation_class"> + </callout> + </calloutlist> + <calloutlist> + <title>Initializer configuration (optional):</title> + <callout arearefs="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_initializer_implementation_class"> <para> - Initializer implementation class. + Initializer implementation class. </para> - </callout> - <!-- b9 --> - <callout arearefs="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_initializer_implementation_properties"> + </callout> + <callout arearefs="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_initializer_implementation_properties"> <para> - The list of properties (in name-value pairs). Properties are supported: + The list of properties (in name-value pairs). Properties are supported: </para> <variablelist> <varlistentry> <term>root-nodetype</term> - <listitem> - <para> - The node type for root node initialization. - </para> - </listitem> + <listitem> + <para> + The node type for root node initialization. + </para> + </listitem> </varlistentry> <varlistentry> <term>root-permissions</term> - <listitem> - <para> - Default permissions of the root node. It is defined as a set of semicolon-delimited permissions containing a group of space-delimited identities and the type of permission. - </para> - <para> - For example any read;:/admin read;:/admin add_node;:/admin set_property;:/admin remove means that users from group admin have all permissions and other users have only a &#39;read&#39; permission. - </para> - <para> - Configurable initializer adds a capability to override workspace initial startup procedure. - </para> - </listitem> + <listitem> + <para> + Default permissions of the root node. It is defined as a set of semicolon-delimited permissions containing a group of space-delimited identities and the type of permission. + </para> + <para> + For example any read;:/admin read;:/admin add_node;:/admin set_property;:/admin remove means that users from group admin have all permissions and other users have only a 'read' permission. + </para> + <para> + Configurable initializer adds a capability to override workspace initial startup procedure. + </para> + </listitem> </varlistentry> </variablelist> - </callout> - </calloutlist> - <calloutlist id="call-Reference_Guide-repository_configuration.xml_Part_2-Cache_configuration"> - <title>Cache configuration:</title> - <!-- b10 --> - <callout arearefs="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_cache_enabled"> + </callout> + </calloutlist> + <calloutlist> + <title>Cache configuration:</title> + <callout arearefs="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_cache_enabled"> <para> - Defines if the workspace cache is enabled. + Defines if the workspace cache is enabled. </para> - </callout> - <!-- b11 --> - <callout arearefs="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_cache_class"> + </callout> + <callout arearefs="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_cache_class"> <para> - Cache implementation class. This is optional from JCR version 1.9. + Cache implementation class. This is optional from JCR version 1.9. </para> <para> The default value is <literal>org.exoplatform.services.jcr.impl.dataflow.persistent.LinkedWorkspaceStorageCacheImpl</literal>. </para> <para> - The cache can be configured to use concrete implementations of the <literal>WorkspaceStorageCache</literal> interface. + The cache can be configured to use concrete implementations of the <literal>WorkspaceStorageCache</literal> interface. </para> <para> The JCR core has two implementations to use: @@ -450,73 +429,67 @@ <para> This implementation is a legacy from pre 1.9 versions of the JCR. However, it can still be used. </para> - </callout> - <!-- b12 --> - <callout arearefs="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_cache_properties"> + </callout> + <callout arearefs="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_cache_properties"> <para> - The list of properties (in name-value pairs) for the workspace cache: + The list of properties (in name-value pairs) for the workspace cache: </para> <variablelist> - <varlistentry> - <term>max-size</term> - <listitem> - <para> - The maximum size of the cache. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>live-time</term> - <listitem> - <para> - Cached item live time. - </para> - </listitem> - </varlistentry> + <varlistentry> + <term>max-size</term> + <listitem> + <para> + The maximum size of the cache. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>live-time</term> + <listitem> + <para> + Cached item live time. + </para> + </listitem> + </varlistentry> </variablelist> - </callout> - </calloutlist> - <calloutlist id="call-Reference_Guide-repository_configuration.xml_Part_2-Query_Handler_configuration"> - <title>Query Handler configuration:</title> - <!-- b13 --> - <callout arearefs="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_query-handler-class"> + </callout> + </calloutlist> + <calloutlist> + <title>Query Handler configuration:</title> + <callout arearefs="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_query-handler-class"> <para> - A Query Handler class name. + A Query Handler class name. </para> - </callout> - <!-- b14 --> - <callout arearefs="area-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_query-handler-properties"> + </callout> + <callout arearefs="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_query-handler-properties"> <para> - The list of properties (name-value pairs) for a Query Handler (<literal>indexDir</literal>) properties and advanced features described in <xref linkend="sect-Reference_Guide-Search_Configuration" />. + The list of properties (name-value pairs) for a Query Handler (<literal>indexDir</literal>) properties and advanced features described in <xref linkend="sect-Reference_Guide-Search_Configuration"/>. </para> - </callout> - </calloutlist> - </programlistingco> - </para> - </formalpara> + </callout> + </calloutlist> + </programlistingco> + </section> - - <section id="sect-Reference_Guide-JCR_configuration-Related_Sections"> + <section id="sect-Reference_Guide-JCR_configuration-Related_documents"> <title>Related Sections</title> <itemizedlist> <listitem> <para> - <xref linkend="sect-Reference_Guide-Search_Configuration" /> + <xref linkend="sect-Reference_Guide-Search_Configuration"/> </para> </listitem> <listitem> <para> - <xref linkend="sect-Reference_Guide-JDBC_Data_Container_Config" /> + <xref linkend="sect-Reference_Guide-JDBC_Data_Container_Config"/> </para> </listitem> <listitem> <para> - <xref linkend="sect-Reference_Guide-External_Value_Storages" /> + <xref linkend="sect-Reference_Guide-External_Value_Storages"/> </para> </listitem> </itemizedlist> </section> </section> - Modified: epp/docs/branches/EPP_5_0_Branch/Reference_Guide/en-US/modules/Advanced/JCR/external-value-storages.xml =================================================================== --- epp/docs/branches/EPP_5_0_Branch/Reference_Guide/en-US/modules/Advanced/JCR/external-value-storages.xml 2010-10-06 23:24:30 UTC (rev 4564) +++ epp/docs/branches/EPP_5_0_Branch/Reference_Guide/en-US/modules/Advanced/JCR/external-value-storages.xml 2010-10-06 23:48:59 UTC (rev 4565) @@ -11,7 +11,7 @@ JCR values are stored in the Workspace Data container by default. eXo JCR offers an additional option of storing JCR values separately from the Workspace Data container which can help keep Binary Large Objects (BLOBs) separate. </para> <para> - Value storage configuration is a part of the repository configuration. Refer to <xref linkend="sect-Reference_Guide-JCR_configuration-Repository_Service_Configuration" /> for more details. + Value storage configuration is a part of the repository configuration. Refer to <xref linkend="sect-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration" /> for more details. </para> <para> Tree-based storage is recommended in most cases.