[gatein-commits] gatein SVN: r5048 - in epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US: extras/Advanced_Development_JCR_jdbc-data-container-config and 5 other directories.

Author: smumford Date: 2010-11-11 21:47:21 -0500 (Thu, 11 Nov 2010) New Revision: 5048 Removed: epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/extras/Advanced_Development_JCR_jdbc-data-container-config/default38.xml Modified: epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/Book_Info.xml epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/Reference_Guide.xml epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/Revision_History.xml epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/Advanced/JCR.xml epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/Advanced/JCR/cluster-config.xml epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/Advanced/JCR/configuration-persister.xml epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/Advanced/JCR/configuration.xml epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/Advanced/JCR/external-value-storages.xml epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/Advanced/JCR/intro.xml epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/Advanced/JCR/jdbc-data-container-config.xml epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/AuthenticationAndIdentity/SSO.xml epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/PortalDevelopment/InternationalizationConfiguration.xml epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/WSRP.xml Log: JBEPP-517: Incorporated EPP Docs Review feedback/action items Modified: epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/Book_Info.xml =================================================================== --- epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/Book_Info.xml 2010-11-12 02:40:21 UTC (rev 5047) +++ epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/Book_Info.xml 2010-11-12 02:47:21 UTC (rev 5048) @@ -9,7 +9,7 @@ <productname>JBoss Enterprise Portal Platform</productname> <productnumber>5</productnumber> <edition>1</edition> - <pubsnumber>1.14</pubsnumber> + <pubsnumber>1.15</pubsnumber> <abstract> <para> This Reference Guide is a high-level usage document. It deals with more advanced topics than the Installation and User Guides, adding new content or taking concepts discussed in the earlier documents further. It aims to provide supporting documentation for advanced users of the &PRODUCT; product. Its primary focus is on advanced use of the product and it assumes an intermediate or advanced knowledge of the technology and terms. Modified: epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/Reference_Guide.xml =================================================================== --- epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/Reference_Guide.xml 2010-11-12 02:40:21 UTC (rev 5047) +++ epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/Reference_Guide.xml 2010-11-12 02:47:21 UTC (rev 5048) @@ -9,7 +9,7 @@ <xi:include href="modules/Introduction.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <xi:include href="modules/PortalDevelopment.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <xi:include href="modules/PortletDevelopment.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="modules/GadgetDevelopment.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <!--<xi:include href="modules/GadgetDevelopment.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />--> <xi:include href="modules/AuthenticationAndIdentity.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <xi:include href="modules/WSRP.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <xi:include href="modules/Advanced.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> Modified: epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/Revision_History.xml =================================================================== --- epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/Revision_History.xml 2010-11-12 02:40:21 UTC (rev 5047) +++ epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/Revision_History.xml 2010-11-12 02:47:21 UTC (rev 5048) @@ -6,7 +6,23 @@ <appendix id="appe-Reference_Guide-Revision_History"> <title>Revision History</title> <simpara> - <revhistory> + <revhistory> + <revision> + <revnumber>1-1.15</revnumber> + <date>Thu Nov 11 2010</date> + <author> + <firstname>Scott</firstname> + <surname>Mumford</surname> + <email&gt;smumford(a)redhat.com&lt;/email&gt; + </author> + <revdescription> + <simplelist> + <member>Incorporated further feedback from GLS.</member> + <member>Added first cut of WSRP 2.0 content.</member> + <member>Highlighted JCR sections for possible removal.</member> + </simplelist> + </revdescription> + </revision> <revision> <revnumber>1-1.14</revnumber> <date>Tue Nov 02 2010</date> Deleted: epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/extras/Advanced_Development_JCR_jdbc-data-container-config/default38.xml =================================================================== --- epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/extras/Advanced_Development_JCR_jdbc-data-container-config/default38.xml 2010-11-12 02:40:21 UTC (rev 5047) +++ epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/extras/Advanced_Development_JCR_jdbc-data-container-config/default38.xml 2010-11-12 02:47:21 UTC (rev 5048) @@ -1,69 +0,0 @@ -<component> - <key>org.exoplatform.services.naming.InitialContextInitializer</key> - <type>org.exoplatform.services.naming.InitialContextInitializer</type> - <component-plugins> - <component-plugin> - <name>bind.datasource</name> - <set-method>addPlugin</set-method> - <type>org.exoplatform.services.naming.BindReferencePlugin</type> - <init-params> - <value-param> - <name>bind-name</name> - <value>jdbcjcr</value> - </value-param> - <value-param> - <name>class-name</name> - <value>javax.sql.DataSource</value> - </value-param> - <value-param> - <name>factory</name> - <value>org.apache.commons.dbcp.BasicDataSourceFactory</value> - </value-param> - <properties-param> - <name>ref-addresses</name> - <description>ref-addresses</description> - <property name="driverClassName" value="org.hsqldb.jdbcDriver"/> - <property name="url" value="jdbc:hsqldb:file:target/temp/data/portal"/> - <property name="username" value="sa"/> - <property name="password" value=""/> - </properties-param> - </init-params> - </component-plugin> - <component-plugin> - <name>bind.datasource</name> - <set-method>addPlugin</set-method> - <type>org.exoplatform.services.naming.BindReferencePlugin</type> - <init-params> - <value-param> - <name>bind-name</name> - <value>jdbcjcr1</value> - </value-param> - <value-param> - <name>class-name</name> - <value>javax.sql.DataSource</value> - </value-param> - <value-param> - <name>factory</name> - <value>org.apache.commons.dbcp.BasicDataSourceFactory</value> - </value-param> - <properties-param> - <name>ref-addresses</name> - <description>ref-addresses</description> - <property name="driverClassName" value="com.mysql.jdbc.Driver"/> - <property name="url" value="jdbc:mysql://exoua.dnsalias.net/jcr"/> - <property name="username" value="exoadmin"/> - <property name="password" value="exo12321"/> - <property name="maxActive" value="50"/> - <property name="maxIdle" value="5"/> - <property name="initialSize" value="5"/> - </properties-param> - </init-params> - </component-plugin> - <component-plugins> - <init-params> - <value-param> - <name>default-context-factory</name> - <value>org.exoplatform.services.naming.SimpleContextFactory</value> - </value-param> - </init-params> - </component> Modified: epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/Advanced/JCR/cluster-config.xml =================================================================== --- epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/Advanced/JCR/cluster-config.xml 2010-11-12 02:40:21 UTC (rev 5047) +++ epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/Advanced/JCR/cluster-config.xml 2010-11-12 02:47:21 UTC (rev 5048) @@ -3,10 +3,9 @@ <!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent"> %BOOK_ENTITIES; ]> -<!--This file has been commented out. See ../JCR.xml --> <section id="sect-Reference_Guide-Configuring_JBoss_AS_with_eXo_JCR_in_cluster"> - <title>Clustering with JBoss Application Server</title> + <title>Clustering with JBoss Application Server - REMOVABLE?</title> <formalpara id="form-Reference_Guide-Configuring_JBoss_AS_with_eXo_JCR_in_cluster-Deploying_eXo_JCR_to_JBoss_As"> <title>Deploying eXo JCR in JBoss Application Server</title> <para> Modified: epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/Advanced/JCR/configuration-persister.xml =================================================================== --- epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/Advanced/JCR/configuration-persister.xml 2010-11-12 02:40:21 UTC (rev 5047) +++ epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/Advanced/JCR/configuration-persister.xml 2010-11-12 02:47:21 UTC (rev 5048) @@ -3,10 +3,9 @@ <!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent"> %BOOK_ENTITIES; ]> -<!--This file has been commented out. See ../JCR.xml --> <section id="sect-Reference_Guide-The_JCR_Configuration_persister"> - <title>The JCR Configuration persister</title> + <title>The JCR Configuration persister - REMOVABLE?</title> <para> The JCR Repository Service uses the <classname>org.exoplatform.services.jcr.config.RepositoryServiceConfiguration</classname> component to read its configuration. </para> Modified: epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/Advanced/JCR/configuration.xml =================================================================== --- epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/Advanced/JCR/configuration.xml 2010-11-12 02:40:21 UTC (rev 5047) +++ epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/Advanced/JCR/configuration.xml 2010-11-12 02:47:21 UTC (rev 5048) @@ -3,7 +3,6 @@ <!ENTITY % BOOK_ENTITIES SYSTEM "../../../Reference_Guide.ent"> %BOOK_ENTITIES; ]> -<!--This file has been commented out. See ../JCR.xml --> <section id="sect-Reference_Guide-JCR_configuration"> <title>JCR configuration</title> @@ -15,7 +14,9 @@ <para> To modify the configuration of the JCR Service, you would need to modify the file found at <filename>/<replaceable>JBOSS_AS</replaceable>/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/02portal.war/WEB-INF/conf/jcr/repository-configuration.xml</filename>. - <programlisting><![CDATA[ + </para> + +<programlisting><![CDATA[ <repository-service default-repository="repository"> <repositories> <repository name="repository" system-workspace="system" default-workspace="portal-system"> @@ -30,9 +31,7 @@ </repository> </repositories> </repository-service>]]> - - </programlisting> - </para> +</programlisting> <procedure> <step> <para> @@ -43,33 +42,35 @@ <literal>system</literal> </para> </listitem> - <listitem> - <para> - <literal>portal-system</literal>: To store portal metadata such as page compositions - </para> - </listitem> - <listitem> - <para> - <literal>portal-work</literal>: To store elements that are temporary such as tokens - </para> - </listitem> - <listitem> - <para> - <literal>wsrp-system</literal>: To store WSRP related data - </para> - </listitem> - <listitem> - <para> - <literal>wsrp-system</literal>: To store Portlet Container related data (such as portlet preferences - </para> - </listitem> + <listitem> + <para> + <literal>portal-system</literal>: To store portal metadata such as page compositions + </para> + </listitem> + <listitem> + <para> + <literal>portal-work</literal>: To store elements that are temporary such as tokens + </para> + </listitem> + <listitem> + <para> + <literal>wsrp-system</literal>: To store WSRP related data + </para> + </listitem> + <listitem> + <para> + <literal>wsrp-system</literal>: To store Portlet Container related data (such as portlet preferences + </para> + </listitem> </itemizedlist> </para> </step> - <step> - <para>Locate the workspace to modify. - <step> + <step> + <para> + Locate the workspace to modify. + </para> + </step> <step> <para> The repository configuration supports human-readable values. They are not case-sensitive. @@ -220,7 +221,7 @@ </programlistingco> </section> - +<!-- <section id="sect-Reference_Guide-JCR_configuration-Related_documents"> <title>Related Sections</title> <itemizedlist> @@ -241,5 +242,5 @@ </listitem> </itemizedlist> </section> - +--> </section> Modified: epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/Advanced/JCR/external-value-storages.xml =================================================================== --- epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/Advanced/JCR/external-value-storages.xml 2010-11-12 02:40:21 UTC (rev 5047) +++ epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/Advanced/JCR/external-value-storages.xml 2010-11-12 02:47:21 UTC (rev 5048) @@ -3,7 +3,6 @@ <!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent"> %BOOK_ENTITIES; ]> -<!--This file has been commented out. See ../JCR.xml --> <section id="sect-Reference_Guide-External_Value_Storages"> <title>External Value Storages</title> Modified: epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/Advanced/JCR/intro.xml =================================================================== --- epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/Advanced/JCR/intro.xml 2010-11-12 02:40:21 UTC (rev 5047) +++ epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/Advanced/JCR/intro.xml 2010-11-12 02:47:21 UTC (rev 5048) @@ -8,7 +8,10 @@ <warning> <title>eXo JCR usage</title> <para> - The JBoss Enterprise Portal Platform is using a JCR API to store its information for internal usage. We do not support usage of the JCR to store application infornation. The information below only exists if one need to understand particular low level details on how the JBoss Enterprise Portal Platform works and how it can be fine-tuned. + The JBoss Enterprise Portal Platform is using a JCR API to store its information for internal usage. We do not support usage of the JCR to store application information. + </para> + <para> + The information below is intended to assist users to understand particular low level details on how the JBoss Enterprise Portal Platform works and how it can be fine-tuned. </para> </warning> <para> Modified: epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/Advanced/JCR/jdbc-data-container-config.xml =================================================================== --- epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/Advanced/JCR/jdbc-data-container-config.xml 2010-11-12 02:40:21 UTC (rev 5047) +++ epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/Advanced/JCR/jdbc-data-container-config.xml 2010-11-12 02:47:21 UTC (rev 5048) @@ -231,8 +231,8 @@ <para> For example, in <application>mysql</application> it is necessary to add a parameter for the JDBC driver to the JDBC URL protocol. For instance: <code>jdbc:mysql://exoua.dnsalias.net/portal?characterEncoding=utf8<... </para> - <para> - There are pre-configured configuration files for HSQLDB. These files are stored in the <filename>/conf/portal</filename> and <filename>/conf/standalone</filename> folders of the <filename>exo.jcr.component.core-XXX.XXX.jar</filename> jar-file or source-distribution of the eXo JCR implementation. + <para> + While HSQL is not supported in production, there are pre-configured configuration files stored in the <filename>/conf/portal</filename> and <filename>/conf/standalone</filename> folders of the <filename>exo.jcr.component.core-XXX.XXX.jar</filename> jar-file or source-distribution of the eXo JCR implementation. <emphasis role="bold">These files are included primarily for development and/or familiarization purposes.</emphasis> </para> <para> The configuration files are located in service jars <filename>/conf/portal/configuration.xml</filename> (eXo services including JCR Repository Service) and <filename>exo-jcr-config.xml</filename> (repositories configuration) by default. @@ -327,11 +327,7 @@ <para> It is the JNDI context initializer which registers (binds) naming resources (DataSources) for data containers. </para> - <!-- DOC NOTE: The below section has been commented as it refers to an example of repositories configured in standalone mode -<para> -The following example is in standalone mode with two data containers <parameter>jdbcjcr</parameter> (a local HSQLDB) and <parameter>jdbcjcr1</parameter> (a remote MySQL container): -</para> -<programlisting language="XML" role="XML"><xi:include parse="text" href="../../../extras/Advanced_Development_JCR_jdbc-data-container-config/default38.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> --> + </step> <step> <para> @@ -339,7 +335,7 @@ </para> <variablelist> <varlistentry> - <term>driverClassName</term> + <term><emphasis role="bold">driverClassName</emphasis></term> <listitem> <para> Some examples are &#34;<literal>org.hsqldb.jdbcDriver</literal>&#34;, &#34;<literal>com.mysql.jdbc.Driver</literal>&#34; and &#34;<literal>org.postgresql.Driver</literal>&#34; @@ -347,7 +343,7 @@ </listitem> </varlistentry> <varlistentry> - <term>URL</term> + <term><emphasis role="bold">URL</emphasis></term> <listitem> <para> For example: &#34;<literal>jdbc:hsqldb:file:target/temp/data/portal&#34;, &#34;jdbc:mysql://exoua.dnsalias.net/jcr</literal>&#34; @@ -355,7 +351,7 @@ </listitem> </varlistentry> <varlistentry> - <term>username</term> + <term><emphasis role="bold">username</emphasis></term> <listitem> <para> Examples are &#34;<literal>sa</literal>&#34;, &#34;<literal>exoadmin</literal>&#34; @@ -363,7 +359,7 @@ </listitem> </varlistentry> <varlistentry> - <term>password</term> + <term><emphasis role="bold">password</emphasis></term> <listitem> <para> Enter a password. @@ -378,7 +374,7 @@ </para> <variablelist> <varlistentry> - <term>maxActive</term> + <term><emphasis role="bold">maxActive</emphasis></term> <listitem> <para> Enter a maximum period of active time. For example; 50. @@ -386,7 +382,7 @@ </listitem> </varlistentry> <varlistentry> - <term>maxIdle</term> + <term><emphasis role="bold">maxIdle</emphasis></term> <listitem> <para> Enter a period of idle time. @@ -394,7 +390,7 @@ </listitem> </varlistentry> <varlistentry> - <term>initialSize</term> + <term><emphasis role="bold">initialSize</emphasis></term> <listitem> <para> Define an initial size. For example; 5. @@ -420,7 +416,7 @@ <programlisting language="XML" role="XML"><xi:include href="../../../extras/Advanced_Development_JCR_jdbc-data-container-config/default39.java" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> <variablelist> <varlistentry> - <term>source-name</term> + <term><emphasis role="bold">source-name</emphasis></term> <listitem> <para> A <literal>javax.sql.DataSource</literal> name configured in the <literal>InitialContextInitializer</literal> component. This was known as <parameter>sourceName</parameter> in JCR versions earlier than 1.9. @@ -428,7 +424,7 @@ </listitem> </varlistentry> <varlistentry> - <term>dialect</term> + <term><emphasis role="bold">dialect</emphasis></term> <listitem> <para> A database dialect. @@ -496,7 +492,7 @@ </listitem> </varlistentry> <varlistentry> - <term>multi-db</term> + <term><emphasis role="bold">multi-db</emphasis></term> <listitem> <para> This parameter enables multi-database containers when set to &#34;true&#34;. @@ -504,7 +500,7 @@ </listitem> </varlistentry> <varlistentry> - <term>max-buffer-size</term> + <term><emphasis role="bold">max-buffer-size</emphasis></term> <listitem> <para> A threshold (in bytes) after which a <literal>javax.jcr.Value</literal> content will be swapped to a file in a temporary storage. That is, swap for pending changes. @@ -512,7 +508,7 @@ </listitem> </varlistentry> <varlistentry> - <term>swap-directory</term> + <term><emphasis role="bold">swap-directory</emphasis></term> <listitem> <para> A path in the file system used to swap the pending changes. Modified: epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/Advanced/JCR.xml =================================================================== --- epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/Advanced/JCR.xml 2010-11-12 02:40:21 UTC (rev 5047) +++ epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/Advanced/JCR.xml 2010-11-12 02:47:21 UTC (rev 5048) @@ -10,14 +10,15 @@ <!-- <xi:include href="JCR/jdbc-data-container-config.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> --> - <xi:include href="JCR/external-value-storages.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <!--Section removed as JCR requirements already configured in EPP--> + <xi:include href="JCR/external-value-storages.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <xi:include href="JCR/search-configuration.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <xi:include href="JCR/multilanguage-support.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <!--<xi:include href="JCR/configuration-persister.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />--> - <!--Section removed as JCR requirements already configured in EPP--> - <!--<xi:include href="JCR/cluster-config.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />--> - <!--Section removed as JCR requirements already configured in EPP--> + <!-- + <xi:include href="JCR/configuration-persister.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + --> + <!-- + <xi:include href="JCR/cluster-config.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + --> <xi:include href="JCR/jbosscache-configuration-templates.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <xi:include href="JCR/lock-manager-config.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <xi:include href="JCR/query-handler-config.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> Modified: epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/AuthenticationAndIdentity/SSO.xml =================================================================== --- epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/AuthenticationAndIdentity/SSO.xml 2010-11-12 02:40:21 UTC (rev 5047) +++ epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/AuthenticationAndIdentity/SSO.xml 2010-11-12 02:47:21 UTC (rev 5048) @@ -723,7 +723,7 @@ <section id="sect-Reference_Guide-SSO_Single_Sign_On-SPNEGO_Simple_and_Protected_GSSAPI_Negotiation_Mechanism"> - <title>SPNEGO - Simple and Protected GSSAPI Negotiation Mechanism</title> + <title>SPNEGO - Simple and Protected GSSAPI Negotiation Mechanism - Please Review</title> <para> The Simple and Protected GSSAPI Negotiation Mechanism (<emphasis role="bold">SPNEGO</emphasis>) uses desktop credentials provided during a desktop login to transparently authenticate a portal user through a web browser. </para> @@ -785,11 +785,6 @@ </step> <step> <para> - Add the JBoss Negotiation binary by copying <filename><replaceable>PORTAL_SSO</replaceable>/spnego/jboss-negotiation-2.0.3.GA.jar</filename> to <filename>jboss-as/server/<replaceable>PROFILE</replaceable>/lib</filename>. - </para> - </step> - <step> - <para> Add the Gatein SSO module binaries by adding <filename><replaceable>PORTAL_SSO</replaceable>/spnego/gatein.ear/lib/sso-agent.jar</filename> and <filename><replaceable>PORTAL_SSO</replaceable>/spnego/gatein.ear/lib/spnego-<replaceable>VERSION</replaceable>-epp-GA.jar</filename> to <filename>deploy/gatein.ear/lib</filename>. </para> </step> Modified: epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/PortalDevelopment/InternationalizationConfiguration.xml =================================================================== --- epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/PortalDevelopment/InternationalizationConfiguration.xml 2010-11-12 02:40:21 UTC (rev 5047) +++ epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/PortalDevelopment/InternationalizationConfiguration.xml 2010-11-12 02:47:21 UTC (rev 5048) @@ -47,7 +47,7 @@ It is also possible to use a proprietary XML format to define translations. This is a more convenient way to translate a document for some languages such as Japanese, Arabic or Russian. </para> <para> - Property files have te be ASCII encoded, while the XML file can define its encoding. As a result it&#39;s easier for a human being to read a translation in XML instead of having to decode and encode the property file. + Property files have to be ISO 8859-1 encoded, while the XML file can define its encoding. As a result it&#39;s easier for a human being to read a translation in XML instead of having to decode and encode the property file. </para> <para> For more information refer to: <xref linkend="chap-Reference_Guide-XML_Resources_Bundles" /> Modified: epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/WSRP.xml =================================================================== --- epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/WSRP.xml 2010-11-12 02:40:21 UTC (rev 5047) +++ epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/WSRP.xml 2010-11-12 02:47:21 UTC (rev 5048) @@ -4,7 +4,7 @@ %BOOK_ENTITIES; ]> <chapter id="chap-Reference_Guide-Web_Services_for_Remote_Portlets_WSRP"> - <title>Web Services for Remote Portlets (WSRP)</title> + <title>Web Services for Remote Portlets (WSRP) - Please Review</title> <section id="sect-Reference_Guide-Web_Services_for_Remote_Portlets_WSRP-Introduction"> <title>Introduction</title> <para> @@ -56,13 +56,8 @@ &PRODUCT; 5.0 provides a complete implementation of WSRP 1.0 while &PRODUCT; 5.1 includes an implementation of WSRP 2.0. </para> <para> - All optional features in WSRP 2 are implemented except support for lifetimes and leasing support. + All optional features in WSRP 2 are implemented in &PRODUCT; 5.1 except support for lifetimes and leasing support. </para> - <note> - <para> - As of version &VERSION; of &PRODUCT;, WSRP is only activated and supported when &PRODUCT; is deployed on JBoss Application Server. - </para> - </note> <para> Users should familiarize themselves with the appropriate sections of this chapter based on their version of &PRODUCT;. </para> @@ -72,28 +67,50 @@ <section id="sect-Reference_Guide-Web_Services_for_Remote_Portlets_WSRP-Deploying_WSRP"> <title>Deploying WSRP</title> <note> - <title>Assumptions</title> + <title>Notational Devices</title> <para> - The following list of support files assumes: + The following list of support files uses the following notational devices: </para> - <orderedlist> - <listitem> - <para> - That the directory &PRODUCT; has been installed into will be referred to as <replaceable>PORTAL_HOME</replaceable>. - </para> - </listitem> - <listitem> - <para> - That <replaceable>WSRP_VERSION</replaceable> is the version of the WSRP component in use. - </para> - </listitem> - <listitem> - <para> - That <replaceable>PORTAL_VERSION</replaceable> is the version of &PRODUCT; in use. - </para> - </listitem> - </orderedlist> + <variablelist> + <title></title> + <varlistentry> + <term><replaceable>EPP_HOME</replaceable></term> + <listitem> + <para> + <replaceable>EPP_HOME</replaceable> refers to the directory that your instance of &PRODUCT; has been extracted/installed to. For example: <filename>/home/<replaceable>USERNAME</replaceable>/jboss-epp-5.0/</filename> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><replaceable>WSRP_PATH</replaceable></term> + <listitem> + <para> + The WSRP files referred to in this section are found in the <filename><replaceable>EPP_HOME</replaceable>/jboss-as/server/$CONFIG/deploy/gatein.ear</filename> directory. + </para> + <para> + For ease of reference this path will be represented by: <replaceable>WSRP_PATH</replaceable>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><replaceable>WSRP_VERSION</replaceable></term> + <listitem> + <para> + <replaceable>WSRP_VERSION</replaceable> represents the version of the WSRP component in use. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><replaceable>PORTAL_VERSION</replaceable></term> + <listitem> + <para> + <replaceable>PORTAL_VERSION</replaceable> represents the version of &PRODUCT; in use. + </para> + </listitem> + </varlistentry> + </variablelist> </note> + <variablelist id="vari-Reference_Guide-Deploying_WSRP-WSRP_support_files"> <title>WSRP support files</title> <varlistentry> @@ -250,12 +267,6 @@ <section id="sect-Reference_Guide-Web_Services_for_Remote_Portlets_WSRP-Consuming_WSRP_portlets_from_a_remote_Consumer"> <title>Consuming WSRP portlets from a remote Consumer</title> - <important> - <title><emphasis role="bold">DOC NOTE</emphasis></title> - <para> - Is this section relevant? Do we want users consuming portlets produced by EPP elsewhere? - </para> - </important> <para> Configuration is extremely variable between different WSRP Consumers. Most, however, require a specification of the URL for the Producer's WSDL definition. If the &PRODUCT; Consumer is not being used, refer to the documentation for the Consumer that is in use for specific instructions. </para> @@ -310,10 +321,30 @@ <section id="sect-Reference_Guide-Configuring_a_Remote_Producer-The_Configuration_Portlet"> <title>The Configuration Portlet</title> <para> - &PRODUCT; provides a portlet to configure access (among other functions) to remote WSRP Producers grahically. + &PRODUCT; provides a graphical portlet to assist with configuring access to, and other facets of, remote WSRP Producers. </para> - <formalpara> - <title><emphasis role="bold">&PRODUCT; 5.0: Installing the Configuration Portlet</emphasis></title> +<!--DOC NOTE: Branching issue --> + <important> + <title>Version-specific Information:</title> + <para> + <emphasis role="bold">The implementation of this portlet has changed between the &PRODUCT; 5.0 and &PRODUCT; 5.1 releases:</emphasis> + </para> + <itemizedlist> + <listitem> + <para> + <emphasis role="bold">&PRODUCT; version 5.0</emphasis> users should read <xref linkend="form-Reference_Guide-Configuring_a_Remote_Producer-The_Configuration_Portlet-5.0_Installing"/> for instructions on how to install the configuration portlet. + </para> + </listitem> + <listitem> + <para> + <emphasis role="bold">&PRODUCT; version 5.1</emphasis> users should read <xref linkend="form-Reference_Guide-Configuring_a_Remote_Producer-The_Configuration_Portlet-5.1_Accessing"/> for how to access the pre-installed configuration portlet. + </para> + </listitem> + </itemizedlist> + </important> + + <formalpara id="form-Reference_Guide-Configuring_a_Remote_Producer-The_Configuration_Portlet-5.0_Installing" > + <title><emphasis role="bold">EPP 5.0: Installing the Configuration Portlet</emphasis></title> <para> This portlet is not installed by default in &PRODUCT; 5.0. It must be installed using the Application Registry. </para> @@ -339,8 +370,8 @@ </para> </step> </procedure> - <formalpara> - <title><emphasis role="bold">&PRODUCT; 5.1: Accessing the Configuration Portlet</emphasis></title> + <formalpara id="form-Reference_Guide-Configuring_a_Remote_Producer-The_Configuration_Portlet-5.1_Accessing"> + <title><emphasis role="bold">EPP 5.1: Accessing the Configuration Portlet</emphasis></title> <para> The Configuration Portlet is installed by default in &PRODUCT; 5.1. It is available at: <ulink type="http" url="http://localhost:8080/portal/login?initialURI=%2Fportal%2Fprivate%2Fclassic%2FwsrpConfiguration&amp;username=root&amp;password=gtn"></ulink> </para> @@ -465,7 +496,7 @@ <imagedata align="center" contentwidth="140mm" fileref="images/WSRP/config_end.png" format="PNG" /> </imageobject> </mediaobject> - </section> <!-- Close Section: <number><title> --> + </section> </section> @@ -541,7 +572,7 @@ The information defined at the XML level is only processed for producer definition for which no information is already present in the JCR. </para> <para> - Therefore, to delete a Producer configuration, the associated information in the database must be deleted (this can be accomplished using the configuration portlet as shown in <xref linkend="sect-Reference_Guide-Configuring_a_Remote_Producer-Using_the_Configuration_Portlet" />). + Therefore, to delete a Producer configuration, the associated information in the database must be deleted (this can be accomplished using the configuration portlet as shown in <xref linkend="sect-Reference_Guide-Configuring_a_Remote_Producer-The_Configuration_Portlet" />). </para> <para> The associated information in <filename>wsrp-consumers-config.xml</filename> (if such information exists) must also be removed, otherwise the producer will be re-created the next time the WSRP is launched. @@ -664,7 +695,7 @@ Therefore at times it may be necessary to modify the registration that sets the service agreement between a consumer and a producer. </para> <para> - For example; the producer requiring an email that was configured in <xref linkend="sect-Reference_Guide-Configuring_a_Remote_Producer-Using_the_Configuration_Portlet" />. In that case the producer was requiring registration and required a value to be provided for the <literal>email</literal> property. + For example; the producer requiring an email that was configured in <xref linkend="sect-Reference_Guide-Configuring_a_Remote_Producer-The_Configuration_Portlet" />. In that case the producer was requiring registration and required a value to be provided for the <literal>email</literal> property. </para> <para> To update the email address that was provided, the remote producer must be informed that some registration data has been modified.