Author: smumford Date: 2011-08-11 00:52:38 -0400 (Thu, 11 Aug 2011) New Revision: 7045 Modified: epp/docs/branches/5.1/Reference_Guide/en-US/Book_Info.xml epp/docs/branches/5.1/Reference_Guide/en-US/Reference_Guide.xml epp/docs/branches/5.1/Reference_Guide/en-US/Revision_History.xml epp/docs/branches/5.1/Reference_Guide/en-US/modules/Advanced/JCR/as_managed_datasources.xml epp/docs/branches/5.1/Reference_Guide/en-US/modules/AuthenticationAndIdentity.xml epp/docs/branches/5.1/Reference_Guide/en-US/modules/AuthenticationAndIdentity/LDAP.xml epp/docs/branches/5.1/Reference_Guide/en-US/modules/AuthenticationAndIdentity/SSO.xml epp/docs/branches/5.1/Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalNavigationConfiguration.xml epp/docs/branches/5.1/Reference_Guide/en-US/modules/WSRP.xml epp/docs/branches/5.1/Reference_Guide/publican.cfg Log: Checking in remarked sections before removing highlights for 5.1.1 push Modified: epp/docs/branches/5.1/Reference_Guide/en-US/Book_Info.xml =================================================================== --- epp/docs/branches/5.1/Reference_Guide/en-US/Book_Info.xml 2011-08-11 04:41:47 UTC (rev 7044) +++ epp/docs/branches/5.1/Reference_Guide/en-US/Book_Info.xml 2011-08-11 04:52:38 UTC (rev 7045) @@ -9,7 +9,7 @@ <productname>JBoss Enterprise Portal Platform</productname> <productnumber>5.1</productnumber> <edition>2</edition> - <pubsnumber>5.1.2</pubsnumber> + <pubsnumber>5.1.7</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 JBoss Enterprise Portal Platform 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/5.1/Reference_Guide/en-US/Reference_Guide.xml =================================================================== --- epp/docs/branches/5.1/Reference_Guide/en-US/Reference_Guide.xml 2011-08-11 04:41:47 UTC (rev 7044) +++ epp/docs/branches/5.1/Reference_Guide/en-US/Reference_Guide.xml 2011-08-11 04:52:38 UTC (rev 7045) @@ -3,15 +3,15 @@ <!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent"> %BOOK_ENTITIES; ]> -<book status="draft"> - <xi:include href="Book_Info.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> +<book> + <xi:include href="Book_Info.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <xi:include href="Preface.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <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/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/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" /> - <xi:include href="Revision_History.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" /> + <xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> </book> Modified: epp/docs/branches/5.1/Reference_Guide/en-US/Revision_History.xml =================================================================== --- epp/docs/branches/5.1/Reference_Guide/en-US/Revision_History.xml 2011-08-11 04:41:47 UTC (rev 7044) +++ epp/docs/branches/5.1/Reference_Guide/en-US/Revision_History.xml 2011-08-11 04:52:38 UTC (rev 7045) @@ -8,6 +8,76 @@ <simpara> <revhistory> <revision> + <revnumber>2-5.1.7</revnumber> + <date>Thu Aug 11 2011</date> + <author> + <firstname>Scott</firstname> + <surname>Mumford</surname> + <email></email> + </author> + <revdescription> + <simplelist> + <member>Prep for 5.1.1 release.</member> + </simplelist> + </revdescription> + </revision> + <!-- <revision> + <revnumber>2-5.1.6</revnumber> + <date>Wed Aug 10 2011</date> + <author> + <firstname>Scott</firstname> + <surname>Mumford</surname> + <email></email> + </author> + <revdescription> + <simplelist> + <member>Incorporated QA feedback.</member> + </simplelist> + </revdescription> + </revision> + <revision> + <revnumber>2-5.1.5</revnumber> + <date>Fri Aug 5 2011</date> + <author> + <firstname>Scott</firstname> + <surname>Mumford</surname> + <email></email> + </author> + <revdescription> + <simplelist> + <member>Incorporated changes from GateIn revision 6987.</member> + </simplelist> + </revdescription> + </revision> --> + <revision> + <revnumber>2-5.1.4</revnumber> + <date>Tue Aug 2 2011</date> + <author> + <firstname>Scott</firstname> + <surname>Mumford</surname> + <email></email> + </author> + <revdescription> + <simplelist> + <member>JBEPP-894: Updated 'Enable SSO' section.</member> + </simplelist> + </revdescription> + </revision> + <!--<revision> + <revnumber>2-5.1.3</revnumber> + <date>Mon Aug 1 2011</date> + <author> + <firstname>Scott</firstname> + <surname>Mumford</surname> + <email></email> + </author> + <revdescription> + <simplelist> + <member>JBEPP-894: Added Section 14.7.2. Enabling SSO.</member> + </simplelist> + </revdescription> + </revision> + <revision> <revnumber>2-5.1.2</revnumber> <date>Fri Jul 15 2011</date> <author> @@ -21,7 +91,7 @@ </simplelist> </revdescription> </revision> - <!--<revision> + <revision> <revnumber>2-5.1.1</revnumber> <date>Monday June 27 2011</date> <author> @@ -34,7 +104,7 @@ <member>Updated for 5.1.1 Release.</member> </simplelist> </revdescription> - </revision>--> + </revision> <revision> <revnumber>1-5.8</revnumber> <date>Wed June 22 2011</date> @@ -78,7 +148,7 @@ </simplelist> </revdescription> </revision> - <!--<revision> + <revision> <revnumber>1-5.5</revnumber> <date>Thu May 12 2011</date> <author> @@ -217,7 +287,7 @@ <member>Republished for 5.1 branch.</member> </simplelist> </revdescription> - </revision> --> + </revision> <revision> <revnumber>1-1.21</revnumber> <date>Wed Dec 01 2010</date> @@ -232,7 +302,7 @@ </simplelist> </revdescription> </revision> - <!-- <revision> + <revision> <revnumber>1-1.20</revnumber> <date>Mon Nov 29 2010</date> <author> @@ -304,7 +374,7 @@ <member>Updated to remove numerous minor spelling and typographic errors.</member> </simplelist> </revdescription> - </revision> --> + </revision> <revision> <revnumber>1-1.13</revnumber> <date>Tue Oct 26 2010</date> @@ -319,7 +389,7 @@ </simplelist> </revdescription> </revision> -<!-- <revision> + <revision> <revnumber>1-1.11</revnumber> <date>Thu Sep 30 2010</date> <author> @@ -360,7 +430,7 @@ <member>Started content for &#34;Debugging Resource Bundle Usage&#34; section. Started homoginizing filepath variables.</member> </simplelist> </revdescription> - </revision> --> + </revision> <revision> <revnumber>1-1.8</revnumber> <date>Fri Aug 27 2010</date> @@ -375,7 +445,7 @@ </simplelist> </revdescription> </revision> -<!-- <revision> + <revision> <revnumber>1-1.7</revnumber> <date>Mon Aug 9 2010</date> <author> @@ -388,7 +458,7 @@ <member>Further clean-up of programlisting rendering.</member> </simplelist> </revdescription> - </revision> --> + </revision> <revision> <revnumber>1-1.6</revnumber> <date>Thu Aug 5 2010</date> @@ -403,7 +473,7 @@ </simplelist> </revdescription> </revision> -<!-- <revision> + <revision> <revnumber>1-1.5</revnumber> <date>Thu Jul 29 2010</date> <author> Modified: epp/docs/branches/5.1/Reference_Guide/en-US/modules/Advanced/JCR/as_managed_datasources.xml =================================================================== --- epp/docs/branches/5.1/Reference_Guide/en-US/modules/Advanced/JCR/as_managed_datasources.xml 2011-08-11 04:41:47 UTC (rev 7044) +++ epp/docs/branches/5.1/Reference_Guide/en-US/modules/Advanced/JCR/as_managed_datasources.xml 2011-08-11 04:52:38 UTC (rev 7045) @@ -9,7 +9,7 @@ The EAP Admin and Config Guide URL: http://docs/docs/en-US/JBoss_Enterprise_Application_Platform/5/html-singl... -Author: ECS +Author: Misty Stanley-Jones (RH; ECS) License: CC-BY-SA The eXo Platoform Reference Guide @@ -122,8 +122,7 @@ <term>&lt;depends&gt;</term> <listitem> <para> - The <literal>ObjectName</literal> of an MBean service this <classname>ConnectionFactory</classname> - or<classname>DataSource</classname> deployment depends upon. The connection manager service will not be started until the dependent services have been started. + The <literal>ObjectName</literal> of an MBean service this <classname>ConnectionFactory</classname> or <classname>DataSource</classname> deployment depends upon. The connection manager service will not be started until the dependent services have been started. </para> </listitem> </varlistentry> @@ -176,19 +175,19 @@ <itemizedlist> <title>Possible values for &lt;transaction-isolation&gt;</title> <listitem> - <para>TRANSACTION_READ_UNCOMMITTED</para> + <para><parameter>TRANSACTION_READ_UNCOMMITTED</parameter></para> </listitem> <listitem> - <para>TRANSACTION_READ_COMMITTED</para> + <para><parameter>TRANSACTION_READ_COMMITTED</parameter></para> </listitem> <listitem> - <para>TRANSACTION_REPEATABLE_READ</para> + <para><parameter>TRANSACTION_REPEATABLE_READ</parameter></para> </listitem> <listitem> - <para>TRANSACTION_SERIALIZABLE</para> + <para><parameter>TRANSACTION_SERIALIZABLE</parameter></para> </listitem> <listitem> - <para>TRANSACTION_NONE</para> + <para><parameter>TRANSACTION_NONE</parameter></para> </listitem> </itemizedlist> </listitem> @@ -229,7 +228,7 @@ <term>&lt;track-statements&gt;</term> <listitem> <para> - Whether to monitor for unclosed Statements and ResultSets and issue warnings when they haven&apos;t been closed. The default value is <literal>NOWARN</literal>. + Whether to monitor for unclosed Statements and ResultSets and issue warnings when they have not been closed. The default value is <literal>NOWARN</literal>. </para> </listitem> </varlistentry> @@ -245,10 +244,10 @@ <term>&lt;share-prepared-statements&gt;</term> <listitem> <para> - When the &lt;prepared-statement-cache-size&gt; is non-zero, determines whether two requests in the same transaction should return the same statement. Defaults to <literal>FALSE</literal>. + When the <parameter>&lt;prepared-statement-cache-size&gt;</parameter> is non-zero, determines whether two requests in the same transaction should return the same statement. Defaults to <literal>FALSE</literal>. </para> <example> - <title>Using &lt;share-prepared-statements&gt;</title> + <title>Using <parameter>&lt;share-prepared-statements&gt;</parameter></title> <para> The goal is to work around questionable driver behavior, where the driver applies auto-commit semantics to local transactions. </para> @@ -277,15 +276,15 @@ <term>&lt;query-timeout&gt;</term> <listitem> <para> - The maximum time, in seconds, before a query times out. You can override this value by setting &lt;set-tx-query-timeout&gt; to <literal>TRUE</literal>. + The maximum time, in seconds, before a query times out. You can override this value by setting <parameter>&lt;set-tx-query-timeout&gt;</parameter> to <literal>TRUE</literal>. </para> </listitem> </varlistentry> <varlistentry> - <term>&lt;metadata&gt;&gt;&lt;type-mapping&gt;</term> + <term>&lt;type-mapping&gt;</term> <listitem> <para> - A pointer to the type mapping in <filename>conf/standardjbosscmp.xml</filename>. A legacy from JBoss4. + A pointer to the type mapping in <filename>conf/standardjbosscmp.xml</filename>. This element is a child element of <parameter>&lt;metadata&gt;</parameter>. A legacy from JBoss4. </para> </listitem> </varlistentry> @@ -293,7 +292,7 @@ <term>&lt;validate-on-match&gt;</term> <listitem> <para> - Whether to validate the connection when the JCA layer matches a managed connection, such as when the connection is checked out of the pool. With the addition of &lt;background-validation&gt; this is not required. It is usually not necessary to specify <literal>TRUE</literal> for &lt;validate-on-match&gt; in conjunction with specifying <literal>TRUE</literal> for &lt;background-validation&gt;. Defaults to <literal>TRUE</literal>. + Whether to validate the connection when the JCA layer matches a managed connection, such as when the connection is checked out of the pool. With the addition of <parameter>&lt;background-validation&gt;</parameter> this is not required. It is usually not necessary to specify <literal>TRUE</literal> for <parameter>&lt;validate-on-match&gt;</parameter> in conjunction with specifying <literal>TRUE</literal> for <parameter>&lt;background-validation&gt;</parameter>. Defaults to <literal>TRUE</literal>. </para> </listitem> </varlistentry> @@ -309,7 +308,7 @@ <term>&lt;background-validation&gt;</term> <listitem> <para> - Background connection validation reduces the overall load on the RDBMS system when validating a connection. When using this feature, EAP checks whether the current connection in the pool a separate thread (ConnectionValidator). &lt;background-validation-minutes&gt; depends on this value also being set to <literal>TRUE</literal>. Defaults to <literal>FALSE</literal>. + Background connection validation reduces the overall load on the RDBMS system when validating a connection. When using this feature, EAP checks whether the current connection in the pool a separate thread (ConnectionValidator). <parameter>&lt;background-validation-minutes&gt;</parameter> depends on this value also being set to <literal>TRUE</literal>. Defaults to <literal>FALSE</literal>. </para> </listitem> </varlistentry> @@ -317,12 +316,10 @@ <term>&lt;background-validation-millis&gt;</term> <listitem> <para> - Background connection validation reduces the overall load on the RDBMS system when validating a - connection. Setting this parameter means that JBoss will attempt to validate the current connections in - the pool as a separate thread (<classname>ConnectionValidator</classname>). This parameter&apos;s value - defines the interval, in milliseconds, for which the <classname>ConnectionValidator</classname> will - run. (This value should not be the same as your <literal><![CDATA[<idle-timeout-minutes]]></literal> - value.) + Background connection validation reduces the overall load on the RDBMS system when validating a connection. Setting this parameter means that JBoss will attempt to validate the current connections in the pool as a separate thread (<classname>ConnectionValidator</classname>). This parameter&apos;s value defines the interval, in milliseconds, for which the <classname>ConnectionValidator</classname> will run. + </para> + <para> + This value should not be the same as your <literal>&lt;idle-timeout-minutes&gt;</literal> value. </para> </listitem> @@ -362,7 +359,7 @@ </para> <note> <para> - You should set this to a smallervalue than &lt;idle-timeout-minutes&gt;, unless you have specified &lt;min-pool-size&gt; a minimum pool size set. + You should set this to a smallervalue than <parameter>&lt;idle-timeout-minutes&gt;</parameter>, unless you have specified <parameter>&lt;min-pool-size&gt;</parameter> a minimum pool size set. </para> </note> </listitem> @@ -371,7 +368,7 @@ <term>&lt;url-delimiter&gt;, &lt;url-property&gt;, &lt;url-selector-strategy-class-name&gt;</term> <listitem> <para> - Parameters dealing with database failover. As of JBoss Enterprise Application Platform 5.1, these are configured as part of the main datasource configuration. In previous versions, &lt;url-delimiter&gt; appeared as &lt;url-delimeter&gt;. + Parameters dealing with database failover. As of JBoss Enterprise Application Platform 5.1, these are configured as part of the main datasource configuration. In previous versions, <parameter>&lt;url-delimiter&gt;</parameter> appeared as <parameter>&lt;url-delimeter&gt;</parameter>. </para> </listitem> </varlistentry> @@ -395,7 +392,7 @@ <term>&lt;min-pool-size&gt;</term> <listitem> <para> - The minimum number of connections maintained in the pool. Unless &lt;prefill&gt; is <literal>TRUE</literal>, the pool remains empty until the first use, at which point the pool is filled to the &lt;min-pool-size&gt;. When the pool size drops below the &lt;min-pool-size&gt; due to idle timeouts, the pool is refilled to the &lt;min-pool-size&gt;. Defaults to <literal>0</literal>. + The minimum number of connections maintained in the pool. Unless <parameter>&lt;prefill&gt;</parameter> is <literal>TRUE</literal>, the pool remains empty until the first use, at which point the pool is filled to the <parameter>&lt;min-pool-size&gt;</parameter>. When the pool size drops below the <parameter>&lt;min-pool-size&gt;</parameter> due to idle timeouts, the pool is refilled to the <parameter>&lt;min-pool-size&gt;</parameter>. Defaults to <literal>0</literal>. </para> </listitem> </varlistentry> @@ -444,7 +441,7 @@ Used to configure the connections retrieved from the <classname>java.sql.Driver</classname>. </para> <example> - <title>Example &lt;connection-property&gt;</title> + <title>Example <parameter>&lt;connection-property&gt;</parameter></title> <programlisting language="XML" role="XML"> &lt;connection-property name=&quot;char.encoding&quot;&gt;UTF-8&lt;/connection-property&gt; </programlisting> @@ -469,7 +466,7 @@ Properties used to configure the <classname>XADataSource</classname>. </para> <example> - <title>Example &lt;xa-datasource-property&gt; Declarations</title> + <title>Example <parameter>&lt;xa-datasource-property&gt; Declarations</parameter></title> <programlisting language="XML" role="XML">&lt;xa-datasource-property name=&quot;IfxWAITTIME&quot;&gt;10&lt;/xa-datasource-property&gt; &lt;xa-datasource-property name=&quot;IfxIFXHOST&quot;&gt;myhost.mydomain.com&lt;/xa-datasource-property&gt; &lt;xa-datasource-property name=&quot;PortNumber&quot;&gt;1557&lt;/xa-datasource-property&gt; @@ -517,9 +514,7 @@ <variablelist> <title>Security Parameters</title> <varlistentry> - <term> - <literal><![CDATA[<application-managed-security>]]></literal> - </term> + <term>&lt;application-managed-security&gt;</term> <listitem> <para> Uses the username and password passed on the <methodname>getConnection</methodname> or @@ -528,9 +523,7 @@ </listitem> </varlistentry> <varlistentry> - <term> - <literal><![CDATA[<security-domain>]]></literal> - </term> + <term>&lt;security-domain&gt;</term> <listitem> <para> Uses the identified login module configured in <filename>conf/login-module.xml</filename>. @@ -538,9 +531,7 @@ </listitem> </varlistentry> <varlistentry> - <term> - <literal><![CDATA[<security-domain-and-application>]]></literal> - </term> + <term>&lt;security-domain-and-application&gt;</term> <listitem> <para> Uses the identified login module configured in <filename>conf/login-module.xml</filename> and other @@ -590,7 +581,7 @@ </variablelist> <para> The fields in <xref linkend="xa-recovery-parameters" /> should have a fall back value of their non-recover - counterparts: &lt;user-name&gt;,&lt; password&gt; and &lt;security-domain&gt;. + counterparts: <parameter>&lt;user-name&gt;</parameter>, <parameter>&lt; password&gt;</parameter> and <parameter>&lt;security-domain&gt;</parameter>. </para> </section> <section> @@ -619,7 +610,7 @@ </para> <note> <para> - Use of the &lt;use-java-context&gt; setting is not recommended in a production environment. It requires accessing a + Use of the <parameter>&lt;use-java-context&gt;</parameter> setting is not recommended in a production environment. It requires accessing a connection pool remotely and this can cause unexpected problems, since connections are not serializable. Also, transaction propagation is not supported, since it can lead to connection leaks if unreliability is present, such as in a system crash or network failure. A remote session bean facade is the preferred way to access a datasource @@ -632,7 +623,7 @@ <procedure> <title>Configuring a Datasource to Use Login Modules</title> <step> - <title>Add the &lt;security-domain-parameter&gt; to the XML file for the datasource.</title> + <title>Add the <parameter>&lt;security-domain-parameter&gt;</parameter> to the XML file for the datasource.</title> <programlisting language="XML" role="XML"> &lt;datasources&gt; &lt;local-tx-datasource&gt; Modified: epp/docs/branches/5.1/Reference_Guide/en-US/modules/AuthenticationAndIdentity/LDAP.xml =================================================================== --- epp/docs/branches/5.1/Reference_Guide/en-US/modules/AuthenticationAndIdentity/LDAP.xml 2011-08-11 04:41:47 UTC (rev 7044) +++ epp/docs/branches/5.1/Reference_Guide/en-US/modules/AuthenticationAndIdentity/LDAP.xml 2011-08-11 04:52:38 UTC (rev 7045) @@ -13,7 +13,7 @@ </para> </note> <para> - <emphasis role="bold">LDAP</emphasis> (Lightweight Directory Access Protocol) is a set of open protocols used to access centrally stored information over a network. It is based on the X.500 standard for directory sharing, but is less complex and resource-intensive + <emphasis role="bold">LDAP</emphasis> (Lightweight Directory Access Protocol) is a set of open protocols used to access centrally stored information over a network. It is based on the X.500 standard for directory sharing, but is less complex and resource-intensive. </para> <para> Using a client/server architecture, LDAP provides a reliable means to create a central information directory accessible from the network. When a client attempts to modify information within this directory, the server verifies the user has permission to make the change, and then adds or updates the entry as requested. To ensure the communication is secure, the Secure Sockets Layer (<emphasis>SSL</emphasis>) or Transport Layer Security (<emphasis>TLS</emphasis>) cryptographic protocols can be used to prevent an attacker from intercepting the transmission. @@ -285,8 +285,10 @@ </step> <step> <para> - Comment out the default Picketlink <literal>config</literal> value: <parameter>war:/conf/organization/picketlink-idm/picketlink-idm-config.xml</parameter> + Comment out the default Picketlink <literal>config</literal> value: </para> +<programlisting language="XML" role="XML"><![CDATA[<value>war:/conf/organization/picketlink-idm/picketlink-idm-config.xml</value> +]]></programlisting> </step> <step> <para> @@ -325,7 +327,8 @@ <para> Uncomment the <parameter>groupTypeMappings</parameter> under "<emphasis>Uncomment for ACME LDAP example</emphasis>": </para> -<programlisting language="XML" role="XML"><![CDATA[<entry> +<programlisting language="XML" role="XML"><![CDATA[<!-- Uncomment for ACME LDAP example --> +<entry> <key><string>/acme/roles/*</string></key> <value><string>acme_roles_type</string></value> </entry> @@ -359,7 +362,8 @@ <para> Uncomment the <parameter>groupTypeMappings</parameter> under "<emphasis>Uncomment for MSAD ReadOnly LDAP example</emphasis>": </para> -<programlisting language="XML" role="XML"><![CDATA[<entry> +<programlisting language="XML" role="XML"><![CDATA[<!-- Uncomment for MSAD ReadOnly LDAP example --> +<entry> <key><string>/acme/roles/*</string></key> <value><string>msad_roles_type</string></value> </entry> @@ -394,7 +398,8 @@ <para> Uncomment the <parameter>groupTypeMappings</parameter> under "<emphasis>Uncomment for ACME LDAP example</emphasis>": </para> -<programlisting language="XML" role="XML"><![CDATA[<entry> +<programlisting language="XML" role="XML"><![CDATA[<!-- Uncomment for ACME LDAP example --> +<entry> <key><string>/acme/roles/*</string></key> <value><string>acme_roles_type</string></value> </entry> Modified: epp/docs/branches/5.1/Reference_Guide/en-US/modules/AuthenticationAndIdentity/SSO.xml =================================================================== --- epp/docs/branches/5.1/Reference_Guide/en-US/modules/AuthenticationAndIdentity/SSO.xml 2011-08-11 04:41:47 UTC (rev 7044) +++ epp/docs/branches/5.1/Reference_Guide/en-US/modules/AuthenticationAndIdentity/SSO.xml 2011-08-11 04:52:38 UTC (rev 7045) @@ -61,7 +61,7 @@ </section> <section> - <title><remark>Enabling SSO using JBoss SSO valve</remark></title> + <title><remark>Enabling SSO using JBoss SSO Valve</remark></title> <!-- Source Metadata URL: https://issues.jboss.org/browse/JBQA-4530 Author [w/email]: Marek Posolda (mposolda(a)redhat.com) @@ -73,40 +73,22 @@ Author [w/email]: Marek Posolda (mposolda(a)redhat.com) --> <para> + The JBoss SSO valve is useful to authenticate a user on one JBoss Enterprise Portal Platform node in a cluster and have that authentication automatically carry across to other nodes in the cluster. + </para> + <para> + This authentication can also be used in any other web applications which may require authentication, <emphasis role="bold">provided that these applications use same roles as the main portal instance</emphasis>. Attempting to use an SSO authentication in an application that uses different roles may create authentication errors (<emphasis role="bold">403</emphasis> errors, for example). + </para> + + <para> + More info about the JBoss SSO valve can be found at <ulink type="http" url="http://docs.redhat.com/docs/en-US/JBoss_Enterprise_Web_Platform...;. + </para> + <para> To successfully implement SSO integration, do the following: </para> <procedure> <title>SSO Integration</title> <step> <para> - Open the <filename><replaceable>&lt;JBOSS_HOME&gt;</replaceable>/server/<replaceable>&lt;PROFILE&gt;</replaceable>/deploy/jmx-console.war/WEB-INF/web.xml</filename> file and ensure the following lines are present and unaltered: - </para> - -<programlisting language="XML" role="XML"><![CDATA[<security-constraint> - <web-resource-collection> - <web-resource-name>HtmlAdaptor</web-resource-name> - <description>An example security config that only allows users with the - role JBossAdmin to access the HTML JMX console web application - </description> - <url-pattern>/*</url-pattern> - </web-resource-collection> - <auth-constraint> - <role-name>JBossAdmin</role-name> - </auth-constraint> -</security-constraint> - -<login-config> - <auth-method>BASIC</auth-method> - <realm-name>JBoss JMX Console</realm-name> -</login-config> - -<security-role> - <role-name>JBossAdmin</role-name> -</security-role> -]]></programlisting> - </step> - <step> - <para> Open the <filename>/<replaceable>&lt;JBOSS_HOME&gt;</replaceable>/server/<replaceable>&lt;PROFILE&gt;</replaceable>/deploy/jbossweb.sar/server.xml</filename> file and uncomment one of the two <parameter>Valve</parameter> entries: </para> <itemizedlist> @@ -201,6 +183,187 @@ </itemizedlist> </step> </procedure> + <formalpara> + <title>Testing the SSO Valve</title> + <para> + Once the JBoss SSO Valve has been enabled, it can be tested with the following steps: + </para> + </formalpara> + <procedure> + <title>Testing the SSO Vavle</title> + <step> + <para> + Copy the <replaceable>&lt;PROFILE&gt;</replaceable> you enabled the valve in (<literal>default</literal>, for example) into two new profiles called <literal>node1</literal> and <literal>node2</literal>. + </para> + </step> + <step> + <para> + Run an instance of JBoss Enterprise Portal Platform using the <literal>node1</literal> profile on a local machine: + </para> +<programlisting>./run.sh -c node1 -Djboss.service.binding.set=ports-default -Dexo.profiles=cluster -Djboss.messaging.ServerPeerID=0 &amp; +</programlisting> + </step> + <step> + <para> + Start another instance using the <literal>node2</literal> profile: + </para> +<programlisting>./run.sh -c node2 -Djboss.service.binding.set=ports-01 -Dexo.profiles=cluster -Djboss.messaging.ServerPeerID=1 &amp; +</programlisting> + </step> + <step> + <para> + Navigate to <ulink type="http" url="http://localhost:8080/portal/private/classic"></ulink> and authenticate with the pre-configured user account "<systemitem>root</systemitem>" (password "<systemitem>gtn</systemitem>"). + </para> + </step> + <step> + <para> + Navigate to <ulink type="http" url="http://localhost:8180/portal/private/classic"></ulink>. You should be automatically authenticated as user <systemitem>root</systemitem> on this node as well. + </para> + </step> + </procedure> + <formalpara> + <title>Enabling SSO in a physical cluster</title> + <para> + If you require SSO to work across a physical cluster of separate machines you will need to use the <parameter>cookieDomain</parameter> attribute of the SSO valve. + </para> + </formalpara> + <procedure> + <step> + <para> + Open the <filename><replaceable>&lt;JBOSS_HOME&gt;</replaceable>/server/<replaceable>&lt;PROFILE&gt;</replaceable>/deploy/jbossweb.sar/server.xml</filename> file. + </para> + </step> + <step> + <para> + Uncomment the line: + </para> +<programlisting language="XML" role="XML"><![CDATA[<!-- +<Valve className="org.jboss.web.tomcat.service.sso.ClusteredSingleSignOn" /> +--> +]]></programlisting> + </step> + <step> + <para> + And edit it to match the following: + </para> +<programlisting language="XML" role="XML"><![CDATA[<Valve className="org.jboss.web.tomcat.service.sso.ClusteredSingleSignOn" cookieDomain="yourdomain.com" /> +]]></programlisting> + <para> + (Where <literal>yourdomain.com</literal> is the domain used in your cluster. For example; <ulink type="http" url="http://machine1.yourdomain.com:8080/portal/private/classic"></ulink> and <ulink type="http" url="http://machine2.yourdomain.com:8080/portal/private/classic"></ulink>) + </para> + </step> + <step> + <para> + Repeat the process in the other nodes in the cluster. + </para> + </step> + </procedure> + + <para> + This will ensure the <literal>JSESSIONIDSSO</literal> cookie is be used in the correct domain, allowing the SSO authentication to occur. + </para> + <formalpara> + <title>Enabling SSO with Other Web Applications</title> + <para> + As mentioned earlier, in order to use SSO authentication between JBoss Enterprise Portal Platform instances and other web applications, the roles defined in the web application must match those used in the portal instance. + </para> + </formalpara> + <para> + As an example, to use the SSO Valve to authenticate a user in both a portal instance and the JMX Console, the following actions would be required: + </para> + <procedure> + <title></title> + <step> + <para> + Open the <filename><replaceable>&lt;JBOSS_HOME&gt;</replaceable>/server/<replaceable>&lt;PROFILE&gt;</replaceable>/deploy/jmx-console.war/WEB-INF/web.xml</filename> file and edit it as follows: + </para> + <substeps> + <step> + <para> + Change the <parameter>&lt;role-name&gt;</parameter> entry in the <parameter>&lt;auth-constraint&gt;</parameter> element (line <literal>110</literal>) from <literal>JBossAdmin</literal> to <literal>users</literal>: + </para> +<programlisting language="XML" role="XML"><![CDATA[<auth-constraint> + <!--<role-name>JBossAdmin</role-name>--> + <role-name>users</role-name> +</auth-constraint>]]></programlisting> + </step> + <step> + <para> + Change the <parameter>&lt;role-name&gt;</parameter> entry in the <parameter>&lt;security-role&gt;</parameter> element (line <literal>120</literal>) from <literal>JBossAdmin</literal> to <literal>users</literal> + </para> +<programlisting language="XML" role="XML"><![CDATA[<security-role> + <!--<role-name>JBossAdmin</role-name>--> + <role-name>users</role-name> +</security-role>]]></programlisting> + </step> + </substeps> + </step> + </procedure> + <formalpara> + <title>Testing SSO With Other Web Applications</title> + <para> + To test that SSO authentication is enabled from portal instances to other web applications (in this case, the JMX Console), do the following: + </para> + </formalpara> + <procedure> + <title>Test SSO Between Portal and JMX Console</title> + <step> + <para> + Start a portal instance on one node: + </para> +<programlisting>./run.sh -c node1 -Djboss.service.binding.set=ports-default -Dexo.profiles=cluster -Djboss.messaging.ServerPeerID=0 &amp; +</programlisting> + </step> + <step> + <para> + Navigate to <ulink type="http" url="http://localhost:8080/portal/private/classic"></ulink> and authenticate with the pre-configured user account "<systemitem>root</systemitem>" (password "<systemitem>gtn</systemitem>"). + </para> + </step> + <step> + <para> + Navigate to <ulink type="http" url="http://localhost:8080/jmx-console"></ulink>. You should be automatically authenticated into the JMX Console. + </para> + </step> + </procedure> + <formalpara> + <title>Using SSO to Authenticate From the Public Page</title> + <para> + The previous configuration changes in this section are useful if a user is using a private URL (<ulink type="http" url="http://localhost:8080/portal/private/classic"></ulink>, for example) to log in to the portal instance. + </para> + </formalpara> + <para> + Further changes are needed however, if SSO authentication is required to work with the <guilabel>Sign In</guilabel> button on the front page of the portal (<ulink type="http" url="http://localhost:8080/portal/public/classic"></ulink>). + </para> + <para> + To enable this functionality, the <guilabel>Sign In</guilabel> link must redirect to the <filename>login.jsp</filename> file edited earlier to call the JAAS authentication directly. + </para> + <procedure> + <title>Redirect to Use SSO Valve Authentication</title> + <step> + <para> + Open the <filename><replaceable>&lt;JBOSS_HOME&gt;</replaceable>/server/<replaceable>&lt;PROFILE&gt;</replaceable>/deploy/gatein.ear/web.war/groovy/groovy/webui/component/UIBannerPortlet.gtml</filename> file and edit the line: + </para> +<programlisting language="Java" role="java"><![CDATA[<a class="Login" onclick="$signInAction"><%=_ctx.appRes("UILoginForm.label.Signin")%></a> +]]></programlisting> + <para> + To read: + </para> +<programlisting language="Java" role="java"><![CDATA[<a class="Login" href="/portal/private/classic"><%=_ctx.appRes("UILoginForm.label.Signin")%></a> +]]></programlisting> + </step> + <step> + <para> + Open the <filename><replaceable>&lt;JBOSS_HOME&gt;</replaceable>/server/<replaceable>&lt;PROFILE&gt;</replaceable>/deploy/gatein.ear/web.war/groovy/portal/webui/component/UILogoPortlet.gtmpl</filename> file and change the line: + </para> +<programlisting language="Java" role="java"><![CDATA[<a onclick="$signInAction"><%=_ctx.appRes("UILogoPortlet.action.signin")%></a> +]]></programlisting> + <para> + To read: + </para> +<programlisting language="Java" role="java"><![CDATA[<a href="/portal/private/classic"><%=_ctx.appRes("UILogoPortlet.action.signin")%></a> +]]></programlisting> + </step> + </procedure> </section> <section id="sect-Reference_Guide-SSO_Single_Sign_On-CAS_Central_Authentication_Service"> @@ -357,14 +520,14 @@ <title>Redirect to CAS</title> <step> <para> - Modify the '<emphasis role="bold">Sign In</emphasis>' link in the <filename>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>&lt;JBOSS_HOME&gt;</replaceable>/server/<replaceable>&lt;PROFILE&gt;</replaceable>/deploy/gatein.ear/web.war/groovy/groovy/webui/component/UIBannerPortlet.gtml</filename> file as follows: </para> <programlisting language="XML" role="XML"><xi:include href="../../extras/Authentication_Identity_SSO/default106.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></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: + Modify the '<emphasis role="bold">Sign In</emphasis>' link in the <filename><replaceable>&lt;JBOSS_HOME&gt;</replaceable>/server/<replaceable>&lt;PROFILE&gt;</replaceable>/deploy/gatein.ear/web.war/groovy/portal/webui/component/UILogoPortlet.gtmpl</filename> file as follows: </para> <programlisting language="XML" role="XML"><xi:include href="../../extras/Authentication_Identity_SSO/default107.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> @@ -523,7 +686,7 @@ <title>Setup the portal to redirect to JOSSO</title> <step> <para> - In the <filename>gatein.ear/web.war/groovy/groovy/webui/component/UIBannerPortlet.gtml</filename> file modify the 'Sign In' link as follows: + In the <filename><replaceable>&lt;JBOSS_HOME&gt;</replaceable>/server/<replaceable>&lt;PROFILE&gt;</replaceable>/deploy/gatein.ear/web.war/groovy/groovy/webui/component/UIBannerPortlet.gtml</filename> file modify the 'Sign In' link as follows: </para> <programlisting language="XML" role="XML"><xi:include href="../../extras/Authentication_Identity_SSO/default112.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> @@ -823,7 +986,7 @@ <title>Setup the portal to redirect to OpenSSO</title> <step> <para> - Modify the '<emphasis role="bold">Sign In</emphasis>' link in the <filename>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>&lt;JBOSS_HOME&gt;</replaceable>/server/<replaceable>&lt;PROFILE&gt;</replaceable>/deploy/gatein.ear/web.war/groovy/groovy/webui/component/UIBannerPortlet.gtml</filename> file as follows: </para> <programlisting language="XML" role="XML"><xi:include href="../../extras/Authentication_Identity_SSO/default119.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> Modified: epp/docs/branches/5.1/Reference_Guide/en-US/modules/AuthenticationAndIdentity.xml =================================================================== --- epp/docs/branches/5.1/Reference_Guide/en-US/modules/AuthenticationAndIdentity.xml 2011-08-11 04:41:47 UTC (rev 7044) +++ epp/docs/branches/5.1/Reference_Guide/en-US/modules/AuthenticationAndIdentity.xml 2011-08-11 04:52:38 UTC (rev 7045) @@ -56,7 +56,7 @@ Start (or restart) your JBoss Enterprise Portal Platform. </para> <para> - Any passwords written to the JCR will now be encoded and not plain-text. + Any passwords written to the JCR will now be encoded and not plain text. </para> </step> </procedure> Modified: epp/docs/branches/5.1/Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalNavigationConfiguration.xml =================================================================== --- epp/docs/branches/5.1/Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalNavigationConfiguration.xml 2011-08-11 04:41:47 UTC (rev 7044) +++ epp/docs/branches/5.1/Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalNavigationConfiguration.xml 2011-08-11 04:52:38 UTC (rev 7045) @@ -4,170 +4,263 @@ %BOOK_ENTITIES; ]> <chapter id="chap-Reference_Guide-Portal_Navigation_Configuration"> - <title>Portal Navigation Configuration</title> - <section id="sect-Reference_Guide-Portal_Navigation_Configuration-Overview"> - <title>Overview</title> - <para> - There are three types of navigation available to portal users: - </para> - <itemizedlist> - <listitem> - <para> - <xref linkend="sect-Reference_Guide-Portal_Navigation_Configuration-Portal_Navigation" /> - </para> - </listitem> - <listitem> - <para> - <xref linkend="sect-Reference_Guide-Portal_Navigation_Configuration-Group_Navigation" /> - </para> - </listitem> - <listitem> - <para> - <xref linkend="sect-Reference_Guide-Portal_Navigation_Configuration-User_Navigation" /> - </para> - </listitem> - </itemizedlist> - <para> - These navigations are configured using XML syntax in the file; &#34;<filename>02portal.war:/WEB-INF/conf/portal/portal-configuration.xml</filename>&#34;. - </para> - + <title><remark>Portal Navigation Configuration</remark></title> + <section id="sect-Reference_Guide-Portal_Navigation_Configuration-Overview"> + <title>Overview</title> + <para> + There are three types of navigation available to portal users: + </para> + <itemizedlist> + <listitem> + <para> + <xref linkend="sect-Reference_Guide-Portal_Navigation_Configuration-Portal_Navigation" /> + </para> + </listitem> + <listitem> + <para> + <xref linkend="sect-Reference_Guide-Portal_Navigation_Configuration-Group_Navigation" /> + </para> + </listitem> + <listitem> + <para> + <xref linkend="sect-Reference_Guide-Portal_Navigation_Configuration-User_Navigation" /> + </para> + </listitem> + </itemizedlist> + <para> + These navigations are configured using the standard XML syntax in the file; &#34;<filename>02portal.war:/WEB-INF/conf/portal/portal-configuration.xml</filename>&#34;. + </para> + <programlisting language="XML" role="XML"><xi:include href="../../extras/PortalDevelopment_DefaultPortalNavigationConfiguration/default144.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> - <para> - This XML configuration defines where in the portal's <literal>WAR</literal> to look for configuration settings, and which portals, groups, and user specific views to include in portal/group/user navigation. - </para> - <para> - The first time the portal is launched those files will be used to create an initial navigation. That information will then be stored in the JCR content repository and can be modified and managed from the portal UI. - </para> - </section> + <para> + This XML configuration defines where in the portal's <literal>WAR</literal> to look for configuration settings, and which portals, groups, and user specific views to include in portal/group/user navigation. + </para> + <para> + The first time the portal is launched those files will be used to create an initial navigation. That information will then be stored in the JCR content repository and can be modified and managed from the portal UI. + </para> + <remark>Added based on Gatein revision 6987:</remark> + <para> +Each portal, groups and users navigation is indicated by a configuration paragraph, for example: + </para> +<programlistingco> + <areaspec> + <area coords="5" id="area-Reference_Guide.Portalconf.predifinedOwner" /> + <area coords="10" id="area-Reference_Guide.Portalconf.ownerType" /> + <area coords="13" id="area-Reference_Guide.Portalconf.templateLocation" /> + <area coords="16" id="area-Reference_Guide.Portalconf.importMode" /> + </areaspec> +<programlisting language="XML" role="XML"><![CDATA[<object-param> + <name>portal.configuration</name> + <description>description</description> + <object type="org.exoplatform.portal.config.NewPortalConfig"> + <field name="predefinedOwner"> + <collection type="java.util.HashSet"> + <value><string>classic</string></value> + </collection> + </field> + <field name="ownerType"> + <string>portal</string> + </field> + <field name="templateLocation"> + <string>war:/conf/portal/</string> + </field> + <field name="importMode"> + <string>conserve</string> + </field> + </object> +</object-param>]]> +</programlisting> +</programlistingco> - - <section id="sect-Reference_Guide-Portal_Navigation_Configuration-Portal_Navigation"> - <title>Portal Navigation</title> - <para> - The portal navigation incorporates the pages that can be accessed even when a user is not logged in (assuming the applicable permissions allow public access). For example; several portal navigations could be used when a company has multiple trademarks, and websites are set up for each of them. - </para> - <para> - The <emphasis>Classic</emphasis> portal is configured by three XML files in the <filename>02portal.war:/WEB-INF/conf/portal/portal/classic</filename> directory: - </para> - <variablelist> - <varlistentry> - <term>portal.xml</term> - <listitem> - <para> - This file describes the layout and portlets that will be shown on all pages. Usually the layout contains the banner, footer, menu and breadcrumbs portlets. JBoss Enterprise Portal Platform is extremely configurable as every view element (even the banner and footer) is a portlet. - </para> - +<calloutlist> + <callout arearefs="area-Reference_Guide.Portalconf.predifinedOwner"> + <para> + <emphasis>predefinedOwner</emphasis> define the navigation owner, portal will look for the configuration files in folder with this name, if there is no suitable folder, a default portal will be created with name is this value. + </para> + </callout> + <callout arearefs="area-Reference_Guide.Portalconf.ownerType"> + <para> + <emphasis> ownerType</emphasis> define the type of portal navigation. It may be a portal, group or user + </para> + </callout> + <callout arearefs="area-Reference_Guide.Portalconf.templateLocation"> + <para> + <emphasis> templateLocation</emphasis> the classpath where contains all portal configuration files + </para> + </callout> + <callout arearefs="area-Reference_Guide.Portalconf.importMode"> + <para> + <emphasis> importMode</emphasis> The mode for navigation import. There are 4 types of import mode: + </para> + <itemizedlist> + <listitem> + <para> + <emphasis>conserve</emphasis>: Import data when it does not exist, otherwise do nothing. + </para> + </listitem> + <listitem> + <para> + <emphasis>insert</emphasis>: Import data when it does not exist, otherwise performs a strategy that adds new data only. + </para> + </listitem> + <listitem> + <para> + <emphasis>merge</emphasis>: Import data when it does not exist, update data when it exists. + </para> + </listitem> + <listitem> + <para> + <emphasis>rewrite</emphasis>: Overwrite data whatsoever. + </para> + </listitem> + </itemizedlist> + </callout> +</calloutlist> + + <para> +Base on these parameters, portal will look for the configuration files and create a relevant portal navigation, pages and data import strategy. The portal configuration files will be stored in folders with path look like <literal>{templateLocation}/{ownerType}/{predefinedOwner}</literal>, all navigations are defined in the <literal>navigation.xml</literal> file, pages are defined in pages.xml and portal configuration is defined in <literal>{ownerType}.xml</literal>. +For example, with the above configuration, portal will look for all configuration files from <literal>war:/conf/portal/portal/classic path.</literal> + </para> + </section> + + <section id="sect-Reference_Guide-Portal_Navigation_Configuration-Portal_Navigation"> + <title><remark>Portal Navigation</remark></title> + <!-- Updated based on Gatein revision 6987 --> + <para> + The portal navigation incorporates the pages that can be accessed even when a user is not logged in (assuming the applicable permissions allow public access). For example; several portal navigations could be used when a company has multiple trademarks, and websites are set up for each of them. + </para> + <para> + The <emphasis>Classic</emphasis> portal is configured by three XML files in the <filename>02portal.war:/WEB-INF/conf/portal/portal/classic</filename> directory: + </para> + <variablelist> + <varlistentry> + <term>portal.xml</term> + <listitem> + <para> + This file describes the layout and portlets that will be shown on all pages. Usually the layout contains the banner, footer, menu and breadcrumbs portlets. JBoss Enterprise Portal Platform is extremely configurable as every view element (even the banner and footer) is a portlet. + </para> + <programlisting language="XML" role="XML"><xi:include href="../../extras/PortalDevelopment_DefaultPortalNavigationConfiguration/portal.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> - <para> - It is also possible to apply a nested container that can also contain portlets. Row, column or tab containers are then responsible for the layout of their child portlets. - </para> - <para> - Each application references a portlet using its application name (usually the name of the WAR file) -and a portlet reference (the name of the portlet as defined in portlet.xml). - </para> - <para> - Use the <literal>page-body</literal> tag to define where JBoss Enterprise Portal Platform should render the current page. - </para> - <para> - The defined <emphasis>classic</emphasis> portal is accessible to &#34;Everyone&#34; (at <literal>/portal/public/classic</literal>) but only members of the group <literal>/platform/administrators</literal> can edit it. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>navigation.xml</term> - <listitem> - <para> - This file defines all the navigation nodes the portal will have. The syntax is simple and uses nested node tags. Each node references a page defined in <filename>pages.xml</filename> file. - </para> - <para> - When the <literal>#{...}</literal> syntax is used in a <literal>&#60;label&#62;</literal> element, the enclosed property name serves as a key that is automatically passed to internationalization mechanism which replaces the literal property name with a localized value taken from the associated properties file matching the current locale. - </para> - <!-- DOC NOTE: Replaced code navigation.xml with code from GateIn commit r3831 (as per instruction from theute) --> + <para> + It is also possible to apply a nested container that can also contain portlets. Row, column or tab containers are then responsible for the layout of their child portlets. + </para> + <remark>Updated based on Gatein revision 6987:</remark> + <para> + Each application references a portlet using the id <literal>portal#{portalName}:/{portletWarName}/{portletName}/{uniqueId}</literal>. + </para> + <para> + Use the <literal>page-body</literal> tag to define where JBoss Enterprise Portal Platform should render the current page. + </para> + <para> + The defined <emphasis>classic</emphasis> portal is accessible to &#34;Everyone&#34; (at <literal>/portal/public/classic</literal>) but only members of the group <literal>/platform/administrators</literal> can edit it. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>navigation.xml</term> + <listitem> + <para> + This file defines all the navigation nodes the portal will have. The syntax is simple and uses nested node tags. Each node references a page defined in <filename>pages.xml</filename> file. + </para> + <remark>Updated based on Gatein revision 6987:</remark> + <para> + If the administrator wants to create node labels for each language, they will have to use <literal>xml:lang</literal> attribute in the label tag with value of <literal>xml:lang</literal> is the relevant locale. + </para> + <para> + Otherwise, if they want the node label is localized by resource bundle files, the <literal>#{...}</literal> syntax will be used, the enclosed property name serves as a key that is automatically passed to internationalization mechanism which replaces the literal property name with a localized value taken from the associated properties file matching the current locale. + </para> + <!-- DOC NOTE: Replaced code navigation.xml with code from GateIn commit r3831 (as per instruction from theute) --> <programlisting language="XML" role="XML"><xi:include href="../../extras/PortalDevelopment_DefaultPortalNavigationConfiguration/navigation.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> - <para> - This navigation tree can have multiple views inside portlets (such as the breadcrumbs portlet) that render the current view node, the site map or the menu portlets. - </para> - <warning> - <para> - For top nodes, the <emphasis role="bold">uri</emphasis> and the <emphasis role="bold">name</emphasis> of your navigation nodes must have the <emphasis>same</emphasis> value. For other nodes the <emphasis role="bold">uri</emphasis> is a relative path. - </para> - <para> - For example; <emphasis><uri>contentmanagement/fileexplorer</uri></emphasis> where '<literal>contentmanagement</literal> ' is the name of the parent node and '<literal>fileexplorer</literal>' is the name of the node ( <emphasis>&#60;name&#62;fileexplorer&#60;/name&#62; </emphasis> ). - </para> - </warning> - </listitem> - </varlistentry> - <varlistentry> - <term>Subnodes</term> - <listitem> - <para> - Subnodes can also be created using the following XML structure - </para> - <programlistingco> - <areaspec> - <area coords="9 40" id="area-Reference_Guide-Portal_Navigation_Configuration-Portal_Navigation-subpage" /> - </areaspec> - + <para> + This navigation tree can have multiple views inside portlets (such as the breadcrumbs portlet) that render the current view node, the site map or the menu portlets. + </para> + <warning> + <para> + For top nodes, the <emphasis role="bold">uri</emphasis> and the <emphasis role="bold">name</emphasis> of your navigation nodes must have the <emphasis>same</emphasis> value. For other nodes the <emphasis role="bold">uri</emphasis> is a relative path. + </para> + <para> + For example; <emphasis><uri>contentmanagement/fileexplorer</uri></emphasis> where '<literal>contentmanagement</literal> ' is the name of the parent node and '<literal>fileexplorer</literal>' is the name of the node ( <emphasis>&#60;name&#62;fileexplorer&#60;/name&#62; </emphasis> ). + </para> + </warning> + </listitem> + </varlistentry> + <varlistentry> + <term>Subnodes</term> + <listitem> + <para> + Subnodes can also be created using the following XML structure + </para> + <programlistingco> + <areaspec> + <area coords="9 40" id="area-Reference_Guide-Portal_Navigation_Configuration-Portal_Navigation-subpage" /> + </areaspec> + <programlisting language="XML" role="XML"><xi:include href="../../extras/PortalDevelopment_DefaultPortalNavigationConfiguration/subpage.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> - <calloutlist> - <callout arearefs="area-Reference_Guide-Portal_Navigation_Configuration-Portal_Navigation-subpage"> - <para> - This element defines the parent/child relationship between a page and a subnode. - </para> - </callout> - </calloutlist> - </programlistingco> - </listitem> - </varlistentry> - <varlistentry> - <term>pages.xml</term> - <listitem> - <para> + <calloutlist> + <callout arearefs="area-Reference_Guide-Portal_Navigation_Configuration-Portal_Navigation-subpage"> + <para> + This element defines the parent/child relationship between a page and a subnode. + </para> + </callout> + </calloutlist> + </programlistingco> + </listitem> + </varlistentry> + <varlistentry> + <term>pages.xml</term> + <listitem> + <para> This configuration file structure is very similar to <filename>portal.xml</filename> and it can also contain container tags (some usage examples of container tags can be found in <filename>02portal.war/WEB-INF/conf/portal/portal/sharedlayout.xml</filename>). </para> <para> Each application can decide whether to render the portlet border, the window state, the icons or portlet's mode. - </para> + </para> <!-- DOC NOTE: look into including some actual examples of 'container tags' from sharedlayout.xml in place here. --> <programlisting language="XML" role="XML"><xi:include href="../../extras/PortalDevelopment_DefaultPortalNavigationConfiguration/pages.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> - </listitem> - </varlistentry> - </variablelist> - </section> + </listitem> + </varlistentry> + </variablelist> + </section> - - <section id="sect-Reference_Guide-Portal_Navigation_Configuration-Group_Navigation"> - <title>Group Navigation</title> - <para> - Group navigations are dynamically added to the user navigation at login. This allows users to see the pages assigned to any groups they belong to in the menu. - </para> - <para> - The group navigation menu is configured by two XML files (<filename>navigation.xml</filename> and <filename>pages.xml</filename>). The syntax used in these files is the same as those covered in <xref linkend="sect-Reference_Guide-Portal_Navigation_Configuration-Portal_Navigation" />. - </para> - <para> - They are located in <filename>02portal.war/WEB-INF/conf/portal/group<replaceable>/group-name-path/</replaceable></filename> directory (For example; <filename>02portal.war/WEB-INF/conf/portal/group/platform/administrators/</filename>). - </para> - </section> + + <section id="sect-Reference_Guide-Portal_Navigation_Configuration-Group_Navigation"> + <title>Group Navigation</title> + <para> + Group navigations are dynamically added to the user navigation at login. This allows users to see the pages assigned to any groups they belong to in the menu. + </para> + <para> + The group navigation menu is configured by two XML files (<filename>navigation.xml</filename> and <filename>pages.xml</filename>). The syntax used in these files is the same as those covered in <xref linkend="sect-Reference_Guide-Portal_Navigation_Configuration-Portal_Navigation" />. + </para> + <para> + They are located in <filename>02portal.war/WEB-INF/conf/portal/group<replaceable>/group-name-path/</replaceable></filename> directory (For example; <filename>02portal.war/WEB-INF/conf/portal/group/platform/administrators/</filename>). + </para> + </section> - - <section id="sect-Reference_Guide-Portal_Navigation_Configuration-User_Navigation"> - <title>User Navigation</title> - <para> - User navigation is the set of nodes and pages that are owned by a user. They are part of the user's dashboard. - </para> - <para> - Two files configure the user navigation (<filename>navigation.xml</filename> and <filename>pages.xml</filename>). They are located in the directory &#34;<filename>02portal.war/WEB-INF/conf/portal/users/{userName}</filename>&#34;. - </para> - <para> - The file <filename>eXoGadgets.war/WEB-INF/gadget.xml</filename> defines the gadgets that will be available on a user dashboard. - </para> - <para> - The example below shows a dashboard with all of the default gadgets included, as well as an extra currency converter gadget sourced from <ulink type="http" url="http://www.google.com/ig/directory?synd=open">Google Gadgets</ulink>. - </para> - + + <section id="sect-Reference_Guide-Portal_Navigation_Configuration-User_Navigation"> + <title><remark>User Navigation</remark></title> + <para> + User navigation is the set of nodes and pages that are owned by a user. They are part of the user's dashboard. + </para> + <remark>This Paragraph:</remark> + <para> + Two files configure the user navigation (<filename>navigation.xml</filename> and <filename>pages.xml</filename>). They are located in the directory &#34;<filename>02portal.war/WEB-INF/conf/portal/users/{userName}</filename>&#34;. + </para> + <remark>Became this paragraph in GateIn r6987</remark> + <para> + Three files configure the user navigation (<filename>navigation.xml</filename>, <filename>pages.xml</filename> and <filename>portlet-preferences.xml</filename>). They are located in the <filename>{templateLocation}/{ownerType}/{predefinedOwner}</filename> directory with <literal>ownerType</literal> is <literal>user</literal> and <literal>predefinedOwner</literal> is username that want to create the navigation. For example, if administrator want to create navigation for user <literal>root</literal>, he has to locate the configuration files in <filename>portal.war/WEB-INF/conf/portal/user/root </filename> + </para> + <remark>Which is appropriate for EPP 5.1.1?</remark> + <para> + The file <filename>eXoGadgets.war/WEB-INF/gadget.xml</filename> defines the gadgets that will be available on a user dashboard. + </para> + <para> + The example below shows a dashboard with all of the default gadgets included, as well as an extra currency converter gadget sourced from <ulink type="http" url="http://www.google.com/ig/directory?synd=open">Google Gadgets</ulink>. + </para> + <programlisting language="XML" role="XML"><xi:include href="../../extras/PortalDevelopment_DefaultPortalNavigationConfiguration/gadgets.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> - </section> + </section> </chapter> Modified: epp/docs/branches/5.1/Reference_Guide/en-US/modules/WSRP.xml =================================================================== --- epp/docs/branches/5.1/Reference_Guide/en-US/modules/WSRP.xml 2011-08-11 04:41:47 UTC (rev 7044) +++ epp/docs/branches/5.1/Reference_Guide/en-US/modules/WSRP.xml 2011-08-11 04:52:38 UTC (rev 7045) @@ -1313,10 +1313,10 @@ <section id="sect-Reference_Guide-Web_Services_for_Remote_Portlets_WSRP-Removing_WSRP"> <title><remark>Removing WSRP</remark></title> <para> - If you are not going to use WSRP in your JBoss Enterprise Portal Platform instance, your installation will not be adversely affected should you leave the WSRP files in place. + If you are not going to use WSRP in your JBoss Enterprise Portal Platform instance, the WSRP configuration files may be left in place. They will not adversely affect your installation. </para> <para> - However, if you wish to completely remove WSRP from your JBoss Enterprise Portal Platform installation, follow this procedure: + However, if you wish to completely remove WSRP from your portal installation, follow this procedure: </para> <procedure> <title></title> @@ -1430,11 +1430,6 @@ Save and exit the file. </para> </step> - <step> - <para> - Remove all the <emphasis role="bold">WSRP</emphasis> SHA1 entries in the <filename>MANIFEST.MF</filename> file. They are not required. - </para> - </step> </substeps> </step> <step> Modified: epp/docs/branches/5.1/Reference_Guide/publican.cfg =================================================================== --- epp/docs/branches/5.1/Reference_Guide/publican.cfg 2011-08-11 04:41:47 UTC (rev 7044) +++ epp/docs/branches/5.1/Reference_Guide/publican.cfg 2011-08-11 04:52:38 UTC (rev 7045) @@ -5,7 +5,7 @@ type: Book brand: JBoss debug:1 -show_remarks: 1 +#show_remarks: 1 cvs_branch: DOCS-RHEL-6 cvs_root: :ext:cvs.devel.redhat.com:/cvs/dist cvs_pkg: JBoss_Enterprise_Portal_Platform-Reference_Guide-5.1-web-__LANG__ \ No newline at end of file