[gatein-commits] gatein SVN: r8192 - in portal/trunk/docs/reference-guide/en-US/modules: AuthenticationAndIdentity and 1 other directory.

Author: smumford Date: 2011-12-04 23:34:52 -0500 (Sun, 04 Dec 2011) New Revision: 8192 Modified: portal/trunk/docs/reference-guide/en-US/modules/AuthenticationAndIdentity/SSO.xml portal/trunk/docs/reference-guide/en-US/modules/WSRP.xml Log: JBEPP-1431: Actioning QE feedback Modified: portal/trunk/docs/reference-guide/en-US/modules/AuthenticationAndIdentity/SSO.xml =================================================================== --- portal/trunk/docs/reference-guide/en-US/modules/AuthenticationAndIdentity/SSO.xml 2011-12-05 04:33:56 UTC (rev 8191) +++ portal/trunk/docs/reference-guide/en-US/modules/AuthenticationAndIdentity/SSO.xml 2011-12-05 04:34:52 UTC (rev 8192) @@ -336,7 +336,7 @@ <section id="sect-Reference_Guide-CAS_Central_Authentication_Service-CAS_server"> <title>CAS server</title> <para> - First, set up the server to authenticate against the portal login module. In this example, the CAS server is installed on Tomcat. + First, set up the server to authenticate against the portal login module. In this example, the CAS server is installed on Tomcat. </para> <section id="sect-Reference_Guide-CAS_server-Obtaining_CAS"> <title>Obtaining CAS</title> @@ -352,7 +352,7 @@ <section id="sect-Reference_Guide-CAS_server-Modifying_CAS_server"> <title>Modifying the CAS server</title> <para> - To configure the web archive as desired, the simplest way is to make the necessary changes directly in the CAS codebase. + To configure the web archive as desired, the simplest way is to make the necessary changes directly in the CAS codebase. </para> <note> <para> @@ -361,10 +361,10 @@ </para> </note> <para> - First, change the default authentication handler with the one provided by &PRODUCT;. + First, change the default authentication handler with the one provided by &PRODUCT;. </para> <para> - The CAS Server Plugin makes secure authentication callbacks to a RESTful service installed on the remote &PRODUCT; server to authenticate a user. + The CAS Server Plugin makes secure authentication callbacks to a RESTful service installed on the remote &PRODUCT; server to authenticate a user. </para> <para> In order for the plugin to function correctly, it needs to be properly configured to connect to this service. This configuration is done via the <filename>cas.war/WEB-INF/deployerConfigContext.xml </filename> file. @@ -457,7 +457,7 @@ Change the default port to avoid a conflict with the default &PRODUCT; (for testing purposes). Edit <filename>TOMCAT_HOME/conf/server.xml</filename> and replace the 8080 port to 8888. <note> <para> - If &PRODUCT; is running on the same machine as Tomcat, other ports need to be changed in addition to 8080 to avoid port conflicts. + If &PRODUCT; is running on the same machine as Tomcat, other ports need to be changed in addition to 8080 to avoid port conflicts. They can be changed to any free port. For example, you can change admin port from 8005 to 8805, and AJP port from 8009 to 8809. </para> </note> @@ -513,7 +513,7 @@ <itemizedlist> <listitem> <para> - In JBoss AS, edit <filename>gatein.ear/META-INF/gatein-jboss-beans.xml</filename> and uncomment on this section: + In JBoss AS, edit <filename>gatein.ear/META-INF/gatein-jboss-beans.xml</filename> and uncomment on this section: </para> <programlisting> <![CDATA[ @@ -533,7 +533,7 @@ </listitem> <listitem> <para> - In Tomcat, edit <filename>GATEIN_HOME/conf/jaas.conf</filename>, uncomment on this section and comment other parts: + In Tomcat, edit <filename>GATEIN_HOME/conf/jaas.conf</filename>, uncomment on this section and comment other parts: </para> <programlisting>org.gatein.sso.agent.login.SSOLoginModule required; org.exoplatform.services.security.j2ee.TomcatLoginModule required @@ -687,18 +687,18 @@ <section id="sect-Reference_Guide-Single_Sign_On-JOSSO"> <title>JOSSO</title> <para> - This Single-Sign-On plugin enables the seamless integration between &PRODUCT; and the JOSSO Single-Sign-On Framework. Details about JOSSO can be found <ulink url="http://www.josso.org">here</ulink>. + This Single-Sign-On plugin enables the seamless integration between &PRODUCT; and the JOSSO Single-Sign-On Framework. Details about JOSSO can be found <ulink url="http://www.josso.org">here</ulink>. </para> <para> - Setting up this integration consists of two steps: installing/configuring a JOSSO server, and setting up the portal to use the JOSSO server. + Setting up this integration consists of two steps: installing/configuring a JOSSO server, and setting up the portal to use the JOSSO server. </para> <section id="sect-Reference_Guide-JOSSO-JOSSO_server"> <title>JOSSO server</title> <para> - This section describes how to set up the JOSSO server to authenticate against the &PRODUCT; login module. + This section describes how to set up the JOSSO server to authenticate against the &PRODUCT; login module. </para> <para> - In this example, the JOSSO server will be installed on Tomcat. + In this example, the JOSSO server will be installed on Tomcat. </para> <section id="sect-Reference_Guide-JOSSO_server-Obtaining_JOSSO"> <title>Obtaining JOSSO</title> @@ -981,7 +981,7 @@ </section> <section id="sect-Reference_Guide-OpenSSO_server-Modifying_OpenSSO_server"> - <title>Modifying the OpenSSO server</title> + <title>Modifying the OpenSSO server</title> <para> To configure the web server as desired, it is simpler to directly modify the sources. </para> @@ -989,7 +989,7 @@ The first step is to add the &PRODUCT; Authentication Plugin: </para> <para> - The plugin makes secure authentication callbacks to a RESTful service installed on the remote &PRODUCT; server to authenticate a user. + The plugin makes secure authentication callbacks to a RESTful service installed on the remote &PRODUCT; server to authenticate a user. </para> <para> In order for the plugin 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. @@ -1002,7 +1002,7 @@ </step> <step> <para> - Change the default port to avoid a conflict with the default &PRODUCT; port (for testing purposes) by editing <filename>TOMCAT_HOME/conf/server.xml</filename> and replacing the 8080 port with 8888. + Change the default port to avoid a conflict with the default &PRODUCT; port (for testing purposes) by editing <filename>TOMCAT_HOME/conf/server.xml</filename> and replacing the 8080 port with 8888. <note> <para> If &PRODUCT; is running on the same machine as Tomcat, other ports need to be changed in addition to 8080 to avoid port conflicts. @@ -1140,7 +1140,7 @@ </listitem> <listitem> <para> - If you are running &PRODUCT; in Tomcat, edit $GATEIN_HOME/conf/jaas.conf, uncomment on this section and comment other parts: + If you are running &PRODUCT; in Tomcat, edit $GATEIN_HOME/conf/jaas.conf, uncomment on this section and comment other parts: </para> <programlisting>org.gatein.sso.agent.login.SSOLoginModule required; org.exoplatform.services.security.j2ee.TomcatLoginModule required @@ -1572,7 +1572,7 @@ adding the 'SPNEGO' authenticators property. </para> -<programlisting language="xml"> +<programlisting language="XML"> <![CDATA[<deployment xmlns="urn:jboss:bean-deployer:2.0"> <property name="authenticators"> <map class="java.util.Properties" keyClass="java.lang.String" valueClass="java.lang.String"> @@ -1625,7 +1625,7 @@ Modify the <emphasis role="bold">JBOSS_HOME/server/defaut/deploy/gatein.ear/META-INF/gatein-jboss-beans.xml</emphasis> file as below: </para> - <programlisting language="xml"><![CDATA[ + <programlisting language="XML"><![CDATA[ <deployment xmlns="urn:jboss:bean-deployer:2.0"> <application-policy xmlns="urn:jboss:security-beans:1.0" name="gatein-form-auth-domain"> @@ -1691,7 +1691,7 @@ <para> Modify <emphasis role="bold">JBOSS_HOME/server/default/deploy/gatein.ear/02portal.war/WEB-INF/web.xml</emphasis> as below.</para> - <programlisting language="xml"><![CDATA[ + <programlisting language="XML"><![CDATA[ <!-- <login-config> <auth-method>FORM</auth-method> <realm-name>gatein-domain</realm-name> Modified: portal/trunk/docs/reference-guide/en-US/modules/WSRP.xml =================================================================== --- portal/trunk/docs/reference-guide/en-US/modules/WSRP.xml 2011-12-05 04:33:56 UTC (rev 8191) +++ portal/trunk/docs/reference-guide/en-US/modules/WSRP.xml 2011-12-05 04:34:52 UTC (rev 8192) @@ -171,7 +171,7 @@ for more details. </para> <para> - Of course, if you have modified you have modified the host name and port on which your server runs, you will + Of course, if you have modified the host name and port on which your server runs, you will need to update the configuration for the consumer used to consume &PRODUCT_NAME;'s 'self' producer. Please refer to the @@ -233,7 +233,7 @@ <para>&PRODUCT_NAME; uses JBossWS Native to handle ws-security. Please see the WS-Security section of the <ulink url="http://www.jboss.org/jbossas/docs/5-x">JBoss AS 5 Administration and Configuration Guide </ulink> for indepth configuration options. Please note that since the consumer passes its credentials - to the producer, the consumer will act at the wss client and the producer will act as the wss server. + to the producer, the consumer will act as the wss client and the producer will act as the wss server. </para> <para> The following are the JBossWS Native configuration files which need to be configure for WSRP: </para> @@ -294,16 +294,16 @@ </para> <itemizedlist> <listitem> - <para>The JBossWS configuration files must be configured</para> + <para>The JBossWS configuration files must be configured.</para> </listitem> <listitem> - <para>The filter must be added to the portal's web.xml</para> + <para>The filter must be added to the portal's web.xml.</para> </listitem> <listitem> - <para>the enable wss feature must be check in the wsrp admin</para> + <para>The enable wss feature must be check in the wsrp admin.</para> </listitem> </itemizedlist> - <para>The consumer will not properly handle ws-security unless all 3 are properly configured</para> + <para>The consumer will not properly handle ws-security unless all 3 are properly configured.</para> </note> </sect2> </sect1> @@ -356,9 +356,7 @@ <para> It is also possible to specify that all the portlets declared within a given portlet application to be remotable by default. This is done by specifying the - <code> - container-runtime-option - </code> + <code>container-runtime-option</code> at the <code>portlet-app</code> element level. Individual portlets can override that value to not be remotely exposed. Let's look at an @@ -415,11 +413,11 @@ <varname>RemotelyExposedPortlet</varname> inherits the remotable status defined at the <code>portlet-app</code> - level since it does not specify a value for the<code>org.gatein.pc.remotable container-runtime-option</code>. + level since it does not specify a value for the <code>org.gatein.pc.remotable container-runtime-option</code>. The<varname>NotRemotelyExposedPortlet</varname>, however, overrides the default behavior and is not remotely exposed. Note that in the absence of a top-level <code>org.gatein.pc.remotable container-runtime-option</code> - value set to<code>true</code>, portlets are NOT remotely exposed. + value set to <code>true</code>, portlets are NOT remotely exposed. </para> </sect1> @@ -481,7 +479,7 @@ <para> &PRODUCT_NAME; provides a portlet to configure access (among other functions) to remote WSRP Producers - grahically. Starting with &PRODUCT_VERSION;, the WSRP configuration portlet is installed by default. You + graphically. Starting with &PRODUCT_VERSION;, the WSRP configuration portlet is installed by default. You can find it at <ulink url="http://localhost:8080/portal/login?initialURI=%2Fportal%2Fprivate%2Fclassic%2FwsrpConfiguration&amp;username=root&amp;password=gtn"> @@ -592,7 +590,7 @@ properties, as is the case for the <literal>selfv2</literal> consumer (the consumer that accesses the portlets made remotely available by &PRODUCT_NAME;'s producer via - WSRP 2), we'd have seen something similar to, after pressing the "Refresh &amp; Save" button: + WSRP 2), we'd have seen something similar to the screenshot below, after pressing the "Refresh &amp; Save" button: <mediaobject> <imageobject> <imagedata fileref="images/WSRP/config_refresh.png" format="PNG" align="center" valign="middle"