[gatein-commits] gatein SVN: r9093 - in epp/docs/branches/6.0/Reference_Guide/en-US: modules and 2 other directories.
do-not-reply at jboss.org
do-not-reply at jboss.org
Mon Jan 28 23:31:05 EST 2013
Author: jaredmorgs
Date: 2013-01-28 23:31:05 -0500 (Mon, 28 Jan 2013)
New Revision: 9093
Modified:
epp/docs/branches/6.0/Reference_Guide/en-US/Preface.xml
epp/docs/branches/6.0/Reference_Guide/en-US/Reference_Guide.xml
epp/docs/branches/6.0/Reference_Guide/en-US/Revision_History.xml
epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/BackendConfiguration.xml
epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/SSO.xml
epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalConfiguration.xml
epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/InternationalizationConfiguration.xml
epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/LocalizationConfiguration.xml
epp/docs/branches/6.0/Reference_Guide/en-US/modules/ServerIntegration.xml
epp/docs/branches/6.0/Reference_Guide/en-US/modules/WSRP.xml
Log:
Incorporated feedback for BZ#903884, and Changed all references to to JPP_HOME, and added this file path abbreviation to sect-File_Name_Conventions
Modified: epp/docs/branches/6.0/Reference_Guide/en-US/Preface.xml
===================================================================
--- epp/docs/branches/6.0/Reference_Guide/en-US/Preface.xml 2013-01-28 22:04:59 UTC (rev 9092)
+++ epp/docs/branches/6.0/Reference_Guide/en-US/Preface.xml 2013-01-29 04:31:05 UTC (rev 9093)
@@ -16,11 +16,11 @@
</term>
<listitem>
<para>
- The installation root of the Central Authentication Service (CAS) single sign-on framework. This directory is an arbitrary location chosen when CAS is downloaded and installed.
- </para>
- <para>
- This convention is mainly used in <xref linkend="sect-SSO_Single_Sign_On_-Central_Authentication_Service" />.
- </para>
+ The installation root of the Central Authentication Service (CAS) single sign-on framework. This directory is an arbitrary location chosen when CAS is downloaded and installed.
+ </para>
+ <para>
+ This convention is mainly used in <xref linkend="sect-SSO_Single_Sign_On_-Central_Authentication_Service"/>.
+ </para>
</listitem>
</varlistentry>
<varlistentry>
@@ -29,11 +29,11 @@
</term>
<listitem>
<para>
- The <filename>JPP_SERVER/gatein/gatein.ear/portal.war/WEB-INF/conf/organization/</filename> directory, which contains identity-related configuration resources.
- </para>
- <para>
- This convention is mainly used in <xref linkend="chap-LDAP_Integration" />.
- </para>
+ The <filename>JPP_SERVER/gatein/gatein.ear/portal.war/WEB-INF/conf/organization/</filename> directory, which contains identity-related configuration resources.
+ </para>
+ <para>
+ This convention is mainly used in <xref linkend="chap-LDAP_Integration"/>.
+ </para>
</listitem>
</varlistentry>
<varlistentry>
@@ -42,21 +42,34 @@
</term>
<listitem>
<para>
- The installation root of the JBoss Portal Platform instance. For example, if the JBoss Portal Platform distribution archive is extracted to the <filename>/opt/jboss/JPP/</filename> directory, the <replaceable>JPP_DIST</replaceable> directory is <filename>/opt/jboss/JPP</filename>.
- </para>
+ The installation root of the JBoss Portal Platform instance. For example, if the JBoss Portal Platform distribution archive is extracted to the <filename>/opt/jboss/JPP/</filename> directory, the <replaceable>JPP_DIST</replaceable> directory is <filename>/opt/jboss/JPP</filename>.
+ </para>
<para>
- This directory contains the <filename>jboss-jpp-<replaceable><VERSION></replaceable></filename>, <filename>gatein-management</filename> and <filename>gatein-sso</filename> directories.
- </para>
+ This directory contains the <filename>jboss-jpp-&VY;</filename>, <filename>gatein-management</filename> and <filename>gatein-sso</filename> directories.
+ </para>
</listitem>
</varlistentry>
<varlistentry>
<term>
+ <replaceable>JPP_HOME</replaceable>
+ </term>
+ <listitem>
+ <para>
+ The server root of the JBoss Portal Platform instance. For example, if the JBoss Portal Platform distribution archive is extracted to the <filename>/opt/jboss/JPP/</filename> directory, the <replaceable>JPP_DIST</replaceable> directory is <filename>/opt/jboss/JPP/jboss-jpp-&VY;/</filename>.
+ </para>
+ <para>
+ This directory contains the <filename>gatein</filename>, <filename>modules</filename> and <filename>standalone</filename> directories.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
<replaceable>JPP_SERVER</replaceable>
</term>
<listitem>
<para>
- The <filename>JPP_DIST/jboss-jpp-<replaceable><VERSION></replaceable></filename> directory, which contains the application server and the configuration files necessary to run JBoss Portal Platform.
- </para>
+ The <filename>JPP_DIST/jboss-jpp-<replaceable><VERSION></replaceable></filename> directory, which contains the application server and the configuration files necessary to run JBoss Portal Platform.
+ </para>
</listitem>
</varlistentry>
<varlistentry>
@@ -65,11 +78,11 @@
</term>
<listitem>
<para>
- The installation root of the Apache Tomcat server. Apache Tomcat is a simple Java-based web server that can host servlets or JSP applications. It is not a part of JBoss Portal Platform, however, it is used in various examples in this guide to host single sign-on authentication services.
- </para>
- <para>
- This convention is mainly used in <xref linkend="sect-Reference_Guide-SSO_Single_Sign_On"/>.
- </para>
+ The installation root of the Apache Tomcat server. Apache Tomcat is a simple Java-based web server that can host servlets or JSP applications. It is not a part of JBoss Portal Platform, however, it is used in various examples in this guide to host single sign-on authentication services.
+ </para>
+ <para>
+ This convention is mainly used in <xref linkend="sect-Reference_Guide-SSO_Single_Sign_On"/>.
+ </para>
</listitem>
</varlistentry>
</variablelist>
Modified: epp/docs/branches/6.0/Reference_Guide/en-US/Reference_Guide.xml
===================================================================
--- epp/docs/branches/6.0/Reference_Guide/en-US/Reference_Guide.xml 2013-01-28 22:04:59 UTC (rev 9092)
+++ epp/docs/branches/6.0/Reference_Guide/en-US/Reference_Guide.xml 2013-01-29 04:31:05 UTC (rev 9093)
@@ -7,6 +7,7 @@
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Book_Info.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Preface.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="modules/Introduction.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="modules/ServerIntegration.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="modules/PortalDevelopment.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="modules/PortletDevelopment.xml"/>
<part>
Modified: epp/docs/branches/6.0/Reference_Guide/en-US/Revision_History.xml
===================================================================
--- epp/docs/branches/6.0/Reference_Guide/en-US/Revision_History.xml 2013-01-28 22:04:59 UTC (rev 9092)
+++ epp/docs/branches/6.0/Reference_Guide/en-US/Revision_History.xml 2013-01-29 04:31:05 UTC (rev 9093)
@@ -8,6 +8,21 @@
<simpara>
<revhistory>
<revision>
+ <revnumber>6.0.0-41</revnumber>
+ <date>Tue Jan 27 2013</date>
+ <author>
+ <firstname>Jared</firstname>
+ <surname>Morgan</surname>
+ <email/>
+ </author>
+ <revdescription>
+ <simplelist>
+ <member>Incorporated feedback for BZ#903884 "Default Portal Configuration".</member>
+ <member>Changed all references to $JBOSS_HOME to JPP_HOME, and added this file path abbreviation to <xref linkend="sect-File_Name_Conventions"/>.</member>
+ </simplelist>
+ </revdescription>
+ </revision>
+ <revision>
<revnumber>6.0.0-40</revnumber>
<date>Mon Jan 26 2013</date>
<author>
Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/BackendConfiguration.xml
===================================================================
--- epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/BackendConfiguration.xml 2013-01-28 22:04:59 UTC (rev 9092)
+++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/BackendConfiguration.xml 2013-01-29 04:31:05 UTC (rev 9093)
@@ -5,7 +5,7 @@
]>
<chapter id="sect-Reference_Guide-PicketLink_IDM_integration">
<title>PicketLink IDM integration</title>
-<remark> Source https://docs.jboss.org/author/display/GTNPORTAL35/PicketLink+IDM+integration</remark>
+ <remark> Source https://docs.jboss.org/author/display/GTNPORTAL35/PicketLink+IDM+integration</remark>
<para>
JBoss Portal Platform uses the <literal>PicketLink IDM</literal> component to store necessary identity information about users, groups and memberships. While legacy interfaces are still used (<literal>org.exoplatform.services.organization</literal>) for identity management, there is a wrapper implementation that delegates to PicketLink IDM framework.
</para>
@@ -394,7 +394,7 @@
<title>Configuration files</title>
<para>
The main configuration file is
- <code>JBOSS_HOME/gatein/gatein.ear/portal.war/WEB-INF/conf/organization/idm-configuration.xml</code>
+ <code>JPP_HOME/gatein/gatein.ear/portal.war/WEB-INF/conf/organization/idm-configuration.xml</code>
:
</para>
<informalexample>
Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/SSO.xml
===================================================================
--- epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/SSO.xml 2013-01-28 22:04:59 UTC (rev 9092)
+++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/SSO.xml 2013-01-29 04:31:05 UTC (rev 9093)
@@ -66,6 +66,7 @@
</para>
<section id="sect-CAS-Authentication_Process">
<title>Authentication Process</title>
+ <remark>Source: https://docs.jboss.org/author/display/GTNPORTAL35/Central+Authentication+Service+(CAS)#CentralAuthenticationService%28CAS%29-Loginworkflow</remark>
<para>
The authentication process with CAS integration occurs in the following order:
</para>
@@ -129,6 +130,7 @@
</section>
<section id="sect-CAS-Logout_Workflow">
<title>Logout Process</title>
+ <remark>Source: https://docs.jboss.org/author/display/GTNPORTAL35/Central+Authentication+Service+(CAS)#CentralAuthenticationService%28CAS%29-Logoutworkflow</remark>
<para>
The logout process with CAS integration occurs in the following order:
</para>
@@ -165,6 +167,7 @@
</section>
<section id="sect-CAS-Configuration_Overview">
<title>CAS Configuration Overview</title>
+ <remark>Source: https://docs.jboss.org/author/display/GTNPORTAL35/Central+Authentication+Service+(CAS)#CentralAuthenticationService%28CAS%29-CASserver</remark>
<para>
For scope purposes, the setup instructions assume the following configuration outcomes:
</para>
@@ -197,10 +200,10 @@
</itemizedlist>
<section id="sect-CAS-Download_CAS">
<title><remark>BZ#856430 </remark>Download CAS</title>
+ <remark>Source: https://docs.jboss.org/author/display/GTNPORTAL35/Central+Authentication+Service+(CAS)#CentralAuthenticationService%28CAS%29-ObtainingCAS</remark>
<para>
CAS can be downloaded from <ulink url="http://www.jasig.org/cas/download"/> . The supported version is <emphasis role="italics">CAS 3.5</emphasis> . More recent CAS versions may also work, however have not been officially tested as part of this specific configuration exercise.
</para>
- <remark>Docs Note - jmorgan - Marek, I originally incorrectly specified that an admin should extract the CAS source binary into the Tomcat server. It's my fault, because I didn't realise that you need to configure CAS first, *then* build the WAR, and finally deploy to Tomcat. The following sentence makes this much clearer now.</remark>
<para>
Extract the downloaded file into a suitable working directory. This location will be referred to as <code>CAS_DIR</code> in subsequent configuration instructions.
</para>
@@ -208,11 +211,13 @@
</section>
<section id="sect-CAS-Modifying_CAS_Server">
<title>Modifying the CAS server</title>
+ <remark>Source: https://docs.jboss.org/author/display/GTNPORTAL35/Central+Authentication+Service+(CAS)#CentralAuthenticationService%28CAS%29-ModifyingtheCASserver</remark>
<para>
To configure the CAS server correctly, the most effective way is to make the necessary changes directly in the CAS code base. Follow the instructions in the sections below to make the required changes to the CAS code base, before using Maven to build the CAS web archive.
</para>
<section id="sect-CAS_Authentication_Plug-in">
<title>Authentication Plug-in</title>
+ <remark>Source: https://docs.jboss.org/author/display/GTNPORTAL35/Central+Authentication+Service+(CAS)#CentralAuthenticationService%28CAS%29-Authenticationpluginsetup</remark>
<para>
While it is possible (and perfectly acceptable) for an administrator to configure CAS to retrieve user credentials from an external database, or from a LDAP server, it is also possible to use JBoss technology.
</para>
@@ -265,6 +270,7 @@
</section>
<section id="sect-CAS_Logout_Redirection">
<title>Logout redirection setup</title>
+ <remark>Source: https://docs.jboss.org/author/display/GTNPORTAL35/Central+Authentication+Service+(CAS)#CentralAuthenticationService%28CAS%29-Logoutredirectionsetup</remark>
<para>
The CAS server displays the CAS logout page with a link to return to the portal by default. To make the CAS server redirect to the portal page after a logout, modify <code>CAS_DIR/cas-server-webapp/src/main/webapp/</code> <code>WEB-INF/cas-servlet.xml</code> to include the <code>followServiceRedirects="true"</code> parameter:
</para>
@@ -278,6 +284,7 @@
</section>
<section id="sect-CAS_SSO_Cookie_Configuration">
<title>CAS SSO cookie configuration (CASTGC)</title>
+ <remark>Source: https://docs.jboss.org/author/display/GTNPORTAL35/Central+Authentication+Service+(CAS)#CentralAuthenticationService%28CAS%29-CASSSOcookieconfiguration</remark>
<para>
Jasic CAS uses a cookie named
<firstterm> CAS Ticket Granting Cookie </firstterm>
@@ -331,6 +338,7 @@
</section>
<section id="sect-CAS-Install_Tomcat_Server">
<title>Install Apache Tomcat Server</title>
+ <remark>Source: https://docs.jboss.org/author/display/GTNPORTAL35/Central+Authentication+Service+(CAS)#CentralAuthenticationService%28CAS%29-SSOserversetup</remark>
<para>
Install and configure Apache Tomcat 7, which provides the host server for the CAS server.
</para>
@@ -369,6 +377,7 @@
</section>
<section id="sect-CAS-Modifying_the_Portal">
<title>Modifying the Portal</title>
+ <remark>Source: https://docs.jboss.org/author/display/GTNPORTAL35/Central+Authentication+Service+(CAS)#CentralAuthenticationService%28CAS%29-Setuptheportal</remark>
<para>
Before building and deploying the Jasig CAS sever, configuration needs to be implemented on the JBoss Portal Platform server to prepare the portal for CAS integration.
</para>
@@ -386,6 +395,7 @@
</section>
<section id="sect-CAS_Configuring_the_Platform">
<title>Portal configuration.properties for CAS SSO</title>
+ <remark>Source: https://docs.jboss.org/author/display/GTNPORTAL35/Central+Authentication+Service+(CAS)#CentralAuthenticationService%28CAS%29-Setuptheportal</remark>
<para>
To prepare the portal platform for CAS authentication, SSO filters and login modules need to be specified in global configuration files. The location of the CAS server, as configured in a locally-running Apache Tomcat server, also needs to be specified.
</para>
@@ -414,6 +424,7 @@
</programlisting>
</step>
</procedure>
+ <remark>Source: https://docs.jboss.org/author/display/GTNPORTAL35/Central+Authentication+Service+(CAS)#CentralAuthenticationService%28CAS%29-Configurationpropertiesdetails</remark>
<variablelist>
<varlistentry>
<term>gatein.sso.enabled</term>
@@ -680,7 +691,7 @@
<procedure>
<step>
<para>
- Some of the configuration properties in <filename>JBOSS_HOME/standalone/configuration/gatein/configuration.properties</filename> need to be set on the client server.
+ Some of the configuration properties in <filename>JPP_HOME/standalone/configuration/gatein/configuration.properties</filename> need to be set on the client server.
</para>
<para>
Locate the <literal>#SSO</literal> section of the file and edit it to match the sample below:
@@ -727,7 +738,7 @@
</listitem>
<listitem>
<para>
- The <code>gatein.sso.josso.agent.config.file</code> property points to the location of the Agent configuration file, which is relative to classpath. Therefore the agent file location is actually located at <filename>JBOSS_HOME/gatein/gatein.ear/portal.war/WEB-INF/classes/sso/josso/1.8/josso-agent-config.xml</filename>.
+ The <code>gatein.sso.josso.agent.config.file</code> property points to the location of the Agent configuration file, which is relative to classpath. Therefore the agent file location is actually located at <filename>JPP_HOME/gatein/gatein.ear/portal.war/WEB-INF/classes/sso/josso/1.8/josso-agent-config.xml</filename>.
</para>
<para>
In the majority of cases, nothing in this file will need to be configured beyond the defaults.
@@ -742,12 +753,12 @@
<substeps>
<step>
<para>
- Delete the <filename>JBOSS_HOME/modules/org/gatein/sso</filename> directory.
+ Delete the <filename>JPP_HOME/modules/org/gatein/sso</filename> directory.
</para>
</step>
<step>
<para>
- Copy the <filename>SSO_HOME/josso/gatein-josso-<replaceable><version></replaceable>/modules/org/gatein/sso</filename> directory into <filename>JBOSS_HOME/modules/org/gatein/</filename>.
+ Copy the <filename>SSO_HOME/josso/gatein-josso-<replaceable><version></replaceable>/modules/org/gatein/sso</filename> directory into <filename>JPP_HOME/modules/org/gatein/</filename>.
</para>
</step>
</substeps>
@@ -922,7 +933,7 @@
<procedure>
<step>
<para>
- Assuming again that you have JBoss Portal Platform running on JBoss Enterprise Application Platform 6, you need to change some of the properties in the SSO sections of <filename>JBOSS_HOME/standalone/configuration/gatein/configuration.properties</filename> to match those below:
+ Assuming again that you have JBoss Portal Platform running on JBoss Enterprise Application Platform 6, you need to change some of the properties in the SSO sections of <filename>JPP_HOME/standalone/configuration/gatein/configuration.properties</filename> to match those below:
</para>
<informalexample>
<programlisting>
@@ -947,7 +958,7 @@
</programlisting>
</informalexample>
<para>
- Note that <code>gatein.sso.filter.logout.url</code> is empty now as the logout URL will be obtained from the JOSSO agent configuration set in file <filename>JBOSS_HOME/gatein/gatein.ear/portal.war/WEB-INF/classes/sso/josso/2.2/josso-agent-config.xml</filename>.
+ Note that <code>gatein.sso.filter.logout.url</code> is empty now as the logout URL will be obtained from the JOSSO agent configuration set in file <filename>JPP_HOME/gatein/gatein.ear/portal.war/WEB-INF/classes/sso/josso/2.2/josso-agent-config.xml</filename>.
</para>
</step>
<step>
@@ -957,12 +968,12 @@
<substeps>
<step>
<para>
- Delete the <filename>JBOSS_HOME/modules/org/gatein/sso</filename> directory.
+ Delete the <filename>JPP_HOME/modules/org/gatein/sso</filename> directory.
</para>
</step>
<step>
<para>
- Copy the <filename>SSO_HOME/josso/gatein-josso-182/modules/org/gatein/sso</filename> into <filename>JBOSS_HOME/modules/org/gatein/</filename> directory.
+ Copy the <filename>SSO_HOME/josso/gatein-josso-182/modules/org/gatein/sso</filename> into <filename>JPP_HOME/modules/org/gatein/</filename> directory.
</para>
</step>
</substeps>
@@ -1002,7 +1013,7 @@
</step>
<step>
<para>
- Copy the JAR files for the appropriate JOSSO version from <filename>GATEIN_SSO_HOME/josso/gatein-josso-<replaceable><version></replaceable>/modules/org/gatein/sso/main into JBOSS_HOME/lib/</filename>.
+ Copy the JAR files for the appropriate JOSSO version from <filename>GATEIN_SSO_HOME/josso/gatein-josso-<replaceable><version></replaceable>/modules/org/gatein/sso/main into JPP_HOME/lib/</filename>.
</para>
<para>
Use <replaceable>gatein-josso-181</replaceable> if you are on JOSSO 1.8.1 or older or <replaceable>gatein-josso-182</replaceable> if you are on JOSSO 1.8.2 or newer or on JOSSO 2.2.
@@ -1453,7 +1464,7 @@
# Thie only time when you might need to uncomment these lines and change
# the enctypes is if you have local software that will break on ticket
# caches containing ticket encryption types it doesn't know about (such as
-# old versions of Sun Java).
+# old versions of Oracle).
default_tgs_enctypes = rc4-hmac
default_tkt_enctypes = rc4-hmac
Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalConfiguration.xml
===================================================================
--- epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalConfiguration.xml 2013-01-28 22:04:59 UTC (rev 9092)
+++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalConfiguration.xml 2013-01-29 04:31:05 UTC (rev 9093)
@@ -31,7 +31,7 @@
Notice that the <literal>NewPortalConfigListener</literal> <parameter>component-plugin</parameter> is used to add configuration to <literal>UserPortalConfigService</literal>, which is designed in this way to allow other components to add configuration to it.
</para>
<para>
- <emphasis>Components</emphasis>, <emphasis>component-plugins</emphasis>, and <emphasis>init-params</emphasis> are explained in a later chapter of this document.
+ <emphasis>Components</emphasis>, <emphasis>component-plugins</emphasis>, and <emphasis>init-params</emphasis> are explained in <xref linkend="chap-Reference_Guide-Foundations"/>.
</para>
</section>
<section>
@@ -83,44 +83,44 @@
</section>
<section>
<title>Set the Info Bar Behavior</title>
- <para>You can set the info bar shown by default for portlets of a portal by adding a <property> to the <portal-config> configuration of the <filename>JPP_HOME/gatein/gatein.ear/portal.war/WEB-INF/conf/portal/portal/classic/portal.xml</filename> file.</para>
+ <para>You can set the info bar shown by default for portlets of a portal by adding an <entry> directive to the <properties> configuration of the <filename>JPP_HOME/gatein/gatein.ear/portal.war/WEB-INF/conf/portal/portal/classic/portal.xml</filename> file.</para>
<programlisting language="XML"><properties>
<entry key="showPortletInfo">1</entry>
</properties></programlisting>
<para>There are two values for "showPortletInfo": 0 and 1. If the value is 1, the info bar of portlets is shown by default. If the value is 0, it is hidden.</para>
+ <remark>Disabling a Portal Container (BZ#794416) commented out due to issues with content. Comments from BZ#903884 added to the affected BZ, and linking done in BZ.</remark>
</section>
- <section id="sect-Reference_Guide-Default_Portal_Configuration-Disabling_a_Portal">
-<!--
+<!--Disabling a Portal Container
This content is mirrored in the JPP 5.2 Reference Guide.
Any changes here should be reflected there as well.
- --> <title><remark>BZ#794416</remark>Disabling a Portal</title>
- <para>
- Once you have created a custom portal that suits your needs, you may wish to disable a portal that is no longer required.
+ --><!--<section id="sect-Reference_Guide-Default_Portal_Configuration-Disabling_a_Portal_Container">
+ <title><remark>BZ#794416</remark>Disabling a Portal Container</title>
+ <para>
+ Once you have created a custom portal container that suits your needs, you may wish to disable a portal container that is no longer required.
</para>
- <task>
- <title>Task: Disable a portal in JBoss Portal Platform 5</title>
- <tasksummary>
- <para>
- The procedure below will show you how to disable an unused portal in a JBoss Portal Platform instance.
+ <task>
+ <title>Task: Disable a portal in JBoss Portal Platform 5</title>
+ <tasksummary>
+ <para>Disable an unused portal container in a JBoss Portal Platform instance.
</para>
- </tasksummary>
- <taskprerequisites>
- <title>Prerequisites: </title>
- <itemizedlist>
- <listitem>
- <para>
- <remark>Are there any pre-reqs for this task?</remark>
+ </tasksummary>
+ <taskprerequisites>
+ <title>Prerequisites: </title>
+ <itemizedlist>
+ <listitem>
+ <para>
+A new portal container is created,
</para>
- </listitem>
- </itemizedlist>
- </taskprerequisites>
- <procedure>
- <title/>
- <step>
- <para>
- Add the following configuration to the <filename>configuration.xml</filename> of the custom extension in order to disable a portal:
+ </listitem>
+ </itemizedlist>
+ </taskprerequisites>
+ <procedure>
+ <title/>
+ <step>
+ <para>
+ Add the following configuration to the <filename>configuration.xml</filename> of the custom extension in order to disable a portal container:
</para>
- <programlisting language="XML" role="XML"><![CDATA[<?xml version="1.0" encoding="UTF-8"?>
+ <programlisting language="XML" role="XML"><![CDATA[<?xml version="1.0" encoding="UTF-8"?>
<configuration xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.exoplaform.org/xml/ns/kernel_1_0.xsd http://www.exoplaform.org/xml/ns/kernel_1_1.xsd"
xmlns="http://www.exoplaform.org/xml/ns/kernel_1_1.xsd">
@@ -151,16 +151,18 @@
</external-component-plugins>
</configuration>
]]></programlisting>
- </step>
- </procedure>
- <taskrelated>
- <note>
- <title/>
- <para>
+ </step>
+ <step>
+ <para>The portal name declared in the <values-param> directive will no longer be available at http://{hostname}:{port}/portal</para>
+ </step>
+ </procedure>
+ <taskrelated>
+ <note>
+ <title/>
+ <para>
Disabling the default <emphasis>portal</emphasis> container is possible as well, but some functions, such as WSRP, or Services Management, depend on the default portal container to be deployed, and will no longer work if this is disabled.
</para>
- </note>
- </taskrelated>
- </task>
- </section>
-</chapter>
+ </note>
+ </taskrelated>
+ </task>
+</section>--></chapter>
Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/InternationalizationConfiguration.xml
===================================================================
--- epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/InternationalizationConfiguration.xml 2013-01-28 22:04:59 UTC (rev 9092)
+++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/InternationalizationConfiguration.xml 2013-01-29 04:31:05 UTC (rev 9093)
@@ -4,8 +4,8 @@
%BOOK_ENTITIES;
]>
<chapter id="chap-Reference_Guide-Internationalization_Configuration">
- <title>Internationalization Configuration</title>
- <remark>Source docs are located at https://docs.jboss.org/author/display/GTNPORTAL35/Internationalization+Configuration</remark>
+ <title><remark>BZ#896760 </remark>Internationalization Configuration</title>
+ <remark>Source: https://docs.jboss.org/author/display/GTNPORTAL35/Internationalization+Configuration</remark>
<section id="sect-Reference_Guide-Internationalization_Configuration-Overview">
<title>Overview</title>
<note>
@@ -13,8 +13,7 @@
<para>
JBoss Portal Platform is fully configurable for internationalization, however users should have a general knowledge of Internationalization in Java products before attempting these configurations.
</para>
- <para>
- Sun Java hosts a comprehensive guide to internationalizing Java products at <ulink url="http://java.sun.com/docs/books/tutorial/i18n/TOC.html"/>.
+ <para>Oracle hosts a comprehensive guide to internationalizing Java products at <ulink url="http://docs.oracle.com/javase/tutorial/i18n/TOC.html"/>.
</para>
</note>
<para>
@@ -55,6 +54,7 @@
</section>
<section id="sect-Reference_Guide-Internationalization_Configuration-Locales_Configuration">
<title>Locales Configuration</title>
+ <remark>Source: https://docs.jboss.org/author/display/GTNPORTAL35/Internationalization+Configuration</remark>
<para>
Various languages are available in the portal package. The configuration below will define which languages are shown in the "<emphasis role="bold">Change Language</emphasis>" section and made available to users.
</para>
@@ -90,6 +90,7 @@
</section>
<section id="sect-Reference_Guide-Internationalization_Configuration-ResourceBundleService">
<title>ResourceBundleService</title>
+ <remark>Source: https://docs.jboss.org/author/display/GTNPORTAL35/Internationalization+Configuration</remark>
<para>
The resource bundle service is configured in: <filename>portal.war:/WEB-INF/conf/common/common-configuration.xml</filename>:
</para>
@@ -107,6 +108,7 @@
</section>
<section id="sect-Reference_Guide-Internationalization_Configuration-Navigation_Resource_Bundles">
<title>Navigation Resource Bundles</title>
+ <remark>Source: https://docs.jboss.org/author/display/GTNPORTAL35/Internationalization+Configuration</remark>
<para>
There is a resource bundle for each navigation. A navigation can exist for user, groups, and portal.
</para>
@@ -131,6 +133,7 @@
</section>
<section id="sect-Reference_Guide-Internationalization_Configuration-Portlets">
<title>Portlets</title>
+ <remark>Source: https://docs.jboss.org/author/display/GTNPORTAL35/Internationalization+Configuration</remark>
<para>
Portlets are independent applications and deliver their own resource files.
</para>
@@ -158,6 +161,7 @@
</para>
<section id="sect-Reference_Guide-Portlets-Standard_Portlet_Resource_Keys">
<title>Standard Portlet Resource Keys</title>
+ <remark>Source: https://docs.jboss.org/author/display/GTNPORTAL35/Internationalization+Configuration</remark>
<para>
The portlet specification defines three standard keys: <emphasis>Title</emphasis>, <emphasis>Short Title</emphasis> and <emphasis>Keywords</emphasis>. Keywords is formatted as a comma-separated list of tags.
</para>
@@ -165,7 +169,7 @@
</section>
<section id="sect-Reference_Guide-_Portlets_-Debugging_Resource_Bundle_Usage">
<title>Debugging Resource Bundle Usage</title>
- <remark>Taken from https://docs.jboss.org/author/display/GTNPORTAL35/Internationalization+Configuration. Check here for revision incorporation status. </remark>
+ <remark>Source: https://docs.jboss.org/author/display/GTNPORTAL35/Internationalization+Configuration</remark>
<para>
When translating an application it can sometimes be difficult to find the right key for a given property.
</para>
@@ -196,6 +200,7 @@
</section>
<section id="Translate_Language_Selection_Form">
<title>Translate the Language Selection Form</title>
+ <remark>Source: https://docs.jboss.org/author/display/GTNPORTAL35/Internationalization+Configuration</remark>
<figure>
<title>Language Selection Screen</title>
<mediaobject>
Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/LocalizationConfiguration.xml
===================================================================
--- epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/LocalizationConfiguration.xml 2013-01-28 22:04:59 UTC (rev 9092)
+++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/LocalizationConfiguration.xml 2013-01-29 04:31:05 UTC (rev 9093)
@@ -7,6 +7,7 @@
<title>Localization Configuration</title>
<section id="sect-Reference_Guide-Localization_Configuration-Pluggable_Locale_Policy">
<title>Pluggable Locale Policy</title>
+ <remark>Source: https://docs.jboss.org/author/display/GTNPORTAL35/Pluggable+Locale+Policy</remark>
<para>
Every request processed by every portlet is invoked within a context of the current <literal>Locale</literal>.
</para>
@@ -27,6 +28,7 @@
</para>
<section id="sect-Reference_Guide-Pluggable_Locale_Policy-LocalePolicy_API">
<title>LocalePolicy API</title>
+ <remark>Source: https://docs.jboss.org/author/display/GTNPORTAL35/Pluggable+Locale+Policy#PluggableLocalePolicy-LocalePolicyAPI</remark>
<para>
Customization is achieved by using LocalePolicy API, which is a simple API consisting of one interface, and one class:
</para>
@@ -68,6 +70,7 @@
</section>
<section id="sect-Reference_Guide-Pluggable_Locale_Policy-Default_LocalePolicy">
<title>Default LocalePolicy</title>
+ <remark>Source: https://docs.jboss.org/author/display/GTNPORTAL35/Pluggable+Locale+Policy#PluggableLocalePolicy-Default%7B%7BLocalePolicy%7D%7D</remark>
<para>
By default, <literal>org.exoplatform.portal.application.localization.DefaultLocalePolicyService</literal>, an implementation of <literal>LocalePolicy</literal>, is installed to provide the default behavior. This, however, can easily be extended and overridden. A completely new implementation can also be written from scratch.
</para>
@@ -79,6 +82,7 @@
</para>
<procedure id="proc-Reference_Guide-Default_LocalePolicy-An_algorithm_for_anonymous_users">
<title>An algorithm for anonymous users</title>
+ <remark>Source: https://docs.jboss.org/author/display/GTNPORTAL35/Pluggable+Locale+Policy#PluggableLocalePolicy-Analgorithmforanonymoususers</remark>
<step>
<para>
Iterate over <literal>LocaleContextInfo</literal> properties in the following order:
@@ -135,6 +139,7 @@
</para>
<procedure id="proc-Reference_Guide-Default_LocalePolicy-An_algorithm_for_logged_in_users">
<title>An algorithm for logged-in users</title>
+ <remark>Source: https://docs.jboss.org/author/display/GTNPORTAL35/Pluggable+Locale+Policy#PluggableLocalePolicy-Analgorithmforloggedinusers</remark>
<step>
<para>
Iterate over <literal>LocaleContextInfo</literal> properties in the following order:
@@ -176,6 +181,7 @@
</section>
<section id="sect-Reference_Guide-Pluggable_Locale_Policy-Custom_LocalePolicy">
<title>Custom LocalePolicy</title>
+ <remark>Source: https://docs.jboss.org/author/display/GTNPORTAL35/Pluggable+Locale+Policy#PluggableLocalePolicy-Custom%7B%7BLocalePolicy%7D%7D</remark>
<para>
The easiest way to customize the <literal>LocalePolicy</literal> is to extend <literal>DefaultLocalePolicyService</literal>. A study of the source code is required. JavaDocs provide thorough information on this.
</para>
@@ -203,6 +209,7 @@
</section>
<section id="sect-Reference_Guide-Pluggable_Locale_Policy-LocalePolicy_Configuration">
<title>LocalePolicy Configuration</title>
+ <remark>Source: https://docs.jboss.org/author/display/GTNPORTAL35/Pluggable+Locale+Policy#PluggableLocalePolicy-LocalePolicyConfiguration</remark>
<para>
The <literal>LocalePolicy</literal> framework is enabled for portlets by configuring <literal>LocalizationLifecycle</literal> class in portal's webui configuration file: <filename><replaceable>JPP_HOME</replaceable>/gatein/gatein.ear/portal.war/WEB-INF/webui-configuration.xml</filename>:
</para>
@@ -228,6 +235,7 @@
</section>
<section id="sect-Reference_Guide-Pluggable_Locale_Policy-Keeping_non_bridged_resources_in_sync_with_current_Locale">
<title>Keeping non-bridged resources in sync with current Locale</title>
+ <remark>Source: https://docs.jboss.org/author/display/GTNPORTAL35/Pluggable+Locale+Policy#PluggableLocalePolicy-Analgorithmforloggedinusers</remark>
<para>
All the resources in portals that are not portlets themselves, but are accessed through portlets - reading data through <literal>PortletRequest</literal>, and writing to <literal>PortletResponse</literal> - are referred to as 'bridged'. Any resources that are accessed directly, bypassing portal filters and servlets, are referred to as <firstterm>non-bridged</firstterm>.
</para>
Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/ServerIntegration.xml
===================================================================
(Binary files differ)
Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/WSRP.xml
===================================================================
--- epp/docs/branches/6.0/Reference_Guide/en-US/modules/WSRP.xml 2013-01-28 22:04:59 UTC (rev 9092)
+++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/WSRP.xml 2013-01-29 04:31:05 UTC (rev 9093)
@@ -387,21 +387,21 @@
<entry>OUT</entry>
<entry>
<filename>standalone/configuration/gatein/wsrp/cxf/ws-security/consumer/WSS4JOutInterceptor.properties</filename>
- </entry>
+ </entry>
</row>
<row>
<entry>Producer</entry>
<entry>IN</entry>
<entry>
<filename>standalone/configuration/gatein/wsrp/cxf/ws-security/producer/WSS4JInInterceptor.properties</filename>
- </entry>
+ </entry>
</row>
<row>
<entry/>
<entry>OUT</entry>
<entry>
<filename>standalone/configuration/gatein/wsrp/cxf/ws-security/producer/WSS4JOutInterceptor.properties</filename>
- </entry>
+ </entry>
</row>
</tbody>
</tgroup>
@@ -2004,7 +2004,7 @@
</section>
<section>
<title>Working with WSRP Extensions</title>
-<remark>Source https://docs.jboss.org/author/display/GTNPORTAL35/Working+with+WSRP+extensions</remark>
+ <remark>Source https://docs.jboss.org/author/display/GTNPORTAL35/Working+with+WSRP+extensions</remark>
<section>
<title>Overview</title>
<para>
@@ -2076,7 +2076,7 @@
<code>ServiceLoader</code>
</ulink>
architectural pattern and be deployed in the appropriate
- <code>$JBOSS_HOME/gatein/extensions</code>
+ <code>JPP_HOME/gatein/extensions</code>
directory.
</para>
<para>
@@ -2315,4 +2315,3 @@
</section>
</section>
</chapter>
-
More information about the gatein-commits
mailing list