Author: smumford
Date: 2010-09-23 02:16:24 -0400 (Thu, 23 Sep 2010)
New Revision: 4317
Added:
epp/docs/branches/EPP_5_0_Branch/Reference_Guide/en-US/extras/Advanced_Development_JCR_Configuration/default25.xml
epp/docs/branches/EPP_5_0_Branch/Reference_Guide/en-US/modules/Advanced/JCR/configuration.orig
Modified:
epp/docs/branches/EPP_5_0_Branch/Reference_Guide/en-US/Book_Info.xml
epp/docs/branches/EPP_5_0_Branch/Reference_Guide/en-US/Revision_History.xml
epp/docs/branches/EPP_5_0_Branch/Reference_Guide/en-US/extras/Advanced_Development_JCR_Configuration/default24.xml
epp/docs/branches/EPP_5_0_Branch/Reference_Guide/en-US/extras/PortalDevelopment_InternationalizationConfiguration/default154.java
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/intro.xml
epp/docs/branches/EPP_5_0_Branch/Reference_Guide/en-US/modules/Advanced/JCR/jdbc-data-container-config.xml
epp/docs/branches/EPP_5_0_Branch/Reference_Guide/en-US/modules/AuthenticationAndIdentity/SSO.xml
epp/docs/branches/EPP_5_0_Branch/Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalNavigationConfiguration.xml
epp/docs/branches/EPP_5_0_Branch/Reference_Guide/en-US/modules/PortalDevelopment/InternationalizationConfiguration.xml
epp/docs/branches/EPP_5_0_Branch/Reference_Guide/en-US/modules/PortalDevelopment/Skinning.xml
epp/docs/branches/EPP_5_0_Branch/Reference_Guide/en-US/modules/WSRP.xml
Log:
JBEPP-370: Split repository-configuration.xml code sample into two smaller samples
(workaround callout pointer bug). Removed further references to components in standalone
mode.
Modified: epp/docs/branches/EPP_5_0_Branch/Reference_Guide/en-US/Book_Info.xml
===================================================================
--- epp/docs/branches/EPP_5_0_Branch/Reference_Guide/en-US/Book_Info.xml 2010-09-23
03:26:44 UTC (rev 4316)
+++ epp/docs/branches/EPP_5_0_Branch/Reference_Guide/en-US/Book_Info.xml 2010-09-23
06:16:24 UTC (rev 4317)
@@ -9,7 +9,7 @@
<productname>JBoss Enterprise Portal Platform</productname>
<productnumber>5.0</productnumber>
<edition>1</edition>
- <pubsnumber>1.8</pubsnumber>
+ <pubsnumber>1.10</pubsnumber>
<abstract>
<para>
This Reference Guide is a high-level usage document. It deals with more advanced
topics than the Installation and User Guides, adding new content or taking concepts
discussed in the earlier documents further. It aims to provide supporting documentation
for advanced users of the &PRODUCT; product. Its primary focus is on advanced use of
the product and it assumes an intermediate or advanced knowledge of the technology and
terms.
Modified: epp/docs/branches/EPP_5_0_Branch/Reference_Guide/en-US/Revision_History.xml
===================================================================
--- epp/docs/branches/EPP_5_0_Branch/Reference_Guide/en-US/Revision_History.xml 2010-09-23
03:26:44 UTC (rev 4316)
+++ epp/docs/branches/EPP_5_0_Branch/Reference_Guide/en-US/Revision_History.xml 2010-09-23
06:16:24 UTC (rev 4317)
@@ -8,6 +8,33 @@
<simpara>
<revhistory>
<revision>
+ <revnumber>1.10</revnumber>
+ <date>Thu Sep 23 2010</date>
+ <author>
+ <firstname>Scott</firstname>
+ <surname>Mumford</surname>
+ <email>smumford(a)redhat.com</email>
+ </author>
+ <revdescription>
+ <simplelist>
+ <member>Split
<filename>repository-configuration.xml</filename> code sample into two smaller
samples (workaround callout pointer bug). Removed further references to components in
standalone mode.</member>
+ </simplelist>
+ </revdescription>
+ </revision>
+ <revnumber>1.9</revnumber>
+ <date>Wed Sep 15 2010</date>
+ <author>
+ <firstname>Scott</firstname>
+ <surname>Mumford</surname>
+ <email>smumford(a)redhat.com</email>
+ </author>
+ <revdescription>
+ <simplelist>
+ <member>Started content for "Debugging Resource Bundle Usage"
section. Started homoginizing filepath variables.</member>
+ </simplelist>
+ </revdescription>
+ </revision>
+ <revision>
<revnumber>1.8</revnumber>
<date>Fri Aug 27 2010</date>
<author>
Modified:
epp/docs/branches/EPP_5_0_Branch/Reference_Guide/en-US/extras/Advanced_Development_JCR_Configuration/default24.xml
===================================================================
---
epp/docs/branches/EPP_5_0_Branch/Reference_Guide/en-US/extras/Advanced_Development_JCR_Configuration/default24.xml 2010-09-23
03:26:44 UTC (rev 4316)
+++
epp/docs/branches/EPP_5_0_Branch/Reference_Guide/en-US/extras/Advanced_Development_JCR_Configuration/default24.xml 2010-09-23
06:16:24 UTC (rev 4317)
@@ -1,96 +1,54 @@
<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>
+ <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>
Added:
epp/docs/branches/EPP_5_0_Branch/Reference_Guide/en-US/extras/Advanced_Development_JCR_Configuration/default25.xml
===================================================================
---
epp/docs/branches/EPP_5_0_Branch/Reference_Guide/en-US/extras/Advanced_Development_JCR_Configuration/default25.xml
(rev 0)
+++
epp/docs/branches/EPP_5_0_Branch/Reference_Guide/en-US/extras/Advanced_Development_JCR_Configuration/default25.xml 2010-09-23
06:16:24 UTC (rev 4317)
@@ -0,0 +1,41 @@
+ <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>
Modified:
epp/docs/branches/EPP_5_0_Branch/Reference_Guide/en-US/extras/PortalDevelopment_InternationalizationConfiguration/default154.java
===================================================================
---
epp/docs/branches/EPP_5_0_Branch/Reference_Guide/en-US/extras/PortalDevelopment_InternationalizationConfiguration/default154.java 2010-09-23
03:26:44 UTC (rev 4316)
+++
epp/docs/branches/EPP_5_0_Branch/Reference_Guide/en-US/extras/PortalDevelopment_InternationalizationConfiguration/default154.java 2010-09-23
06:16:24 UTC (rev 4317)
@@ -1,3 +1,3 @@
javax.portlet.title=Breadcrumbs Portlet
- javax.portlet.short-title=Breadcrumbs
+ javax.portlet.short.title=Breadcrumbs
javax.portlet.keywords=Breadcrumbs, Breadcrumb
Added:
epp/docs/branches/EPP_5_0_Branch/Reference_Guide/en-US/modules/Advanced/JCR/configuration.orig
===================================================================
---
epp/docs/branches/EPP_5_0_Branch/Reference_Guide/en-US/modules/Advanced/JCR/configuration.orig
(rev 0)
+++
epp/docs/branches/EPP_5_0_Branch/Reference_Guide/en-US/modules/Advanced/JCR/configuration.orig 2010-09-23
06:16:24 UTC (rev 4317)
@@ -0,0 +1,495 @@
+<?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
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>
+ <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-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/default24.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 <repositories>
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 workspace where /jcr:system node is placed.
+ </para>
+ </callout>
+ <callout
arearefs="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-security-domain">
+ <para>
+ The name of a security domain for JAAS authentication
+ </para>
+ </callout>
+ <callout
arearefs="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>
+ <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.
+ </para>
+ </callout>
+ <callout
arearefs="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-authentication-policy">
+ <para>
+ The name of an authentication policy class.
+ </para>
+ </callout>
+ <callout
arearefs="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-workspaces">
+ <para>
+ The list of workspaces.
+ </para>
+ </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.
+ </para>
+ </callout>
+ <callout
arearefs="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-container">
+ <para>
+ Workspace data container (physical storage) configuration.
+ </para>
+ </callout>
+ <callout
arearefs="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_initializer">
+ <para>
+ Workspace initializer configuration.
+ </para>
+ </callout>
+ <callout
arearefs="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_cache">
+ <para>
+ Workspace storage cache configuration.
+ </para>
+ </callout>
+ <callout
arearefs="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_query-handler">
+ <para>
+ Query handler configuration.
+ </para>
+ </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.
+ </para>
+ </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.
+ </para>
+ </callout>
+ <callout
arearefs="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_lock-manager-path">
+ <para>
+ Each workspace has its own lock folder.
+ </para>
+ </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>
+ <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.
+ </para>
+ </callout>
+ <callout
arearefs="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_workspace-container-value-storages">
+ <para>
+ The list of value storage plugins.
+ </para>
+ </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>
+ <callout
arearefs="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_workspace-container-value-class">
+ <para>
+ A value storage plugin class name (attribute).
+ </para>
+ </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.
+ </para>
+ </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.
+ </para>
+ </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.
+ </para>
+ </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:
+ </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 'read' permission.
+ </para>
+ <para>
+ Configurable initializer adds a capability to override workspace initial
startup procedure.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </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.
+ </para>
+ </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.
+ </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>
+ <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:
+ </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>
+ <title>Query Handler configuration:</title>
+ <callout
arearefs="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_query-handler-class">
+ <para>
+ A Query Handler class name.
+ </para>
+ </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"/>.
+ </para>
+ </callout>
+ </calloutlist>
+ </programlistingco>
+
+ </section>
+
+ <section id="sect-Reference_Guide-JCR_configuration-Related_documents">
+ <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-09-23
03:26:44 UTC (rev 4316)
+++
epp/docs/branches/EPP_5_0_Branch/Reference_Guide/en-US/modules/Advanced/JCR/configuration.xml 2010-09-23
06:16:24 UTC (rev 4317)
@@ -119,85 +119,73 @@
</variablelist>
</step>
</procedure>
+
<section
id="sect-Reference_Guide-Portal_and_Standalone_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>
+ <title><filename>repository-configuration.xml</filename>
Part 1</title>
+ <para>
+ <!--repository-configuration.xml Part 1-->
<programlistingco>
<areaspec>
- <!--1-->
+ <!--a1-->
<area coords="1 60"
id="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-default-repository"/>
- <!--2-->
+ <!--a2-->
<area coords="2 60"
id="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-repositories"/>
- <!--3-->
+ <!--a3-->
<area coords="3 80"
id="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-name"/>
- <!--4-->
+ <!--a4-->
<area coords="3 85"
id="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-system-workspace"/>
- <!--5-->
+ <!--a5-->
<area coords="3 90"
id="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-default-workspace"/>
- <!--6-->
+ <!--a6-->
<area coords="4 60"
id="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-security-domain"/>
- <!--7-->
+ <!--a7-->
<area coords="5 60"
id="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-access-control"/>
- <!--8-->
+ <!--a8-->
<area coords="6 60"
id="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-session-max-age"/>
- <!--9-->
+ <!--a9-->
<area coords="7 100"
id="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-authentication-policy"/>
- <!--10-->
+ <!--a10-->
<area coords="8 60"
id="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-workspaces"/>
- <!--11-->
+ <!--a11-->
<area coords="9 60"
id="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-workspace-name"/>
- <!--12-->
+ <!--a12-->
<area coords="11 90"
id="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-container"/>
- <!--13-->
+ <!--a13-->
<area coords="30 90"
id="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_initializer"/>
- <!--14-->
+ <!--a14-->
<area coords="35 60"
id="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_cache"/>
- <!--15-->
+ <!--a15-->
<area coords="41 100"
id="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_query-handler"/>
- <!--16-->
+ <!--a16-->
<area coords="47 60"
id="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_lock-manager-timeout"/>
- <!--17-->
+ <!--a17-->
<area coords="48 100"
id="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_lock-manager-persister"/>
- <!--18-->
+ <!--a18-->
<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/default24.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting>
<calloutlist>
<title>Repository Service configuration:</title>
+ <!--a1-->
<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>
+ <!--a2-->
<callout
arearefs="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-repositories">
<para>
The list of repositories is configured within the <repositories>
element.
@@ -206,26 +194,31 @@
</calloutlist>
<calloutlist>
<title>Repository configuration:</title>
+ <!--a3-->
<callout
arearefs="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-name">
<para>
The name of the repository being configured.
</para>
</callout>
+ <!--a4-->
<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>
+ <!--a5-->
<callout
arearefs="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="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="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-access-control">
<para>
The name of an access control policy. There can be three types:
@@ -257,16 +250,19 @@
</varlistentry>
</variablelist>
</callout>
+ <!--a8-->
<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.
</para>
</callout>
+ <!--a9-->
<callout
arearefs="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-authentication-policy">
<para>
The name of an authentication policy class.
</para>
</callout>
+ <!--a10-->
<callout
arearefs="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-workspaces">
<para>
The list of workspaces.
@@ -275,26 +271,31 @@
</calloutlist>
<calloutlist>
<title>Workspace configuration:</title>
+ <!--a11-->
<callout
arearefs="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-workspace-name">
<para>
The name of the workspace.
</para>
</callout>
+ <!--a12-->
<callout
arearefs="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration-container">
<para>
Workspace data container (physical storage) configuration.
</para>
</callout>
+ <!--a13-->
<callout
arearefs="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_initializer">
<para>
Workspace initializer configuration.
</para>
</callout>
+ <!--a14-->
<callout
arearefs="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_cache">
<para>
Workspace storage cache configuration.
</para>
</callout>
+ <!--a15-->
<callout
arearefs="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_query-handler">
<para>
Query handler configuration.
@@ -303,34 +304,82 @@
</calloutlist>
<calloutlist>
<title>Lock Manager configuration:</title>
+ <!--a16-->
<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.
</para>
</callout>
+ <!--a17-->
<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.
</para>
</callout>
- <callout
arearefs="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_lock-manager-path">
+ <!--a18-->
+ <callout
arearefs="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_lock-manager-path">
<para>
Each workspace has its own lock folder.
</para>
</callout>
- </calloutlist>
+ </calloutlist>
+ </programlistingco>
+
+ </para>
+ </formalpara>
+ <formalpara>
+ <title><filename>repository-configuration.xml</filename>
Part 2</title>
+ <para>
+ <!--repository-configuration.xml Part 2-->
+ <programlistingco>
+ <areaspec>
+ <!--b1-->
+ <area coords="2 110"
id="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_workspace-container-class"/>
+ <!--b2-->
+ <area coords="3 60"
id="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_workspace-container-properties"/>
+ <!--b3-->
+ <area coords="10 60"
id="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_workspace-container-value-storages"/>
+ <!--b4-->
+ <area coords="11 90"
id="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_workspace-container-value-storage"/>
+ <!--b5-->
+ <area coords="11 95"
id="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_workspace-container-value-class"/>
+ <!--b6-->
+ <area coords="12 60"
id="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_workspace-container-value-properties"/>
+ <!--b7-->
+ <area coords="15 60"
id="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_workspace-container-value-filters"/>
+ <!--b8-->
+ <area coords="21 90"
id="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_initializer_implementation_class"/>
+ <!--b9-->
+ <area coords="22 60"
id="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_initializer_implementation_properties"/>
+ <!--b10-->
+ <area coords="26 90"
id="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_cache_enabled"/>
+ <!--b11-->
+ <area coords="26 95"
id="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_cache_class"/>
+ <!--b12-->
+ <area coords="27 60"
id="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_cache_properties"/>
+ <!--b13-->
+ <area coords="32 100"
id="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_query-handler-class"/>
+ <!--b14-->
+ <area coords="33 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/default25.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting>
+
<calloutlist>
<title>Workspace data container configuration:</title>
+ <!--b1-->
<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="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="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_workspace-container-value-storages">
<para>
The list of value storage plugins.
@@ -339,21 +388,25 @@
</calloutlist>
<calloutlist>
<title>Value storage plugin configuration (optional feature):</title>
+ <!--b4-->
<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="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="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="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_workspace-container-value-filters">
<para>
The list of filters defining conditions when this plugin is applicable.
@@ -362,11 +415,13 @@
</calloutlist>
<calloutlist>
<title>Initializer configuration (optional):</title>
+ <!--b8-->
<callout
arearefs="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_initializer_implementation_class">
<para>
Initializer implementation class.
</para>
</callout>
+ <!--b9-->
<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:
@@ -399,11 +454,13 @@
</calloutlist>
<calloutlist>
<title>Cache configuration:</title>
+ <!--b10-->
<callout
arearefs="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_cache_enabled">
<para>
Defines if the workspace cache is enabled.
</para>
</callout>
+ <!--b11-->
<callout
arearefs="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_cache_class">
<para>
Cache implementation class. This is optional from JCR version 1.9.
@@ -430,6 +487,7 @@
This implementation is a legacy from pre 1.9 versions of the JCR. However, it can
still be used.
</para>
</callout>
+ <!--b12-->
<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:
@@ -456,11 +514,13 @@
</calloutlist>
<calloutlist>
<title>Query Handler configuration:</title>
+ <!--b13-->
<callout
arearefs="Reference_Guide-Portal_and_Standalone_configuration-Repository_service_query-handler-class">
<para>
A Query Handler class name.
</para>
</callout>
+ <!--b14-->
<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"/>.
@@ -468,6 +528,8 @@
</callout>
</calloutlist>
</programlistingco>
+ </para>
+ </formalpara>
</section>
Modified:
epp/docs/branches/EPP_5_0_Branch/Reference_Guide/en-US/modules/Advanced/JCR/intro.xml
===================================================================
---
epp/docs/branches/EPP_5_0_Branch/Reference_Guide/en-US/modules/Advanced/JCR/intro.xml 2010-09-23
03:26:44 UTC (rev 4316)
+++
epp/docs/branches/EPP_5_0_Branch/Reference_Guide/en-US/modules/Advanced/JCR/intro.xml 2010-09-23
06:16:24 UTC (rev 4317)
@@ -15,28 +15,11 @@
<title>Concepts</title>
<variablelist>
<varlistentry>
- <term>The Data Model</term>
- <listitem>
- <para>
- The core of any Content Repository is the data model. The data model defines the
'data elements' (fields, columns, attributes, etc.) that are stored in the CR and
the relationships between these elements.
- </para>
- <para>
- Data elements can be singular pieces of information (the value 3.14, for example),
or compound values ('<emphasis>pi</emphasis>' = 3.14). A data model
uses concepts like 'nodes', 'arrays' and 'links' to define
relationships between data elements.
- </para>
- <para>
- The use and structure of these elements forms the content repository's
'data model'.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
<term>Repository</term>
<listitem>
<para>
A repository is a form of data storage device. A 'repository' differs
from a 'database' in the nature of the information contained. While a database
holds hard data in rigid tables, a repository may access the data on a database by using
less rigid <emphasis>meta</emphasis>-data. In this sense a repository operates
as an 'interpreter' between the database(s) and the user.
</para>
- <para>
- The eXo JCR can access multiple repositories.
- </para>
<note>
<para>
The data model for the interface (the repository) is rarely the same as the
data model used by the repository's underlying storage subsystems (such as a
database), however the repository is able to make persistent data changes in the storage
subsystem.
@@ -45,20 +28,6 @@
</listitem>
</varlistentry>
<varlistentry>
- <term>Data Abstraction</term>
- <listitem>
- <para>
- Data abstraction describes the separation between
<emphasis>abstract</emphasis> and <emphasis>concrete</emphasis>
properties of data stored in a repository. The <emphasis>concrete</emphasis>
properties of the data refer to its implementation details.
- </para>
- <para>
- The <emphasis>concrete</emphasis> properties of the data
implementation may be changed without affecting the
<emphasis>abstract</emphasis> properties of the data itself, which are read by
the data client.
- </para>
- <para>
- Consider the presentation of data in a list, graph or table. While the
information <emphasis>implementation</emphasis> may change, the data itself is
unaffected, and readers to whom the data is presented can perform a mental abstraction to
interpret it correctly, regardless of the implementation.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
<term>Workspace</term>
<listitem>
<para>
@@ -91,14 +60,46 @@
<term>Properties</term>
<listitem>
<para>
- Properties hold data as values of predefined types, such as; <emphasis
role="bold">String</emphasis>, <emphasis
role="bold">Binary</emphasis>, <emphasis
role="bold">Long</emphasis>, <emphasis
role="bold">Boolean</emphasis>, <emphasis
role="bold">Double</emphasis>, <emphasis
role="bold">Date</emphasis>, <emphasis
role="bold">Reference</emphasis> and <emphasis
role="bold">Path</emphasis>.
+ Properties hold data as values of predefined types, such as: <emphasis
role="bold">String</emphasis>, <emphasis
role="bold">Binary</emphasis>, <emphasis
role="bold">Long</emphasis>, <emphasis
role="bold">Boolean</emphasis>, <emphasis
role="bold">Double</emphasis>, <emphasis
role="bold">Date</emphasis>, <emphasis
role="bold">Reference</emphasis> and <emphasis
role="bold">Path</emphasis>.
</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
+<!-- Commented as possibly not required in this document.
+ <varlistentry>
+ <term>The Data Model</term>
+ <listitem>
+ <para>
+ The core of any Content Repository is the data model. The data model defines the
'data elements' (fields, columns, attributes, etc.) that are stored in the CR and
the relationships between these elements.
+ </para>
+ <para>
+ Data elements can be singular pieces of information (the value 3.14, for example),
or compound values ('<emphasis>pi</emphasis>' = 3.14). A data model
uses concepts like 'nodes', 'arrays' and 'links' to define
relationships between data elements.
+ </para>
+ <para>
+ The use and structure of these elements forms the content repository's
'data model'.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>Data Abstraction</term>
+ <listitem>
+ <para>
+ Data abstraction describes the separation between
<emphasis>abstract</emphasis> and <emphasis>concrete</emphasis>
properties of data stored in a repository. The <emphasis>concrete</emphasis>
properties of the data refer to its implementation details.
+ </para>
+ <para>
+ The <emphasis>concrete</emphasis> properties of the data
implementation may be changed without affecting the
<emphasis>abstract</emphasis> properties of the data itself, which are read by
the data client.
+ </para>
+ <para>
+ Consider the presentation of data in a list, graph or table. While the
information <emphasis>implementation</emphasis> may change, the data itself is
unaffected, and readers to whom the data is presented can perform a mental abstraction to
interpret it correctly, regardless of the implementation.
+ </para>
+ </listitem>
+ </varlistentry>-->
</variablelist>
+
+<!-- Commented until image can be redrawn for RedHat. Reinstitue for 5.1.0 release
<mediaobject>
<imageobject role="html">
<imagedata fileref="images/Advanced/JCR/repository_diagram.png"
format="PNG" align="center" scale="90" />
@@ -108,16 +109,19 @@
</imageobject>
</mediaobject>
<para>
- The above diagram depicts a repository R with workspaces W0, W1 and W2. The item
graph of W1 contains a root node with child nodes A, B and C. A has a property D of
type STRING and a child node E, which in turn has a property I of type BINARY. B has
the properties F (a LONG) and G (a BOOLEAN). C has a property H of type DOUBLE.
+ The above diagram depicts a repository R with workspaces W0, W1 and W2. The item
graph of W0 contains a root node with child nodes A, B and C. A has a property D of
type STRING and a child node E, which in turn has a property I of type BINARY. B has
the properties F (a LONG) and G (a BOOLEAN). C has a property H of type DOUBLE.
</para>
- <formalpara>
+ <warning>
<title>DOC TODO: Placeholders</title>
<para>
- The above diagram is being redrawn for RedHat. The explanatory note needs to be
rewritten to avoid copyright infringment.
+ The above diagram is being redrawn for RedHat. The explanatory note needs to be
rewritten to avoid possible licensing issues.
</para>
- </formalpara>
- <para>
- Further information on JCR concepts can be found at <ulink type="http"
url="http://www.day.com/specs/jcr/2.0/3_Repository_Model.html"&...;.
- </para>
+ </warning>
+
+ Metadata:
+Source URL:
http://www.day.com/specs/jcr/2.0/3_Repository_Model.html
+ Source Author: Day Management AG
+ Source Author email:
+ Source License:
http://www.day.com/specs/jcr/2.0/license.html] -->
</section>
</section>
\ No newline at end of file
Modified:
epp/docs/branches/EPP_5_0_Branch/Reference_Guide/en-US/modules/Advanced/JCR/jdbc-data-container-config.xml
===================================================================
---
epp/docs/branches/EPP_5_0_Branch/Reference_Guide/en-US/modules/Advanced/JCR/jdbc-data-container-config.xml 2010-09-23
03:26:44 UTC (rev 4316)
+++
epp/docs/branches/EPP_5_0_Branch/Reference_Guide/en-US/modules/Advanced/JCR/jdbc-data-container-config.xml 2010-09-23
06:16:24 UTC (rev 4317)
@@ -7,12 +7,6 @@
<title>JDBC Data Container Config</title>
<section>
<title>Concepts</title>
- <note>
- <title>DOC TODO</title>
- <para>
- Complete the following concepts.
- </para>
- </note>
<variablelist>
<varlistentry>
<term>JDBC</term>
@@ -20,25 +14,14 @@
<para>
Java DataBase Connectivity (JDBC) is an industry standard API for connecting
Java-based applications to a wide range of databases. The API enables dynamically loading
Java packages (and registering them with the Driver Manager which creates JDBC
connections). JDBC connections are used to create and execute statements. These may be
update statements (such as CREATE, INSERT, UPDATE and DELETE), or query statements (such
as SELECT). JDBC is oriented towards relational databases (See RDBMS below).
</para>
+<!-- Metadata: -->
+<!-- Source URL:
http://en.wikipedia.org/wiki/Java_Database_Connectivity -->
+<!-- Source Author: [the name of the original author - add as many as necessary
-->
+<!-- Source Author email: [source author email, match up name and email pairs please
-->
+<!-- Source License:
http://en.wikipedia.org/wiki/Wikipedia:Text_of_Creative_Commons_Attributi...
-->
</listitem>
</varlistentry>
<varlistentry>
- <term>Workspace</term>
- <listitem>
- <para>
- Would the 'Workspace' definition be better utilized here?
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>JCR Service Mode</term>
- <listitem>
- <para>
- Can't find any conctrete definition of this (our documents seem to be the main
source for this sort of info). Does 'Service Mode' mean that the JCR is
'servicing' another application (ie EPP) as opposed to running in standalone
mode?
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
<term>Relational Database</term>
<listitem>
<para>
@@ -50,13 +33,24 @@
<para>
This approach gives relational databases the ability to build new tables of
information from existing data tables, increasing the speed and versatility of the
database.
</para>
+ <para>
+ <emphasis role="bold">Relational database management
systems</emphasis> (RDBMS) allow users to create, administer and use relational
databases. Most RDBMSs use the Structured Query Language (SQL) to access the data held in
the database.
+ </para>
</listitem>
+<!-- Metadata: -->
+<!-- Source URL:
http://computer.howstuffworks.com/question599.htm -->
+<!--
http://en.wikipedia.org/wiki/Relational_database -->
+<!--
http://aspalliance.com/1211_Relational_Database_Management_Systems__Conce...
-->
+<!--
http://en.wikipedia.org/wiki/Relational_database_management_system-->
+<!-- Source Author: -->
+<!-- Source Author email: [source author email, match up name and email pairs please
-->
+<!-- Source License: [the license of the original material*] -->
</varlistentry>
<varlistentry>
- <term>Relational DataBase Management Systems (RDBMS)</term>
+ <term>Database Dialect</term>
<listitem>
<para>
- Relational database management systems allow users to create, administer and use
relational databases. Most RDBMSs use the Structured Query Language (SQL) to access the
data held in the database.
+ The database dialect defines the SQL language a database management system uses
when interacting with its clients.
</para>
</listitem>
</varlistentry>
@@ -70,20 +64,19 @@
While ANSI standards are not formal requirements in computing, adherence to them
increases interoperability between platforms and products.
</para>
</listitem>
+<!-- Metadata: -->
+<!-- Source URL:
http://www.ansi.org/-->
+<!--http://en.wikipedia.org/wiki/American_National_Standards_Institute-->
+<!-- Source Author: [the name of the original author - add as many as necessary
-->
+<!-- Source Author email: [source author email, match up name and email pairs please
-->
+<!-- Source License: [the license of the original material*] -->
</varlistentry>
- <varlistentry>
- <term>Database Dialect</term>
- <listitem>
- <para>
- The database dialect defines which version of the programming language (MYSQL,
Oracle, Sybase) an database management system should use when interacting with the
database.
- </para>
- </listitem>
- </varlistentry>
</variablelist>
</section>
<section
id="sect-Reference_Guide-JDBC_Data_Container_Config-Introduction">
<title>Introduction</title>
+<!-- Commented as the two options are only applicable when considering the option to
use JCR in standalone mode, which is not supported in EPP
<para>
The eXo JCR persistent data container can work in two configuration modes:
</para>
@@ -104,56 +97,14 @@
</para>
</listitem>
</varlistentry>
- </variablelist>
+ </variablelist> -->
<para>
The data container uses the JDBC driver to communicate with the actual database
software. That is, any JDBC-enabled data storage can be used with eXo JCR implementation.
</para>
<para>
Currently the data container is tested with the following Rational Database Management
Systems (RDBMS):
</para>
-<!-- Commented out in favor of more extensive list found in EPP 5.0 ERD (and converted
to XML for Release Notes)
- <itemizedlist>
- <listitem>
- <para>
- MySQL (5.x including UTF8 support)
- </para>
- </listitem>
- <listitem>
- <para>
- PostgreSQL (8.x)
- </para>
- </listitem>
- <listitem>
- <para>
- Oracle Database (9i, 10g)
- </para>
- </listitem>
- <listitem>
- <para>
- Microsoft SQL Server (2005)
- </para>
- </listitem>
- <listitem>
- <para>
- Sybase ASE (15.0)
- </para>
- </listitem>
- <listitem>
- <para>
- Apache Derby/Java DB (10.1.x, 10.2.x)
- </para>
- </listitem>
- <listitem>
- <para>
- IBM DB2 (8.x, 9.x)
- </para>
- </listitem>
- <listitem>
- <para>
- HSQLDB (1.8.0.7)
- </para>
- </listitem>
- </itemizedlist> -->
+
<table
id="tabl-Release_Notes-Certified_Environments-Database_Support_">
<title>Database Support </title>
<tgroup cols="3">
@@ -326,84 +277,16 @@
Configure the data containers in the
<classname>org.exoplatform.services.naming.InitialContextInitializer</classname>
service.
</para>
<para>
- It's the JNDI context initializer which registers (binds) naming resources
(DataSources) for data containers.
+ It is the JNDI context initializer which registers (binds) naming resources
(DataSources) for data containers.
</para>
+
+<!-- DOC NOTE: The below section has been commented as it refers to an example of
repositories configured in standalone mode
<para>
The following example is in standalone mode with two data containers
<parameter>jdbcjcr</parameter> (a local HSQLDB) and
<parameter>jdbcjcr1</parameter> (a remote MySQL container):
</para>
-<programlisting language="XML" role="XML"><xi:include
parse="text"
href="../../../extras/Advanced_Development_JCR_jdbc-data-container-config/default38.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting>
+<programlisting language="XML" role="XML"><xi:include
parse="text"
href="../../../extras/Advanced_Development_JCR_jdbc-data-container-config/default38.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> -->
-<!--<programlisting language="XML"
role="XML"><![CDATA[<component>
- <key>org.exoplatform.services.naming.InitialContextInitializer</key>
- <type>org.exoplatform.services.naming.InitialContextInitializer</type>
- <component-plugins>
- <component-plugin>
- <name>bind.datasource</name>
- <set-method>addPlugin</set-method>
- <type>org.exoplatform.services.naming.BindReferencePlugin</type>
- <init-params>
- <value-param>
- <name>bind-name</name>
- <value>jdbcjcr</value>
- </value-param>
- <value-param>
- <name>class-name</name>
- <value>javax.sql.DataSource</value>
- </value-param>
- <value-param>
- <name>factory</name>
- <value>org.apache.commons.dbcp.BasicDataSourceFactory</value>
- </value-param>
- <properties-param>
- <name>ref-addresses</name>
- <description>ref-addresses</description>
- <property name="driverClassName"
value="org.hsqldb.jdbcDriver"/>
- <property name="url"
value="jdbc:hsqldb:file:target/temp/data/portal"/>
- <property name="username" value="sa"/>
- <property name="password" value=""/>
- </properties-param>
- </init-params>
- </component-plugin>
- <component-plugin>
- <name>bind.datasource</name>
- <set-method>addPlugin</set-method>
- <type>org.exoplatform.services.naming.BindReferencePlugin</type>
- <init-params>
- <value-param>
- <name>bind-name</name>
- <value>jdbcjcr1</value>
- </value-param>
- <value-param>
- <name>class-name</name>
- <value>javax.sql.DataSource</value>
- </value-param>
- <value-param>
- <name>factory</name>
- <value>org.apache.commons.dbcp.BasicDataSourceFactory</value>
- </value-param>
- <properties-param>
- <name>ref-addresses</name>
- <description>ref-addresses</description>
- <property name="driverClassName"
value="com.mysql.jdbc.Driver"/>
- <property name="url"
value="jdbc:mysql://exoua.dnsalias.net/jcr"/>
- <property name="username" value="exoadmin"/>
- <property name="password" value="exo12321"/>
- <property name="maxActive" value="50"/>
- <property name="maxIdle" value="5"/>
- <property name="initialSize" value="5"/>
- </properties-param>
- </init-params>
- </component-plugin>
- <component-plugins>
- <init-params>
- <value-param>
- <name>default-context-factory</name>
- <value>org.exoplatform.services.naming.SimpleContextFactory</value>
- </value-param>
- </init-params>
- </component>]]></programlisting>
--->
</step>
<step>
<para>
@@ -491,70 +374,6 @@
<programlisting language="XML" role="XML"><xi:include
parse="text"
href="../../../extras/Advanced_Development_JCR_jdbc-data-container-config/default39.java"
xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting>
-<!--<programlisting><workspaces>
- <workspace name="ws"
auto-init-root-nodetype="nt:unstructured">
- <container
class="org.exoplatform.services.jcr.impl.storage.jdbc.JDBCWorkspaceDataContainer">
- <properties>
- <property name="source-name" value="jdbcjcr"/>
- <property name="dialect" value="hsqldb"/>
- <property name="multi-db" value="true"/>
- <property name="max-buffer-size" value="200K"/>
- <property name="swap-directory"
value="target/temp/swap/ws"/>
- </properties>
- </container>
- <cache enabled="true">
- <properties>
- <property name="max-size"
value="10K"/><!- 10KBytes ->
- <property name="live-time"
value="30m"/><!- 30 min ->
- </properties>
- </cache>
- <query-handler
class="org.exoplatform.services.jcr.impl.core.query.lucene.SearchIndex">
- <properties>
- <property name="index-dir"
value="target/temp/index"/>
- </properties>
- </query-handler>
- <lock-manager>
- <time-out>15m</time-out><!- 15 min ->
- <persister
class="org.exoplatform.services.jcr.impl.core.lock.FileSystemLockPersister">
- <properties>
- <property name="path"
value="target/temp/lock/ws"/>
- </properties>
- </persister>
- </lock-manager>
- </workspace>
- <workspace name="ws1"
auto-init-root-nodetype="nt:unstructured">
- <container
class="org.exoplatform.services.jcr.impl.storage.jdbc.JDBCWorkspaceDataContainer">
- <properties>
- <property name="source-name" value="jdbcjcr1"/>
- <property name="dialect" value="mysql"/>
- <property name="multi-db" value="true"/>
- <property name="max-buffer-size" value="200K"/>
- <property name="swap-directory"
value="target/temp/swap/ws1"/>
- </properties>
- </container>
- <cache enabled="true">
- <properties>
- <property name="max-size" value="10K"/>
- <property name="live-time" value="5m"/>
- </properties>
- </cache>
- <query-handler
class="org.exoplatform.services.jcr.impl.core.query.lucene.SearchIndex">
- <properties>
- <property name="index-dir"
value="target/temp/index"/>
- </properties>
- </query-handler>
- <lock-manager>
- <time-out>15m</time-out><!- 15 min ->
- <persister
class="org.exoplatform.services.jcr.impl.core.lock.FileSystemLockPersister">
- <properties>
- <property name="path"
value="target/temp/lock/ws1"/>
- </properties>
- </persister>
- </lock-manager>
- </workspace>
-</workspaces>
-</programlisting>-->
-
<variablelist>
<varlistentry>
<term>source-name</term>
@@ -680,40 +499,6 @@
<programlisting language="XML" role="XML"><xi:include
parse="text"
href="../../../extras/Advanced_Development_JCR_jdbc-data-container-config/default40.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting>
-<!--<programlisting language="XML"
role="XML"><![CDATA[<external-component-plugins>
-
<target-component>org.exoplatform.services.naming.InitialContextInitializer</target-component>
- <component-plugin>
- <name>bind.datasource</name>
- <set-method>addPlugin</set-method>
- <type>org.exoplatform.services.naming.BindReferencePlugin</type>
- <init-params>
- <value-param>
- <name>bind-name</name>
- <value>jdbcjcr</value>
- </value-param>
- <value-param>
- <name>class-name</name>
- <value>javax.sql.DataSource</value>
- </value-param>
- <value-param>
- <name>factory</name>
- <value>org.apache.commons.dbcp.BasicDataSourceFactory</value>
- </value-param>
- <properties-param>
- <name>ref-addresses</name>
- <description>ref-addresses</description>
- <property name="driverClassName"
value="org.postgresql.Driver"/>
- <property name="url"
value="jdbc:postgresql://exoua.dnsalias.net/portal"/>
- <property name="username" value="exoadmin"/>
- <property name="password" value="exo12321"/>
- <property name="maxActive" value="50"/>
- <property name="maxIdle" value="5"/>
- <property name="initialSize" value="5"/>
- </properties-param>
- </init-params>
- </component-plugin>
- </external-component-plugins>]]></programlisting>
--->
<para>
To configure multiple repository workspaces with a single database the
"multi-db" parameter must be switched off (set the value to "false").
</para>
@@ -723,64 +508,6 @@
<programlisting language="XML" role="XML"><xi:include
parse="text"
href="../../../extras/Advanced_Development_JCR_jdbc-data-container-config/default41.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting>
-<!--<programlisting language="XML"
role="XML"><![CDATA[<workspaces>
- <workspace name="ws"
auto-init-root-nodetype="nt:unstructured">
- <container
class="org.exoplatform.services.jcr.impl.storage.jdbc.JDBCWorkspaceDataContainer">
- <properties>
- <property name="source-name" value="jdbcjcr"/>
- <property name="dialect" value="pgsql"/>
- <property name="multi-db" value="false"/>
- <property name="max-buffer-size" value="200K"/>
- <property name="swap-directory"
value="target/temp/swap/ws"/>
- </properties>
- </container>
- <cache enabled="true">
- <properties>
- <property name="max-size" value="10K"/>
- <property name="live-time" value="30m"/>
- </properties>
- </cache>
- <query-handler
class="org.exoplatform.services.jcr.impl.core.query.lucene.SearchIndex">
- <properties>
- <property name="index-dir" value="../temp/index"/>
- </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="target/temp/lock/ws"/>
- </properties>
- </persister>
- </lock-manager>
- </workspace>
- <workspace name="ws1"
auto-init-root-nodetype="nt:unstructured">
- <container
class="org.exoplatform.services.jcr.impl.storage.jdbc.JDBCWorkspaceDataContainer">
- <properties>
- <property name="source-name" value="jdbcjcr"/>
- <property name="dialect" value="pgsql"/>
- <property name="multi-db" value="false"/>
- <property name="max-buffer-size" value="200K"/>
- <property name="swap-directory"
value="target/temp/swap/ws1"/>
- </properties>
- </container>
- <cache enabled="true">
- <properties>
- <property name="max-size" value="10K"/>
- <property name="live-time" value="5m"/>
- </properties>
- </cache>
- <lock-manager>
- <time-out>15m</time-out>
- <persister
class="org.exoplatform.services.jcr.impl.core.lock.FileSystemLockPersister">
- <properties>
- <property name="path" value="target/temp/lock/ws1"/>
- </properties>
- </persister>
- </lock-manager>
- </workspace>
-</workspaces>]]></programlisting>
--->
<section
id="sect-Reference_Guide-Single_database_configuration-Configuration_without_DataSource">
<title>Configuration without DataSource</title>
<para>
@@ -801,15 +528,6 @@
<programlisting language="XML" role="XML"><xi:include
parse="text"
href="../../../extras/Advanced_Development_JCR_jdbc-data-container-config/default42.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting>
-<!--<programlisting language="XML"
role="XML"><![CDATA[<workspace name="ws"
auto-init-root-nodetype="nt:unstructured">
- <container
class="org.exoplatform.services.jcr.impl.storage.jdbc.JDBCWorkspaceDataContainer">
- <properties>
- <property name="dialect" value="hsqldb"/>
- <property name="driverClassName"
value="org.hsqldb.jdbcDriver"/>
- <property name="url"
value="jdbc:hsqldb:file:target/temp/data/portal"/>
- <property name="username" value="su"/>
- <property name="password" value=""/>
- ......]]></programlisting>-->
<note>
<para>
Ensure the JDBC driver provides connection pooling. Connection pooling is required
for use with JCR to prevent a database overload.
@@ -956,6 +674,4 @@
</para>
</section>
</section>
-</section>
-
-
+</section>
\ No newline at end of file
Modified:
epp/docs/branches/EPP_5_0_Branch/Reference_Guide/en-US/modules/AuthenticationAndIdentity/SSO.xml
===================================================================
---
epp/docs/branches/EPP_5_0_Branch/Reference_Guide/en-US/modules/AuthenticationAndIdentity/SSO.xml 2010-09-23
03:26:44 UTC (rev 4316)
+++
epp/docs/branches/EPP_5_0_Branch/Reference_Guide/en-US/modules/AuthenticationAndIdentity/SSO.xml 2010-09-23
06:16:24 UTC (rev 4317)
@@ -178,7 +178,7 @@
</step>
<step>
<para>
- Edit the
<filename>jboss-as/server/<SERVER-TYPE>/deploy/gatein.ear/META-INF/gatein-jboss-beans.xml</filename>
and uncomment this section:
+ Edit the
<filename>jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/META-INF/gatein-jboss-beans.xml</filename>
and uncomment this section:
</para>
<programlisting language="XML" role="XML"><xi:include
parse="text"
href="../../extras/Authentication_Identity_SSO/default105.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting>
@@ -353,7 +353,7 @@
</step>
<step>
<para>
- Edit
<filename>jboss-as/server/<SERVER-TYPE>/deploy/gatein.ear/META-INF/gatein-jboss-beans.xml</filename>
and uncomment this section:
+ Edit
<filename>jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/META-INF/gatein-jboss-beans.xml</filename>
and uncomment this section:
</para>
<programlisting language="XML" role="XML"><xi:include
parse="text"
href="../../extras/Authentication_Identity_SSO/default111.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting>
@@ -652,7 +652,7 @@
</step>
<step>
<para>
- Edit the
<filename>jboss-as/server/<SERVER-TYPE>/deploy/gatein.ear/META-INF/gatein-jboss-beans.xml</filename>
and uncomment this section:
+ Edit the
<filename>jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/META-INF/gatein-jboss-beans.xml</filename>
and uncomment this section:
</para>
<programlisting language="XML" role="XML"><xi:include
parse="text"
href="../../extras/Authentication_Identity_SSO/default118.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting>
@@ -777,7 +777,7 @@
<title>SPNEGO Configuration</title>
<step>
<para>
- Activate the Host authentication. Add the following host login module to the
<filename>jboss-as/server/<SERVER-TYPE>/conf/login-config.xml</filename>:
+ Activate the Host authentication. Add the following host login module to the
<filename>jboss-as/server/<replaceable>PROFILE</replaceable>/conf/login-config.xml</filename>:
</para>
<programlisting language="XML" role="XML"><xi:include
parse="text"
href="../../extras/Authentication_Identity_SSO/default124.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting>
@@ -801,7 +801,7 @@
</step>
<step>
<para>
- Add the Gatein SSO module binaries by adding
<filename><replaceable>PORTAL_SSO</replaceable>/spnego/gatein.ear/lib/sso-agent.jar</filename>
and
<filename><replaceable>PORTAL_SSO</replaceable>/spnego/gatein.ear/lib/sso-spnego.jar</filename>
to <filename>deploy/gatein.ear/lib</filename>.
+ Add the Gatein SSO module binaries by adding
<filename><replaceable>PORTAL_SSO</replaceable>/spnego/gatein.ear/lib/sso-agent.jar</filename>
and
<filename><replaceable>PORTAL_SSO</replaceable>/spnego/gatein.ear/lib/spnego-<replaceable>VERSION</replaceable>-epp-GA.jar</filename>
to <filename>deploy/gatein.ear/lib</filename>.
</para>
</step>
<step>
@@ -839,7 +839,7 @@
</step>
<step>
<para>
- Edit the '<emphasis role="bold">Sign In</emphasis>'
link in
<filename>gatein.war/web.war/groovy/groovy/webui/component/UIBannerPortlet.gtmpl</filename>
to match the following:
+ Edit the '<emphasis role="bold">Sign In</emphasis>'
link in
<filename><replaceable>JBOSS_HOME</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/web.war/groovy/groovy/webui/component/UIBannerPortlet.gtmpl</filename>
to match the following:
</para>
<programlisting language="Java" role="Java"><xi:include
parse="text"
href="../../extras/Authentication_Identity_SSO/default129.java"
xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting>
@@ -853,8 +853,12 @@
Start the &PRODUCT;;
</para>
-<programlisting language="Java" role="Java"><xi:include
parse="text"
href="../../extras/Authentication_Identity_SSO/default130.java"
xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting>
+<!--<programlisting language="Java"
role="Java"><xi:include parse="text"
href="../../extras/Authentication_Identity_SSO/default130.java"
xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting>-->
+<programlisting><command>sudo ./run.sh
-Djava.security.krb5.realm=LOCAL.NETWORK -Djava.security.krb5.kdc=server.local.network -c
<replaceable>PROFILE</replaceable> -b
server.local.network</command></programlisting>
+ <para>
+ The <replaceable>PROFILE</replaceable> parameter in the above command
should be replaced with the server profile modified with the above configuration.
+ </para>
</step>
<step>
<para>
Modified:
epp/docs/branches/EPP_5_0_Branch/Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalNavigationConfiguration.xml
===================================================================
---
epp/docs/branches/EPP_5_0_Branch/Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalNavigationConfiguration.xml 2010-09-23
03:26:44 UTC (rev 4316)
+++
epp/docs/branches/EPP_5_0_Branch/Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalNavigationConfiguration.xml 2010-09-23
06:16:24 UTC (rev 4317)
@@ -33,111 +33,6 @@
<programlisting language="XML" role="XML"><xi:include
parse="text"
href="../../extras/PortalDevelopment_DefaultPortalNavigationConfiguration/default144.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting>
-<!--<programlisting language="XML"
role="XML"><![CDATA[<component>
- <key>org.exoplatform.portal.config.UserPortalConfigService</key>
- <type>org.exoplatform.portal.config.UserPortalConfigService</type>
- <component-plugins>
- <component-plugin>
- <name>new.portal.config.user.listener</name>
- <set-method>initListener</set-method>
- <type>org.exoplatform.portal.config.NewPortalConfigListener</type>
- <description>this listener init the portal configuration</descript
-ion>
- <init-params>
- <value-param>
- <name>default.portal</name>
- <description>The default portal for checking db is empty or no
-t</description>
- <value>classic</value>
- </value-param>
- <value-param>
- <name>page.templates.location</name>
- <description>the path to the location that contains Page templ
-ates</description>
- <value>war:/conf/portal/template/pages</value>
- </value-param>
- <object-param>
- <name>site.templates.location</name>
- <description>description</description>
- <object type="org.exoplatform.portal.config.SiteConfigTemplate
-">
- <field name="location">
- <string>war:/conf/portal</string>
- </field>
- <field name="portalTemplates">
- <collection type="java.util.HashSet">
- <value>
- <string>classic</string>
- </value>
- </collection>
- </field>
- <field name="groupTemplates">
- <collection type="java.util.HashSet">
- <value>
- <string>group</string>
- </value>
- </collection>
- </field>
- <field name="userTemplates">
- <collection type="java.util.HashSet">
- <value>
- <string>user</string>
- </value>
- </collection>
- </field>
- </object>
- </object-param>
- <object-param>
- <name>portal.configuration</name>
- <description>description</description>
- <object type="org.exoplatform.portal.config.NewPortalConfig">
- <field name="predefinedOwner">
- <collection type="java.util.HashSet">
- <value><string>classic</string></value>
- </collection>
- </field>
- <field
name="ownerType"><string>portal</string></field>
- <field
name="templateLocation"><string>war:/conf/portal/</string></field>
- </object>
- </object-param>
- <object-param>
- <name>group.configuration</name>
- <description>description</description>
- <object type="org.exoplatform.portal.config.NewPortalConfig">
- <field name="predefinedOwner">
- <collection type="java.util.HashSet">
-
<value><string>/platform/administrators</string></value>
- <value><string>/platform/users</string></value>
- <value><string>/platform/guests</string></value>
-
<value><string>/organization/management/executive-board</string></value>
- </collection>
- </field>
- <field
name="ownerType"><string>group</string></field>
- <field
name="templateLocation"><string>war:/conf/portal</string></field>
- </object>
- </object-param>
- <object-param>
- <name>user.configuration</name>
- <description>description</description>
- <object type="org.exoplatform.portal.config.NewPortalConfig">
- <field name="predefinedOwner">
- <collection type="java.util.HashSet">
- <value><string>root</string></value>
- <value><string>john</string></value>
- <value><string>mary</string></value>
- <value><string>demo</string></value>
- <value><string>user</string></value>
- </collection>
- </field>
- <field
name="ownerType"><string>user</string></field>
- <field
name="templateLocation"><string>war:/conf/portal</string></field>
- </object>
- </object-param>
- </init-params>
- </component-plugin>
- </component-plugins>
-</component>]]></programlisting>-->
-
<para>
This XML configuration defines where in the portal's
<literal>WAR</literal> to look for configuration settings, and which portals,
groups, and user specific views to include in portal/group/user navigation.
</para>
@@ -185,60 +80,10 @@
<para>
When the <literal>#{...}</literal> syntax is used in a
<literal><label></literal> element, the enclosed property name
serves as a key that is automatically passed to internationalization mechanism which
replaces the literal property name with a localized value taken from the associated
properties file matching the current locale.
</para>
+
+<!-- Replaced code navigation.xml with code from GateIn commit r3831 (as per
instruction from theute) -->
<programlisting role="XML" language="XML"><xi:include
href="../../extras/PortalDevelopment_DefaultPortalNavigationConfiguration/navigation.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" parse="text"
/></programlisting>
-<!-- Replaced code navigation.xml with code from GateIn commit r3831 (as per
instruction from theute)
-<?xml version="1.0" encoding="UTF-8"?>
-<node-navigation
-
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-
xsi:schemaLocation="http://www.gatein.org/xml/ns/gatein_objects_1_0
http://www.gatein.org/xml/ns/gatein_objects_1_0"
-
xmlns="http://www.gatein.org/xml/ns/gatein_objects_1_0">
- <priority>1</priority>
- <page-nodes>
- <node>
- <uri>home</uri>
- <name>home</name>
- <label>#{portal.classic.home}</label>
- <page-reference>portal::classic::homepage</page-reference>
- </node>
- <node>
- <uri>sitemap</uri>
- <name>sitemap</name>
- <label>#{portal.classic.sitemap}</label>
- <visibility>DISPLAYED</visibility>
- <page-reference>portal::classic::sitemap</page-reference>
- </node>
- <node>
- <uri>groupnavigation</uri>
- <name>groupnavigation</name>
- <label>#{portal.classic.groupnavigation}</label>
- <visibility>SYSTEM</visibility>
- <page-reference>portal::classic::groupnavigation</page-reference>
- </node>
- <node>
- <uri>portalnavigation</uri>
- <name>portalnavigation</name>
- <label>#{portal.classic.portalnavigation}</label>
- <visibility>SYSTEM</visibility>
- <page-reference>portal::classic::portalnavigation</page-reference>
- </node>
- <node>
- <uri>register</uri>
- <name>register</name>
- <label>#{portal.classic.register}</label>
- <visibility>SYSTEM</visibility>
- <page-reference>portal::classic::register</page-reference>
- </node>
- <!- NOT FOUND node ->
- <node>
- <uri>notfound</uri>
- <name>notfound</name>
- <label>NotFound</label>
- <visibility>SYSTEM</visibility>
- </node>
- </page-nodes>
-</node-navigation> -->
-
<para>
This navigation tree can have multiple views inside portlets (such as the
breadcrumbs portlet) that render the current view node, the site map or the menu
portlets.
</para>
Modified:
epp/docs/branches/EPP_5_0_Branch/Reference_Guide/en-US/modules/PortalDevelopment/InternationalizationConfiguration.xml
===================================================================
---
epp/docs/branches/EPP_5_0_Branch/Reference_Guide/en-US/modules/PortalDevelopment/InternationalizationConfiguration.xml 2010-09-23
03:26:44 UTC (rev 4316)
+++
epp/docs/branches/EPP_5_0_Branch/Reference_Guide/en-US/modules/PortalDevelopment/InternationalizationConfiguration.xml 2010-09-23
06:16:24 UTC (rev 4317)
@@ -213,18 +213,19 @@
</para>
<programlisting language="Java" role="Java"><xi:include
parse="text"
href="../../extras/PortalDevelopment_InternationalizationConfiguration/default154.java"
xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting>
-
</section>
-
+<!--Commented out as not fully enterpise ready:
https://jira.jboss.org/browse/GTNPORTAL-1482
+Will reinstate when issues resolved
+
<section
id="sect-Reference_Guide-_Portlets_-Debugging_Resource_Bundle_Usage">
- <title>Debugging Resource Bundle Usage</title>
+ <title>Debugging Resource Bundle Usage - PLEASE REVIEW</title>
<para>
When translating an application it can sometimes be difficult to find the right key
for a given property.
</para>
<para>
- You can start the ortal in <emphasis>debug mode</emphasis> and use the
<emphasis role="bold">Magic locale</emphasis> special language to
assist in finding the correct translated key value.
+ You can start the Portal in <emphasis>debug mode</emphasis> and use the
<emphasis role="bold">Magic locale</emphasis> special language to
assist in finding the correct translated key value.
</para>
<procedure>
<title>Executing the portal in <emphasis role="bold">debug
mode</emphasis></title>
@@ -237,17 +238,27 @@
</step>
<step>
<para>
- Add the <literal>-Xdebug</literal> parameter to the <emphasis
role="bold">JAVA_OPTS</emphasis> listed on (or near, if you have made
previous configuration changes) line 45.
+ Add the <literal>-Xdebug</literal> parameter to the JVM <emphasis
role="bold">JAVA_OPTS</emphasis> listed on (or near, if you have made
previous configuration changes) line 45.
</para>
<programlisting>if [ "x$JAVA_OPTS" = "x" ]; then
JAVA_OPTS="-Xms256m -Xmx512m <emphasis
role="bold">-Xdebug</emphasis> -XX:MaxPermSize=256m
-Dorg.jboss.resolver.warning=true -Dsun.rmi.dgc.client.gcInterval=3600000
-Dsun.rmi.dgc.server.gcInterval=3600000
-Dsun.lang.ClassLoader.allowArraySyntax=true"
fi</programlisting>
+ <para>
+ Please note that the memory settings in the above example have been changed from
the default.
+ </para>
</step>
+ Metadata:
+ Source URL:
http://www.coderanch.com/t/90611/JBoss/Running-JBoss-Debug-mode
+
http://community.jboss.org/thread/78131
+
http://stackoverflow.com/questions/1891053/how-to-run-jboss-4-2-3-in-the-...
+Source Author: [the name of the original author - add as many as necessary
+Source Author email: [source author email, match up name and email pairs please
+Source License: [the license of the original material*]
<step>
<para>
Start the portal as normal:
</para>
-<programlisting>[<replaceable>USER</replaceable>@<replaceable>HOST</replaceable>
<replaceable>JBOSS_AS</replaceable>]$ ./bin/run.sh
+<programlisting><command>[<replaceable>USER</replaceable>@<replaceable>HOST</replaceable>
<replaceable>JBOSS_AS</replaceable>]$ ./bin/run.sh [-c
<replaceable>PROFILE]</replaceable></command>
</programlisting>
</step>
</procedure>
@@ -255,7 +266,7 @@
<title>Setting the Magic Locale</title>
<step>
<para>
- Step 1.
+ <emphasis role="bold">I have no idea how to do this. And no amount
of Googling is revealing anything...</emphasis>
</para>
</step>
</procedure>
@@ -265,7 +276,7 @@
<para>
For example, the translated value for the key
"<parameter>organization.title</parameter>" is simply the value
"<parameter>organization.title</parameter>". Selecting that language
allows use of the portal and its applications with all the keys visible. This makes it
easier to find out the correct key for a given label in the portal page.
</para>
- </section>
+ </section>-->
</section>
Modified:
epp/docs/branches/EPP_5_0_Branch/Reference_Guide/en-US/modules/PortalDevelopment/Skinning.xml
===================================================================
---
epp/docs/branches/EPP_5_0_Branch/Reference_Guide/en-US/modules/PortalDevelopment/Skinning.xml 2010-09-23
03:26:44 UTC (rev 4316)
+++
epp/docs/branches/EPP_5_0_Branch/Reference_Guide/en-US/modules/PortalDevelopment/Skinning.xml 2010-09-23
06:16:24 UTC (rev 4317)
@@ -15,7 +15,7 @@
<section id="sect-Reference_Guide-Skinning_the_portal-Skin_Components">
<title>Skin Components</title>
<para>
- The skinning of a page is composed of three separate parts:
+ The skin of a page is composed of three separate parts:
</para>
<variablelist>
<varlistentry>
@@ -385,7 +385,7 @@
<section
id="sect-Reference_Guide-Creating_a_New_Window_Style-How_to_Set_the_Default_Window_Style">
<title>How to Set the Default Window Style</title>
<para>
- To set the default window style to be used for a portal, you will to specify the
CSS classes for a theme called <literal>DefaultTheme</literal>.
+ To set the default window style to be used for a portal, you must specify the CSS
classes for a theme called <literal>DefaultTheme</literal>.
</para>
<note>
<title>DefaultTheme</title>
@@ -488,9 +488,10 @@
<para>
For example, the property can be passed as a JVM parameter with
<literal>-D</literal> option when running &PRODUCT;.
</para>
+<programlisting><command>sh jboss-as/bin/run.sh
-Dexo.product.developing=true</command>
+</programlisting>
+<!--<programlisting language="Java"
role="Java"><xi:include parse="text"
href="../../extras/PortalDevelopment_Skinning/default192.java"
xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting>-->
-<programlisting language="Java" role="Java"><xi:include
parse="text"
href="../../extras/PortalDevelopment_Skinning/default192.java"
xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting>
-
<warning>
<para>
This option may cause display bugs in some browsers.
Modified: epp/docs/branches/EPP_5_0_Branch/Reference_Guide/en-US/modules/WSRP.xml
===================================================================
--- epp/docs/branches/EPP_5_0_Branch/Reference_Guide/en-US/modules/WSRP.xml 2010-09-23
03:26:44 UTC (rev 4316)
+++ epp/docs/branches/EPP_5_0_Branch/Reference_Guide/en-US/modules/WSRP.xml 2010-09-23
06:16:24 UTC (rev 4317)
@@ -134,21 +134,22 @@
</listitem>
</varlistentry>
<varlistentry>
- <term><replaceable>PORTAL_HOME</replaceable>/lib/wsrp-wsrp2-ws-<replaceable>WSRP_VERSION</replaceable>.jar</term>
+ <term><replaceable>PORTAL_HOME</replaceable>/lib/wsrp-wsrp1-ws-<replaceable>WSRP_VERSION</replaceable>.jar</term>
<listitem>
<para>
- This file contains the JAX-WS classes for WSRP version 2.
+ This file contains the generated JAX-WS classes for WSRP version 1.
</para>
</listitem>
</varlistentry>
+ <!-- DOC TODO: Uncomment this entry for version 5.1.0. Check to see if WSRP1 entry is
still relevant
<varlistentry>
- <term><replaceable>PORTAL_HOME</replaceable>/lib/wsrp-wsrp1-ws-<replaceable>WSRP_VERSION</replaceable>.jar</term>
+ <term><replaceable>PORTAL_HOME</replaceable>/lib/wsrp-wsrp2-ws-<replaceable>WSRP_VERSION</replaceable>.jar</term>
<listitem>
<para>
- This file contains the generated JAX-WS classes for WSRP version 1.
+ This file contains the JAX-WS classes for WSRP version 2.
</para>
</listitem>
- </varlistentry>
+ </varlistentry> -->
<varlistentry>
<term><replaceable>PORTAL_HOME</replaceable>/lib/gatein.portal.component.wsrp-<replaceable>PORTAL_VERSION</replaceable>.jar</term>
<listitem>
@@ -205,24 +206,6 @@
<programlisting language="XML" role="XML"><xi:include
parse="text" href="../extras/WSRP/default255.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting>
-<!--<programlisting language="XML"
role="XML"><![CDATA[<?xml version="1.0"
standalone="yes"?>
-<portlet-app
xmlns="http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd"
-
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-
xsi:schemaLocation="http://java.sun.com/xml/ns/portlet/portlet-app_2...
http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd"
- version="2.0">
-<portlet-app>
- <portlet>
- <portlet-name>BasicPortlet</portlet-name>
-
- ...
-
- <container-runtime-option>
- <name>org.gatein.pc.remotable</name>
- <value>true</value>
- </container-runtime-option>
- </portlet>
-</portlet-app>]]></programlisting>-->
-
<para>
It is also possible to specify that all the portlets declared within a given portlet
application be remotable by default.
</para>
@@ -235,33 +218,6 @@
<programlisting language="XML" role="XML"><xi:include
parse="text" href="../extras/WSRP/default256.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting>
-<!--<programlisting language="XML"
role="XML"><![CDATA[<?xml version="1.0"
standalone="yes"?>
-<portlet-app
xmlns="http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd"
-
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-
xsi:schemaLocation="http://java.sun.com/xml/ns/portlet/portlet-app_2...
http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd"
- version="2.0">
-<portlet-app>
-
- <portlet>
- <portlet-name>RemotelyExposedPortlet</portlet-name>
- ...
- </portlet>
- <portlet>
- <portlet-name>NotRemotelyExposedPortlet</portlet-name>
- ...
- <container-runtime-option>
- <name>org.gatein.pc.remotable</name>
- <value>false</value>
- </container-runtime-option>
- </portlet>
-
- <container-runtime-option>
- <name>org.gatein.pc.remotable</name>
- <value>true</value>
- </container-runtime-option>
-</portlet-app>
-]]></programlisting>-->
-
<para>
This example defines two portlets. As the <code>org.gatein.pc.remotable
container-runtime-option</code> is set to <code>true</code> at the
<code>portlet-app</code> level, all portlets defined in this particular
portlet application are exposed remotely by &PRODUCT_NAME;'s WSRP Producer.
</para>
@@ -490,29 +446,6 @@
<programlisting language="XML" role="XML"><xi:include
parse="text" href="../extras/WSRP/default257.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting>
-<!--<programlisting language="XML"
role="XML"><![CDATA[<?xml version='1.0'
encoding='UTF-8' ?>
-<deployments
xmlns="http://www.gatein.org/xml/ns/gatein_wsrp_consumer_1_0"
-
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-
xsi:schemaLocation="http://www.gatein.org/xml/ns/gatein_wsrp_consume...
http://www.jboss.org/portal/xsd/gatein_wsrp_consumer_1_0.xsd">
- <deployment>
- <wsrp-producer id="self" expiration-cache="300"
ws-timeout="30000">
-
<endpoint-wsdl-url>http://localhost:8080/wsrp-producer/MarkupService?wsdl</endpoint-wsdl-url>
- <registration-data>
- <property>
- <name>email</name>
- <lang>en</lang>
- <value>example(a)example.com</value>
- </property>
- </registration-data>
- </wsrp-producer>
- </deployment>
- <deployment>
- <wsrp-producer id="oracle" expiration-cache="300">
-
<
endpoint-wsdl-url>http://portalstandards.oracle.com/portletapp/portlet...
- <registration-data/>
- </wsrp-producer>
- </deployment>
-</deployments>]]></programlisting>-->
<para>
The file as shown above specifies access to two producers:
<literal>self</literal>, which consumes &PRODUCT_NAME;'s own WSRP
producer (albeit in a version that assumes that the producer requires a value for an
<literal>email</literal> registration property), and
<literal>oracle</literal>, which consumes Oracle's public producer, both
in configurations as shown in the procedure above.
</para>
@@ -677,44 +610,12 @@
<programlisting language="XML" role="XML"><xi:include
parse="text" href="../extras/WSRP/default258.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting>
-<!--<programlisting language="XML"
role="XML"><![CDATA[<?xml version='1.0'
encoding='UTF-8' ?>
-<deployments
xmlns="http://www.gatein.org/xml/ns/gatein_wsrp_consumer_1_0"
-
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-
xsi:schemaLocation="http://www.gatein.org/xml/ns/gatein_wsrp_consume...
http://www.jboss.org/portal/xsd/gatein_wsrp_consumer_1_0.xsd">
- <deployment>
- <wsrp-producer id="self" expiration-cache="300"
ws-timeout="30000">
-
<endpoint-wsdl-url>http://localhost:8080/wsrp-producer/MarkupService?wsdl</endpoint-wsdl-url>
- <registration-data/>
- </wsrp-producer>
- </deployment>
-</deployments>
-]]></programlisting>-->
<para>
This is an example of a WSRP descriptor with registration data and cache expiring
every minute:
</para>
<programlisting language="XML" role="XML"><xi:include
parse="text" href="../extras/WSRP/default259.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting>
-
-<!--<programlisting language="XML"
role="XML"><![CDATA[<?xml version='1.0'
encoding='UTF-8' ?>
-<deployments
xmlns="http://www.gatein.org/xml/ns/gatein_wsrp_consumer_1_0"
-
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-
xsi:schemaLocation="http://www.gatein.org/xml/ns/gatein_wsrp_consume...
http://www.jboss.org/portal/xsd/gatein_wsrp_consumer_1_0.xsd">
-<deployments>
- <deployment>
- <wsrp-producer id="AnotherProducer"
expiration-cache="60">
-
<
endpoint-wsdl-url>http://example.com/producer/producer?WSDL</endpoi...
- <registration-data>
- <property>
- <name>property name</name>
- <lang>en</lang>
- <value>property value</value>
- </property>
- </registration-data>
- </wsrp-producer>
- </deployment>
-</deployments>
-]]></programlisting>-->
-
+
</section>
</section>