gatein SVN: r8965 - in epp/docs/branches/5.2/Reference_Guide/en-US: modules and 3 other directories.
by do-not-reply@jboss.org
Author: jaredmorgs
Date: 2012-11-18 19:47:09 -0500 (Sun, 18 Nov 2012)
New Revision: 8965
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/Reference_Guide.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/AuthenticationAndIdentity/SSO.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/cluster-config.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/configuration/external-value-storages.xml
Log:
BZ#877827 - Removed Chapters not required in JCR section, as confirmed in BZ comments from eXo lead
Modified: epp/docs/branches/5.2/Reference_Guide/en-US/Reference_Guide.xml
===================================================================
--- epp/docs/branches/5.2/Reference_Guide/en-US/Reference_Guide.xml 2012-11-15 15:45:31 UTC (rev 8964)
+++ epp/docs/branches/5.2/Reference_Guide/en-US/Reference_Guide.xml 2012-11-19 00:47:09 UTC (rev 8965)
@@ -9,8 +9,7 @@
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="modules/Introduction.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="modules/PortalDevelopment.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="modules/PortletDevelopment.xml"/>
-<!-- <xi:include href="modules/GadgetDevelopment.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> -->
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="modules/AuthenticationAndIdentity.xml"/>
+<!-- <xi:include href="modules/GadgetDevelopment.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> --> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="modules/AuthenticationAndIdentity.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="modules/WSRP.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="modules/Advanced.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="modules/eXoJCR.xml"/>
Modified: epp/docs/branches/5.2/Reference_Guide/en-US/modules/AuthenticationAndIdentity/SSO.xml
===================================================================
--- epp/docs/branches/5.2/Reference_Guide/en-US/modules/AuthenticationAndIdentity/SSO.xml 2012-11-15 15:45:31 UTC (rev 8964)
+++ epp/docs/branches/5.2/Reference_Guide/en-US/modules/AuthenticationAndIdentity/SSO.xml 2012-11-19 00:47:09 UTC (rev 8965)
@@ -973,6 +973,300 @@
</para>
</section>
</section>
+<!--BZ#862935 - Added OpenAM section, but needs more work before next GA.--> <section>
+ <title>OpenAM</title>
+ <para>
+ This section details setting up an OpenAM server to authenticate against the JBoss Enterprise Portal Platform login module.
+ </para>
+ <procedure id="proc-Reference_Guide-OpenSSO-Obtaining_OpenSSO_1">
+ <title>Obtaining OpenAM</title>
+ <step>
+ <para>
+Visit <ulink url="http://forgerock.org/openam.html" type="http">ForgeRock's OpenAM downloads page </ulink> and download the OpenAM WAR.
+ </para>
+ <para>Download the latest stable version. </para>
+ </step>
+ <step>
+ <para>Copy the WAR to the <remark><SOMEWHERE YET TO BE DETERMINED></remark>.
+ </para>
+ </step>
+ </procedure>
+ <section id="sect-Reference_Guide-SSO_Single_Sign_On_-Modifying_the_OpenSSO_server_1">
+ <title>Modifying the OpenAM server</title>
+ <para>
+ To configure the web server as required, it is simpler to directly modify the source files.
+ </para>
+ <para>
+ The first step is to add the JBoss Enterprise Portal Platform Authentication Plugin.
+ </para>
+ <para>
+ The plug-in makes secure callbacks to a RESTful service installed on the remote JBoss Enterprise Portal Platform server to authenticate a user.
+ </para>
+ <para>
+ In order for the plug-in to function correctly, it needs to be properly configured to connect to this service. This configuration is done via the <filename>opensso.war/config/auth/default/AuthenticationPlugin.xml</filename> file.
+ </para>
+ <procedure id="proc-Reference_Guide-Modifying_the_OpenSSO_server-Modifying_OpenSSO_server_1">
+ <title>Modifying OpenAM server</title>
+ <step>
+ <para>
+ Obtain a copy of Tomcat and extract it into a suitable location. This location will be referred to as <filename>TOMCAT_HOME</filename> in this example.
+ </para>
+ </step>
+ <step>
+ <para>
+ Edit <filename>TOMCAT_HOME/conf/server.xml</filename> and change the 8080 port to 8888 to avoid a conflict with the default JBoss Enterprise Portal Platform port.
+ <note>
+ <para>
+ If JBoss Enterprise Portal Platform is running on the same machine as Tomcat, other ports need to be changed in addition to 8080 in order to avoid port conflicts. They can be changed to any free port. For example, you can change the admin port from 8005 to 8805 and the AJP port from 8009 to 8809.
+ </para>
+ </note>
+
+ </para>
+ </step>
+ <step>
+ <para>
+ Ensure the <filename>TOMCAT_HOME/webapps/opensso/config/auth/default/AuthenticationPlugin.xml</filename> file matches the following:
+ </para>
+ <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/Authentication_Identity_SSO/default117.xml" parse="text"/></programlisting>
+ </step>
+ <step>
+ <para>
+ Copy the following files into the Tomcat directory at <filename>TOMCAT_HOME/webapps/opensso/WEB-INF/lib</filename>:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <filename><replaceable>PORTAL_SSO</replaceable>/opensso/plugin/WEB-INF/lib/sso-opensso-plugin-<replaceable>VERSION</replaceable>.jar</filename>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <filename><replaceable>PORTAL_SSO</replaceable>/opensso/plugin/WEB-INF/lib/commons-httpclient-<replaceable>VERSION</replaceable>.jar</filename>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <filename><replaceable>PORTAL_SSO</replaceable>/opensso/plugin/WEB-INF/lib/commons-logging-<replaceable>VERSION</replaceable>.jar</filename>
+ </para>
+ </listitem>
+ </itemizedlist>
+ </step>
+ <step>
+ <para>
+ Copy the <filename><replaceable>PORTAL_SSO</replaceable>/opensso/plugin/WEB-INF/classes/gatein.properties</filename> file into the <filename>TOMCAT_HOME/webapps/opensso/WEB-INF/classes</filename> directory.
+ </para>
+ </step>
+ <step>
+ <para>
+ Tomcat should start and be able to access <ulink url="http://localhost:8888/opensso/UI/Login?realm=gatein" type="http"> http://localhost:8888/opensso/UI/Login?realm=gatein </ulink> .
+ </para>
+ <mediaobject>
+ <imageobject role="html">
+ <imagedata width="444" align="center" scale="110" fileref="images/AuthenticationAndIdentity/SSO/opensso-shot.png" format="PNG"/>
+ </imageobject>
+ <imageobject role="fo">
+ <imagedata width="444" contentwidth="150mm" align="center" fileref="images/AuthenticationAndIdentity/SSO/opensso-shot.png" format="PNG"/>
+ </imageobject>
+ </mediaobject>
+ <note>
+ <para>
+ Login will not be available at this point.
+ </para>
+ </note>
+ </step>
+ </procedure>
+ <procedure id="proc-Reference_Guide-Modifying_the_OpenSSO_server-Configure_the_gatein_realm_1">
+ <title>Configure the "gatein" realm</title>
+ <step>
+ <para>
+ Direct your browser to <ulink url="http://localhost:8888/opensso" type="http"> http://localhost:8888/opensso </ulink>
+ </para>
+ </step>
+ <step>
+ <para>
+ Create a default configuration.
+ </para>
+ </step>
+ <step>
+ <para>
+ Login as <literal>amadmin</literal>.
+ </para>
+ <important>
+ <para>
+ Go to <menuchoice>
+ <guimenu>Configuration</guimenu>
+ <guimenuitem> Authentication </guimenuitem>
+ </menuchoice> and follow the link to <guilabel>Core</guilabel>
+ </para>
+ <para>
+ Add a new value with the class name <literal>org.gatein.sso.opensso.plugin.AuthenticationPlugin</literal>.
+ </para>
+ <para>
+ If this is not done <literal>AuthenticationPlugin</literal> is not available among other OpenSSO authentication modules.
+ </para>
+ </important>
+ </step>
+ <step>
+ <para>
+ Go to the <guilabel>Access control</guilabel> tab and create new realm called <literal>gatein</literal>.
+ </para>
+ </step>
+ <step>
+ <substeps>
+ <step>
+ <para>
+ Go to the new <literal>gatein</literal> realm and click on the <guilabel>Authentication</guilabel> tab.
+ </para>
+ </step>
+ <step>
+ <para>
+ Click on <guilabel>LDAPService</guilabel> (at the bottom in the <guilabel>Authentication chaining</guilabel> section).
+ </para>
+ </step>
+ <step>
+ <para>
+ Change the selection from <literal>Datastore</literal>, which is the default module in the authentication chain, to <literal>AuthenticationPlugin</literal>.
+ </para>
+ </step>
+ </substeps>
+ <para>
+ These changes enable authentication of the <literal>gatein</literal> realm using the <literal>GateIn REST</literal> service instead of the OpenSSO LDAP server.
+ </para>
+ </step>
+ <step>
+ <para>
+ Go to <guilabel>Advanced properties</guilabel> and change <literal>UserProfile</literal> from <parameter>Required</parameter> to <parameter>Dynamic</parameter> to ensure all new users are automatically created in the OpenSSO datastore after successful authentication.
+ </para>
+ </step>
+ <step>
+ <para>
+ Increase the user privileges to allow REST access with the following procedure:
+ </para>
+ <substeps>
+ <step>
+ <para>
+ Go to <menuchoice>
+ <guimenu>Access control</guimenu>
+ <guimenuitem> Top level realm </guimenuitem>
+ <guimenuitem> Privileges </guimenuitem>
+ <guimenuitem> All authenticated users </guimenuitem>
+ </menuchoice>.
+ </para>
+ </step>
+ <step>
+ <para>
+ Check the last two checkboxes:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Read and write access only for policy properties
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Read and write access to all realm and policy properties
+ </para>
+ </listitem>
+ </itemizedlist>
+ </step>
+ </substeps>
+ </step>
+ <step>
+ <para>
+ Repeat step 7 for the '<literal>gatein</literal>' realm as well.
+ </para>
+ </step>
+ </procedure>
+ </section>
+ <section id="sect-Reference_Guide-SSO_Single_Sign_On_-Setup_the_OpenSSO_Client_1">
+ <title>Setup the OpenSSO Client</title>
+ <procedure id="proc-Reference_Guide-Setup_the_OpenSSO_Client-Setup_the_OpenSSO_client_1">
+ <title>Setup the OpenSSO client</title>
+ <step>
+ <para>
+ Copy all libraries from the <filename><replaceable>PORTAL_SSO</replaceable>/opensso/gatein.ear/lib</filename> directory into the <filename><replaceable>EPP_DIST</replaceable>/jboss-as/server/default/deploy/gatein.ear/lib</filename> directory.
+ </para>
+ <para>
+ Alternatively, in a Tomcat environment, copy the libraries into the <filename><replaceable>EPP_DIST</replaceable>/jboss-as/ibib</filename> directory.
+ </para>
+ </step>
+ <step>
+ <para>
+ Edit the <filename><replaceable>EPP_DIST</replaceable>/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 xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/Authentication_Identity_SSO/default118.xml" parse="text"/></programlisting>
+ </step>
+<!-- Removed as per https://issues.jboss.org/browse/JBEPP-1350
+ <step>
+ <para>
+ If you are running the product in Tomcat, edit <replaceable><JBOSS_HOME></replaceable>/conf/jaas.conf, uncomment the following section and comment all other sections:
+ </para>
+<programlisting>org.gatein.sso.agent.login.SSOLoginModule required;
+org.exoplatform.services.security.j2ee.TomcatLoginModule required
+portalContainerName=portal
+realmName=gatein-domain;
+</programlisting>
+ </step>
+ --> <step>
+ <para>
+ Test the installation:
+ </para>
+ <procedure>
+ <step>
+ <para>
+ Access JBoss Enterprise Portal Platform by going to <ulink url="http://localhost:8888/opensso/UI/Login?realm=gatein" type="http"> http://localhost:8888/opensso/UI/Login?realm=gatein </ulink> (assuming that the OpenSSO server using Tomcat is still running).
+ </para>
+ </step>
+ <step>
+ <para>
+ Login with the username <literal>root</literal> and the password <literal>gtn</literal> or any account created through the portal.
+ </para>
+ </step>
+ </procedure>
+ </step>
+ </procedure>
+ </section>
+ <section id="sect-Reference_Guide-SSO_Single_Sign_On_-Setup_the_portal_to_redirect_to_OpenSSO_1">
+ <title>Setup the portal to redirect to OpenSSO</title>
+ <para>
+ The next part of the process is to redirect all user authentication to the OpenSSO server.
+ </para>
+ <para>
+ Information about where the OpenSSO server is hosted must be properly configured within the Enterprise Portal Platform instance. The required configuration is done by modifying three files:
+ </para>
+ <procedure id="proc-Reference_Guide-Setup_the_portal_to_redirect_to_OpenSSO-Setup_the_portal_to_redirect_to_OpenSSO_1">
+ <title>Setup the portal to redirect to OpenSSO</title>
+ <step>
+ <para>
+ Modify the '<emphasis role="bold">Sign In</emphasis>' link in the <filename><replaceable>EPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/web.war/groovy/groovy/webui/component/UIBannerPortlet.gtml</filename> file as follows:
+ </para>
+ <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/Authentication_Identity_SSO/default119.xml" parse="text"/></programlisting>
+ </step>
+ <step>
+ <para>
+ Modify the '<emphasis role="bold">Sign In</emphasis>' link in the <filename>gatein.ear/web.war/groovy/portal/webui/component/UILogoPortlet.gtmpl</filename> file as follows:
+ </para>
+ <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/Authentication_Identity_SSO/default120.xml" parse="text"/></programlisting>
+ </step>
+ <step>
+ <para>
+ Replace the entire contents of <filename>gatein.ear/02portal.war/login/jsp/login.jsp</filename> with:
+ </para>
+ <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/Authentication_Identity_SSO/default121.xml" parse="text"/></programlisting>
+ </step>
+ <step>
+ <para>
+ Add the following Filters to the top of the filter chain in <filename>gatein.ear/02portal.war/WEB-INF/web.xml</filename>:
+ </para>
+ <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/Authentication_Identity_SSO/default122.xml" parse="text"/></programlisting>
+ </step>
+ </procedure>
+ <para>
+ From now on, all links redirecting to the user authentication pages will redirect to the OpenSSO centralized authentication form.
+ </para>
+ </section>
+ </section>
<section id="sect-Reference_Guide-SSO_Single_Sign_On_-SPNEGO_Simple_and_Protected_GSSAPI_Negotiation_Mechanism">
<title>Simple and Protected GSSAPI Negotiation Mechanism (SPNEGO)</title>
<para>
Modified: epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/cluster-config.xml
===================================================================
--- epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/cluster-config.xml 2012-11-15 15:45:31 UTC (rev 8964)
+++ epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/cluster-config.xml 2012-11-19 00:47:09 UTC (rev 8965)
@@ -4,89 +4,105 @@
%BOOK_ENTITIES;
]>
<chapter id="chap-Reference_Guide-Cluster_Configuration">
- <title>Configuring Cluster</title>
- <section id="sect-Reference_Guide-Cluster_Configuration-Launching_Cluster">
- <title>Launching Cluster</title>
- <section id="sect-Reference_Guide-Launching_Cluster-Deploying_eXo_JCR_to_JBoss_Application_Server">
- <title>Deploying eXo JCR to JBoss Application Server</title>
- <para>
- To deploy eXo JCR to the JBoss AS, do the following:
- </para>
- <procedure>
- <title/>
- <step>
- <para>
- Download the latest version of eXo JCR <filename>.ear</filename> file distribution.
+ <title><remark>BZ#841259 </remark>Configuring Cluster</title>
+ <section id="sect-Reference_Guide-Requirements-Environment_requirements">
+ <title>Environment requirements</title>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Every node of the cluster <emphasis role="bold">must</emphasis> have the same mounted Network File System (<abbrev>NFS</abbrev>) with the read and write permissions on it.
</para>
- </step>
- <step>
- <para>
- Copy the file into <filename><replaceable>EPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy</filename> directory.
+ </listitem>
+ <listitem>
+ <para>
+ Every node of cluster <emphasis role="bold">must</emphasis> use the same database.
</para>
- </step>
- <step>
- <para>
- Drop <filename>exo-configuration.xml</filename> into your root <filename><replaceable>EPP_DIST</replaceable>/jboss-as/</filename> directory.
+ </listitem>
+ <listitem>
+ <para>
+ The same Clusters on different nodes <emphasis role="bold">must</emphasis> have the same names.
</para>
- </step>
- <step>
+ <example id="exam-Reference_Guide-Environment_requirements-Example">
+ <title>Example</title>
<para>
- Configure JAAS by inserting the XML fragment shown below into <filename><replaceable>EPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/conf/login-config.xml</filename>
- </para>
- <programlisting language="XML" role="XML"><application-policy name="exo-domain">
- <authentication>
- <login-module code="org.exoplatform.services.security.j2ee.JbossLoginModule" flag="required"></login-module>
- </authentication>
-</application-policy></programlisting>
- </step>
- <step>
- <para>
- To ensure that <emphasis>JBossTS</emphasis> and <emphasis>JBossCache</emphasis> are used, your <filename>configuration.xml</filename> file must contain:
- </para>
- <programlisting language="XML" role="XML"><component>
- <key>org.jboss.cache.transaction.TransactionManagerLookup</key>
- <type>org.jboss.cache.GenericTransactionManagerLookup</type>^
-</component>
-
-<component>
- <key>org.exoplatform.services.transaction.TransactionService</key>
- <type>org.exoplatform.services.transaction.jbosscache.JBossTransactionsService</type>
- <init-params>
- <value-param>
- <name>timeout</name>
- <value>300</value>
- </value-param>
- </init-params>
-</component></programlisting>
- </step>
- <step>
- <para>
- Start server:
- </para>
- <para>
- In Linux systems:
- </para>
- <programlisting><command>sh bin/run.sh</command></programlisting>
- <para>
- In Windows systems:
- </para>
- <programlisting><command>bin/run.bat</command></programlisting>
- </step>
- <step>
- <para>
- Navigate to <ulink url="http://localhostu:8080/browser" type="http"/> ans use the credentials <emphasis role="bold">root</emphasis>/<emphasis role="bold">exo</emphasis> (login/password).
- </para>
- </step>
- </procedure>
- </section>
- <section id="sect-Reference_Guide-Launching_Cluster-Configuring_JCR_to_use_external_configuration">
- <title>Configuring JCR to use external configuration</title>
- <itemizedlist>
- <listitem>
- <para>
+ If the <emphasis>Indexer</emphasis> cluster in the <emphasis>production</emphasis> workspace on the first node is named <literal>production_indexer_cluster</literal>, then <emphasis>indexer</emphasis> clusters in the <emphasis>production</emphasis> workspace on all other nodes <emphasis role="bold">must</emphasis> also be named <literal>production_indexer_cluster</literal>.
+ </para>
+ </example>
+ </listitem>
+ </itemizedlist>
+ </section>
+ <section id="sect-Reference_Guide-Requirements-Configuration_requirements">
+ <title>Configuration requirements</title>
+ <para>
+ The configuration of every workspace in the repository must contain the following elements:
+ </para>
+ <example id="exam-Reference_Guide-Configuration_requirements-Value_Storage_configuration">
+ <title>Value Storage configuration</title>
+ <programlisting language="XML" role="XML"><value-storages>
+ <value-storage id="system" class="org.exoplatform.services.jcr.impl.storage.value.fs.TreeFileValueStorage">
+ <properties>
+ <property name="path" value="/mnt/tornado/temp/values/production" /> <!--path within NFS where ValueStorage will hold it's data-->
+ </properties>
+ <filters>
+ <filter property-type="Binary" />
+ </filters>
+ </value-storage>
+</value-storages></programlisting>
+ </example>
+ <example id="exam-Reference_Guide-Configuration_requirements-Cache_configuration">
+ <title>Cache configuration</title>
+ <programlisting language="XML" role="XML"><cache enabled="true" class="org.exoplatform.services.jcr.impl.dataflow.persistent.jbosscache.JBossCacheWorkspaceStorageCache">
+ <properties>
+ <property name="jbosscache-configuration" value="jar:/conf/portal/test-jbosscache-data.xml" /> <!-- path to JBoss Cache configuration for data storage -->
+ <property name="jgroups-configuration" value="jar:/conf/portal/udp-mux.xml" /> <!-- path to JGroups configuration -->
+ <property name="jbosscache-cluster-name" value="JCR_Cluster_cache_production" /> <!-- JBoss Cache data storage cluster name -->
+ <property name="jgroups-multiplexer-stack" value="true" />
+ </properties>
+</cache></programlisting>
+ </example>
+ <example id="exam-Reference_Guide-Configuration_requirements-Indexer_configuration">
+ <title>Indexer configuration</title>
+ <programlisting language="XML" role="XML"><query-handler class="org.exoplatform.services.jcr.impl.core.query.lucene.SearchIndex">
+ <properties>
+ <property name="changesfilter-class" value="org.exoplatform.services.jcr.impl.core.query.jbosscache.JBossCacheIndexChangesFilter" />
+ <property name="index-dir" value="/mnt/tornado/temp/jcrlucenedb/production" /> <!-- path within NFS where ValueStorage will hold it's data -->
+ <property name="jbosscache-configuration" value="jar:/conf/portal/test-jbosscache-indexer.xml" /> <!-- path to JBoss Cache configuration for indexer -->
+ <property name="jgroups-configuration" value="jar:/conf/portal/udp-mux.xml" /> <!-- path to JGroups configuration -->
+ <property name="jbosscache-cluster-name" value="JCR_Cluster_indexer_production" /> <!-- JBoss Cache indexer cluster name -->
+ <property name="jgroups-multiplexer-stack" value="true" />
+ </properties>
+</query-handler></programlisting>
+ </example>
+ <example id="exam-Reference_Guide-Configuration_requirements-Lock_Manager_configuration">
+ <title>Lock Manager configuration</title>
+ <programlisting language="XML" role="XML"><lock-manager class="org.exoplatform.services.jcr.impl.core.lock.jbosscache.CacheableLockManagerImpl">
+ <properties>
+ <property name="time-out" value="15m" />
+ <property name="jbosscache-configuration" value="jar:/conf/portal/test-jbosscache-lock.xml" /> <!-- path to JBoss Cache configuration for lock manager -->
+ <property name="jgroups-configuration" value="jar:/conf/portal/udp-mux.xml" /> <!-- path to JGroups configuration -->
+ <property name="jgroups-multiplexer-stack" value="true" />
+ <property name="jbosscache-cluster-name" value="JCR_Cluster_lock_production" /> <!-- JBoss Cache locks cluster name -->
+
+ <property name="jbosscache-cl-cache.jdbc.table.name" value="jcrlocks_production"/> <!-- the name of the DB table where lock's data will be stored -->
+ <property name="jbosscache-cl-cache.jdbc.table.create" value="true"/>
+ <property name="jbosscache-cl-cache.jdbc.table.drop" value="false"/>
+ <property name="jbosscache-cl-cache.jdbc.table.primarykey" value="jcrlocks_production_pk"/>
+ <property name="jbosscache-cl-cache.jdbc.fqn.column" value="fqn"/>
+ <property name="jbosscache-cl-cache.jdbc.node.column" value="node"/>
+ <property name="jbosscache-cl-cache.jdbc.parent.column" value="parent"/>
+ <property name="jbosscache-cl-cache.jdbc.datasource" value="jdbcjcr"/>
+ </properties>
+</lock-manager></programlisting>
+ </example>
+ </section>
+ <section id="sect-Reference_Guide-Launching_Cluster-Configuring_JCR_to_use_external_configuration">
+ <title>Configuring JCR to use external configuration</title>
+ <itemizedlist>
+ <listitem>
+ <para>
To manually configure a repository, create a new configuration file (<filename>exo-jcr-configuration.xml</filename> for example). For details, see <xref linkend="chap-Reference_Guide-JCR_configuration"/>.
</para>
- <para>
+ <para>
The configuration file must be formatted as follows:
</para>
<example>
@@ -155,7 +171,7 @@
<para>
Then, update <parameter>RepositoryServiceConfiguration</parameter> configuration in the <filename>exo-configuration.xml</filename> to reference your file:
</para>
- <programlisting language="XML" role="XML"><component>
+ <programlisting language="XML" role="XML"><component>
<key>org.exoplatform.services.jcr.config.RepositoryServiceConfiguration</key>
<type>org.exoplatform.services.jcr.impl.config.RepositoryServiceConfigurationImpl</type>
<init-params>
@@ -166,101 +182,7 @@
</value-param>
</init-params>
</component></programlisting>
- </listitem>
- </itemizedlist>
- </section>
+ </listitem>
+ </itemizedlist>
</section>
- <section id="sect-Reference_Guide-Cluster_Configuration-Requirements">
- <title>Requirements</title>
- <section id="sect-Reference_Guide-Requirements-Environment_requirements">
- <title>Environment requirements</title>
- <itemizedlist>
- <listitem>
- <para>
- Every node of the cluster <emphasis role="bold">must</emphasis> have the same mounted Network File System (<abbrev>NFS</abbrev>) with the read and write permissions on it.
- </para>
- </listitem>
- <listitem>
- <para>
- Every node of cluster <emphasis role="bold">must</emphasis> use the same database.
- </para>
- </listitem>
- <listitem>
- <para>
- The same Clusters on different nodes <emphasis role="bold">must</emphasis> have the same names.
- </para>
- <example id="exam-Reference_Guide-Environment_requirements-Example">
- <title>Example</title>
- <para>
- If the <emphasis>Indexer</emphasis> cluster in the <emphasis>production</emphasis> workspace on the first node is named <literal>production_indexer_cluster</literal>, then <emphasis>indexer</emphasis> clusters in the <emphasis>production</emphasis> workspace on all other nodes <emphasis role="bold">must</emphasis> also be named <literal>production_indexer_cluster</literal>.
- </para>
- </example>
- </listitem>
- </itemizedlist>
- </section>
- <section id="sect-Reference_Guide-Requirements-Configuration_requirements">
- <title>Configuration requirements</title>
- <para>
- The configuration of every workspace in the repository must contain the following elements:
- </para>
- <example id="exam-Reference_Guide-Configuration_requirements-Value_Storage_configuration">
- <title>Value Storage configuration</title>
- <programlisting language="XML" role="XML"><value-storages>
- <value-storage id="system" class="org.exoplatform.services.jcr.impl.storage.value.fs.TreeFileValueStorage">
- <properties>
- <property name="path" value="/mnt/tornado/temp/values/production" /> <!--path within NFS where ValueStorage will hold it's data-->
- </properties>
- <filters>
- <filter property-type="Binary" />
- </filters>
- </value-storage>
-</value-storages></programlisting>
- </example>
- <example id="exam-Reference_Guide-Configuration_requirements-Cache_configuration">
- <title>Cache configuration</title>
- <programlisting language="XML" role="XML"><cache enabled="true" class="org.exoplatform.services.jcr.impl.dataflow.persistent.jbosscache.JBossCacheWorkspaceStorageCache">
- <properties>
- <property name="jbosscache-configuration" value="jar:/conf/portal/test-jbosscache-data.xml" /> <!-- path to JBoss Cache configuration for data storage -->
- <property name="jgroups-configuration" value="jar:/conf/portal/udp-mux.xml" /> <!-- path to JGroups configuration -->
- <property name="jbosscache-cluster-name" value="JCR_Cluster_cache_production" /> <!-- JBoss Cache data storage cluster name -->
- <property name="jgroups-multiplexer-stack" value="true" />
- </properties>
-</cache></programlisting>
- </example>
- <example id="exam-Reference_Guide-Configuration_requirements-Indexer_configuration">
- <title>Indexer configuration</title>
- <programlisting language="XML" role="XML"><query-handler class="org.exoplatform.services.jcr.impl.core.query.lucene.SearchIndex">
- <properties>
- <property name="changesfilter-class" value="org.exoplatform.services.jcr.impl.core.query.jbosscache.JBossCacheIndexChangesFilter" />
- <property name="index-dir" value="/mnt/tornado/temp/jcrlucenedb/production" /> <!-- path within NFS where ValueStorage will hold it's data -->
- <property name="jbosscache-configuration" value="jar:/conf/portal/test-jbosscache-indexer.xml" /> <!-- path to JBoss Cache configuration for indexer -->
- <property name="jgroups-configuration" value="jar:/conf/portal/udp-mux.xml" /> <!-- path to JGroups configuration -->
- <property name="jbosscache-cluster-name" value="JCR_Cluster_indexer_production" /> <!-- JBoss Cache indexer cluster name -->
- <property name="jgroups-multiplexer-stack" value="true" />
- </properties>
-</query-handler></programlisting>
- </example>
- <example id="exam-Reference_Guide-Configuration_requirements-Lock_Manager_configuration">
- <title>Lock Manager configuration</title>
- <programlisting language="XML" role="XML"><lock-manager class="org.exoplatform.services.jcr.impl.core.lock.jbosscache.CacheableLockManagerImpl">
- <properties>
- <property name="time-out" value="15m" />
- <property name="jbosscache-configuration" value="jar:/conf/portal/test-jbosscache-lock.xml" /> <!-- path to JBoss Cache configuration for lock manager -->
- <property name="jgroups-configuration" value="jar:/conf/portal/udp-mux.xml" /> <!-- path to JGroups configuration -->
- <property name="jgroups-multiplexer-stack" value="true" />
- <property name="jbosscache-cluster-name" value="JCR_Cluster_lock_production" /> <!-- JBoss Cache locks cluster name -->
-
- <property name="jbosscache-cl-cache.jdbc.table.name" value="jcrlocks_production"/> <!-- the name of the DB table where lock's data will be stored -->
- <property name="jbosscache-cl-cache.jdbc.table.create" value="true"/>
- <property name="jbosscache-cl-cache.jdbc.table.drop" value="false"/>
- <property name="jbosscache-cl-cache.jdbc.table.primarykey" value="jcrlocks_production_pk"/>
- <property name="jbosscache-cl-cache.jdbc.fqn.column" value="fqn"/>
- <property name="jbosscache-cl-cache.jdbc.node.column" value="node"/>
- <property name="jbosscache-cl-cache.jdbc.parent.column" value="parent"/>
- <property name="jbosscache-cl-cache.jdbc.datasource" value="jdbcjcr"/>
- </properties>
-</lock-manager></programlisting>
- </example>
- </section>
- </section>
</chapter>
Modified: epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/configuration/external-value-storages.xml
===================================================================
--- epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/configuration/external-value-storages.xml 2012-11-15 15:45:31 UTC (rev 8964)
+++ epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/configuration/external-value-storages.xml 2012-11-19 00:47:09 UTC (rev 8965)
@@ -1,202 +1,76 @@
-<?xml version='1.0' encoding='utf-8' ?>
+<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
%BOOK_ENTITIES;
]>
<chapter id="chap-Reference_Guide-External_Value_Storages">
- <title>External Value Storages</title>
- <section id="sect-Reference_Guide-External_Value_Storages-Introduction">
- <title>Introduction</title>
- <para>
+ <title>External Value Storages</title>
+ <section id="sect-Reference_Guide-External_Value_Storages-Introduction">
+ <title>Introduction</title>
+ <para>
JCR values are stored in the Workspace Data container by default. The eXo JCR offers an additional option of storing JCR values separately from the Workspace Data container which can help keep Binary Large Objects (BLOBs) separate.
</para>
- <!-- <para>
+<!-- <para>
Value storage configuration is a part of the repository configuration. Refer to <xref linkend="sect-Reference_Guide-JCR_configuration-Example_of_the_portal_system_workspace" /> for more details.
- </para> --> <para>
+ </para> --> <para>
Tree-based storage is recommended in most cases.
</para>
- <!-- Not sure this is necessary
+<!-- Not sure this is necessary
<para>
If you run an application on Amazon EC2 - the S3 option may be interesting for architecture. Simple 'flat' storage is good in speed of creation/deletion of values, it might be a compromise for a small storages.
-</para> -->
- </section>
-
- <section id="sect-Reference_Guide-External_Value_Storages-Tree_File_Value_Storage">
- <title>Tree File Value Storage</title>
- <para>
+</para> --> </section>
+ <section id="sect-Reference_Guide-External_Value_Storages-Tree_File_Value_Storage">
+ <title>Tree File Value Storage</title>
+ <para>
Tree File Value Storage holds values in tree-like file system files. <property>Path</property> property points to the root directory to store the files.
</para>
- <para>
+ <para>
This is a recommended type of external storage because it can contain large amount of files limited only by disk/volume free space.
</para>
- <para>
+ <para>
However, using Tree File Value Storage can result in a higher time on value deletion, due to the removal of unused tree-nodes.
</para>
-<example>
-<title>Tree File Value Storage Configuration</title>
-<programlisting language="XML" role="XML"><xi:include href="../../../../extras/Advanced_Development_JCR_external-value-storages/default25.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting>
- <para>
+ <example>
+ <title>Tree File Value Storage Configuration</title>
+ <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../../../extras/Advanced_Development_JCR_external-value-storages/default25.xml" parse="text"/></programlisting>
+ <para>
Comment #1: The <emphasis role="bold">id</emphasis> is the value storage unique identifier, used for linking with properties stored in a workspace container.
</para>
- <para>
+ <para>
Comment #2: the <emphasis role="bold">path</emphasis> is a location where value files will be stored.
</para>
-</example>
- <para>
+ </example>
+ <para>
Each file value storage can have the <function>filters</function> for incoming values. A filter can match values by <property>property-type</property>, <property>property-name</property>, <property>ancestor-path</property>. It can also match the size of values stored (<property>min-value-size</property>) in bytes.
</para>
- <para>
+ <para>
In the previous example a filter with <property>property-type</property> and <property>min-value-size</property> has been used. This results in storage for binary values with size greater of 1MB.
</para>
- <para>
+ <para>
It is recommended that properties with large values are stored in file value storage only.
</para>
- <para>
+ <para>
The example below shows a value storage with different locations for large files (<property>min-value-size</property> a 20Mb-sized filter).
</para>
- <para>
+ <para>
A value storage uses ORed logic in the process of filter selection. This means the first filter in the list will be called first and if it is not matched the next will be called, and so on.
</para>
- <para>
- In this example a value matches the 20MB filter <property>min-value-size</property> and will be stored in the path "<literal>data/20Mvalues</literal>". All other filters will be stored in "<literal>data/values</literal>".
+ <para>
+ In this example a value matches the 20MB filter <property>min-value-size</property> and will be stored in the path "<literal>data/20Mvalues</literal>". All other filters will be stored in "<literal>data/values</literal>".
</para>
-
-<programlisting language="XML" role="XML"><xi:include href="../../../../extras/Advanced_Development_JCR_external-value-storages/default26.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting>
-
- </section>
-
- <!-- <section id="sect-Reference_Guide-External_Value_Storages-Simple_File_Value_Storage">
-<title>Simple File Value Storage</title>
-<note>
-<para>
-Not recommended to use in production due to low capacity capabilities on most file systems.
-</para>
-<para>
-But if you're sure in your file-system or data amount is small it may be useful for you as haves a faster speed of Value removal.
-</para>
-</note>
-<para>
-Holds Values in flat file system files. <property>path</property> property points to root directory in order to store files
-</para>
-<programlisting language="Java" role="Java"><xi:include parse="text" href="../../../../extras/Advanced_Development_JCR_external-value-storages/default27.java" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting>
-<programlisting><value-storage id="Storage #1" class="org.exoplatform.services.jcr.impl.storage.value.fs.SimpleFileValueStorage">
-<properties>
-<property name="path" value="data/values"/>
-</properties>
-<filters>
-<filter property-type="Binary" min-value-size="1M"/>
-</filters>
-</programlisting>
-</section> --> <section id="sect-Reference_Guide-External_Value_Storages-Content_Addressable_Value_storage_CAS_support">
- <title>Content Addressable Value storage (CAS) support</title>
- <para>
- eXo JCR supports the <phrase>Content-addressable storage</phrase> feature for <phrase>values</phrase> storing.
- </para>
- <para>
- Content-addressable storage, also referred to as associative storage and abbreviated as <emphasis role="bold">CAS</emphasis>, is a mechanism for storing information that can be retrieved based on its content, not its storage location.
- </para>
- <para>
- It is typically used for high-speed storage and retrieval of fixed content, such as documents stored for compliance with government regulations.
- </para>
- <para>
- Content-addressable value storage stores unique content once. Different properties (values) with same content will be stored as one data file shared between those values. We can tell the value content will be shared across some values in storage and will be stored in one physical file.
- </para>
- <para>
- Storage size will be decreased for applications which govern potentially same data in the content.
- </para>
- <para>
- As an example; if 100 different properties contain the same data (mail attachments for example) the storage stores only one single file. The file will be shared with all referencing properties.
- </para>
- <para>
- If a property value changes it is stored in an additional file. Alternatively the file is shared with other values, pointing to the same content.
- </para>
- <para>
- The storage calculates value content address each time the property was changed. CAS write operations are more expensive compared to the non-CAS storages.
- </para>
- <para>
- Content address calculation is based on <literal>java.security.MessageDigest</literal> hash computation and has been tested with MD5 and SHA1 algorithms.
- </para>
- <note>
- <para>
- CAS storage works most efficiently on data that does not change often. For data that changes frequently CAS is not as efficient as location-based addressing.
- </para>
-
- </note>
- <para>
- CAS support can be enabled for <phrase>Tree</phrase> and <phrase>Simple File Value Storage</phrase> types.
- </para>
- <para>
- To enable CAS support just configure it in the JCR Repositories configuration with other Value Storages.
- </para>
-
-<programlisting language="XML" role="XML"><xi:include href="../../../../extras/Advanced_Development_JCR_external-value-storages/default28.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting>
- <variablelist id="vari-Reference_Guide-Content_Addressable_Value_storage_CAS_support-CAS_Properties">
- <title>CAS Properties</title>
- <varlistentry>
- <term>digest-algo</term>
- <listitem>
- <para>
- Digest hash algorithm (MD5 and SHA1 were tested).
- </para>
-
- </listitem>
-
- </varlistentry>
- <varlistentry>
- <term>vcas-type</term>
- <listitem>
- <para>
- Value CAS internal data type, JDBC backed is currently implemented:
- </para>
- <para>
- <literal>org.exoplatform.services.jcr.impl.storage.value.cas.JDBCValueContentAddressStorageImpl</literal>
- </para>
-
- </listitem>
-
- </varlistentry>
- <varlistentry>
- <term>jdbc-source-name</term>
- <listitem>
- <para>
- A <literal>JDBCValueContentAddressStorageImpl</literal> specific parameter, a database will be used to save CAS metadata.
- </para>
-
- </listitem>
-
- </varlistentry>
- <varlistentry>
- <term>jdbc-dialect</term>
- <listitem>
- <para>
- A <literal>DBCValueContentAddressStorageImpl</literal> specific parameter defining database dialect.
- </para>
-
- </listitem>
-
- </varlistentry>
-
- </variablelist>
-
- </section>
-
- <section id="sect-Reference_Guide-External_Value_Storages-Disabling_value_storage">
- <title>Disabling value storage</title>
- <para>
+ <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../../../extras/Advanced_Development_JCR_external-value-storages/default26.xml" parse="text"/></programlisting>
+ </section>
+ <section id="sect-Reference_Guide-External_Value_Storages-Disabling_value_storage">
+ <title>Disabling value storage</title>
+ <para>
The JCR allows you to disable value storage by adding the following property into its configuration.
</para>
-
-<programlisting language="XML"><property name="enabled" value="false" /></programlisting>
- <warning>
- <title>Warning</title>
- <para>
+ <programlisting language="XML"><property name="enabled" value="false" /></programlisting>
+ <warning>
+ <title>Warning</title>
+ <para>
It is recommended that this functionality be used for internal and testing purpose only, and with caution, as all stored values will be inaccessible.
</para>
-
- </warning>
-
- </section>
-
-
+ </warning>
+ </section>
</chapter>
-
Modified: epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR.xml
===================================================================
--- epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR.xml 2012-11-15 15:45:31 UTC (rev 8964)
+++ epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR.xml 2012-11-19 00:47:09 UTC (rev 8965)
@@ -1,132 +1,35 @@
-<?xml version='1.0' encoding='utf-8' ?>
+<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE part 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;
]>
- <part id="part-Reference_Guide-The_Java_Content_Repository_">
- <title>The Java Content Repository</title>
- <!-- <xi:include href="eXoJCR/eXoJCR/jcr.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> -->
- <xi:include href="eXoJCR/jcr/intro.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <!--concepts -->
- <!--<xi:include href="eXoJCR/jcr/concepts/why-jcr.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> -->
- <xi:include href="eXoJCR/jcr/concepts/jcr-exo-implementation.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <!--<xi:include href="eXoJCR/jcr/concepts/jcr-advantages.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />-->
- <!--<xi:include href="eXoJCR/jcr/concepts/jcr-compatibility-levels.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />-->
- <!--<xi:include href="eXoJCR/jcr/concepts/jcr-usage.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />-->
- <!-- <xi:include href="eXoJCR/jcr/concepts/jcr-extensions.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> -->
- <!--<xi:include href="eXoJCR/jcr/concepts/jcr-applications.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />-->
- <!--<xi:include href="eXoJCR/jcr/concepts/nodetypes-and-namespaces.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />-->
- <!--<xi:include href="eXoJCR/jcr/concepts/nodetype-registration.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />-->
- <!-- <xi:include href="eXoJCR/jcr/concepts/jcr-registry-service.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />-->
- <!--<xi:include href="eXoJCR/jcr/concepts/jcr-namespace-altering.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />-->
-
- <!-- common configs -->
- <xi:include href="eXoJCR/jcr/configuration/exo-jcr-configuration.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
-
- <xi:include href="eXoJCR/jcr/configuration/multilanguage-support.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
-
- <xi:include href="eXoJCR/jcr/configuration/search-configuration.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
-
- <!-- <xi:include href="eXoJCR/jcr/configuration/configuration-persister.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />-->
-
- <xi:include href="eXoJCR/jcr/configuration/jdbc-data-container-config.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
-
- <xi:include href="eXoJCR/jcr/configuration/external-value-storages.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
-
- <xi:include href="eXoJCR/jcr/configuration/workspace-persistence-storage.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
-
- <xi:include href="eXoJCR/jcr/configuration/rest-services-on-groovy.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
-
-
- <!-- cluster configs -->
- <xi:include href="eXoJCR/jcr/cluster-config.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
-
- <xi:include href="eXoJCR/jcr/jbosscache-configuration-templates.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
-
- <xi:include href="eXoJCR/jcr/lock-manager-config.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
-
- <xi:include href="eXoJCR/jcr/query-handler-config.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
-
- <xi:include href="eXoJCR/jcr/jbossts-transaction-service.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
-
- <xi:include href="eXoJCR/jcr/transaction-manager-lookup.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
-
- <xi:include href="eXoJCR/jcr/repository-creation-service.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
-
-
-
- <!-- search -->
- <xi:include href="eXoJCR/jcr/searching/jcr-query-usecases.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
-
- <xi:include href="eXoJCR/jcr/searching/searching-repository-content.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
-
- <xi:include href="eXoJCR/jcr/searching/fulltext-search-and-settings.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
-
-
-
- <!-- api extensions -->
- <!--<xi:include href="eXoJCR/jcr/api-extensions.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />-->
-
-
-
- <!-- protocols -->
- <xi:include href="eXoJCR/jcr/protocols/webdav.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
-
- <xi:include href="eXoJCR/jcr/protocols/ftp.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
-
-
-
- <!-- backup -->
-<!-- <xi:include href="eXoJCR/jcr/backup/exojcr-backup-service.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> -->
-
-<!-- <xi:include href="eXoJCR/jcr/backup/backup-client.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> -->
-
- <xi:include href="eXoJCR/jcr/backup/use-external-backup-tool.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
-
-
- <!-- other -->
- <xi:include href="eXoJCR/jcr/statistics.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
-
- <xi:include href="eXoJCR/jcr/repository-check-controller.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
-
- <!--<xi:include href="eXoJCR/jcr/jta.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />-->
-
- <!--<xi:include href="eXoJCR/jcr/jca.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />-->
-
- <!--<xi:include href="eXoJCR/jcr/other/acl.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />-->
-
- <!--<xi:include href="eXoJCR/jcr/other/acl-ext.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />-->
-
- <xi:include href="eXoJCR/jcr/other/link-producer.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
-
- <!--<xi:include href="eXoJCR/jcr/other/binary-values-processing.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />-->
-
- <xi:include href="eXoJCR/jcr/other/jcr-resources.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
-
-
- <!-- data container configs -->
- <xi:include href="eXoJCR/jcr/data-container.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <!-- <xi:include href="eXoJCR/jcr/data-container-howto.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> -->
- <xi:include href="eXoJCR/jcr/db-cleaner-service.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
-
-
- <!-- tuning guide
- DOC NOTE: Could possibly be moved to a specific Tuning Guide later -->
- <xi:include href="eXoJCR/jcr/performance-tuning-guide.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
-
-
- <!-- JCR Core
+<part id="part-Reference_Guide-The_Java_Content_Repository_">
+ <title>The Java Content Repository</title>
+<!-- <xi:include href="eXoJCR/eXoJCR/jcr.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> --> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/intro.xml"/>
+<!--concepts --><!--<xi:include href="eXoJCR/jcr/concepts/why-jcr.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> --> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/concepts/jcr-exo-implementation.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/configuration/exo-jcr-configuration.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/configuration/multilanguage-support.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/configuration/search-configuration.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/configuration/jdbc-data-container-config.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/configuration/external-value-storages.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/configuration/workspace-persistence-storage.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/cluster-config.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/jbosscache-configuration-templates.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/lock-manager-config.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/query-handler-config.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/jbossts-transaction-service.xml"/>
+<!-- search --> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/searching/jcr-query-usecases.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/searching/searching-repository-content.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/searching/fulltext-search-and-settings.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/protocols/webdav.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/protocols/ftp.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/backup/use-external-backup-tool.xml"/>
+<!-- other --> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/statistics.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/repository-check-controller.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/performance-tuning-guide.xml"/>
+<!-- JCR Core
DOC NOTE: This section seems to include items covered elsewhere in this guide, or things that are not relevant to EPP
- <xi:include href="eXoJCR/core.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> -->
-
-
- <!-- Web services
+ <xi:include href="eXoJCR/core.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> --><!-- Web services
DOC NOTE: Red Hat JBoss has two possible Web Services packages. No need to document the eXo offering:
- <xi:include href="eXoJCR/ws.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> -->
-
-
- <!-- GateIn and JCR -->
- <xi:include href="eXoJCR/jcr-with-gatein.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <!-- DOC NOTE: Commented FAQ section out as per advice from Philippe Aristote; "Unfit for publication" -->
- <!-- <xi:include href="eXoJCR/faq.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> -->
- </part>
+ <xi:include href="eXoJCR/ws.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> --><!-- GateIn and JCR --> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr-with-gatein.xml"/>
+<!-- DOC NOTE: Commented FAQ section out as per advice from Philippe Aristote; "Unfit for publication" --><!-- <xi:include href="eXoJCR/faq.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> --></part>
12 years, 1 month
gatein SVN: r8964 - in epp/docs/branches/5.2/Site_Publisher/User_Guide/en-US: modules/Advanced/Administration and 1 other directory.
by do-not-reply@jboss.org
Author: ppenicka
Date: 2012-11-15 10:45:31 -0500 (Thu, 15 Nov 2012)
New Revision: 8964
Modified:
epp/docs/branches/5.2/Site_Publisher/User_Guide/en-US/Revision_History.xml
epp/docs/branches/5.2/Site_Publisher/User_Guide/en-US/modules/Advanced/Administration/Presentation.xml
Log:
Inserted more appropriate section ID for the section added by previous commit.
Modified: epp/docs/branches/5.2/Site_Publisher/User_Guide/en-US/Revision_History.xml
===================================================================
--- epp/docs/branches/5.2/Site_Publisher/User_Guide/en-US/Revision_History.xml 2012-11-15 15:28:35 UTC (rev 8963)
+++ epp/docs/branches/5.2/Site_Publisher/User_Guide/en-US/Revision_History.xml 2012-11-15 15:45:31 UTC (rev 8964)
@@ -7,7 +7,7 @@
<title>Revision History</title> <simpara>
<revhistory>
<revision>
- <revnumber>5.2.2-101</revnumber>
+ <revnumber>5.2.2-102</revnumber>
<date>Wed Nov 15 2012</date>
<author>
<firstname>Petr</firstname>
Modified: epp/docs/branches/5.2/Site_Publisher/User_Guide/en-US/modules/Advanced/Administration/Presentation.xml
===================================================================
--- epp/docs/branches/5.2/Site_Publisher/User_Guide/en-US/modules/Advanced/Administration/Presentation.xml 2012-11-15 15:28:35 UTC (rev 8963)
+++ epp/docs/branches/5.2/Site_Publisher/User_Guide/en-US/modules/Advanced/Administration/Presentation.xml 2012-11-15 15:45:31 UTC (rev 8964)
@@ -313,7 +313,7 @@
</para>
</step>
</procedure>
- <section id="portal_development-groovy">
+ <section id="sect-User_Guide-Content_Presentation_Manager-Manage_a_Template-Embedding">
<title>Embedding Template Code in Another Template</title>
<para>
The code of a template can be embedded in the code of another template. Using this technique, you can avoid repetitive use of identical code in multiple templates. This facilitates code maintenance as you only need to edit the code in one template for the changes to be reflected in all templates where the code is embedded.
12 years, 1 month
gatein SVN: r8963 - in epp/docs/branches/5.2/Site_Publisher/User_Guide/en-US: images and 1 other directories.
by do-not-reply@jboss.org
Author: ppenicka
Date: 2012-11-15 10:28:35 -0500 (Thu, 15 Nov 2012)
New Revision: 8963
Modified:
epp/docs/branches/5.2/Site_Publisher/User_Guide/en-US/Revision_History.xml
epp/docs/branches/5.2/Site_Publisher/User_Guide/en-US/images/manage_templates_form.png
epp/docs/branches/5.2/Site_Publisher/User_Guide/en-US/modules/Advanced/Administration/Presentation.xml
Log:
BZ#850880 - added information about embedding of view and dialog templates in Site Publisher.
Modified: epp/docs/branches/5.2/Site_Publisher/User_Guide/en-US/Revision_History.xml
===================================================================
--- epp/docs/branches/5.2/Site_Publisher/User_Guide/en-US/Revision_History.xml 2012-11-15 01:10:18 UTC (rev 8962)
+++ epp/docs/branches/5.2/Site_Publisher/User_Guide/en-US/Revision_History.xml 2012-11-15 15:28:35 UTC (rev 8963)
@@ -7,6 +7,22 @@
<title>Revision History</title> <simpara>
<revhistory>
<revision>
+ <revnumber>5.2.2-101</revnumber>
+ <date>Wed Nov 15 2012</date>
+ <author>
+ <firstname>Petr</firstname>
+ <surname>Penicka</surname>
+ <email/>
+ </author>
+
+ <revdescription>
+ <simplelist>
+ <member>BZ#850880 - added information about embedding of view and dialog templates in Site Publisher.</member>
+ </simplelist>
+ </revdescription>
+ </revision>
+
+ <revision>
<revnumber>5.2.2-100</revnumber> <date>Wed Sep 05 2012</date>
<author>
<firstname>Jared</firstname> <surname>Morgan</surname> <email/>
@@ -18,7 +34,7 @@
</simplelist>
</revdescription>
</revision>
-
+
<revision>
<revnumber>5.2.1-101</revnumber> <date>Tue Apr 17 2012</date>
<author>
Modified: epp/docs/branches/5.2/Site_Publisher/User_Guide/en-US/images/manage_templates_form.png
===================================================================
(Binary files differ)
Modified: epp/docs/branches/5.2/Site_Publisher/User_Guide/en-US/modules/Advanced/Administration/Presentation.xml
===================================================================
--- epp/docs/branches/5.2/Site_Publisher/User_Guide/en-US/modules/Advanced/Administration/Presentation.xml 2012-11-15 01:10:18 UTC (rev 8962)
+++ epp/docs/branches/5.2/Site_Publisher/User_Guide/en-US/modules/Advanced/Administration/Presentation.xml 2012-11-15 15:28:35 UTC (rev 8963)
@@ -15,7 +15,7 @@
</para>
<para>
- The <emphasis>Template Management</emphasis> system allows users to view, delete or modify the predefined templates or to add a new template.
+ The <guilabel>Manage Templates</guilabel> section allows users to view, delete or modify the templates and create new templates.
</para>
<mediaobject>
@@ -63,7 +63,7 @@
<step id="step-User_Guide-Add_a_New_Template-Assign_memberships_to_the_group">
<para>
- Select a group from the left panel and the membership from the right panel. Alternatively you can set permission for everyone by clicking the icon next to <guilabel>Any Permission</guilabel>
+ Select a group from the left panel and the membership from the right panel. Alternatively you can set permission for everyone by clicking the icon next to <guilabel>Any Permission</guilabel>.
</para>
<mediaobject>
@@ -171,7 +171,7 @@
<step>
<para>
- Click <guibutton>Save</guibutton> to accept all changes in the Dialog tab.
+ Click <guibutton>Save</guibutton> to accept all changes in the <guilabel>Dialog</guilabel> tab.
</para>
</step>
</substeps>
@@ -211,7 +211,7 @@
<substeps>
<step>
<para>
- Click the View tab and enter content into the content field.
+ Click the <guilabel>View</guilabel> tab and enter content into the content field.
</para>
</step>
@@ -249,7 +249,7 @@
<step>
<para>
- Click <guibutton>Save</guibutton> to accept all changes in the View tab.
+ Click <guibutton>Save</guibutton> to accept all changes in the <guilabel>View</guilabel> tab.
</para>
</step>
</substeps>
@@ -266,20 +266,20 @@
</para>
<para>
- If the dialog has at least two versions, in the <guilabel>View</guilabel> tab, it displays the <guibutton>Restore</guibutton> button. You can use <guibutton>Restore</guibutton> to roll back to the previous View.
+ If the dialog has at least two versions, in the <guilabel>View</guilabel> tab, it displays the <guibutton>Restore</guibutton> button. You can use <guibutton>Restore</guibutton> to roll back to the previous <guilabel>View</guilabel>.
</para>
</note>
</step>
<step performance="optional" id="step-User_Guide-Edit_a_Template-Delete_an_existing_dialog_in_the_Dialog_tab">
<para>
- To delete an existing dialog, do the following:
+ To delete an existing view, do the following:
</para>
<substeps>
<step>
<para>
- Click the <guilabel>trash can</guilabel> icon in the dialog row you want to edit.
+ Click the <guilabel>trash can</guilabel> icon in the view row you want to delete.
</para>
</step>
@@ -297,7 +297,7 @@
</substeps>
</step>
</procedure>
-
+
<procedure id="proc-User_Guide-Manage_a_Template-Delete_a_Template">
<title>Delete a Template</title>
@@ -313,7 +313,50 @@
</para>
</step>
</procedure>
+ <section id="portal_development-groovy">
+ <title>Embedding Template Code in Another Template</title>
+ <para>
+ The code of a template can be embedded in the code of another template. Using this technique, you can avoid repetitive use of identical code in multiple templates. This facilitates code maintenance as you only need to edit the code in one template for the changes to be reflected in all templates where the code is embedded.
+ </para>
+ <para>
+ The embedding is performed by calling the <literal>_ctx.include</literal> method in the code of a template. When the template that contains the method call is displayed, the code of the embedded template is inserted at the location of the method call.
+ </para>
+<programlisting language="Java">
+_ctx.include(TemplatePath);
+</programlisting>
+ <para>
+ The path to the template whose code shall be embedded must be provided in the method's parameter. The value can be obtained dynamically as demonstrated in the following code sample.
+ </para>
+<programlisting language="Java">
+import org.exoplatform.services.cms.templates.TemplateService;
+
+public String getTemplatePath(boolean isDialog, String nodeTypeName, String templateName) throws Exception {
+ TemplateService tempService = uicomponent.getApplicationComponent(TemplateService.class);
+ String path = tempService.getTemplatePath(isDialog, nodeTypeName, templateName);
+ return path;
+}
+</programlisting>
+ <para>
+ To see practical examples of view template embedding, you can inspect some of the default templates that come with your distribution of Site Publisher. For example, the code extract below shows how the <systemitem>mix:votable</systemitem> and <systemitem>exo:comments</systemitem> view templates are embedded at the bottom of the <systemitem>exo:sample</systemitem> view template.
+ </para>
+<programlisting language="HTML">
+<![CDATA[<div><% _ctx.include(uicomponent.getViewTemplate("mix:votable", "view1")); %></div>
+<div><% _ctx.include(uicomponent.getViewTemplate("exo:comments", "view1")); %></div>]]>
+</programlisting>
+ <para>
+ Embedding of dialog templates is not demonstrated in any of the default templates. However, it can be achieved similarly to what is show above. For example, the following code snippet can be copied and pasted into any dialog template to embed the <systemitem>exo:podcast</systemitem> dialog template in its code.
+ </para>
+<programlisting language="HTML">
+<![CDATA[<%
+ import org.exoplatform.services.cms.templates.TemplateService;
+ TemplateService tempService = uicomponent.getApplicationComponent(TemplateService.class);
+ String path = tempService.getTemplatePath(true, "exo:podcast", "dialog1") ;
+%>
+
+<% _ctx.include(path); %>]]>
+</programlisting>
</section>
+ </section>
<section id="sect-User_Guide-Content_Presentation_Manager-Metadata_Management">
<title>Metadata Management</title>
12 years, 1 month
gatein SVN: r8962 - epp/docs/branches/6.0/Admin_Guide/en-US.
by do-not-reply@jboss.org
Author: jaredmorgs
Date: 2012-11-14 20:10:18 -0500 (Wed, 14 Nov 2012)
New Revision: 8962
Modified:
epp/docs/branches/6.0/Admin_Guide/en-US/Administration_Guide.xml
epp/docs/branches/6.0/Admin_Guide/en-US/Revision_History.xml
epp/docs/branches/6.0/Admin_Guide/en-US/chapter-1-Introduction.xml
epp/docs/branches/6.0/Admin_Guide/en-US/chapter-4-Management_Extensions.xml
epp/docs/branches/6.0/Admin_Guide/en-US/chapter-5-Administration_and_Monitoring.xml
Log:
BZ#856436 - Added in changes to Admin Guide for Admin and Monitoring section
Modified: epp/docs/branches/6.0/Admin_Guide/en-US/Administration_Guide.xml
===================================================================
--- epp/docs/branches/6.0/Admin_Guide/en-US/Administration_Guide.xml 2012-11-13 04:12:15 UTC (rev 8961)
+++ epp/docs/branches/6.0/Admin_Guide/en-US/Administration_Guide.xml 2012-11-15 01:10:18 UTC (rev 8962)
@@ -3,7 +3,7 @@
<!ENTITY % BOOK_ENTITIES SYSTEM "Administration_Guide.ent">
%BOOK_ENTITIES;
]>
-<book>
+<book status="draft">
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Book_Info.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Preface.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="chapter-1-Introduction.xml"/>
Modified: epp/docs/branches/6.0/Admin_Guide/en-US/Revision_History.xml
===================================================================
--- epp/docs/branches/6.0/Admin_Guide/en-US/Revision_History.xml 2012-11-13 04:12:15 UTC (rev 8961)
+++ epp/docs/branches/6.0/Admin_Guide/en-US/Revision_History.xml 2012-11-15 01:10:18 UTC (rev 8962)
@@ -8,6 +8,21 @@
<simpara>
<revhistory>
<revision>
+ <revnumber>6.0.0-3</revnumber>
+ <date>Wed Nov 14 2012</date>
+ <author>
+ <firstname>Jared</firstname>
+ <surname>Morgan</surname>
+ <email/>
+ </author>
+ <revdescription>
+ <simplelist>
+ <member>BZ#856436 - Updated Administration and Monitoring section to reflect the minor changes Nick Scavelli made in https://docs.jboss.org/author/display/GTNPORTAL35/Administration+and+Moni.... With the exception of the Installing RHQ, because that is community-specific. See the Installation Guide for changes to installing JON Plugin info.</member>
+ <member>BZ#794408 - Petr Penicka updated the Import and Export procedures, in both the 5.2 and 6.0 docs.</member>
+ </simplelist>
+ </revdescription>
+ </revision>
+ <revision>
<revnumber>6.0.0-2</revnumber>
<date>Tue Oct 30 2012</date>
<author>
Modified: epp/docs/branches/6.0/Admin_Guide/en-US/chapter-1-Introduction.xml
===================================================================
--- epp/docs/branches/6.0/Admin_Guide/en-US/chapter-1-Introduction.xml 2012-11-13 04:12:15 UTC (rev 8961)
+++ epp/docs/branches/6.0/Admin_Guide/en-US/chapter-1-Introduction.xml 2012-11-15 01:10:18 UTC (rev 8962)
@@ -118,7 +118,7 @@
</section>
<section id="sid-8094332_GateInManagement-Goals">
<title>Goals</title>
- <para>The management component provides a foundation for managing portal side components. By doing so it allows management extensions to register resources and operations over a set of API's, which in turn allows us to expose these over common interfaces like REST and CLI. In other words, management extensions don't have to worry about the interfaces in which they will be managed over. This allows us to add additional interfaces without needing to change anything. Also by providing a set of API's to obtain managed resources, interfaces are built in a consistent manner. So managing the same component in one interface should be very similar if you were to manage it in another.</para>
+ <para>The management component provides a foundation for managing portal side components. By doing so it allows management extensions to register resources and operations over a set of API's, which in turn allows us to expose these over common interfaces like REST and CLI. In other words, management extensions do not have to worry about the interfaces in which they will be managed over. This allows us to add additional interfaces without needing to change anything. Also by providing a set of API's to obtain managed resources, interfaces are built in a consistent manner. So managing the same component in one interface should be very similar if you were to manage it in another.</para>
</section>
<section id="sid-8094332_GateInManagement-Operations">
<title>Operations</title>
Modified: epp/docs/branches/6.0/Admin_Guide/en-US/chapter-4-Management_Extensions.xml
===================================================================
--- epp/docs/branches/6.0/Admin_Guide/en-US/chapter-4-Management_Extensions.xml 2012-11-13 04:12:15 UTC (rev 8961)
+++ epp/docs/branches/6.0/Admin_Guide/en-US/chapter-4-Management_Extensions.xml 2012-11-15 01:10:18 UTC (rev 8962)
@@ -42,7 +42,7 @@
<code>import-resource</code>
operation can only be executed at the mop component (root managed resource of the mop extension). This is because the exported zip file contains the path information (like site type and site name). So executing an
<code>import-resource</code>
- operation on a group site, when the zip contains data from a portal site, doesn't make sense.
+ operation on a group site, when the zip contains data from a portal site, does not make sense.
</para>
<para>This operation is accessed through the portal using the <application>Import/Export Site</application> tool. For more information about this tool, refer to the <citetitle>Import and Export</citetitle> section in the <citetitle>User Guide</citetitle>.</para>
<para>
@@ -489,7 +489,7 @@
</example>
<important>
<title>Important</title>
- <para>All three artifacts (site layout, navigation, and pages) are included in export by default. In other words if you don't specify their path template in the filter, the data will be included.</para>
+ <para>All three artifacts (site layout, navigation, and pages) are included in export by default. In other words if you do not specify their path template in the filter, the data will be included.</para>
</important>
</section>
</section>
Modified: epp/docs/branches/6.0/Admin_Guide/en-US/chapter-5-Administration_and_Monitoring.xml
===================================================================
--- epp/docs/branches/6.0/Admin_Guide/en-US/chapter-5-Administration_and_Monitoring.xml 2012-11-13 04:12:15 UTC (rev 8961)
+++ epp/docs/branches/6.0/Admin_Guide/en-US/chapter-5-Administration_and_Monitoring.xml 2012-11-15 01:10:18 UTC (rev 8962)
@@ -4,9 +4,10 @@
%BOOK_ENTITIES;
]>
<chapter id="Administration_and_Monitoring">
- <title>Administration and Monitoring</title>
+ <title><remark>BZ#856436</remark> Administration and Monitoring</title>
<para>JBoss Portal Platform provides a JBoss Operations Network plug-in (<firstterm>GateIn JON Plug-in</firstterm>) to assist with monitoring the platform.</para>
- <para>The plug-in captures portlet and site statistics. A different set of statistics are collected depending on the context of each portlet. <xref linkend="fig-GateIn_JON_Plug-in_Interface"/> shows the basic JON interface.</para>
+ <para>The plug-in captures application/portlet and site statistics. A different set of statistics are collected depending on the context of each portlet. <xref linkend="fig-GateIn_JON_Plug-in_Interface"/> shows the basic JON interface.</para>
+ <para>Follow the download and installation instructions in the <citetitle>Installation Guide</citetitle> to activate Administration and Monitoring.</para>
<figure id="fig-GateIn_JON_Plug-in_Interface">
<title>GateIn JON Plug-in Interface</title>
<mediaobject>
@@ -20,7 +21,9 @@
</figure>
<section id="AdministrationandMonitoring-Metrics">
<title>Metrics</title>
- <para>The metrics collected by the GateIn JON Plug-in include Site and Portlet statistics. Each portlet contains statistics relevant to the individual portlet, and one additional Throughput statistic for site portlets. Refer to <xref linkend="table-Site_and_Portlet_Statistics"/> for a description of the available metrics.</para>
+ <para>The metrics collected by the GateIn JON Plug-in include Site and Application/Portlet statistics. Each portlet contains statistics relevant to the individual portlet, and one additional Throughput statistic for site portlets. Refer to <xref linkend="table-Site_and_Portlet_Statistics"/> for a description of the available metrics.</para>
+ <remark>BZ#856436 Added this next paragraph as part of the changes in https://docs.jboss.org/author/display/GTNPORTAL35/Administration+and+Moni.... Also added applications/portlets to the table to match the scope in the confluence source.</remark>
+ <para>The metrics and statistics are runtime only values, and are not persisted anywhere on the server. When the server is restarted, the runtime values are reset. JBoss Operations Network keeps a history of these statistics and metrics to give an accurate view of the data over time.</para>
<table id="table-Site_and_Portlet_Statistics">
<title>Site and Portlet Statistics</title>
<tgroup cols="2">
@@ -42,7 +45,7 @@
<para>Average Execution Time</para>
</entry>
<entry>
- <para>The average execution time in seconds for a page or portlet to render within a site.</para>
+ <para>The average execution time in seconds for a page or application/portlet to render within a site.</para>
</entry>
</row>
<row>
@@ -50,7 +53,7 @@
<para>Execution Count</para>
</entry>
<entry>
- <para>The amount of times the portlet or site has been accessed.</para>
+ <para>The amount of times the application/portlet or site has been accessed.</para>
</entry>
</row>
<row>
@@ -58,7 +61,7 @@
<para>Maximum Execution Time</para>
</entry>
<entry>
- <para>The maximum execution time in seconds for a page or portlet to render within a site.</para>
+ <para>The maximum execution time in seconds for a page or application/portlet to render within a site.</para>
</entry>
</row>
<row>
@@ -66,7 +69,7 @@
<para>Minimum Execution Time</para>
</entry>
<entry>
- <para>The minimum execution time in seconds for a page or portlet to render within a site.</para>
+ <para>The minimum execution time in seconds for a page or application/portlet to render within a site.</para>
</entry>
</row>
<row>
@@ -83,7 +86,7 @@
</section>
<section id="Administration_and_Monitoring-Operations">
<title>Operations</title>
- <para>The GateIn JON Plug-in itself does not provide any operations; it's sole purpose is reporting and statistics relating to portlets and sites. The JBoss Operations Network AS plug-in does support many management operations, and is included in JBoss Portal Platform binaries. With the AS plug-in, the following non-exhaustive list of actions are possible:</para>
+ <para>The GateIn JON Plug-in itself does not provide any operations; it's sole purpose is reporting and statistics relating to applications/portlets and sites. The JBoss Operations Network AS plug-in does support many management operations, and is included in JBoss Portal Platform binaries. With the AS plug-in, the following non-exhaustive list of actions are possible:</para>
<itemizedlist>
<listitem>
<para>Server control: start, stop, restart.</para>
@@ -92,9 +95,9 @@
<para>Application control: deploy, and remove EAR and WAR applications.</para>
</listitem>
<listitem>
- <para>Resource control: manage other components of the platform, such as datasources.</para>
+ <para>Resource control: manage other components of the platform, such as data sources.</para>
</listitem>
</itemizedlist>
- <para>For detailed information about JBoss Operations Network, and how it can be used to manage platforms, refer to the JBoss Operations Network <citetitle>How to Manage JBoss Servers</citetitle> guide available from <ulink url="http://docs.redhat.com/docs/en-US/JBoss_Operations_Network/index.html"/>.</para>
+ <para>For detailed information about JBoss Operations Network, and how it can be used to manage platforms, refer to the JBoss Operations Network <citetitle>How to Manage JBoss Servers</citetitle> guide available from <ulink url="http://access.redhat.com/knowledge/docs/JBoss_Operations_Network/"/>.</para>
</section>
</chapter>
12 years, 1 month
gatein SVN: r8961 - epp/docs/branches/6.0/Migration_Guide.
by do-not-reply@jboss.org
Author: jaredmorgs
Date: 2012-11-12 23:12:15 -0500 (Mon, 12 Nov 2012)
New Revision: 8961
Added:
epp/docs/branches/6.0/Migration_Guide/DON'T_EDIT_THIS_SOURCE
Log:
adding a stray file in my working directory
Added: epp/docs/branches/6.0/Migration_Guide/DON'T_EDIT_THIS_SOURCE
===================================================================
--- epp/docs/branches/6.0/Migration_Guide/DON'T_EDIT_THIS_SOURCE (rev 0)
+++ epp/docs/branches/6.0/Migration_Guide/DON'T_EDIT_THIS_SOURCE 2012-11-13 04:12:15 UTC (rev 8961)
@@ -0,0 +1,3 @@
+This is not the canonical source for this documentation.
+
+The guide is a PressGang CCMS book.
12 years, 1 month
gatein SVN: r8960 - in epp/docs/branches/6.0: Developer_Guide/en-US and 13 other directories.
by do-not-reply@jboss.org
Author: jaredmorgs
Date: 2012-11-12 23:09:53 -0500 (Mon, 12 Nov 2012)
New Revision: 8960
Modified:
epp/docs/branches/6.0/Admin_Guide/en-US/Revision_History.xml
epp/docs/branches/6.0/Developer_Guide/en-US/Book_Info.xml
epp/docs/branches/6.0/Developer_Guide/en-US/Revision_History.xml
epp/docs/branches/6.0/Reference_Guide/en-US/Author_Group.xml
epp/docs/branches/6.0/Reference_Guide/en-US/Book_Info.xml
epp/docs/branches/6.0/Reference_Guide/en-US/Preface.xml
epp/docs/branches/6.0/Reference_Guide/en-US/Revision_History.xml
epp/docs/branches/6.0/Reference_Guide/en-US/extras/PortletBridge_Configuration/default201.xml
epp/docs/branches/6.0/Reference_Guide/en-US/extras/PortletBridge_Configuration/default202.xml
epp/docs/branches/6.0/Reference_Guide/en-US/modules/Advanced/Foundations/Config_Retrieval.xml
epp/docs/branches/6.0/Reference_Guide/en-US/modules/Advanced/Foundations/Configuring_Services.xml
epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/AuthenticationAuthorizationOverview.xml
epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/AuthenticationTokenConfiguration.xml
epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/CoreOrganizationInitializer.xml
epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/LDAP.xml
epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/PasswordEncryption.xml
epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/PredefinedUserConfiguration.xml
epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/SAML2.xml
epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/SSO.xml
epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalPermissionConfiguration.xml
epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/LocalizationConfiguration.xml
epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/NavigationController.xml
epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/RTLFramework.xml
epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortletDevelopment/Global_Portlet.xml
epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge.xml
epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge/configuration.xml
epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge/portlet_development.xml
epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortletDevelopment/Standard.xml
epp/docs/branches/6.0/Reference_Guide/en-US/modules/WSRP.xml
epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR.xml
epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr-with-gtn/managed-datasources-under-jboss-as.xml
epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr/cluster-config.xml
epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr/configuration/exo-jcr-configuration.xml
epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr/configuration/jdbc-data-container-config.xml
epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr/configuration/multilanguage-support.xml
epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr/configuration/search-configuration.xml
epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr/jbosscache-configuration-templates.xml
epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/searching-repository-content.xml
epp/docs/branches/6.0/User_Guide/en-US/Author_Group.xml
epp/docs/branches/6.0/User_Guide/en-US/Book_Info.xml
epp/docs/branches/6.0/User_Guide/en-US/Revision_History.xml
Log:
Updated all references to the old product name, including file path abbreviations.
Modified: epp/docs/branches/6.0/Admin_Guide/en-US/Revision_History.xml
===================================================================
--- epp/docs/branches/6.0/Admin_Guide/en-US/Revision_History.xml 2012-11-12 14:52:07 UTC (rev 8959)
+++ epp/docs/branches/6.0/Admin_Guide/en-US/Revision_History.xml 2012-11-13 04:09:53 UTC (rev 8960)
@@ -8,6 +8,20 @@
<simpara>
<revhistory>
<revision>
+ <revnumber>6.0.0-2</revnumber>
+ <date>Tue Oct 30 2012</date>
+ <author>
+ <firstname>Jared</firstname>
+ <surname>Morgan</surname>
+ <email/>
+ </author>
+ <revdescription>
+ <simplelist>
+ <member>Standardized subtitle across all books.</member>
+ </simplelist>
+ </revdescription>
+ </revision>
+ <revision>
<revnumber>6.0.0-1</revnumber>
<date>Thu Oct 25 2012</date>
<author>
Modified: epp/docs/branches/6.0/Developer_Guide/en-US/Book_Info.xml
===================================================================
--- epp/docs/branches/6.0/Developer_Guide/en-US/Book_Info.xml 2012-11-12 14:52:07 UTC (rev 8959)
+++ epp/docs/branches/6.0/Developer_Guide/en-US/Book_Info.xml 2012-11-13 04:09:53 UTC (rev 8960)
@@ -5,7 +5,7 @@
]>
<bookinfo id="book-Developer_Guide-Developer_Guide">
<title>Developer Guide</title>
- <subtitle>for use with JBoss Portal Platform &VY; and its patch releases.</subtitle>
+ <subtitle>for use with JBoss Portal Platform 6 and it's patch releases.</subtitle>
<productname>JBoss Portal Platform</productname>
<productnumber>6</productnumber>
<edition>6.0.0</edition>
Modified: epp/docs/branches/6.0/Developer_Guide/en-US/Revision_History.xml
===================================================================
--- epp/docs/branches/6.0/Developer_Guide/en-US/Revision_History.xml 2012-11-12 14:52:07 UTC (rev 8959)
+++ epp/docs/branches/6.0/Developer_Guide/en-US/Revision_History.xml 2012-11-13 04:09:53 UTC (rev 8960)
@@ -4,6 +4,20 @@
<title>Revision History</title>
<simpara>
<revhistory>
+ <revision>
+ <revnumber>6.0.0-5</revnumber>
+ <date>Tue Oct 30 2012</date>
+ <author>
+ <firstname>Jared</firstname>
+ <surname>Morgan</surname>
+ <email/>
+ </author>
+ <revdescription>
+ <simplelist>
+ <member>Standardized subtitle across all books.</member>
+ </simplelist>
+ </revdescription>
+ </revision>
<revision>
<revnumber>6.0.0-4</revnumber>
<date>Thu Oct 25 2012</date>
Modified: epp/docs/branches/6.0/Reference_Guide/en-US/Author_Group.xml
===================================================================
--- epp/docs/branches/6.0/Reference_Guide/en-US/Author_Group.xml 2012-11-12 14:52:07 UTC (rev 8959)
+++ epp/docs/branches/6.0/Reference_Guide/en-US/Author_Group.xml 2012-11-13 04:09:53 UTC (rev 8960)
@@ -4,21 +4,17 @@
%BOOK_ENTITIES;
]>
<authorgroup>
+ <author>
+ <firstname>Red Hat</firstname>
+ <surname>Documentation Group</surname>
+ </author>
<editor>
<firstname>Thomas</firstname>
<surname>Heute</surname>
- <affiliation>
- <shortaffil>Red Hat</shortaffil>
- <orgdiv>JBoss Engineering</orgdiv>
- </affiliation>
</editor>
<editor>
<firstname>Chris</firstname>
<surname>Laprun</surname>
- <affiliation>
- <shortaffil>Red Hat</shortaffil>
- <orgdiv>JBoss Engineering</orgdiv>
- </affiliation>
</editor>
<othercredit>
<affiliation>
Modified: epp/docs/branches/6.0/Reference_Guide/en-US/Book_Info.xml
===================================================================
--- epp/docs/branches/6.0/Reference_Guide/en-US/Book_Info.xml 2012-11-12 14:52:07 UTC (rev 8959)
+++ epp/docs/branches/6.0/Reference_Guide/en-US/Book_Info.xml 2012-11-13 04:09:53 UTC (rev 8960)
@@ -5,7 +5,7 @@
]>
<bookinfo id="book-Reference_Guide-Reference_Guide">
<title>Reference Guide</title>
- <subtitle>for use with JBoss Portal Platform and its patch releases.</subtitle>
+ <subtitle>for use with JBoss Portal Platform 6.</subtitle>
<productname>JBoss Portal Platform</productname>
<productnumber>6</productnumber>
<edition>6.0.0</edition>
Modified: epp/docs/branches/6.0/Reference_Guide/en-US/Preface.xml
===================================================================
--- epp/docs/branches/6.0/Reference_Guide/en-US/Preface.xml 2012-11-12 14:52:07 UTC (rev 8959)
+++ epp/docs/branches/6.0/Reference_Guide/en-US/Preface.xml 2012-11-13 04:09:53 UTC (rev 8960)
@@ -14,12 +14,12 @@
<variablelist id="vari-Reference_Guide-Introduction-Devices">
<varlistentry>
<term>
- <replaceable>EPP_DIST</replaceable>
+ <replaceable>JPP_DIST</replaceable>
</term>
<listitem>
<para>The installation root of the JBoss Enterprise Application Platform instance. This folder contains the main folders that comprise the server such as <filename>/jboss-as</filename>.
</para>
- <para>For example, if the JBoss Portal Platform instance is deployed into the <filename>/opt/jboss/jboss-epp-&VY;/</filename> directory, the <replaceable>EPP_DIST</replaceable> directory is <filename>/opt/jboss/jboss-epp-&VY;</filename>.
+ <para>For example, if the JBoss Portal Platform instance is deployed into the <filename>/opt/jboss/jboss-epp-&VY;/</filename> directory, the <replaceable>JPP_DIST</replaceable> directory is <filename>/opt/jboss/jboss-epp-&VY;</filename>.
</para>
</listitem>
</varlistentry>
@@ -28,7 +28,7 @@
<replaceable>PORTAL_SSO</replaceable>
</term>
<listitem>
- <para>The zip file located in the <filename><filename>EPP_DIST</filename>/gatein-sso</filename> directory of the JBoss Portal Platform binary package. Used throughout <xref linkend="sect-Reference_Guide-SSO_Single_Sign_On"/>.</para>
+ <para>The zip file located in the <filename><filename>JPP_DIST</filename>/gatein-sso</filename> directory of the JBoss Portal Platform binary package. Used throughout <xref linkend="sect-Reference_Guide-SSO_Single_Sign_On"/>.</para>
</listitem>
</varlistentry>
<varlistentry>
@@ -52,8 +52,8 @@
<replaceable>PROFILE</replaceable>
</term>
<listitem>
- <para>The name of the server profile used as part of testing or production configuration. The server profiles reside in <filename>EPP_DIST/jboss-as/server</filename>.</para>
- <para>For example, to use the <literal>default</literal> profile, replace the <replaceable>PROFILE</replaceable> text in the file path to read <filename><replaceable>EPP_DIST</replaceable>/jboss-as/server/<replaceable>default</replaceable>/</filename>
+ <para>The name of the server profile used as part of testing or production configuration. The server profiles reside in <filename>JPP_DIST/jboss-as/server</filename>.</para>
+ <para>For example, to use the <literal>default</literal> profile, replace the <replaceable>PROFILE</replaceable> text in the file path to read <filename><replaceable>JPP_DIST</replaceable>/jboss-as/server/<replaceable>default</replaceable>/</filename>
</para>
</listitem>
</varlistentry>
Modified: epp/docs/branches/6.0/Reference_Guide/en-US/Revision_History.xml
===================================================================
--- epp/docs/branches/6.0/Reference_Guide/en-US/Revision_History.xml 2012-11-12 14:52:07 UTC (rev 8959)
+++ epp/docs/branches/6.0/Reference_Guide/en-US/Revision_History.xml 2012-11-13 04:09:53 UTC (rev 8960)
@@ -8,8 +8,23 @@
<simpara>
<revhistory>
<revision>
+ <revnumber>6.0.0-17</revnumber>
+ <date>Mon Nov 5 2012</date>
+ <author>
+ <firstname>Jared</firstname>
+ <surname>Morgan</surname>
+ <email/>
+ </author>
+ <revdescription>
+ <simplelist>
+ <member>BZ#856417 - Added Examples to Portlet Bridge section from content in https://docs.jboss.org/author/display/PBR/Examples, and did a final review of content before submitting JSF2 and RF4 tasks for QE validation. </member>
+ <member>Also removed text references to JBoss Enterprise Portal Platform, Enterprise Portal Platform, EPP_HOME, and EPP_DIST.</member>
+ </simplelist>
+ </revdescription>
+ </revision>
+ <revision>
<revnumber>6.0.0-16</revnumber>
- <date>Fri Nov 2 2012</date>
+ <date>Fri Nov 02 2012</date>
<author>
<firstname>Petr</firstname>
<surname>Penicka</surname>
@@ -21,9 +36,23 @@
</simplelist>
</revdescription>
</revision>
- <revision>
+ <revision>
+ <revnumber>6.0.0-15</revnumber>
+ <date>Thu Nov 01 2012</date>
+ <author>
+ <firstname>Jared</firstname>
+ <surname>Morgan</surname>
+ <email/>
+ </author>
+ <revdescription>
+ <simplelist>
+ <member>BZ#856427 - Added Implementing Portlet Bridge section from content contained at https://docs.jboss.org/author/display/PBR/Installing+Portlet+Bridge</member>
+ </simplelist>
+ </revdescription>
+ </revision>
+ <revision>
<revnumber>6.0.0-14</revnumber>
- <date>Thu Nov 1 2012</date>
+ <date>Thu Nov 01 2012</date>
<author>
<firstname>Petr</firstname>
<surname>Penicka</surname>
@@ -31,11 +60,25 @@
</author>
<revdescription>
<simplelist>
- <member>Finished BZ#850885 - added relevant information about rendering of route parameters.</member>
+ <member>BZ#850885 - added relevant information about rendering of route parameters.</member>
</simplelist>
</revdescription>
</revision>
- <revision>
+ <revision>
+ <revnumber>6.0.0-13</revnumber>
+ <date>Tue Oct 30 2012</date>
+ <author>
+ <firstname>Jared</firstname>
+ <surname>Morgan</surname>
+ <email/>
+ </author>
+ <revdescription>
+ <simplelist>
+ <member>Put in idrefs for all SAML 2 content, and changed title of subtitle for uniformity.</member>
+ </simplelist>
+ </revdescription>
+ </revision>
+ <revision>
<revnumber>6.0.0-12</revnumber>
<date>Mon Oct 25 2012</date>
<author>
Modified: epp/docs/branches/6.0/Reference_Guide/en-US/extras/PortletBridge_Configuration/default201.xml
===================================================================
--- epp/docs/branches/6.0/Reference_Guide/en-US/extras/PortletBridge_Configuration/default201.xml 2012-11-12 14:52:07 UTC (rev 8959)
+++ epp/docs/branches/6.0/Reference_Guide/en-US/extras/PortletBridge_Configuration/default201.xml 2012-11-13 04:09:53 UTC (rev 8960)
@@ -1,8 +1,4 @@
- <context-param>
- <param-name>javax.portlet.faces.RENDER_POLICY</param-name>
- <param-value>
- ALWAYS_DELEGATE
- </param-value>
- </context-param>
- ...
-</web-app>
+<context-param>
+ <param-name>javax.portlet.faces.RENDER_POLICY</param-name>
+ <param-value>ALWAYS_DELEGATE</param-value>
+</context-param>
Modified: epp/docs/branches/6.0/Reference_Guide/en-US/extras/PortletBridge_Configuration/default202.xml
===================================================================
--- epp/docs/branches/6.0/Reference_Guide/en-US/extras/PortletBridge_Configuration/default202.xml 2012-11-12 14:52:07 UTC (rev 8959)
+++ epp/docs/branches/6.0/Reference_Guide/en-US/extras/PortletBridge_Configuration/default202.xml 2012-11-13 04:09:53 UTC (rev 8960)
@@ -1,13 +1,5 @@
-<web-app xmlns="http://java.sun.com/xml/ns/j2ee"
- xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd"
- version="2.4">
-<!-- Other configuration information removed for clarity -->
- <context-param>
- <param-name>javax.portlet.faces.RENDER_POLICY </param-name>
- <param-value>
- NEVER_DELEGATE
- </param-value>
- </context-param>
-<!-- Other configuration information removed for clarity -->
-</web-app>
+<context-param>
+ <param-name>javax.portlet.faces.RENDER_POLICY </param-name>
+ <param-value>NEVER_DELEGATE</param-value>
+</context-param>
+
Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/Advanced/Foundations/Config_Retrieval.xml
===================================================================
--- epp/docs/branches/6.0/Reference_Guide/en-US/modules/Advanced/Foundations/Config_Retrieval.xml 2012-11-12 14:52:07 UTC (rev 8959)
+++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/Advanced/Foundations/Config_Retrieval.xml 2012-11-13 04:09:53 UTC (rev 8960)
@@ -14,17 +14,17 @@
<procedure>
<step>
<para>
- Services default <envar>RootContainer</envar> configurations from JAR files <filename><replaceable>EPP_DIST/jboss-as/</replaceable>/conf/gatein/configuration.xml</filename>.
+ Services default <envar>RootContainer</envar> configurations from JAR files <filename><replaceable>JPP_DIST/jboss-as/</replaceable>/conf/gatein/configuration.xml</filename>.
</para>
</step>
<step>
<para>
- External <envar>RootContainer</envar> configuration can be found at <filename><replaceable>EPP_DIST/jboss-as/</replaceable>/conf/gatein/configuration.xml</filename>.
+ External <envar>RootContainer</envar> configuration can be found at <filename><replaceable>JPP_DIST/jboss-as/</replaceable>/conf/gatein/configuration.xml</filename>.
</para>
</step>
<step>
<para>
- Services default <envar>PortalContainer</envar> configurations from JAR files <filename><replaceable>EPP_DIST</replaceable>/jboss-as/conf/portal/configuration.xml</filename>.
+ Services default <envar>PortalContainer</envar> configurations from JAR files <filename><replaceable>JPP_DIST</replaceable>/jboss-as/conf/portal/configuration.xml</filename>.
</para>
</step>
<step>
@@ -34,7 +34,7 @@
</step>
<step>
<para>
- External configuration for services of named portal can be found at <filename><replaceable>EPP_DIST</replaceable>/jboss-as/conf/gatein/configuration.xml</filename>.
+ External configuration for services of named portal can be found at <filename><replaceable>JPP_DIST</replaceable>/jboss-as/conf/gatein/configuration.xml</filename>.
</para>
</step>
</procedure>
Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/Advanced/Foundations/Configuring_Services.xml
===================================================================
--- epp/docs/branches/6.0/Reference_Guide/en-US/modules/Advanced/Foundations/Configuring_Services.xml 2012-11-12 14:52:07 UTC (rev 8959)
+++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/Advanced/Foundations/Configuring_Services.xml 2012-11-13 04:09:53 UTC (rev 8960)
@@ -21,7 +21,7 @@
All <filename>configuration.xml</filename> files located at <filename>conf/portal/configuration.xml</filename> in the classpath will have their services configured at the <literal>PortalContainer</literal> scope.
</para>
<para>
- Additionally, <emphasis role="bold">portal extensions</emphasis> can use configuration information stored in <filename><replaceable>EPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/02portal.war/WEB-INF/conf/configuration.xml</filename>, and will also have their services configured in the <literal>PortalContainer</literal> scope.
+ Additionally, <emphasis role="bold">portal extensions</emphasis> can use configuration information stored in <filename><replaceable>JPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/02portal.war/WEB-INF/conf/configuration.xml</filename>, and will also have their services configured in the <literal>PortalContainer</literal> scope.
</para>
<para>
When eXo kernel reads a configuration, it loads the file from the kernel jar using the classloader and does not use an internet connection to resolve the file.
Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/AuthenticationAuthorizationOverview.xml
===================================================================
--- epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/AuthenticationAuthorizationOverview.xml 2012-11-12 14:52:07 UTC (rev 8959)
+++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/AuthenticationAuthorizationOverview.xml 2012-11-13 04:09:53 UTC (rev 8960)
@@ -44,7 +44,7 @@
Authentication workflow consists of HTTP requests and redirects which include handshakes. Source code related to authentication is partially included in the WCI module, as the authentication process differs on <ulink url="http://www.jcp.org/en/jsr/detail?id=154" type="http">Servlet 2.5</ulink> containers and <ulink url="http://www.jcp.org/en/jsr/detail?id=315" type="http">Servlet 3.0</ulink> containers.
</para>
<para>
- First you can see in <filename><replaceable>EPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/02portal.war/WEB-INF/web.xml</filename> that authentication is triggered by accessing a secured URL:
+ First you can see in <filename><replaceable>JPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/02portal.war/WEB-INF/web.xml</filename> that authentication is triggered by accessing a secured URL:
</para>
<programlisting language="XML" role="XML">
<![CDATA[
@@ -87,7 +87,7 @@
]]>
</programlisting>
<para>
- <literal>InitiateLoginServlet</literal> simply redirects user to login page placed in <filename><replaceable>EPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/02portal.war/login/jsp/login.jsp</filename>.
+ <literal>InitiateLoginServlet</literal> simply redirects user to login page placed in <filename><replaceable>JPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/02portal.war/login/jsp/login.jsp</filename>.
<mediaobject>
<imageobject role="html">
<imagedata align="center" fileref="images/AuthenticationAndIdentity/Overview/loginScreen.png" format="PNG"/>
@@ -98,7 +98,7 @@
</mediaobject>
</para>
<para>
- Changes to the appearance of this login page can be made in this JSP file. You can also change image or CSS placed in <filename><replaceable>EPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/login/skin</filename> .
+ Changes to the appearance of this login page can be made in this JSP file. You can also change image or CSS placed in <filename><replaceable>JPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/login/skin</filename> .
</para>
<para>
After a user submits the login form, they are redirected to the login URL; <ulink url="http://localhost:8080/portal/login?username=root&password=gtn&ini..." type="http">http://localhost:8080/portal/login?username=root&password=gtn&ini...</ulink>.
Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/AuthenticationTokenConfiguration.xml
===================================================================
--- epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/AuthenticationTokenConfiguration.xml 2012-11-12 14:52:07 UTC (rev 8959)
+++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/AuthenticationTokenConfiguration.xml 2012-11-13 04:09:53 UTC (rev 8960)
@@ -33,7 +33,7 @@
<section id="sect-Reference_Guide-Authentication_Token_Configuration-Configuring_Token_Services">
<title>Configuring Token Services</title>
<para>
- Token services configuration includes specifying the token validity period. The token service is configured as a portal component using the <filename><replaceable>EPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/02portal.war/WEB-INF/conf/common/autologin-configuration.xml</filename> file.
+ Token services configuration includes specifying the token validity period. The token service is configured as a portal component using the <filename><replaceable>JPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/02portal.war/WEB-INF/conf/common/autologin-configuration.xml</filename> file.
</para>
<para>
In the XML example below, <emphasis>CookieTokenService</emphasis> is a subclass of <emphasis role="bold">AbstractTokenService</emphasis> so it has a property which specifies the validity period of the token.
Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/CoreOrganizationInitializer.xml
===================================================================
--- epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/CoreOrganizationInitializer.xml 2012-11-12 14:52:07 UTC (rev 8959)
+++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/CoreOrganizationInitializer.xml 2012-11-13 04:09:53 UTC (rev 8960)
@@ -8,11 +8,11 @@
<para>The plug-in is particularly useful when using the Site Publisher add-on, and directly adding users or groups to a LDAP server through LDIF files, or into a database using SQL. </para>
<section>
<title>Enable Initializer</title>
- <para>The initializer is disabled by default. To activate it, uncomment the block containing the path to the <filename>initializer-configuration.xml</filename> file in <filename><replaceable>EPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/02portal.war/conf/configuration.xml</filename>.
+ <para>The initializer is disabled by default. To activate it, uncomment the block containing the path to the <filename>initializer-configuration.xml</filename> file in <filename><replaceable>JPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/02portal.war/conf/configuration.xml</filename>.
</para>
<programlisting language="XML"><!-- Uncomment for enable initializer (OrganizationListenersInitializerService and related stuff) -->
<import>war:/conf/organization/initializer-configuration.xml</import></programlisting>
- <para>All configuration for the initializer occurs in <filename><replaceable>EPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/02portal.war/conf/organization/initializer-configuration.xml</filename>, which is the main configuration file
+ <para>All configuration for the initializer occurs in <filename><replaceable>JPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/02portal.war/conf/organization/initializer-configuration.xml</filename>, which is the main configuration file
for this initializer. More details about configuration options, along with alternatives to XML directive configuration, are described in subsequent sections.</para>
</section>
<section>
@@ -79,7 +79,7 @@
</section>
<section id="Triggering_Operations">
<title>Using configuration directives</title>
- <para>There are a number of ways of controlling operations associated with CoreOrganizationInitializer. All parameters are configured in <value-param> directive blocks in the <filename><replaceable>EPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/02portal.war/conf/organization/initializer-configuration.xml</filename> file.</para>
+ <para>There are a number of ways of controlling operations associated with CoreOrganizationInitializer. All parameters are configured in <value-param> directive blocks in the <filename><replaceable>JPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/02portal.war/conf/organization/initializer-configuration.xml</filename> file.</para>
<example>
<title><value-param> block for initializer directives</title>
<programlisting language="XML"><value-param>
@@ -91,7 +91,7 @@
<title>Disable launchAll at Startup</title>
<para>For large implementations with many users and groups, consider disabling <parameter>launchAll</parameter> functionality during start-up for each portal container. Disabling this operation during start-up will result in a performance improvement.</para>
<step>
- <para>Open <filename><replaceable>EPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/02portal.war/conf/organization/initializer-configuration.xml</filename></para>
+ <para>Open <filename><replaceable>JPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/02portal.war/conf/organization/initializer-configuration.xml</filename></para>
</step>
<step>
<para>Locate the <parameter>executeAllListenersDuringBoot</parameter> <value-param> parameter.</para>
@@ -104,7 +104,7 @@
<title>Disable launchAll Job Scheduler</title>
<para>A job scheduler is configured to run by default, and executes <parameter>launchAll</parameter> periodically. For large implementations with many users and groups, consider disabling the Job scheduler <parameter>launchAll</parameter> functionality for each portal container. Disabling this operation may result in a performance improvement.</para>
<step>
- <para>Open <filename><replaceable>EPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/02portal.war/conf/organization/initializer-configuration.xml</filename></para>
+ <para>Open <filename><replaceable>JPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/02portal.war/conf/organization/initializer-configuration.xml</filename></para>
</step>
<step>
<para>Search for "scheduler" in the file.</para>
@@ -117,7 +117,7 @@
<title>Alter the way JCR objects are created on-demand, at user login. </title>
<para>When a user logs into the portal, the <parameter>treatUser</parameter> operation runs on-demand to create the required JCR objects. This operation (activated by default) improves overall performance of the portal, because user objects are only created when needed. To disable the operation (not recommended), follow the guidelines below.</para>
<step>
- <para>Open <filename><replaceable>EPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/02portal.war/conf/organization/initializer-configuration.xml</filename></para>
+ <para>Open <filename><replaceable>JPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/02portal.war/conf/organization/initializer-configuration.xml</filename></para>
</step>
<step>
<para>Locate the <parameter>ExtensibleFilter</parameter> directive block.</para>
@@ -145,13 +145,9 @@
<para>Locate the correct MBean, depending on the portal container used. Substitute the portal="<replaceable>portal_name</replaceable>" value with the name of the portal container used in your production environment.</para>
<itemizedlist>
<listitem>
- <para>For Enterprise Portal Platform.</para>
+ <para>For JBoss Portal Platform.</para>
<para>MBean <parameter>name=OrganizationInitializerService,portal="portal", service=OrganizationInitializerService</parameter></para>
</listitem>
- <listitem>
- <para>For Enterprise Portal Platform, with Site Publisher add-on.</para>
- <para>MBean <parameter>name=OrganizationInitializerService,portal="ecmdemo", service=OrganizationInitializerService</parameter></para>
- </listitem>
</itemizedlist>
</step>
<step>
@@ -164,43 +160,57 @@
<para>OrganizationInitializerService can be accessed using a REST interface. Some examples of commands are provided, as a practical way of demonstrating the REST syntax required. Pay particular attention to how forward slash symbols are escaped in directory paths featured in some REST syntax examples.</para>
<variablelist>
<varlistentry>
- <term><ulink url="http://localhost:8080/rest/initializer/launchAllListeners/true">http://localhost:8080/rest/initializer/launchAllListeners/true</ulink></term>
+ <term>
+ <ulink url="http://localhost:8080/rest/initializer/launchAllListeners/true">http://localhost:8080/rest/initializer/launchAllListeners/true</ulink>
+ </term>
<listitem>
<para>Trigger <parameter>launchAll</parameter> for portal container "portal", with <parameter>checkFolders=true</parameter>.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><ulink url="http://localhost:8080/rest-ecmdemo/initializer/launchAllListeners/true">http://localhost:8080/rest-ecmdemo/initializer/launchAllListeners/true</ulink></term>
+ <term>
+ <ulink url="http://localhost:8080/rest-ecmdemo/initializer/launchAllListeners/true">http://localhost:8080/rest-ecmdemo/initializer/launchAllListeners/true</ulink>
+ </term>
<listitem>
<para>Trigger <parameter>launchAll</parameter> for portal container "ecmdemo", with <parameter>checkFolders=true</parameter>.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><ulink url="http://localhost:8080/rest-ecmdemo/initializer/launchAllListeners/false">http://localhost:8080/rest-ecmdemo/initializer/launchAllListeners/false</ulink></term>
+ <term>
+ <ulink url="http://localhost:8080/rest-ecmdemo/initializer/launchAllListeners/false">http://localhost:8080/rest-ecmdemo/initializer/launchAllListeners/false</ulink>
+ </term>
<listitem>
<para>Trigger <parameter>launchAll</parameter> for portal container "ecmdemo", with <parameter>checkFolders=false</parameter>.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><ulink url="http://localhost:8080/rest/initializer/launchUserListeners/jduke/true">http://localhost:8080/rest/initializer/launchUserListeners/jduke/true</ulink></term>
+ <term>
+ <ulink url="http://localhost:8080/rest/initializer/launchUserListeners/jduke/true">http://localhost:8080/rest/initializer/launchUserListeners/jduke/true</ulink>
+ </term>
<listitem>
<para>Trigger <parameter>treatUser</parameter> for portal container "portal", for user "jduke"with <parameter>checkFolders=true</parameter>.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><ulink url="http://localhost:8080/rest-ecmdemo/initializer/launchUserListeners/jduke/...">http://localhost:8080/rest-ecmdemo/initializer/launchUserListeners/jduke/...</ulink></term>
+ <term>
+ <ulink url="http://localhost:8080/rest-ecmdemo/initializer/launchUserListeners/jduke/...">http://localhost:8080/rest-ecmdemo/initializer/launchUserListeners/jduke/...</ulink>
+ </term>
<listitem>
<para>Trigger <parameter>treatUser</parameter> for portal container "portal", for user "jduke"with <parameter>checkFolders=false</parameter>.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><ulink url="http://localhost:8080/rest/initializer/launchGroupListeners/@platform@use...">http://localhost:8080/rest/initializer/launchGroupListeners/@platform@use...</ulink></term>
+ <term>
+ <ulink url="http://localhost:8080/rest/initializer/launchGroupListeners/@platform@use...">http://localhost:8080/rest/initializer/launchGroupListeners/@platform@use...</ulink>
+ </term>
<listitem>
<para>Trigger "<parameter>treatGroup</parameter>" for group "/platform/users" in the portal container "portal".</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><ulink url="http://localhost:8080/rest-ecmdemo/initializer/launchGroupListeners/@acme...">http://localhost:8080/rest-ecmdemo/initializer/launchGroupListeners/@acme...</ulink></term>
+ <term>
+ <ulink url="http://localhost:8080/rest-ecmdemo/initializer/launchGroupListeners/@acme...">http://localhost:8080/rest-ecmdemo/initializer/launchGroupListeners/@acme...</ulink>
+ </term>
<listitem>
<para>Trigger "<parameter>treatGroup</parameter>" for group "/acme/roles/employee" in the portal container "ecmdemo".</para>
</listitem>
Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/LDAP.xml
===================================================================
--- epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/LDAP.xml 2012-11-12 14:52:07 UTC (rev 8959)
+++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/LDAP.xml 2012-11-13 04:09:53 UTC (rev 8960)
@@ -7,7 +7,7 @@
<note>
<title>Notational Device</title>
<para>
- For ease of readability the following section uses the notational device <replaceable>ID_HOME</replaceable> to represent the file path <filename><replaceable>EPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/02portal.war/WEB-INF/conf/organization/</filename>, as this directory is the root of all JBoss Portal Platform's identity-related configuration.
+ For ease of readability the following section uses the notational device <replaceable>ID_HOME</replaceable> to represent the file path <filename><replaceable>JPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/02portal.war/WEB-INF/conf/organization/</filename>, as this directory is the root of all JBoss Portal Platform's identity-related configuration.
</para>
</note>
<para>
Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/PasswordEncryption.xml
===================================================================
--- epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/PasswordEncryption.xml 2012-11-12 14:52:07 UTC (rev 8959)
+++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/PasswordEncryption.xml 2012-11-13 04:09:53 UTC (rev 8960)
@@ -17,7 +17,7 @@
<orderedlist>
<listitem>
<para>
- The <emphasis>Remember Me</emphasis> feature can be disabled by removing the corresponding checkbox in: <filename><replaceable>EPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/02portal.war/login/jsp/login.jsp</filename> and <filename><replaceable>EPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/02portal.war/groovy/portal/webui/UILoginForm.gtmpl</filename>.
+ The <emphasis>Remember Me</emphasis> feature can be disabled by removing the corresponding checkbox in: <filename><replaceable>JPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/02portal.war/login/jsp/login.jsp</filename> and <filename><replaceable>JPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/02portal.war/groovy/portal/webui/UILoginForm.gtmpl</filename>.
</para>
</listitem>
<listitem>
@@ -45,7 +45,7 @@
</step>
<step>
<para>
- Deploy the <filename>codec-example.jar</filename> into your <filename><replaceable>EPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/lib/</filename> directory.
+ Deploy the <filename>codec-example.jar</filename> into your <filename><replaceable>JPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/lib/</filename> directory.
</para>
</step>
<step>
Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/PredefinedUserConfiguration.xml
===================================================================
--- epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/PredefinedUserConfiguration.xml 2012-11-12 14:52:07 UTC (rev 8959)
+++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/PredefinedUserConfiguration.xml 2012-11-13 04:09:53 UTC (rev 8960)
@@ -8,7 +8,7 @@
<section id="sect-Reference_Guide-Predefined_User_Configuration-Overview">
<title>Overview</title>
<para>
- The initial Organization configuration should be specified by editing the content of <filename><replaceable>EPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/02portal.war:/WEB-INF/conf/organization/organization-configuration.xml</filename>. This file uses the portal XML configuration schema. It lists several configuration plug-ins.
+ The initial Organization configuration should be specified by editing the content of <filename><replaceable>JPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/02portal.war:/WEB-INF/conf/organization/organization-configuration.xml</filename>. This file uses the portal XML configuration schema. It lists several configuration plug-ins.
</para>
</section>
<section id="sect-Reference_Guide-Predefined_User_Configuration-Plugin_for_adding_users_groups_and_membership_types">
Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/SAML2.xml
===================================================================
(Binary files differ)
Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/SSO.xml
===================================================================
--- epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/SSO.xml 2012-11-12 14:52:07 UTC (rev 8959)
+++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/SSO.xml 2012-11-13 04:09:53 UTC (rev 8960)
@@ -48,7 +48,7 @@
</para>
</note>
<para>
- All the packages required for SSO setup can be found in a zip file located in the <filename><filename>EPP_DIST</filename>/gatein-sso</filename> directory of the JBoss Portal Platform binary package.
+ All the packages required for SSO setup can be found in a zip file located in the <filename><filename>JPP_DIST</filename>/gatein-sso</filename> directory of the JBoss Portal Platform binary package.
</para>
<para>
In the following scenarios this directory will be referred to as <replaceable>PORTAL_SSO</replaceable>.
@@ -104,7 +104,7 @@
<title>SSO Integration</title>
<step>
<para>
- Open the <filename><replaceable>EPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/jbossweb.sar/server.xml</filename> file and uncomment one of the two <parameter>Valve</parameter> entries:
+ Open the <filename><replaceable>JPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/jbossweb.sar/server.xml</filename> file and uncomment one of the two <parameter>Valve</parameter> entries:
</para>
<itemizedlist>
<listitem>
@@ -167,7 +167,7 @@
</step>
<step>
<para>
- Open the <filename><replaceable>EPP_DIST</replaceable>/jboss-as/server/all/<replaceable>PROFILE</replaceable>/jbossweb.sar/server.xml</filename> file.
+ Open the <filename><replaceable>JPP_DIST</replaceable>/jboss-as/server/all/<replaceable>PROFILE</replaceable>/jbossweb.sar/server.xml</filename> file.
</para>
</step>
<step>
@@ -236,7 +236,7 @@
<title/>
<step>
<para>
- Open the <filename><replaceable>EPP_DIST</replaceable>/jboss-as/server/node1/deploy/jmx-console.war/WEB-INF/web.xml</filename> file and edit it as follows:
+ Open the <filename><replaceable>JPP_DIST</replaceable>/jboss-as/server/node1/deploy/jmx-console.war/WEB-INF/web.xml</filename> file and edit it as follows:
</para>
<substeps>
<step>
@@ -302,7 +302,7 @@
<title>Redirect to Use SSO Valve Authentication</title>
<step>
<para>
- Open the <filename><replaceable>EPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/web.war/groovy/groovy/webui/component/UIBannerPortlet.gtml</filename> file and edit the line:
+ Open the <filename><replaceable>JPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/web.war/groovy/groovy/webui/component/UIBannerPortlet.gtml</filename> file and edit the line:
</para>
<programlisting language="Java" role="java"><a class="Login" onclick="$signInAction"><%=_ctx.appRes("UILoginForm.label.Signin")%></a>
</programlisting>
@@ -314,7 +314,7 @@
</step>
<step>
<para>
- Open the <filename><replaceable>EPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/web.war/groovy/portal/webui/component/UILogoPortlet.gtmpl</filename> file and change the line:
+ Open the <filename><replaceable>JPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/web.war/groovy/portal/webui/component/UILogoPortlet.gtmpl</filename> file and change the line:
</para>
<programlisting language="Java" role="java"><a onclick="$signInAction"><%=_ctx.appRes("UILogoPortlet.action.signin")%></a>
</programlisting>
@@ -409,7 +409,7 @@
</taskprerequisites>
<procedure>
<step>
- <para>Open <filename>EPP_DIST/standalone/configuration/gatein/configuration.properties</filename>, and locate the SSO sections in the file.</para>
+ <para>Open <filename>JPP_DIST/standalone/configuration/gatein/configuration.properties</filename>, and locate the SSO sections in the file.</para>
</step>
<step>
<para>Make the following changes to the file to declare the correct login module, server and portal URLs, and the logout filter. Ensure <replaceable> [portal.container.name]</replaceable> is replaced with the name of the portal container used in production.</para>
@@ -526,12 +526,12 @@
<title>Setup the CAS client</title>
<step>
<para>
- Copy all the libraries from the <filename><replaceable>PORTAL_SSO</replaceable>/cas/gatein.ear/lib</filename> directory into the <filename><replaceable>EPP_DIST</replaceable>/jboss-as/server/default/deploy/gatein.ear/lib</filename>) directory<remark><-- what are the new file paths?</remark>.
+ Copy all the libraries from the <filename><replaceable>PORTAL_SSO</replaceable>/cas/gatein.ear/lib</filename> directory into the <filename><replaceable>JPP_DIST</replaceable>/jboss-as/server/default/deploy/gatein.ear/lib</filename>) directory<remark><-- what are the new file paths?</remark>.
</para>
</step>
<step>
<para>
- Edit the <filename><replaceable>EPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/META-INF/gatein-jboss-beans.xml</filename> file. In the file, first comment out or remove all <login-module> entries. Then uncomment the following section <remark><-- what are the new file paths?</remark>:
+ Edit the <filename><replaceable>JPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/META-INF/gatein-jboss-beans.xml</filename> file. In the file, first comment out or remove all <login-module> entries. Then uncomment the following section <remark><-- what are the new file paths?</remark>:
</para>
<programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/Authentication_Identity_SSO/default105.xml" parse="text"/></programlisting>
<!-- Removing as per https://issues.jboss.org/browse/JBEPP-1350
@@ -576,13 +576,13 @@
<title>Redirect to CAS</title>
<step>
<para>
- Modify the '<emphasis role="bold">Sign In</emphasis>' link in the <filename><replaceable>EPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/web.war/groovy/groovy/webui/component/UIBannerPortlet.gtml</filename> file as follows <remark><-- what are the new file paths?</remark>:
+ Modify the '<emphasis role="bold">Sign In</emphasis>' link in the <filename><replaceable>JPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/web.war/groovy/groovy/webui/component/UIBannerPortlet.gtml</filename> file as follows <remark><-- what are the new file paths?</remark>:
</para>
<programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/Authentication_Identity_SSO/default106.xml" parse="text"/></programlisting>
</step>
<step>
<para>
- Modify the '<emphasis role="bold">Sign In</emphasis>' link in the <filename><replaceable>EPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/web.war/groovy/portal/webui/component/UILogoPortlet.gtmpl</filename> file as follows <remark><-- what are the new file paths?</remark>:
+ Modify the '<emphasis role="bold">Sign In</emphasis>' link in the <filename><replaceable>JPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/web.war/groovy/portal/webui/component/UILogoPortlet.gtmpl</filename> file as follows <remark><-- what are the new file paths?</remark>:
</para>
<programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/Authentication_Identity_SSO/default107.xml" parse="text"/></programlisting>
</step>
@@ -674,16 +674,16 @@
</para>
</note>
<step>
- <para>Copy the library files from <filename><replaceable>PORTAL_SSO</replaceable>/josso/<replaceable>josso-18X</replaceable>/gatein.ear/lib</filename> into <filename><replaceable>EPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/lib</filename>.</para>
+ <para>Copy the library files from <filename><replaceable>PORTAL_SSO</replaceable>/josso/<replaceable>josso-18X</replaceable>/gatein.ear/lib</filename> into <filename><replaceable>JPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/lib</filename>.</para>
</step>
<step>
<para>
- Copy <filename><replaceable>PORTAL_SSO</replaceable>/josso/<replaceable>josso-18X</replaceable>/gatein.ear/portal.war/WEB-INF/classes/josso-agent-config.xml</filename> and paste the file into the <filename><replaceable>EPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/02portal.war/WEB-INF/classes</filename> directory.
+ Copy <filename><replaceable>PORTAL_SSO</replaceable>/josso/<replaceable>josso-18X</replaceable>/gatein.ear/portal.war/WEB-INF/classes/josso-agent-config.xml</filename> and paste the file into the <filename><replaceable>JPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/02portal.war/WEB-INF/classes</filename> directory.
</para>
</step>
<step>
<para>
- Edit <filename><replaceable>EPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/META-INF/gatein-jboss-beans.xml</filename> and uncomment this section:
+ Edit <filename><replaceable>JPP_DIST</replaceable>/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 xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/Authentication_Identity_SSO/default111.xml" parse="text"/></programlisting>
</step>
@@ -716,7 +716,7 @@
</para>
<step>
<para>
- In the <filename><replaceable>EPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/web.war/groovy/groovy/webui/component/UIBannerPortlet.gtml</filename> file modify the <guilabel>Sign In</guilabel> link as follows:
+ In the <filename><replaceable>JPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/web.war/groovy/groovy/webui/component/UIBannerPortlet.gtml</filename> file modify the <guilabel>Sign In</guilabel> link as follows:
</para>
<programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/Authentication_Identity_SSO/default112.xml" parse="text"/></programlisting>
</step>
@@ -763,7 +763,7 @@
</procedure>
<note>
<para>
- It is also possible to use OpenAM instead of OpenSSO server. OpenAM is free and the integration steps between Enterprise Portal Platform and OpenAM are very similar as with OpenSSO. More info is available <ulink url="http://community.jboss.org/wiki/GateInAndOpenAMIntegration" type="http"> here </ulink> .
+ It is also possible to use OpenAM instead of OpenSSO server. OpenAM is free and the integration steps between JBoss Portal Platform and OpenAM are very similar as with OpenSSO. More info is available <ulink url="http://community.jboss.org/wiki/GateInAndOpenAMIntegration" type="http"> here </ulink> .
</para>
</note>
<section id="sect-Reference_Guide-SSO_Single_Sign_On_-Modifying_the_OpenSSO_server">
@@ -960,15 +960,15 @@
<title>Setup the OpenSSO client</title>
<step>
<para>
- Copy all libraries from the <filename><replaceable>PORTAL_SSO</replaceable>/opensso/gatein.ear/lib</filename> directory into the <filename><replaceable>EPP_DIST</replaceable>/jboss-as/server/default/deploy/gatein.ear/lib</filename> directory.
+ Copy all libraries from the <filename><replaceable>PORTAL_SSO</replaceable>/opensso/gatein.ear/lib</filename> directory into the <filename><replaceable>JPP_DIST</replaceable>/jboss-as/server/default/deploy/gatein.ear/lib</filename> directory.
</para>
<para>
- Alternatively, in a Tomcat environment, copy the libraries into the <filename><replaceable>EPP_DIST</replaceable>/jboss-as/ibib</filename> directory.
+ Alternatively, in a Tomcat environment, copy the libraries into the <filename><replaceable>JPP_DIST</replaceable>/jboss-as/ibib</filename> directory.
</para>
</step>
<step>
<para>
- Edit the <filename><replaceable>EPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/META-INF/gatein-jboss-beans.xml</filename> and uncomment this section:
+ Edit the <filename><replaceable>JPP_DIST</replaceable>/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 xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/Authentication_Identity_SSO/default118.xml" parse="text"/></programlisting>
</step>
@@ -1008,13 +1008,13 @@
The next part of the process is to redirect all user authentication to the OpenSSO server.
</para>
<para>
- Information about where the OpenSSO server is hosted must be properly configured within the Enterprise Portal Platform instance. The required configuration is done by modifying three files:
+ Information about where the OpenSSO server is hosted must be properly configured within the JBoss Portal Platform instance. The required configuration is done by modifying three files:
</para>
<procedure id="proc-Reference_Guide-Setup_the_portal_to_redirect_to_OpenSSO-Setup_the_portal_to_redirect_to_OpenSSO">
<title>Setup the portal to redirect to OpenSSO</title>
<step>
<para>
- Modify the '<emphasis role="bold">Sign In</emphasis>' link in the <filename><replaceable>EPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/web.war/groovy/groovy/webui/component/UIBannerPortlet.gtml</filename> file as follows:
+ Modify the '<emphasis role="bold">Sign In</emphasis>' link in the <filename><replaceable>JPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/web.war/groovy/groovy/webui/component/UIBannerPortlet.gtml</filename> file as follows:
</para>
<programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/Authentication_Identity_SSO/default119.xml" parse="text"/></programlisting>
</step>
@@ -1358,10 +1358,10 @@
</step>
<step>
<para>
- Add the SSO module binaries by copying <filename>PORTAL_SSO/spnego/gatein.ear/lib/sso-agent.jar</filename> to the <filename><replaceable>EPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/lib/</filename> directory.
+ Add the SSO module binaries by copying <filename>PORTAL_SSO/spnego/gatein.ear/lib/sso-agent.jar</filename> to the <filename><replaceable>JPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/lib/</filename> directory.
</para>
<para>
- Copy the <filename>PORTAL_SSO/spnego/gatein.ear/lib/sso-spnego.jar</filename> file to the <filename><replaceable>EPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/lib</filename> directory.
+ Copy the <filename>PORTAL_SSO/spnego/gatein.ear/lib/sso-spnego.jar</filename> file to the <filename><replaceable>JPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/lib</filename> directory.
</para>
</step>
<!-- This step not required as EPP already has the correct version of Negotiation 2.0.4.GA
@@ -1374,7 +1374,7 @@
</step>
--> <step>
<para>
- Modify the <filename><replaceable>EPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/META-INF/gatein-jboss-beans.xml</filename> file to match the following:
+ Modify the <filename><replaceable>JPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/META-INF/gatein-jboss-beans.xml</filename> file to match the following:
</para>
<programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/Authentication_Identity_SSO/default126.xml" parse="text"/></programlisting>
<para>
@@ -1383,7 +1383,7 @@
</step>
<step>
<para>
- Modify <filename><replaceable>EPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/02portal.war/WEB-INF/web.xml</filename> to match:
+ Modify <filename><replaceable>JPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/02portal.war/WEB-INF/web.xml</filename> to match:
</para>
<programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/Authentication_Identity_SSO/default127.xml" parse="text"/></programlisting>
<para>
@@ -1417,13 +1417,13 @@
</step>
<step>
<para>
- Integrate the request pre-processing needed for SPNEGO via filters by adding the following filters to the <filename><replaceable>EPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/02portal.war/WEB-INF/web.xml</filename> at the top of the Filter chain.
+ Integrate the request pre-processing needed for SPNEGO via filters by adding the following filters to the <filename><replaceable>JPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/02portal.war/WEB-INF/web.xml</filename> at the top of the Filter chain.
</para>
<programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/Authentication_Identity_SSO/default128.xml" parse="text"/></programlisting>
</step>
<step>
<para>
- Edit the '<emphasis role="bold">Sign In</emphasis>' link in <filename><replaceable>EPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/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>JPP_DIST</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 xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/Authentication_Identity_SSO/default129.java" parse="text"/></programlisting>
</step>
Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalPermissionConfiguration.xml
===================================================================
--- epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalPermissionConfiguration.xml 2012-11-12 14:52:07 UTC (rev 8959)
+++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalPermissionConfiguration.xml 2012-11-13 04:09:53 UTC (rev 8960)
@@ -8,7 +8,7 @@
<section id="sect-Reference_Guide-Portal_Default_Permission_Configuration-Overview">
<title>Overview</title>
<para>
- The default permission configuration for the portal is defined through the <literal>org.exoplatform.portal.config.UserACL</literal> component configuration in the <filename><replaceable>EPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/02portal.war/WEB-INF/conf/portal/portal-configuration.xml</filename> file.
+ The default permission configuration for the portal is defined through the <literal>org.exoplatform.portal.config.UserACL</literal> component configuration in the <filename><replaceable>JPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/02portal.war/WEB-INF/conf/portal/portal-configuration.xml</filename> file.
</para>
<para>
It defines eight permissions types:
Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/LocalizationConfiguration.xml
===================================================================
--- epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/LocalizationConfiguration.xml 2012-11-12 14:52:07 UTC (rev 8959)
+++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/LocalizationConfiguration.xml 2012-11-13 04:09:53 UTC (rev 8960)
@@ -57,7 +57,7 @@
The returned <literal>Locale</literal> has to be one of the locales supported by portal, otherwise it will fall back to the portal default <literal>Locale</literal>.
</para>
<para>
- The supported locales are listed in <filename><replaceable>EPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/02portal.war/WEB-INF/conf/common/locales-config.xml</filename> file as described in <xref linkend="sect-Reference_Guide-Internationalization_Configuration-Locales_Configuration"/> .
+ The supported locales are listed in <filename><replaceable>JPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/02portal.war/WEB-INF/conf/common/locales-config.xml</filename> file as described in <xref linkend="sect-Reference_Guide-Internationalization_Configuration-Locales_Configuration"/> .
</para>
<para>
The <literal>determineLocale()</literal> method takes a parameter of type <literal>LocaleContextInfo</literal>, which represents a compilation of preferred locales from different sources; user’s profile, portal default, browser language settings, current session, browser cookie.
@@ -204,7 +204,7 @@
<section id="sect-Reference_Guide-Pluggable_Locale_Policy-LocalePolicy_Configuration">
<title>LocalePolicy Configuration</title>
<para>
- The <literal>LocalePolicy</literal> framework is enabled for portlets by configuring <literal>LocalizationLifecycle</literal> class in portal's webui configuration file: <filename><replaceable>EPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/02portal.war/WEB-INF/webui-configuration.xml</filename>:
+ The <literal>LocalePolicy</literal> framework is enabled for portlets by configuring <literal>LocalizationLifecycle</literal> class in portal's webui configuration file: <filename><replaceable>JPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/02portal.war/WEB-INF/webui-configuration.xml</filename>:
</para>
<programlisting language="XML" role="XML"><application-life-cycle-listeners>
...
@@ -212,7 +212,7 @@
</application-life-cycle-listeners>
</programlisting>
<para>
- The default <literal>LocalePolicy</literal> implementation is installed as an eXo Kernel portal service via <filename><replaceable>EPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/02portal.war/WEB-INF/conf/portal/web-configuration.xml</filename>.
+ The default <literal>LocalePolicy</literal> implementation is installed as an eXo Kernel portal service via <filename><replaceable>JPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/02portal.war/WEB-INF/conf/portal/web-configuration.xml</filename>.
</para>
<para>
The following excerpt is responsible for installing the service:
@@ -244,7 +244,7 @@
That way even localization of servlets, and .jsps accessed in a non-bridged manner can stay in sync with portlet localization.
</para>
<para>
- <literal>LocalizationFilter</literal> is installed through the portal's web.xml file: <filename><replaceable>EPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/02portal.war/WEB-INF/web.xml</filename>.
+ <literal>LocalizationFilter</literal> is installed through the portal's web.xml file: <filename><replaceable>JPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/02portal.war/WEB-INF/web.xml</filename>.
</para>
<programlisting language="XML" role="XML"><filter>
<filter-name>LocalizationFilter</filter-name>
Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/NavigationController.xml
===================================================================
--- epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/NavigationController.xml 2012-11-12 14:52:07 UTC (rev 8959)
+++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/NavigationController.xml 2012-11-13 04:09:53 UTC (rev 8960)
@@ -391,54 +391,54 @@
</listitem>
</itemizedlist>
</section>
- <section id="sect-Reference_Guide-Creating_Custom_Error_Pages-Overview">
- <title>Custom error pages</title>
- <para>
- When an HTML error code is returned as a response to a URL request (e.g. 404 Not Found), JBoss Enterprise Portal Platform redirects users to a default error page where the error code is displayed together with an explanatory message. To replace the default error page with a customized one, the configuration explained below needs to be performed.
- </para>
- <procedure>
- <title>Configuring redirection to custom error pages</title>
- <step>
- <para>
- Create the actual error pages and place them in the <filename>JPP_HOME/gatein/gatein.ear/portal.war/</filename> directory.
- </para>
- </step>
- <step>
- <para>
- For each error code that shall have its custom error page, add the <literal><error-page></literal> element to the <filename>JPP_HOME/gatein/gatein.ear/portal.war/WEB-INF/web.xml</filename> file. This element specifies what page is displayed when the particular error code is returned.
- </para>
- <para>
- The sample code below ensures that the <filename>my404.html</filename> page is displayed when the 404 error code is returned.
+ <section id="sect-Reference_Guide-Creating_Custom_Error_Pages-Overview">
+ <title>Custom error pages</title>
+ <para>
+ When an HTML error code is returned as a response to a URL request (e.g. 404 Not Found), JBoss Portal Platform redirects users to a default error page where the error code is displayed together with an explanatory message. To replace the default error page with a customized one, the configuration explained below needs to be performed.
+ </para>
+ <procedure>
+ <title>Configuring redirection to custom error pages</title>
+ <step>
+ <para>
+ Create the actual error pages and place them in the <filename>JPP_HOME/gatein/gatein.ear/portal.war/</filename> directory.
+ </para>
+ </step>
+ <step>
+ <para>
+ For each error code that shall have its custom error page, add the <literal><error-page></literal> element to the <filename>JPP_HOME/gatein/gatein.ear/portal.war/WEB-INF/web.xml</filename> file. This element specifies what page is displayed when the particular error code is returned.
+ </para>
+ <para>
+ The sample code below ensures that the <filename>my404.html</filename> page is displayed when the 404 error code is returned.
<programlisting language="XML"><![CDATA[
<error-page>
<error-code>404</error-code>
<location>/my404.html</location>
</error-page>
]]></programlisting>
- </para>
- </step>
- <step>
- <para>
- Specify the error page locations as static resources in the <filename>JPP_HOME/standalone/configuration/gatein/controller.xml</filename> file. The code sample below demonstrates this configuration for the <filename>/my404.html</filename> path.
+ </para>
+ </step>
+ <step>
+ <para>
+ Specify the error page locations as static resources in the <filename>JPP_HOME/standalone/configuration/gatein/controller.xml</filename> file. The code sample below demonstrates this configuration for the <filename>/my404.html</filename> path.
<programlisting language="XML"><![CDATA[
<route path="/my404.html">
<route-param qname="gtn:handler">
- <value>staticResource</value>
+ <value>staticResource</value>
</route-param>
</route>
]]></programlisting>
- </para>
- <para>
- Without this configuration, the portal tries to resolve <filename>/my404.html</filename> as a name of a portal or another resource. This results in unwanted redirection to <filename>/portal/my404.html</filename>. It is therefore necessary to configure the error page locations as static resources.
- </para>
- </step>
- <step>
- <para>
- When all the previous steps are performed, users are redirected to the specified custom error pages when the respective error codes are returned as a response to a URL request.
- </para>
- </step>
- </procedure>
- </section>
+ </para>
+ <para>
+ Without this configuration, the portal tries to resolve <filename>/my404.html</filename> as a name of a portal or another resource. This results in unwanted redirection to <filename>/portal/my404.html</filename>. It is therefore necessary to configure the error page locations as static resources.
+ </para>
+ </step>
+ <step>
+ <para>
+ When all the previous steps are performed, users are redirected to the specified custom error pages when the respective error codes are returned as a response to a URL request.
+ </para>
+ </step>
+ </procedure>
+ </section>
</section>
</section>
<section id="sect-Reference_Guide-Navigation_Controller_-Integrate_to_JBoss_Enterprise_Portal_Platform_WebUI_framework">
Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/RTLFramework.xml
===================================================================
--- epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/RTLFramework.xml 2012-11-12 14:52:07 UTC (rev 8959)
+++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/RTLFramework.xml 2012-11-13 04:09:53 UTC (rev 8960)
@@ -67,7 +67,7 @@
It works by appending -lt or -rt to the stylesheet name.
</para>
<para>
- For instance: <filename><replaceable>EPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/web.war/skin/portal/webui/component/UIFooterPortlet/DefaultStylesheet-rt.css</filename> will return the same stylesheet as <filename><replaceable>EPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/web.war/skin/portal/webui/component/UIFooterPortlet/DefaultStylesheet.css</filename> but processed for the RT orientation. The <parameter>-lt</parameter> suffix is optional.
+ For instance: <filename><replaceable>JPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/web.war/skin/portal/webui/component/UIFooterPortlet/DefaultStylesheet-rt.css</filename> will return the same stylesheet as <filename><replaceable>JPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/web.war/skin/portal/webui/component/UIFooterPortlet/DefaultStylesheet.css</filename> but processed for the RT orientation. The <parameter>-lt</parameter> suffix is optional.
</para>
<para>
Stylesheet authors can annotate their stylesheet to create content that depends on the orientation.
@@ -112,7 +112,7 @@
The web resource filter uses the same naming pattern as the skin service. When an image ends with the -rt suffix the portal will attempt to locate the original image and create a mirror of it.
</para>
<para>
- For instance: requesting the image <filename><replaceable>EPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/01eXoResources.war/skin/DefaultSkin/webui/component/UITabSystem/UITabs/background/NormalTabStyle-rt.gif</filename> returns a mirror of the image <filename><replaceable>EPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/01eXoResources.war/skin/DefaultSkin/webui/component/UITabSystem/UITabs/background/NormalTabStyle.gif</filename>.
+ For instance: requesting the image <filename><replaceable>JPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/01eXoResources.war/skin/DefaultSkin/webui/component/UITabSystem/UITabs/background/NormalTabStyle-rt.gif</filename> returns a mirror of the image <filename><replaceable>JPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/01eXoResources.war/skin/DefaultSkin/webui/component/UITabSystem/UITabs/background/NormalTabStyle.gif</filename>.
</para>
<note>
<para>
Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortletDevelopment/Global_Portlet.xml
===================================================================
--- epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortletDevelopment/Global_Portlet.xml 2012-11-12 14:52:07 UTC (rev 8959)
+++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortletDevelopment/Global_Portlet.xml 2012-11-13 04:09:53 UTC (rev 8960)
@@ -40,7 +40,7 @@
</portlet-app>
</programlisting>
<para>
- The path to the global <filename>portlet.xml</filename> is the value of <literal>gatein.portlet.config</literal> in the <filename>configuration.properties.xml</filename> file. By default, the file path is <filename><replaceable>EPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/conf/gatein/portlet.xml</filename>
+ The path to the global <filename>portlet.xml</filename> is the value of <literal>gatein.portlet.config</literal> in the <filename>configuration.properties.xml</filename> file. By default, the file path is <filename><replaceable>JPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/conf/gatein/portlet.xml</filename>
</para>
<section id="sect-Reference_Guide-Shared_portlet.xml-Global_Metadata_Elements">
<title>Global Metadata Elements</title>
Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge/configuration.xml
===================================================================
--- epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge/configuration.xml 2012-11-12 14:52:07 UTC (rev 8959)
+++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge/configuration.xml 2012-11-13 04:09:53 UTC (rev 8960)
@@ -4,7 +4,7 @@
%BOOK_ENTITIES;
]>
<section id="sect-Reference_Guide-Bridge_Configuration">
- <title>Bridge Configuration</title>
+ <title id="Portlet_Bridge_Bridge_Configuration">Bridge Configuration</title>
<section id="sect-Reference_Guide-Core_Setup_and_Configuration-portlet.xml">
<title>portlet.xml</title>
<para>To have access to all portlet 2 specification features, you must declare the portlet schema definition as prescribed in the <filename>portlet.xml</filename> file. The <init-param> directives are explained in more detail if required below the portlet.xml code.</para>
Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge/portlet_development.xml
===================================================================
--- epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge/portlet_development.xml 2012-11-12 14:52:07 UTC (rev 8959)
+++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge/portlet_development.xml 2012-11-13 04:09:53 UTC (rev 8960)
@@ -5,9 +5,125 @@
]>
<section id="sect-Reference_Guide-Developing_Portlets_with_the_Bridge">
<title>Developing Portlets with the Bridge</title>
- <para>
- This chapter demonstrates common development tasks described by the 329 specification.
+ <para>The following information demonstrates common development tasks described by the 329 specification.
</para>
+ <section id="Portlet_Bridge_Implementing">
+ <title><remark>BZ#856427 </remark>Implementing Portlet Bridge</title>
+ <remark>This entire section incorporates the content located at https://docs.jboss.org/author/display/PBR/Installing+Portlet+Bridge</remark>
+ <para>Portlet Bridge supports JSF2 and RichFaces 4 portlets. There are subtle differences in the way these portlets require Portlet Bridge to be implemented.</para>
+ <para>JSF2 and RichFaces 4 portlets must be JSF2 portlets for this version of the Portlet Bridge to function as expected.
+There are no other specific requirements.
+</para>
+ <section id="Portlet_Bridge_Artifact_Dependencies">
+ <title>Artifact Dependencies </title>
+ <para>A JSF2 portlet can inherit the correct dependencies by configuring the Maven repository. This will include all dependencies for all Portlet Bridge JSF2 scenarios. </para>
+ <procedure>
+ <title>Artifact Dependencies</title>
+ <step>
+ <para>Add the following <filename>pom.xml</filename> dependencies to inherit the correct JSF2 artifacts.</para>
+ <programlisting language="XML"><dependency>
+ <groupId>org.jboss.portletbridge</groupId>
+ <artifactId>portletbridge-api</artifactId>
+ <version>3.1.0.Final</version>
+</dependency>
+<dependency>
+ <groupId>org.jboss.portletbridge</groupId>
+ <artifactId>portletbridge-impl</artifactId>
+ <version>3.1.0.Final</version>
+ <scope>runtime</scope>
+</dependency></programlisting>
+ </step>
+ <step>
+ <para>For RichFaces 4 portlets, add the following additional dependency to inherit the additional RichFaces dependencies.</para>
+ <programlisting language="XML"><dependency>
+ <groupId>org.jboss.portletbridge</groupId>
+ <artifactId>portletbridge-extension-richfaces</artifactId>
+ <version>3.1.0.Final</version>
+ <scope>runtime</scope>
+</dependency></programlisting>
+ </step>
+ </procedure>
+ </section>
+ <section id="Portlet_Bridge_Depchain_Dependencies">
+ <title>Depchain Dependencies</title>
+ <para>It is possible to reduce the <filename>pom.xml</filename> configuration to a single dependency, using the Portlet Bridge Depchain <filename>pom.xml</filename> configuration.</para>
+ <procedure>
+ <title>JSF2 Depchain Dependencies</title>
+ <step>
+ <para>Add the following dependencies to inherit the correct artifacts using the <filename>pom.xml</filename> Depchain.</para>
+ <programlisting language="XML"><dependency>
+ <groupId>org.jboss.portletbridge</groupId>
+ <artifactId>jsf2-depchain</artifactId>
+ <version>3.1.0.Final</version>
+ <type>pom</type>
+</dependency></programlisting>
+ </step>
+ <step>
+ <para>For RichFaces 4 portlets, add the following additional dependency to inherit the correct artifacts using the <filename>pom.xml</filename> Depchain.</para>
+ <programlisting language="XML"><dependency>
+ <groupId>org.jboss.portletbridge</groupId>
+ <artifactId>jsf2-depchain</artifactId>
+ <version>3.1.0.Final</version>
+ <type>pom</type>
+</dependency>
+<dependency>
+ <groupId>org.jboss.portletbridge</groupId>
+ <artifactId>richfaces4-depchain</artifactId>
+ <version>3.1.0.Final</version>
+ <type>pom</type>
+</dependency></programlisting>
+ </step>
+ </procedure>
+ </section>
+ <section id="Portlet_Bridge_Deploying_Portal">
+ <title>Deploying to the portal</title>
+ <para>JBoss Portal Platform injects Portlet Bridge functionality into all JSF2 portlets by default, therefore portlets developed for the portal do not need to include the Portlet Bridge as part of the application. </para>
+ <para>If the Portlet Bridge API is included in a JSF2 or RichFaces 4 portlet, the provided scope must be correctly declared.</para>
+ <procedure>
+ <title>Setting the Provided Scope for JSF2 and RichFaces Portlets that use Portlet Bridge API</title>
+ <step>
+ <para>Add the following <filename>pom.xml</filename> dependencies to declare the JSF2 provided scope.</para>
+ <programlisting language="XML"><dependency>
+ <groupId>org.jboss.portletbridge</groupId>
+ <artifactId>portletbridge-api</artifactId>
+ <version>3.1.0.Final</version>
+ <scope>provided</scope>
+</dependency></programlisting>
+ </step>
+ <step>
+ <para>For RichFaces 4 portlets, add the following additional dependency to declare the RichFaces 4 runtime scope. </para>
+ <note>
+ <para>The RichFaces 4 extension is not included in the portal by default.</para>
+ </note>
+ <programlisting language="XML"><dependency>
+ <groupId>org.jboss.portletbridge</groupId>
+ <artifactId>portletbridge-extension-richfaces</artifactId>
+ <version>portletbridge-extension-richfaces-[VERSION]</version>
+ <scope>runtime</scope>
+</dependency></programlisting>
+ <para>Where <replaceable>[ARTIFACT VERSION]</replaceable> is the <classname>portletbridge-extension-richfaces</classname> version in <filename>JPP_HOME/modules/org/jboss/portletbridge/api/main</filename></para>
+ </step>
+ </procedure>
+ </section>
+ <section id="Portlet_Bridge_Disable_Injection">
+ <title>Disable Automatic Portlet Bridge Injection</title>
+ <para>In some cases, it is appropriate to prevent JBoss Portal Platform from injecting Portlet Bridge into the application. For example, if a different version of Portlet Bridge is required for the application.</para>
+ <procedure>
+ <title>Disabling automatic Portlet Bridge injection</title>
+ <step>
+ <para>Add the following <filename>pom.xml</filename> dependency to prevent JBoss Portal Platform injecting the packaged Portlet Bridge implementation into a portlet application.</para>
+ <note>
+ <para>If a portlet application specifies either WAR_BUNDLES_JSF or JSF_CONFIG_NAME context parameters in the <filename>pom.xml</filename>, Portlet Bridge will not be automatically injected.</para>
+ </note>
+ <programlisting language="XML">
+<context-param>
+ <param-name>org.gatein.portletbridge.WAR_BUNDLES_PORTLETBRIDGE</param-name>
+ <param-value>true</param-value>
+</context-param></programlisting>
+ </step>
+ </procedure>
+ </section>
+ </section>
<section>
<title>Portlet tags</title>
<para>Portlet Bridge supports the following tags from section PLT.26 of the Portlet 2.0 Spec (JSR 286):</para>
@@ -56,22 +172,32 @@
When your application uses request attributes on a per request basis and you do not want that particular attribute to be managed in the extended bridge request scope, you must use the following configuration in your <filename>faces-config.xml</filename>.
</para>
<para>
- In the code sample below you can see that any attribute namespaced as <literal>foo.bar</literal> or any attribute beginning with <literal>foo.baz.(wild-card)</literal> will be excluded from the bridge request scope and only be used per that application's request.
+ In the code sample below, any attribute namespaced as <literal>foo.bar</literal>, or any attribute beginning with <literal>foo.baz.(wild-card)</literal> will be excluded from the bridge request scope and only be used for that application's request.
</para>
<programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../../extras/PortletBridge_Portlet_Development/default223.xml" parse="text"/></programlisting>
</section>
+ <section>
+ <title>Prevent Resources Being Added to Portal Page Head </title>
+ <remark>Taken from https://docs.jboss.org/author/display/PBR/Disable+Adding+Resources+to+Por...</remark>
+ <para>Portlet Bridge will add any JSF Resources for the portlet into the <head> section of the portal page the portlet is on, providing the portlet container supports marking up the head of a page.</para>
+ <para>To prevent Portlet Bridge from adding resources into the <head> section of the portal page, override the default behavior by declaring the following directive in the portlet's <filename> web.xml</filename> file.</para>
+ <programlisting language="XML"><context-param>
+ <param-name>org.jboss.portletbridge.markupHead.enabled</param-name>
+ <param-value>false</param-value>
+</context-param></programlisting>
+ </section>
<section id="JSF_Facelet_View">
- <title>JSF facelet view</title>
+ <title id="Portlet_Bridge_JSF_Facelet_View">JSF facelet view</title>
<para>When creating a JSF Facelet view document, it is common to see content wrapped with the following code.</para>
<programlisting language="HTML"><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" ">
<html xmlns="http://www.w3.org/1999/xhtml" xmlns:h="http://java.sun.com/jsf/html" xmlns:f="http://java.sun.com/jsf/core"
- xmlns:ui="http://java.sun.com/jsf/facelets" xmlns:a4j="http://richfaces.org/a4j">
+ xmlns:ui="http://java.sun.com/jsf/facelets" >
<!-- Unnecessary content removed for clarity -->
</html></programlisting>
<para>Because a single portlet only reflects a potentially small portion of the HTML markup for a page, a JSF portlet returning the above markup for each portlet can be distracting, and potentially problematic.</para>
- <para>The recommended way to wrap the content of a JSF Facelet view document for a portlet is to use the <f:view> element. Using <f:view> means that only the relevant content of the portlet mark-up is returned to the page.</para>
+ <para>The recommended way to wrap the content of a JSF Facelet view document for a portlet is to use the <f:view> element. Using <f:view> results in the relevant portlet mark-up being returned to the page as required.</para>
<programlisting language="HTML"><f:view xmlns="http://www.w3.org/1999/xhtml" xmlns:h="http://java.sun.com/jsf/html" xmlns:f="http://java.sun.com/jsf/core"
- xmlns:ui="http://java.sun.com/jsf/facelets" xmlns:a4j="http://richfaces.org/a4j">
+ xmlns:ui="http://java.sun.com/jsf/facelets" >
<!-- Unnecessary content removed for clarity -->
</f:view></programlisting>
<note>
@@ -79,8 +205,8 @@
</note>
</section>
<section id="JSF_Facelet_Error_Handling">
- <title>Error handling</title>
- <para>To display error pages for specific exceptions in a JSF portlet, the following code is required in the web.xml file.</para>
+ <title id="Portlet_Bridge_Error_Handling">Error handling</title>
+ <para>To display error pages for specific exceptions in a JSF portlet, the following code is required in the <filename>web.xml</filename> file.</para>
<programlisting language="XML"><error-page>
<exception-type>javax.servlet.ServletException</exception-type>
<location>/faces/error.xhtml</location>
@@ -90,14 +216,14 @@
<location>/faces/error.xhtml</location>
</error-page></programlisting>
<para>The above error page definitions are appropriate for a JSF portlet that has a FacesServlet mapping such as /faces/. </para>
- <para>If the FacesServlet mapping was **.jsf, the location would be error, error.jsf or error.xhtml.</para>
+ <para>If the FacesServlet mapping was **.jsf, the location would be <filename>/error</filename>, <filename>/error.jsf</filename> or <filename>/error.xhtml</filename>.</para>
<para>There is no requirement when using FacesServlet suffix mapping to append an extension, the name of the view is all that is required for the page to be found</para>
<note>
<para>Remember to add a link from any error page to the normal flow of the JSF application, otherwise the same error page will be constantly displayed.</para>
</note>
</section>
<section id="sect-Reference_Guide-Developing_Portlets_with_the_Bridge-Supporting_PortletMode_Changes">
- <title>Switching Portlet Modes</title>
+ <title id="Portlet_Bridge_Switching_Portlet_Modes">Switching Portlet Modes</title>
<para>
A <literal>PortletMode</literal> represents a distinct render path within an application. There are three standard modes: <emphasis>view</emphasis>, <emphasis>edit</emphasis>, and <emphasis>help</emphasis>.
</para>
@@ -111,10 +237,10 @@
<programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../../extras/PortletBridge_Portlet_Development/default224.xml" parse="text"/></programlisting>
</example>
</section>
- <section id="sect-Reference_Guide-Developing_Portlets_with_the_Bridge-Navigating_to_a_modes_last_viewId">
+ <section id="Portlet_Bridge-Navigating_to_a_modes_last_viewId">
<title>Navigating to a mode's last viewId</title>
<para>
- By default a mode change will start in the mode's default view without any (prior) existing state. One common portlet pattern when returning to a mode left after entering another mode (e.g.. view -> edit -> view) is to return to the last view (and state) of this origin mode.
+ By default a mode change will start in the mode's default view without any (prior) existing state. One common portlet pattern when returning to a mode left after entering another mode (e.g.. view -> edit -> view) is to return to the last view (and state) of this original mode.
</para>
<para>
The bridge will explicitly encode the necessary information so that when returning to a prior mode it can target the appropriate view and restore the appropriate state.
@@ -130,59 +256,32 @@
<para><remark>BZ#856417 - added from "Portlet Mode's last viewId" Confluence section</remark>This navigation rule causes one to render the <filename>/edit.xhtml</filename> viewId in the portlet edit mode. </para>
<programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../../extras/PortletBridge_Portlet_Development/default225.xml" parse="text"/></programlisting>
</example>
- <section id="sect-Reference_Guide-Navigating_to_a_modes_last_viewId-Note_to_Portlet_Developers">
- <title>Note to Portlet Developers</title>
- <para>
- Depending on the bridge implementation, when using values from these session scoped attributes or any viewIds which may contain query string parameters it may be necessary to use the wild-card syntax when identifying the rule target. In the above, for example, the
- </para>
- <programlisting language="XML" role="XML"><to-view-id>
-</programlisting>
- <para>
- expression returns a <parameter>viewId</parameter> of the form
- </para>
- <programlisting language="XML" role="XML">/viewId?javax.portlet.faces.PortletMode=view&....
-</programlisting>
- <para>
- Without wild-carding, when a subsequent navigation occurs from this new view, the navigation rules wouldn't resolve because there wouldn't be an exact match. Likewise, the above <literal>edit.jspx</literal>
- </para>
- <programlisting language="XML" role="XML"><from-view-id>
-</programlisting>
- <para>
+ </section>
+ <section id="Portlet_Bridge-Note_to_Portlet_Developers">
+ <title>Using Wildcards to Identify the Rule Target</title>
+ <para>When using values from session scoped attributes, or viewIds which may contain query string parameters, it may be necessary to use the wild-card syntax when identifying the rule target. </para>
+ <para>In <xref linkend="Portlet_Bridge-Navigating_to_a_modes_last_viewId"/> the
+<to-view-id>
+ expression returns a <parameter>viewId</parameter> of the form </para>
+ <programlisting language="XML" role="XML">/viewId?javax.portlet.faces.PortletMode=view&....</programlisting>
+ <para> Without wild-carding, when a subsequent navigation occurs from this new view, the navigation rules would not resolve because there would not be an exact match. </para>
+ <para>Similarly, the <literal>edit.jspx</literal>
+<from-view-id>
is wild-carded because there are navigation rules that target it that use a query string:
- </para>
- <programlisting language="XML" role="XML">
-<to-view-id> /edit.jspx?javax.portlet.faces.PortletMode=edit </to-view-id>
-</programlisting>
- <para>
+ </para>
+ <programlisting language="XML" role="XML"><to-view-id> /edit.jspx?javax.portlet.faces.PortletMode=edit </to-view-id></programlisting>
+ <para>
Developers are encouraged to use such wild-carding to ensure they execute properly in the broadest set of bridge implementations.
</para>
- </section>
</section>
- <section id="sect-Reference_Guide-Developing_Portlets_with_the_Bridge-Clearing_The_View_History_When_Changing_Portlet_Modes">
+ <section id="Portlet_Bridge-Clearing_View_History_When_Changing_Portlet_Modes">
<title>Clearing The View History When Changing Portlet Modes</title>
<para>
By default the bridge remembers the view history when you switch to a different portlet mode (like "Help" or "Edit"). You can use the following parameter in your <filename>portlet.xml</filename> to use the default viewId each time you switch modes.
</para>
<programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../../extras/PortletBridge_Portlet_Development/default230.xml" parse="text"/></programlisting>
</section>
-<!--BZ#856417 - Commented out the section "General Error Handling" because it relates to Seam, which isn't supported at time of updating this section of PBR2.--><!--<section id="sect-Reference_Guide-Developing_Portlets_with_the_Bridge-General_Error_Handling">
- <title>General Error Handling</title>
- <note>
- <para>
- If you are developing a <application>Seam</application> portlet you can now use <filename>pages.xml</filename> for all error handling.
- </para>
- </note>
- <para>
- The following configuration may be used to handle exceptions. This is also useful for handling session timeout and <literal>ViewExpiredExceptions</literal>.
- </para>
- <note>
- <title>The Location Element</title>
- <para>
- The location element must contain the <filename>/faces/</filename> mapping to work properly.
- </para>
- </note>
- <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../../extras/PortletBridge_Portlet_Development/default231.xml" parse="text"/></programlisting>
-</section>--><!--BZ#856417 - Deleted the section "Custom Ajax Error Handling" because it isn't supported at time of updating this section of PBR2. See the 5.2 version of the Reference Guide for the original section.--> <section id="sect-Reference_Guide-Developing_Portlets_with_the_Bridge-Communication_Between_Your_Portlets">
+ <section id="Portlet-Bridge-Communication_Between_Your_Portlets">
<title>Communication Between Your Portlets</title>
<para>
There are four different ways to send messages, events, and parameters between portlets which are contained in different <literal>ears/wars</literal> or contained in the same <literal>war</literal>.
@@ -199,7 +298,7 @@
<para>
However, if these do not meet your use case or you have a different strategy, you can use one of the following methods.
</para>
- <section id="sect-Reference_Guide-Communication_Between_Your_Portlets-Storing_Components_in_PortletSession.APPLICATION_SCOPE">
+ <section id="Portlet_Bridge-Storing_Components_in_PortletSession.APPLICATION_SCOPE">
<title>Storing Components in PortletSession.APPLICATION_SCOPE</title>
<para>
Sometimes it is beneficial to store your <application>Seam</application> components in the portlet <parameter>APPLICATION_SCOPE</parameter>.
@@ -217,26 +316,25 @@
This method is demonstrated in this video: <ulink url="http://www.vimeo.com/4521877">Lesson 2: Portlet 1.0 Advanced Seam and RichFaces</ulink>
</para>
</section>
- <section id="sect-Reference_Guide-Communication_Between_Your_Portlets-Using_the_PortletSession">
+ <section id="Portlet_Bridge-Using_the_PortletSession">
<title>Using the PortletSession</title>
<para>
- If you need to access the <literal>PortletSession</literal> to simply share a parameter or value across multiple portlets, you can use the following:
+ If you only need to access the <literal>PortletSession</literal> to share a parameter or value across multiple portlets, you can use the following:
</para>
<programlisting language="Java" role="Java"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../../extras/PortletBridge_Portlet_Development/default236.java" parse="text"/></programlisting>
<para>
Then, in your JSP or Facelets page, you can use:
</para>
- <programlisting language="XML" role="XML">#{httpSessionScope['your parameter name']}
-</programlisting>
+ <programlisting language="XML" role="XML">#{httpSessionScope['your parameter name']}</programlisting>
</section>
</section>
- <section id="sect-Reference_Guide-Developing_Portlets_with_the_Bridge-Linking_to_PortletJSF_Pages_Using_houtputlink">
+ <section id="Portlet_Bridge-Linking_to_PortletJSF_Pages_Using_houtputlink">
<title>Linking to a Facelets page within the same portlet</title>
<para>To link any JSF/Facelets page within a portlet web application, use the following code.
</para>
<programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../../extras/PortletBridge_Portlet_Development/default238.xml" parse="text"/></programlisting>
</section>
- <section id="sect-Reference_Guide-Developing_Portlets_with_the_Bridge-Redirecting_to_an_External_Page_or_Resource">
+ <section id="Portlet_Bridge-Redirecting_to_an_External_Page_or_Resource">
<title>Redirecting to an external page or resource</title>
<para>
To link to a non JSF view, <emphasis>jboss.org</emphasis> for example, you can use the following code.
@@ -250,7 +348,7 @@
}
}</programlisting>
</section>
- <section id="sect-Using_Provided_EL_Variables">
+ <section id="Portlet_Bridge-Using_Provided_EL_Variables">
<title>Using Provided EL Variables</title>
<para>
All <literal>EL</literal> variables found in the JSR-329 (Portlet 2.0) specification are available in the JBoss Portlet Bridge. </para>
Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge.xml
===================================================================
--- epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge.xml 2012-11-12 14:52:07 UTC (rev 8959)
+++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge.xml 2012-11-13 04:09:53 UTC (rev 8960)
@@ -5,11 +5,11 @@
]>
<chapter id="chap-Reference_Guide-Building_JSF_Portlets">
<title>JBoss Portlet Bridge</title>
- <section>
+ <section id="Portlet_Bridge_Definition">
<title>Portlet Bridge</title>
<para>A portlet bridge is a mediator that allows non-native application frameworks to run in a portal environment, independent to the underlying portlet API, or portlet concept. This functionality provides a developer flexibility to continue writing applications in a preferred language, and allows a controlled transition to new technologies. </para>
</section>
- <section>
+ <section id="Portlet_Bridge_What_Is_Portlet_Bridge">
<title>JBoss Portlet Bridge</title>
<para>The JBoss Portlet Bridge is an implementation of the JSR-329 specification. It supports the JSF 2.0 runtime within a JSR 168 or 286 portlet.
Version 3.x of the bridge is compatible with JSF 2.0 and RichFaces 4.x.</para>
@@ -26,21 +26,20 @@
The other part of this implementation is provided by implementing a variety of (standard) <literal>Faces</literal> extensions.
</para>
</section>
- <section>
+ <section id="Portlet_Bridge_File_Locations">
<title>File Locations</title>
<remark>BZ#856417 - NEEDINFO - will we be packaging the portletbridge binaries in this folder for EPP 6? </remark>
- <para>The binaries required for Portlet Bridge applications, and example applications that can be used to learn and understand JSF applications are located in in <filename>EPP_HOME/portletbridge</filename>. </para>
+ <para>The binaries required for Portlet Bridge applications, and example applications that can be used to learn and understand JSF applications are located in in <filename>JPP_DIST/portletbridge</filename>. </para>
<para>Configuration files for Portlet Bridge are located in the following locations: </para>
- <remark>BZ#856417 - NEEDINFO - basing these file paths on what I understand the structure will be using EAP 6. DOMAIN in this case refers to /managed or /standalone</remark>
<itemizedlist>
<listitem>
- <para><replaceable>EPP_HOME</replaceable>/<replaceable>DOMAIN</replaceable>/<replaceable>portlet_name</replaceable>.war/WEB-INF/portlet.xml</para>
+ <para><filename><replaceable>JPP_DIST</replaceable>/standalone/<replaceable>portlet_name</replaceable>.war/WEB-INF/portlet.xml</filename></para>
</listitem>
<listitem>
- <para><replaceable>EPP_HOME</replaceable>/<replaceable>DOMAIN</replaceable>/<replaceable>portlet_name</replaceable>.war/WEB-INF/faces-config.xml</para>
+ <para><filename><replaceable>JPP_DIST</replaceable>/standalone/<replaceable>portlet_name</replaceable>.war/WEB-INF/faces-config.xml</filename></para>
</listitem>
<listitem>
- <para><replaceable>EPP_HOME</replaceable>/<replaceable>DOMAIN</replaceable>/<replaceable>portlet_name</replaceable>.war/WEB-INF/web.xml</para>
+ <para><filename><replaceable>JPP_DIST</replaceable>/standalone/<replaceable>portlet_name</replaceable>.war/WEB-INF/web.xml</filename></para>
</listitem>
</itemizedlist>
<para><variablelist>
@@ -71,29 +70,48 @@
</variablelist></para>
</section>
<section id="What_is_a_portlet_application">
- <title>Portlet application</title>
+ <title id="Portlet_Bridge_Portlet_Application">Portlet application</title>
<para>A portlet application is defined as a single web archive (WAR). </para>
<para>All portlets that are part of the same WAR are considered to form part of the same portlet application.</para>
</section>
<section>
- <title>Extensions</title>
+ <title id="Portlet_Bridge_Extensions">Extensions</title>
<para>Portlet extensions sit atop the portlet bridge framework. They extend the functionality of other JBoss portlet applications, and are critical in JSF portlet development. </para>
- <para>Extensions are made available in the impl development binary, located in <filename><replaceable>EPP_HOME</replaceable>/portletbridge</filename>. </para>
+ <para>Extensions are made available in the impl development binary, located in <filename><replaceable>JPP_DIST</replaceable>/portletbridge</filename>. </para>
</section>
-<!--BZ#856417 - Ken confirmed that this extension is not supported in PBR 3.x at the time of writing.--><!--<section id="sect-Reference_Guide-Bridge_Frameworks_and_Extensions-Seam_Bridgelets">
- <title>Seam Extension</title>
- <para><literal>PortalIdentity</literal> <application>Seam</application> extension allows you to implement Single Sign-On (SSO) between <application>Seam</application> and <application>JBoss Enterprise Portal Platform</application>.
- </para>
- <para>
- This extension is configured in the application's <filename>components.xml</filename> file, by specifying the following directive: </para>
- <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/PortletBridge_GettingStarted/default218.xml" parse="text"/></programlisting>
-</section>--><!--BZ#856417 - Ken confirmed that this extension is not supported in PBR 3.x at the time of writing.--><!--<section id="sect-Reference_Guide-Bridge_Frameworks_and_Extensions-RichFaces_Bridgelets">
- <title>RichFaces Bridgelet</title>
- <para>
- <application>Richfaces</application> does not account for multiple components on the same portal page by default. This following <filename>web.xml</filename> extension renders all <application>RichFaces</application> component javascript portal-friendly.
- </para>
- <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/PortletBridge_GettingStarted/default219.xml" parse="text"/></programlisting>
-</section>--> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="PortletBridge/configuration.xml"/>
+ <section id="Portlet_Bridge_Examples">
+ <title><remark>BZ#856417</remark>Examples</title>
+ <remark>Info taken from https://docs.jboss.org/author/display/PBR/Examples</remark>
+ <para>Portlet Bridge provides example JSF2 portlets, which provide a good starting point for including the framework in portlets, as well as demonstrating the functionality available in Portlet Bridge. </para>
+ <important>
+ <para>The provided examples are not officially supported by Red Hat. </para>
+ </important>
+ <variablelist>
+ <varlistentry>
+ <term>
+ <ulink url="https://github.com/jbossportletbridge/jbossportletbridge/tree/master/exam...">JSF2 Portlet</ulink>
+ </term>
+ <listitem>
+ <para>This example provides a basic JSF2 portlet demonstrating ajax functionality. This example provides a solid foundation for basic JSF2 functionality.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <ulink url="https://github.com/jbossportletbridge/jbossportletbridge/tree/master/exam...">RichFaces 4 Simple</ulink>
+ </term>
+ <listitem>
+ <para>This example demonstrates a simple RichFaces 4 form with ajax submission and an extended data table showing the submitted data. This example provides a solid foundation for basic RichFaces 4 functionality.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>RichFaces 4 Showcase</term>
+ <listitem>
+ <para>This example demonstrates a RichFaces 4 application, with portlet-specific changes. This example is worth deploying for advanced RichFaces 4 functionality, and shows the full spectrum of what can be achieved with RichFaces 4 and Portlet Bridge</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </section>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="PortletBridge/configuration.xml"/>
<section>
<title>Render Policy Parameters</title>
<para>Different JSF View Declaration Languages require different behavior from the JBoss Portlet Bridge when it comes to rendering views. Instructing the Bridge on which policy to use is done using the javax.portlet.faces.RENDER_POLICY <context-param> directive in <filename>web.xml</filename>.</para>
@@ -172,7 +190,7 @@
<programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/PortletBridge_Configuration/default206.xml" parse="text"/></programlisting>
</section>--> <para><xref linkend="table-RichFaces_Local_Remote_Portlet_Support"/> outlines the current status of RichFaces features when used in both local and remote portlets.
</para>
- <remark>BZ#856417 - NEEDINFO - Contacted mvanco on Oct 3 for specifics regarding this table. Ken informed me it was out of date.</remark>
+ <remark>BZ#856417 - NEEDINFO 20121105 - Awaiting mvanco to provide an updated table of features.</remark>
<table id="table-RichFaces_Local_Remote_Portlet_Support">
<title>RichFaces Feature Status</title>
<tgroup cols="3">
@@ -800,8 +818,7 @@
}
}</programlisting>
<para>In the JSP or Facelets page, the value string can be retrieved using the following code.</para>
- <programlisting>
-#{httpSessionScope['your parameter name']}</programlisting>
+ <programlisting>#{httpSessionScope['your parameter name']}</programlisting>
</section>
</section>
<section>
@@ -809,10 +826,13 @@
<para>When using resources from a JSF portlet, it is important to ensure that they are accessed in a way that allows JBoss Portlet Bridge to construct an appropriate Portal URL to the resource being requested.</para>
<para>The correct way to reference a resource is to locate it within the web application, in the <filename>/ resources</filename> directory. This placement allows the resource to be retrieved using JSF2 resource handling.</para>
<programlisting>#{resource['/stylesheet.css']}</programlisting>
+ <important>
+ <para>#{resource} is particularly important when using <methodname>@import</methodname> to retrieve content within CSS files.</para>
+ </important>
<para>In this instance, stylesheet.css would be present in the root of the <filename>/resources</filename> directory, because it does not specify a resource library. For resources that do specify a library, these must be placed in the library sub-directory.</para>
</section>
<section id="sect-Reference_Guide-Portlet_2.0_Coordination-Serving_Your_JSF_Resources_in_a_Portlet">
- <title>Serving Your JSF Resources in a Portlet</title>
+ <title>Serving JSF Resources in a Portlet</title>
<para>
The bridge deals with portlet served resources in one of two ways:
</para>
@@ -831,8 +851,8 @@
<section id="sect-Expression_Language_Reference">
<title>Expression Language Reference</title>
<para>Some examples demonstrating how to use <literal>EL</literal> and a simple bean are provided in the ResourceBean.java file of the Richfaces Portlet example. </para>
- <para>Additional information about <literal>EL</literal> is located in <xref linkend="sect-Using_Provided_EL_Variables"/></para>
- <programlisting language="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/PortletBridge_Configuration/PortletResource.java" parse="text"/></programlisting>
+ <para>Additional information about <literal>EL</literal> is located in <xref linkend="Portlet_Bridge-Using_Provided_EL_Variables"/></para>
+ <programlisting language="Java"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/PortletBridge_Configuration/PortletResource.java" parse="text"/></programlisting>
</section>
<section id="sect-Reference_Guide-Serving_Your_JSF_Resources_in_a_Portlet-Configuration">
<title>Configuration</title>
Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortletDevelopment/Standard.xml
===================================================================
--- epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortletDevelopment/Standard.xml 2012-11-12 14:52:07 UTC (rev 8959)
+++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortletDevelopment/Standard.xml 2012-11-13 04:09:53 UTC (rev 8960)
@@ -142,7 +142,7 @@
</step>
<step>
<para>
- Copy the package file into <literal><replaceable>EPP_DIST</replaceable>/jboss-as/server/default/deploy</literal>.
+ Copy the package file into <literal><replaceable>JPP_DIST</replaceable>/jboss-as/server/default/deploy</literal>.
</para>
</step>
<step>
Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/WSRP.xml
===================================================================
--- epp/docs/branches/6.0/Reference_Guide/en-US/modules/WSRP.xml 2012-11-12 14:52:07 UTC (rev 8959)
+++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/WSRP.xml 2012-11-13 04:09:53 UTC (rev 8960)
@@ -75,12 +75,12 @@
JBoss Portal Platform provides complete support for WSRP 1.0 and 2.0 standard interfaces, and offers both consumer and
producer services. Starting with version 2.1.0-GA of the component, WSRP is packaged as a JBoss Portal Platform
extension, and is self-contained in a package named
- <filename><replaceable>EPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein-wsrp-integration.ear</filename>
+ <filename><replaceable>JPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein-wsrp-integration.ear</filename>
.
</para>
<para>The only files of interest from a user perspective
are located in the
- <filename><replaceable>EPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/conf/gatein/</filename>
+ <filename><replaceable>JPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/conf/gatein/</filename>
directory.</para>
<itemizedlist>
<listitem>
@@ -224,13 +224,13 @@
configuration file for the consumer.
</para>
<para>
- <filename><replaceable>EPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE/</replaceable>conf/gatein/gatein-wsse-consumer.xml</filename></para>
+ <filename><replaceable>JPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE/</replaceable>conf/gatein/gatein-wsse-consumer.xml</filename></para>
</listitem>
<listitem>
<para>JBossWS configuration file for the producer.
</para>
<para>
- <filename><replaceable>EPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/conf/gatein/gatein-wsse-producer.xml </filename></para>
+ <filename><replaceable>JPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/conf/gatein/gatein-wsse-producer.xml </filename></para>
</listitem>
</itemizedlist>
</section>
@@ -264,7 +264,7 @@
relies on a JSR-286-only functionality.
</para>
</important>
- <para>JBoss Enterprise Portal Platform does
+ <para>JBoss Portal Platform does
not, by default, expose local portlets for consumption
by remote WSRP consumers. In order to make a portlet remotely available, it must be made <firstterm>remotable</firstterm> by marking
it as such in the associated
@@ -529,13 +529,13 @@
<para>While it is recommended you use the WSRP Configuration portlet to configure Consumers, the component provides an
alternative way to configure consumers by adding an XML file called
<filename>wsrp-consumers-config.xml</filename> in the
- <filename><replaceable>EPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/conf/gatein/</filename> directory.
+ <filename><replaceable>JPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/conf/gatein/</filename> directory.
</para>
<note>
<title>Note</title>
<para>An XML Schema defining which elements are available to configure Consumers via XML can be found
in
- <filename><replaceable>EPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein-wsrp-integration.ear/lib/wsrp-integration-api-&WSRP_VERSION;.jar/xsd/gatein_wsrp_consumer_1_0.xsd </filename>
+ <filename><replaceable>JPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein-wsrp-integration.ear/lib/wsrp-integration-api-&WSRP_VERSION;.jar/xsd/gatein_wsrp_consumer_1_0.xsd </filename>
</para>
</note>
<important>
@@ -649,7 +649,7 @@
and
<literal>selfv2</literal>
consumers as found in
- <filename><replaceable>EPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein-wsrp-integration.ear/lib/extension-component-&WSRP_VERSION;.jar/conf/wsrp-consumers-config.xml</filename>
+ <filename><replaceable>JPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein-wsrp-integration.ear/lib/extension-component-&WSRP_VERSION;.jar/conf/wsrp-consumers-config.xml</filename>
with a cache expiring every 500 seconds and with a 50 second timeout for web service operations.
<note>
<para>
@@ -1158,7 +1158,7 @@
Alternatively, it is possible to add an XML file called
<filename>wsrp-producer-config.xml</filename>
in the
- <filename><replaceable>EPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/conf/gatein/</filename>
+ <filename><replaceable>JPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/conf/gatein/</filename>
directory.
Several aspects can be modified with respects to whether registration is required for consumers to access
the Producer's services.
@@ -1167,7 +1167,7 @@
<title>Note</title>
<para>An XML Schema defining which elements are available to configure Consumers via XML can be found
in
- <filename><replaceable>EPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein-wsrp-integration.ear/lib/wsrp-integration-api-&WSRP_VERSION;.jar/xsd/gatein_wsrp_producer_1_0.xsd </filename>
+ <filename><replaceable>JPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein-wsrp-integration.ear/lib/wsrp-integration-api-&WSRP_VERSION;.jar/xsd/gatein_wsrp_producer_1_0.xsd </filename>
</para>
</note>
<important>
@@ -1183,7 +1183,7 @@
<title>Note</title>
<para>
The default configuration file for the producer can be found at
- <filename><replaceable>EPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein-wsrp-integration.ear/lib/extension-component-&WSRP_VERSION;.jar/conf/wsrp-producer-config.xml</filename>
+ <filename><replaceable>JPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein-wsrp-integration.ear/lib/extension-component-&WSRP_VERSION;.jar/conf/wsrp-producer-config.xml</filename>
</para>
</note>
</section>
Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr/cluster-config.xml
===================================================================
--- epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr/cluster-config.xml 2012-11-12 14:52:07 UTC (rev 8959)
+++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr/cluster-config.xml 2012-11-13 04:09:53 UTC (rev 8960)
@@ -21,17 +21,17 @@
</step>
<step>
<para>
- Copy the file into <filename><replaceable>EPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy</filename> directory.
+ Copy the file into <filename><replaceable>JPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy</filename> directory.
</para>
</step>
<step>
<para>
- Drop <filename>exo-configuration.xml</filename> into your root <filename><replaceable>EPP_DIST</replaceable>/jboss-as/</filename> directory.
+ Drop <filename>exo-configuration.xml</filename> into your root <filename><replaceable>JPP_DIST</replaceable>/jboss-as/</filename> directory.
</para>
</step>
<step>
<para>
- Configure JAAS by inserting the XML fragment shown below into <filename><replaceable>EPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/conf/login-config.xml</filename>
+ Configure JAAS by inserting the XML fragment shown below into <filename><replaceable>JPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/conf/login-config.xml</filename>
</para>
<programlisting language="XML" role="XML"><application-policy name="exo-domain">
<authentication>
@@ -89,8 +89,8 @@
<para>
The configuration file must be formatted as follows:
</para>
- <example>
- <title>External Configuration</title>
+ <example>
+ <title>External Configuration</title>
<programlisting language="XML" role="XML"><repository-service default-repository="repository1">
<repositories>
<repository name="repository1" system-workspace="ws1" default-workspace="ws1">
@@ -137,16 +137,16 @@
</repository>
</repositories>
</repository-service></programlisting>
- <para>
+ <para>
Comment #1: Refer to <xref linkend="exam-Reference_Guide-Configuration_requirements-Value_Storage_configuration"/>.
</para>
- <para>
+ <para>
Comment #2: Refer to <xref linkend="exam-Reference_Guide-Configuration_requirements-Cache_configuration"/>.
</para>
- <para>
+ <para>
Comment #3: Refer to <xref linkend="exam-Reference_Guide-Configuration_requirements-Indexer_configuration"/>.
</para>
- <para>
+ <para>
Comment #4: Refer to <xref linkend="exam-Reference_Guide-Configuration_requirements-Lock_Manager_configuration"/>.
</para>
</example>
Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr/configuration/exo-jcr-configuration.xml
===================================================================
--- epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr/configuration/exo-jcr-configuration.xml 2012-11-12 14:52:07 UTC (rev 8959)
+++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr/configuration/exo-jcr-configuration.xml 2012-11-13 04:09:53 UTC (rev 8960)
@@ -54,7 +54,7 @@
JCR services are registered in the Portal container.
</para>
<para>
- Below is an example configuration from the <filename><replaceable>EPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/02portal.war/WEB-INF/conf/jcr/jcr-configuration.xml</filename> file.
+ Below is an example configuration from the <filename><replaceable>JPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/02portal.war/WEB-INF/conf/jcr/jcr-configuration.xml</filename> file.
</para>
<programlisting language="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../../../extras/Advanced_Development_JCR_Configuration/jcr-configuration.xml" parse="text"/></programlisting>
<section id="sect-Reference_Guide-Portal_configuration-JCR_Configuration">
@@ -63,7 +63,7 @@
The JCR Service can use multiple <emphasis>Repositories</emphasis> and each repository can have multiple <emphasis>Workspaces</emphasis>.
</para>
<para>
- Configure the workspaces by locating the workspace you need to modify in <filename><replaceable>EPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/02portal.war/WEB-INF/conf/jcr/repository-configuration.xml</filename>.
+ Configure the workspaces by locating the workspace you need to modify in <filename><replaceable>JPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/02portal.war/WEB-INF/conf/jcr/repository-configuration.xml</filename>.
</para>
<para>
The repository configuration supports human-readable values. They are not case-sensitive.
@@ -161,7 +161,7 @@
</section>
<section id="sect-Reference_Guide-Portal_configuration-Repository_service_configuration_JCR_repositories_configuration">
<title>Repository service configuration (JCR repositories configuration)</title>
- <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../../../extras/Advanced_Development_JCR_Configuration/orig.xml" parse="text"/></programlisting>
+ <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../../../extras/Advanced_Development_JCR_Configuration/orig.xml" parse="text"/></programlisting>
<note>
<title>
<parameter> session-max-age </parameter>
Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr/configuration/jdbc-data-container-config.xml
===================================================================
--- epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr/configuration/jdbc-data-container-config.xml 2012-11-12 14:52:07 UTC (rev 8959)
+++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr/configuration/jdbc-data-container-config.xml 2012-11-13 04:09:53 UTC (rev 8960)
@@ -113,7 +113,7 @@
Each database software supports ANSI SQL standards but also has its own specifics. Therefore each database has its own configuration setting in the eXo JCR as a database dialect parameter. More detailed configuration of the database can be set by editing the metadata SQL-script files.
</para>
<para>
- You can find SQL-scripts in <filename>conf/storage/</filename> directory of the <filename><replaceable>EPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/lib/exo.jcr.component.core-XXX.XXX.jar</filename> file .
+ You can find SQL-scripts in <filename>conf/storage/</filename> directory of the <filename><replaceable>JPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/lib/exo.jcr.component.core-XXX.XXX.jar</filename> file .
</para>
<para>
The following tables show the correspondence between the scripts and databases:
Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr/configuration/multilanguage-support.xml
===================================================================
--- epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr/configuration/multilanguage-support.xml 2012-11-12 14:52:07 UTC (rev 8959)
+++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr/configuration/multilanguage-support.xml 2012-11-13 04:09:53 UTC (rev 8960)
@@ -37,7 +37,7 @@
<itemizedlist>
<listitem>
<para>
- The configuration file to be modified for these changes is <filename><replaceable>EPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/02portal.war/WEB-INF/conf/jcr/repository-configuration.xml</filename>.
+ The configuration file to be modified for these changes is <filename><replaceable>JPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/02portal.war/WEB-INF/conf/jcr/repository-configuration.xml</filename>.
</para>
</listitem>
<listitem>
Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr/configuration/search-configuration.xml
===================================================================
--- epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr/configuration/search-configuration.xml 2012-11-12 14:52:07 UTC (rev 8959)
+++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr/configuration/search-configuration.xml 2012-11-13 04:09:53 UTC (rev 8960)
@@ -12,7 +12,7 @@
Below is an example of the configuration file that governs search behaviors. Refer to <xref linkend="sect-Reference_Guide-Search_Configuration-Global_Search_Index"/> for how searching operates in JCR and information about customized searches.
</para>
<para>
- The JCR index configuration file is located at <filename><replaceable>EPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/02portal.war/WEB-INF/conf/jcr/repository-configuration.xml</filename>.
+ The JCR index configuration file is located at <filename><replaceable>JPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/02portal.war/WEB-INF/conf/jcr/repository-configuration.xml</filename>.
</para>
<para>
A code example is included below with a list of the configuration parameters shown below that.
@@ -502,21 +502,21 @@
<para>
By default eXo JCR uses the Lucene standard Analyzer to index contents. This analyzer uses some standard filters in the method that analyzes the content
</para>
- <example>
+ <example>
<title>Standard Analyzed Filters</title>
<programlisting language="Java" role="Java"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../../../extras/Advanced_Development_JCR_search-configuration/default62.java" parse="text"/></programlisting>
- <para>
+ <para>
Comment #1: The first filter (StandardFilter) removes possessive apostrophes (<emphasis role="bold">'s</emphasis>) from the end of words and removes periods (<emphasis role="bold">.</emphasis>) from acronyms.
</para>
- <para>
+ <para>
Comment #2: The second filter (LowerCaseFilter) normalizes token text to lower case.
</para>
- <para>
+ <para>
Comment #3: The last filter (StopFilter) removes stop words from a token stream. The stop set is defined in the analyzer.
</para>
- </example>
+ </example>
<para>
- The global search index is configured in the <filename><replaceable>EPP_DIST</replaceable>/jboss-as/server/<replaceable>VERSION</replaceable>/deploy/gatein.ear/02portal.war/WEB-INF/conf/jcr/repository-configuration.xml</filename> configuration file within the "query-handler" tag.
+ The global search index is configured in the <filename><replaceable>JPP_DIST</replaceable>/jboss-as/server/<replaceable>VERSION</replaceable>/deploy/gatein.ear/02portal.war/WEB-INF/conf/jcr/repository-configuration.xml</filename> configuration file within the "query-handler" tag.
</para>
<programlisting language="XML" role="XML"><query-handler class="org.exoplatform.services.jcr.impl.core.query.lucene.SearchIndex">
</programlisting>
@@ -616,13 +616,13 @@
</programlisting>
<para>
- in <filename><replaceable>EPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/02portal.war/WEB-INF/conf/jcr/repository-configuration.xml</filename> with the new class:
+ in <filename><replaceable>JPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/02portal.war/WEB-INF/conf/jcr/repository-configuration.xml</filename> with the new class:
</para>
<programlisting language="XML" role="XML"><query-handler class="mypackage.indexation.MySearchIndex>
</programlisting>
<para>
- To configure an application to use a new analyzer, add the <parameter>analyzer</parameter> parameter to each query-handler configuration in <filename><replaceable>EPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/02portal.war/WEB-INF/conf/jcr/repository-configuration.xml</filename>:
+ To configure an application to use a new analyzer, add the <parameter>analyzer</parameter> parameter to each query-handler configuration in <filename><replaceable>JPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/02portal.war/WEB-INF/conf/jcr/repository-configuration.xml</filename>:
</para>
<programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../../../extras/Advanced_Development_JCR_search-configuration/default69.xml" parse="text"/></programlisting>
<para>
Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr/jbosscache-configuration-templates.xml
===================================================================
--- epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr/jbosscache-configuration-templates.xml 2012-11-12 14:52:07 UTC (rev 8959)
+++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr/jbosscache-configuration-templates.xml 2012-11-13 04:09:53 UTC (rev 8960)
@@ -70,7 +70,7 @@
<section id="sect-Reference_Guide-JBoss_Cache_configuration-Shipped_JBoss_Cache_configuration_templates">
<title>Shipped JBoss Cache configuration templates</title>
<para>
- The eXo JCR implementation is shipped with ready-to-use JBoss Cache configuration templates for JCR's components. They are located in <filename><replaceable>EPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/02portal.war/WEB-INF/conf/jcr/jbosscache</filename> directory, inside either the <filename>cluster</filename> or <filename>local</filename> directory.
+ The eXo JCR implementation is shipped with ready-to-use JBoss Cache configuration templates for JCR's components. They are located in <filename><replaceable>JPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/02portal.war/WEB-INF/conf/jcr/jbosscache</filename> directory, inside either the <filename>cluster</filename> or <filename>local</filename> directory.
</para>
<section id="sect-Reference_Guide-Shipped_JBoss_Cache_configuration_templates-Data_container_template">
<title>Data container template</title>
Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/searching-repository-content.xml
===================================================================
--- epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/searching-repository-content.xml 2012-11-12 14:52:07 UTC (rev 8959)
+++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr/searching/searching-repository-content.xml 2012-11-13 04:09:53 UTC (rev 8960)
@@ -8,7 +8,7 @@
<section id="sect-Reference_Guide-Searching_Repository_Content-Introduction">
<title>Introduction</title>
<para>
- You can find the JCR configuration file here: <filename><replaceable>EPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/02portal.war/portal/WEB-INF/conf/jcr/repository-configuration.xml</filename>.
+ You can find the JCR configuration file here: <filename><replaceable>JPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/02portal.war/portal/WEB-INF/conf/jcr/repository-configuration.xml</filename>.
</para>
<para>
Please refer to <xref linkend="chap-Reference_Guide-Search_Configuration"/> for more information about index configuration.
Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr-with-gtn/managed-datasources-under-jboss-as.xml
===================================================================
--- epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr-with-gtn/managed-datasources-under-jboss-as.xml 2012-11-12 14:52:07 UTC (rev 8959)
+++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr-with-gtn/managed-datasources-under-jboss-as.xml 2012-11-13 04:09:53 UTC (rev 8960)
@@ -59,7 +59,7 @@
<section id="sect-Reference_Guide-Configurations_Steps-Do_not_bind_datasources_explicitly">
<title>Do not bind datasources explicitly</title>
<para>
- Do not let the portal explicitly bind datasources. Edit the <filename><replaceable>EPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/conf/gatein/configuration.properties</filename> and comment out the following rows in the JCR section:
+ Do not let the portal explicitly bind datasources. Edit the <filename><replaceable>JPP_DIST</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/conf/gatein/configuration.properties</filename> and comment out the following rows in the JCR section:
</para>
<programlisting>#gatein.jcr.datasource.driver=org.hsqldb.jdbcDriver
#gatein.jcr.datasource.url=jdbc:hsqldb:file:${gatein.db.data.dir}/data/jdbcjcr_${name}
Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR.xml
===================================================================
--- epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR.xml 2012-11-12 14:52:07 UTC (rev 8959)
+++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR.xml 2012-11-13 04:09:53 UTC (rev 8960)
@@ -26,9 +26,8 @@
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/searching/fulltext-search-and-settings.xml"/>
<!-- api extensions --><!--<xi:include href="eXoJCR/jcr/api-extensions.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />--><!-- protocols --> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/protocols/webdav.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/protocols/ftp.xml"/>
-<!-- backup --> <!--<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/backup/exojcr-backup-service.xml"/>
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/backup/backup-client.xml"/>-->
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/backup/use-external-backup-tool.xml"/>
+<!-- backup --><!--<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/backup/exojcr-backup-service.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/backup/backup-client.xml"/>--> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/backup/use-external-backup-tool.xml"/>
<!-- other --> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/statistics.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/repository-check-controller.xml"/>
<!--<xi:include href="eXoJCR/jcr/jta.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />--><!--<xi:include href="eXoJCR/jcr/jca.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />--><!--<xi:include href="eXoJCR/jcr/other/acl.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />--><!--<xi:include href="eXoJCR/jcr/other/acl-ext.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />--> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr/other/link-producer.xml"/>
@@ -41,5 +40,5 @@
DOC NOTE: This section seems to include items covered elsewhere in this guide, or things that are not relevant to EPP
<xi:include href="eXoJCR/core.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> --><!-- Web services
DOC NOTE: Red Hat JBoss has two possible Web Services packages. No need to document the eXo offering:
- <xi:include href="eXoJCR/ws.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> --><!-- GateIn and JCR --> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr-with-gatein.xml"/>
-<!-- DOC NOTE: Commented FAQ section out as per advice from Philippe Aristote; "Unfit for publication" --><!-- <xi:include href="eXoJCR/faq.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> --></part>
+ <xi:include href="eXoJCR/ws.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> --> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="eXoJCR/jcr-with-gatein.xml"/>
+</part>
Modified: epp/docs/branches/6.0/User_Guide/en-US/Author_Group.xml
===================================================================
--- epp/docs/branches/6.0/User_Guide/en-US/Author_Group.xml 2012-11-12 14:52:07 UTC (rev 8959)
+++ epp/docs/branches/6.0/User_Guide/en-US/Author_Group.xml 2012-11-13 04:09:53 UTC (rev 8960)
@@ -7,10 +7,6 @@
<editor>
<firstname>Red Hat</firstname>
<surname>Documentation Group</surname>
- <affiliation>
- <shortaffil>Red Hat</shortaffil>
- <orgdiv>Engineering Content Services</orgdiv>
- </affiliation>
</editor>
<othercredit>
<affiliation>
Modified: epp/docs/branches/6.0/User_Guide/en-US/Book_Info.xml
===================================================================
--- epp/docs/branches/6.0/User_Guide/en-US/Book_Info.xml 2012-11-12 14:52:07 UTC (rev 8959)
+++ epp/docs/branches/6.0/User_Guide/en-US/Book_Info.xml 2012-11-13 04:09:53 UTC (rev 8960)
@@ -5,7 +5,7 @@
]>
<bookinfo id="book-User_Guide-User_Guide">
<title>User Guide</title>
- <subtitle>for JBoss Portal Platform 6, and its patch releases.</subtitle>
+ <subtitle>for use with JBoss Portal Platform 6 and it's patch releases.</subtitle>
<productname>JBoss Portal Platform</productname>
<productnumber>6</productnumber>
<edition>6.0.0</edition>
Modified: epp/docs/branches/6.0/User_Guide/en-US/Revision_History.xml
===================================================================
--- epp/docs/branches/6.0/User_Guide/en-US/Revision_History.xml 2012-11-12 14:52:07 UTC (rev 8959)
+++ epp/docs/branches/6.0/User_Guide/en-US/Revision_History.xml 2012-11-13 04:09:53 UTC (rev 8960)
@@ -20,10 +20,10 @@
<member>Minor edits of work done in BZ#813776.</member>
</simplelist>
</revdescription>
- </revision>
+ </revision>
<revision>
<revnumber>6.0.0-7</revnumber>
- <date>Thu Nov 8 2012</date>
+ <date>Mon Nov 8 2012</date>
<author>
<firstname>Petr</firstname>
<surname>Penicka</surname>
@@ -34,10 +34,10 @@
<member>BZ#813776 - removed various screenshots with no added information value and fixed various minor errors identified by docs QE.</member>
</simplelist>
</revdescription>
- </revision>
+ </revision>
<revision>
- <revnumber>6.0.0-5</revnumber>
- <date>Thu Oct 25 2012</date>
+ <revnumber>6.0.0-6</revnumber>
+ <date>Tue Oct 30 2012</date>
<author>
<firstname>Jared</firstname>
<surname>Morgan</surname>
@@ -45,7 +45,7 @@
</author>
<revdescription>
<simplelist>
- <member>Rebuilt book so it would appear under the JBoss Portal Platform banner.</member>
+ <member>Rebuilt book so it would appear under the JBoss Portal Platform banner, and standardized subtitle across all books.</member>
</simplelist>
</revdescription>
</revision>
12 years, 1 month
gatein SVN: r8959 - epp/docs/branches/6.0/User_Guide/en-US.
by do-not-reply@jboss.org
Author: ppenicka
Date: 2012-11-12 09:52:07 -0500 (Mon, 12 Nov 2012)
New Revision: 8959
Modified:
epp/docs/branches/6.0/User_Guide/en-US/Revision_History.xml
Log:
Minor edits of work done in BZ#813776.
Modified: epp/docs/branches/6.0/User_Guide/en-US/Revision_History.xml
===================================================================
--- epp/docs/branches/6.0/User_Guide/en-US/Revision_History.xml 2012-11-12 14:49:15 UTC (rev 8958)
+++ epp/docs/branches/6.0/User_Guide/en-US/Revision_History.xml 2012-11-12 14:52:07 UTC (rev 8959)
@@ -8,6 +8,20 @@
<simpara>
<revhistory>
<revision>
+ <revnumber>6.0.0-8</revnumber>
+ <date>Mon Nov 12 2012</date>
+ <author>
+ <firstname>Petr</firstname>
+ <surname>Penicka</surname>
+ <email></email>
+ </author>
+ <revdescription>
+ <simplelist>
+ <member>Minor edits of work done in BZ#813776.</member>
+ </simplelist>
+ </revdescription>
+ </revision>
+ <revision>
<revnumber>6.0.0-7</revnumber>
<date>Thu Nov 8 2012</date>
<author>
12 years, 1 month
gatein SVN: r8958 - epp/docs/branches/5.2/User_Guide/en-US.
by do-not-reply@jboss.org
Author: ppenicka
Date: 2012-11-12 09:49:15 -0500 (Mon, 12 Nov 2012)
New Revision: 8958
Modified:
epp/docs/branches/5.2/User_Guide/en-US/Revision_History.xml
Log:
Just updated revision history.
Modified: epp/docs/branches/5.2/User_Guide/en-US/Revision_History.xml
===================================================================
--- epp/docs/branches/5.2/User_Guide/en-US/Revision_History.xml 2012-11-12 12:29:34 UTC (rev 8957)
+++ epp/docs/branches/5.2/User_Guide/en-US/Revision_History.xml 2012-11-12 14:49:15 UTC (rev 8958)
@@ -9,8 +9,23 @@
<revhistory>
<revision>
+ <revnumber>5.2.2-104</revnumber>
+ <date>Mon Nov 12 2012</date>
+ <author>
+ <firstname>Petr</firstname>
+ <surname>Penicka</surname>
+ <email/>
+ </author>
+ <revdescription>
+ <simplelist>
+ <member>Minor edits of work done in BZ#813776.</member>
+ </simplelist>
+ </revdescription>
+ </revision>
+
+ <revision>
<revnumber>5.2.2-103</revnumber>
- <date>Wed Oct 15 2012</date>
+ <date>Thu Nov 8 2012</date>
<author>
<firstname>Petr</firstname>
<surname>Penicka</surname>
12 years, 1 month
gatein SVN: r8957 - in epp/docs/branches/5.2/Reference_Guide/en-US: modules and 1 other directory.
by do-not-reply@jboss.org
Author: ekopalov
Date: 2012-11-12 07:29:34 -0500 (Mon, 12 Nov 2012)
New Revision: 8957
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/Revision_History.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR.xml
Log:
removed unneeded exoJCR chapters
Modified: epp/docs/branches/5.2/Reference_Guide/en-US/Revision_History.xml
===================================================================
--- epp/docs/branches/5.2/Reference_Guide/en-US/Revision_History.xml 2012-11-12 12:29:19 UTC (rev 8956)
+++ epp/docs/branches/5.2/Reference_Guide/en-US/Revision_History.xml 2012-11-12 12:29:34 UTC (rev 8957)
@@ -64,6 +64,20 @@
</revdescription>
</revision>
<revision>
+ <revnumber>5.2.2-106</revnumber>
+ <date>Fri Oct 22 2012</date>
+ <author>
+ <firstname>Eva</firstname>
+ <surname>Kopalova</surname>
+ <email/>
+ </author>
+ <revdescription>
+ <simplelist>
+ <member>Bug 850746 - Remove Chapter 41. eXo JCR Backup Service and Chapter 42. HTTPBackupAgent and Backup Client from EPP Reference Guide.</member>
+ </simplelist>
+ </revdescription>
+ </revision>
+ <revision>
<revnumber>5.2.2-105</revnumber>
<date>Fri Oct 19 2012</date>
<author>
Modified: epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR.xml
===================================================================
--- epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR.xml 2012-11-12 12:29:19 UTC (rev 8956)
+++ epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR.xml 2012-11-12 12:29:34 UTC (rev 8957)
@@ -77,9 +77,9 @@
<!-- backup -->
- <xi:include href="eXoJCR/jcr/backup/exojcr-backup-service.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+<!-- <xi:include href="eXoJCR/jcr/backup/exojcr-backup-service.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> -->
- <xi:include href="eXoJCR/jcr/backup/backup-client.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+<!-- <xi:include href="eXoJCR/jcr/backup/backup-client.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> -->
<xi:include href="eXoJCR/jcr/backup/use-external-backup-tool.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
@@ -129,4 +129,4 @@
<xi:include href="eXoJCR/jcr-with-gatein.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<!-- DOC NOTE: Commented FAQ section out as per advice from Philippe Aristote; "Unfit for publication" -->
<!-- <xi:include href="eXoJCR/faq.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> -->
- </part>
\ No newline at end of file
+ </part>
12 years, 1 month
gatein SVN: r8956 - epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortalDevelopment.
by do-not-reply@jboss.org
Author: ekopalov
Date: 2012-11-12 07:29:19 -0500 (Mon, 12 Nov 2012)
New Revision: 8956
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortalDevelopment/DataImportStrategy.xml
Log:
minor language fix
Modified: epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortalDevelopment/DataImportStrategy.xml
===================================================================
--- epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortalDevelopment/DataImportStrategy.xml 2012-11-12 09:29:06 UTC (rev 8955)
+++ epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortalDevelopment/DataImportStrategy.xml 2012-11-12 12:29:19 UTC (rev 8956)
@@ -68,7 +68,7 @@
<section id="sect-Reference_Guide-Data_Import_Strategy-Navigation_Data">
<title>Navigation Data</title>
<para>
- The navigation data import strategy is processed at the import mode level in the following way:
+ The navigation data import strategy is processed at the import mode level as follows:
</para>
<itemizedlist>
<listitem>
12 years, 1 month