[gatein-commits] gatein SVN: r5372 - in epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US: extras/PortletDevelopment_Standard and 5 other directories.
do-not-reply at jboss.org
do-not-reply at jboss.org
Tue Nov 30 01:00:04 EST 2010
Author: smumford
Date: 2010-11-30 01:00:01 -0500 (Tue, 30 Nov 2010)
New Revision: 5372
Modified:
epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/extras/PortalDevelopment_DefaultPortalPermissionConfiguration/default146.xml
epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/extras/PortletDevelopment_Standard/JSPHelloUserPortlet.java
epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/Advanced/JCR/configuration.xml
epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/Advanced/JCR/jdbc-data-container-config.xml
epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/Advanced/JCR/search-configuration.xml
epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/GadgetDevelopment/SetupGadgetServer.xml
epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalPermissionConfiguration.xml
epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/PortalDevelopment/LocalizationConfiguration.xml
epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge/gettingstarted.xml
epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge/portlet_development.xml
epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/WSRP.xml
Log:
JBEPP-517: Updates from feedback
Modified: epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/extras/PortalDevelopment_DefaultPortalPermissionConfiguration/default146.xml
===================================================================
--- epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/extras/PortalDevelopment_DefaultPortalPermissionConfiguration/default146.xml 2010-11-30 05:06:37 UTC (rev 5371)
+++ epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/extras/PortalDevelopment_DefaultPortalPermissionConfiguration/default146.xml 2010-11-30 06:00:01 UTC (rev 5372)
@@ -1,21 +1,20 @@
<external-component-plugins>
- <target-component>org.exoplatform.portal.config.UserACL</target-component>
+ <target-component>org.exoplatform.portal.config.UserACL</target-component>
<component-plugin>
<name>addPortalACLPlugin</name>
<set-method>addPortalACLPlugin</set-method>
<type>org.exoplatform.portal.config.PortalACLPlugin</type>
<description>setting some permission for portal</description>
- <init-params>
+ <init-params>
<values-param>
- <name>access.control.workspace.roles</name>
- <value>*:/platform/administrators</value>
- <value>*:/organization/management/executive-board</value>
+ <name>super.user</name>
+ <value>root</value>
</values-param>
<values-param>
<name>portal.creation.roles</name>
<value>*:/platform/administrators</value>
- <value>*:/organization/management/executive-board</value>
+ <value>*:/organization/management/executive-board</value>
</values-param>
</init-params>
</component-plugin>
- </external-component-plugins>
+</external-component-plugins>
\ No newline at end of file
Modified: epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/extras/PortletDevelopment_Standard/JSPHelloUserPortlet.java
===================================================================
--- epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/extras/PortletDevelopment_Standard/JSPHelloUserPortlet.java 2010-11-30 05:06:37 UTC (rev 5371)
+++ epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/extras/PortletDevelopment_Standard/JSPHelloUserPortlet.java 2010-11-30 06:00:01 UTC (rev 5372)
@@ -1,4 +1,4 @@
-package org.jboss.portal.portlet.portlets;
+package org.jboss.portal.portlet.samples;
import java.io.IOException;
Modified: epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/Advanced/JCR/configuration.xml
===================================================================
--- epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/Advanced/JCR/configuration.xml 2010-11-30 05:06:37 UTC (rev 5371)
+++ epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/Advanced/JCR/configuration.xml 2010-11-30 06:00:01 UTC (rev 5372)
@@ -159,7 +159,6 @@
<section id="sect-Reference_Guide-Portal_and_Standalone_configuration-Repository_service_configuration">
<title>Example of the portal-system workspace</title>
-<!--DOCS NOTE: The callout configuration below is not rerndering correctly in Publican builds. The callout list icons do not rener from number 15 onwards. -->
<programlistingco>
<areaspec>
<!--1-->
Modified: epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/Advanced/JCR/jdbc-data-container-config.xml
===================================================================
--- epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/Advanced/JCR/jdbc-data-container-config.xml 2010-11-30 05:06:37 UTC (rev 5371)
+++ epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/Advanced/JCR/jdbc-data-container-config.xml 2010-11-30 06:00:01 UTC (rev 5372)
@@ -520,7 +520,7 @@
</procedure>
<para>
- The above configures two workspaces which will be persisted in two different databases (<literal>ws</literal> in <literal>HSQLDB</literal> and <literal>ws1</literal> in <literal>MySQL</literal>.
+ The above configures two workspaces which will be persisted in two different databases (<literal>ws</literal> in <literal>HSQLDB</literal> and <literal>ws1</literal> in <literal>MySQL</literal>).
</para>
<note>
<para>
Modified: epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/Advanced/JCR/search-configuration.xml
===================================================================
--- epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/Advanced/JCR/search-configuration.xml 2010-11-30 05:06:37 UTC (rev 5371)
+++ epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/Advanced/JCR/search-configuration.xml 2010-11-30 06:00:01 UTC (rev 5372)
@@ -28,12 +28,13 @@
The table below has been updated based on QE feedback. Please review for technical accuracy.
</para>
</note>
- <table align="left" id="tabl-Reference_Guide-Search_Configuration-Configuration_parameters" pgwide="1">
+ <table id="tabl-Reference_Guide-Search_Configuration-Configuration_parameters" > <!--align="left" pgwide="1"-->
<title>Configuration parameters</title>
<tgroup cols="4">
- <colspec colwidth="90pt"></colspec>
- <colspec colwidth="135pt"></colspec>
- <colspec colwidth="270pt"></colspec>
+ <colspec colname="1" colwidth="90pt"></colspec>
+ <colspec colname="2" colwidth="90pt"></colspec>
+ <colspec colname="3" colwidth="150pt"></colspec>
+ <colspec colname="4" colwidth="50pt"></colspec>
<thead>
<row>
<entry>
Modified: epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/GadgetDevelopment/SetupGadgetServer.xml
===================================================================
--- epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/GadgetDevelopment/SetupGadgetServer.xml 2010-11-30 05:06:37 UTC (rev 5371)
+++ epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/GadgetDevelopment/SetupGadgetServer.xml 2010-11-30 06:00:01 UTC (rev 5372)
@@ -16,7 +16,7 @@
An example would be hosting the portal from <emphasis role="bold">http://www.sample.com</emphasis> and the gadgets from <emphasis role="bold">http://www.samplemodules.com</emphasis>.
</para>
<para>
- To do this, configure the <emphasis>gadgets.hostName</emphasis>parameter in the <filename>server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/02portal.war/WEB-INF/conf/portal/application-registry-configuration.xml</filename>file. The value is the <emphasis role="bold">path/to/gadgetServer</emphasis>in <literal>GadgetRegisteryService</literal>:
+ To do this, configure the <emphasis>gadgets.hostName</emphasis>parameter in the <filename>server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/02portal.war/WEB-INF/conf/portal/application-registry-configuration.xml</filename>file. The value is the <emphasis role="bold">path/to/gadgetServer</emphasis>in <literal>GadgetRegistryService.xml</literal>:
</para>
<programlisting language="XML" role="XML"><xi:include href="../../extras/Gadget_Development_SetupGadgetServer/default139.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" />
</programlisting>
@@ -25,7 +25,7 @@
It is also possible to have multiple rendering servers. This helps to balance the rendering load across multiple servers.
</para>
<para>
- When deploying on the same server ensure the gadget initiates before anything that calls it (for example; the webapp <literal>GateInGadgets</literal>which uses <literal>org.exoplatform.application.gadget.GadgetRegister</literal>).
+ When deploying on the same server ensure the gadget initiates before anything that calls it (for example; the webapp <literal>eXoGadgets</literal>which uses <literal>org.exoplatform.application.gadget.GadgetRegister</literal>).
</para>
</section>
<section id="sect-Reference_Guide-Advanced_Gadget_Administration-Configuration">
@@ -50,7 +50,7 @@
<section id="sect-Reference_Guide-Configuration-Gadget_proxy_and_concat_configuration">
<title>Gadget proxy and concat configuration</title>
<para>
- These servers have to be on the same domain as the gadget server. You can configure the container in <filename>eXoGadgetServer:/WEB-INF/classes/containers/default/container.js</filename>.
+ These servers have to be on the same domain as the gadget server. You can configure the container in <filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable><PROFILE></replaceable>/deploy/gatein.ear/eXoGadgetServer.war:/WEB-INF/classes/containers/default/container.js</filename>.
</para>
<programlisting language="Java" role="Java"><xi:include href="../../extras/Gadget_Development_SetupGadgetServer/default141.java" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" />
</programlisting>
Modified: epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalPermissionConfiguration.xml
===================================================================
--- epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalPermissionConfiguration.xml 2010-11-30 05:06:37 UTC (rev 5371)
+++ epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalPermissionConfiguration.xml 2010-11-30 06:00:01 UTC (rev 5372)
@@ -8,7 +8,7 @@
<section id="sect-Reference_Guide-Portal_Default_Permission_Configuration-Overview">
<title>Overview</title>
<para>
- The default permission configuration for the portal is defined through the <literal>org.exoplatform.portal.config.UserACL</literal> component configuration in the <filename>02portal.war:/WEB-INF/conf/portal/portal-configuration.xml</filename> file.
+ The default permission configuration for the portal is defined through the <literal>org.exoplatform.portal.config.UserACL</literal> component configuration in the <filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable><PROFILE></replaceable>/deploy/gatein.ear/02portal.war:/WEB-INF/conf/portal/portal-configuration.xml</filename> file.
</para>
<para>
It defines eight permissions types:
Modified: epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/PortalDevelopment/LocalizationConfiguration.xml
===================================================================
--- epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/PortalDevelopment/LocalizationConfiguration.xml 2010-11-30 05:06:37 UTC (rev 5371)
+++ epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/PortalDevelopment/LocalizationConfiguration.xml 2010-11-30 06:00:01 UTC (rev 5372)
@@ -4,10 +4,9 @@
%BOOK_ENTITIES;
]>
<chapter id="chap-Reference_Guide-Localization_Configuration">
- <title>Localization Configuration - PLEASE REVIEW</title>
+ <title>Localization Configuration</title>
<section id="sect-Reference_Guide-Portal_Development-Pluggable_Locale_Policy">
<title>Pluggable Locale Policy</title>
-
<para>
Every request processed by every portlet is invoked within a context of the current <literal>Locale</literal>.
</para>
@@ -18,23 +17,20 @@
The exact algorithm for determining the current <literal>Locale</literal> is not specified by Portlet Specification. Portlet containers implement this the way they deem most appropriate.
</para>
<para>
- In &PRODUCT; each portal instance has a default language which can be used to present content for new users. Another option is to use each user’s browser language preference, provided it matches one of the available localizations that &PRODUCT; supports, and only fallback to portal default language if no match is found.
+ In &PRODUCT;, each portal instance has a default language which can be used to present content for new users. Another option is to use each user’s browser language preference, provided it matches one of the available localizations that &PRODUCT; supports, and only fallback to the portal's default language if no match is found.
</para>
<para>
- Every user, while visiting a portal, has an option to change the language of the user interface by using a Language chooser.
- The choice can be remembered for the duration of the session, or it can be remembered for a longer period using a browser cookie,
- or - for registered and logged-in users - it can be saved into user’s profile.
+ Every user, while visiting a portal, has an option to change the language of the user interface by using a Language chooser. The choice can be remembered for the duration of the session, or it can be remembered for a longer period using a browser cookie, or, for registered and logged-in users, it can be saved into the user’s profile.
</para>
- <para>So, we can see that there is more than one way to determine the <literal>Locale</literal> to be used for displaying a portal page
- to the user. For this reason the mechanism for determining the current <literal>Locale</literal> of the request
- is pluggable in &PRODUCT;, so the exact algorithm can be customized.
+ <para>
+ As there is more than one way to determine the <literal>Locale</literal> to be used for displaying a portal page, the mechanism for determining the current <literal>Locale</literal> of the request is pluggable in &PRODUCT;, and the exact algorithm can be customized.
</para>
<section>
<title>LocalePolicy API</title>
- <para>Customization is achieved by using LocalePolicy API, which is a simple API consisting of one interface,
- and one class:
+ <para>
+ Customization is achieved by using LocalePolicy API, which is a simple API consisting of one interface, and one class:
</para>
<itemizedlist>
<listitem>
@@ -45,8 +41,8 @@
</listitem>
</itemizedlist>
- <para><literal>LocalePolicy</literal> interface defines a single method that’s invoked on the installed
- <literal>LocalePolicy</literal> service implementation:
+ <para>
+ The <literal>LocalePolicy</literal> interface defines a single method that is invoked on the installed <literal>LocalePolicy</literal> service implementation:
</para>
<programlisting language="Java" role="Java"><![CDATA[public interface LocalePolicy
@@ -54,36 +50,38 @@
public Locale determineLocale(LocaleContextInfo localeContext);
}]]>
</programlisting>
- <para><literal>Locale</literal> returned by determineLocale() method is the <literal>Locale</literal>
- that will be returned to portlets when they call <literal>javax.portlet.PortletRequest.getLocale()</literal> method.
+ <para>
+ The <literal>Locale</literal> returned by determineLocale() method is the <literal>Locale</literal> that will be returned to portlets when they call <literal>javax.portlet.PortletRequest.getLocale()</literal> method.
</para>
- <para>The returned <literal>Locale</literal> has to be one of the locales supported by portal,
- otherwise it will fallback to portal-default <literal>Locale</literal>.
+ <para>
+ The returned <literal>Locale</literal> has to be one of the locales supported by portal, otherwise it will fall back to the portal default <literal>Locale</literal>.
</para>
-
- <para>The supported locales are listed in <filename>gatein.ear/02portal.war/WEB-INF/conf/common/locales-config.xml</filename> file
- as described in <xref linkend="sect-Reference_Guide-Internationalization_Configuration-Locales_Configuration"/> .
+ <para>
+ The supported locales are listed in <filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable><PROFILE></replaceable>/deploy/gatein.ear/02portal.war/WEB-INF/conf/common/locales-config.xml</filename> file as described in <xref linkend="sect-Reference_Guide-Internationalization_Configuration-Locales_Configuration"/> .
</para>
-
- <para>The <literal>determineLocale()</literal> method takes a parameter of type <literal>LocaleContextInfo</literal>,
- which represents a compilation of preferred locales from different sources - user’s profile, portal default,
- browser language settings, current session, browser cookie … All these different sources of <literal>Locale</literal>
- configuration or preference are used as input to <literal>LocalePolicy</literal> implementation
- that decides which <literal>Locale</literal> should be used.
+ <para>
+ The <literal>determineLocale()</literal> method takes a parameter of type <literal>LocaleContextInfo</literal>, which represents a compilation of preferred locales from different sources; user’s profile, portal default, browser language settings, current session, browser cookie.
</para>
+ <para>
+ All these different sources of <literal>Locale</literal> configuration or preference are used as input to <literal>LocalePolicy</literal> implementation that decides which <literal>Locale</literal> should be used.
+ </para>
+ </section>
- </section>
- <section>
+ <section id="sect-Reference_Guide-Portal_Development-Default_LocalePolicy">
<title>Default <literal>LocalePolicy</literal></title>
- <para>By default, <literal>org.exoplatform.portal.application.localization.DefaultLocalePolicyService</literal> - an implementation
- of <literal>LocalePolicy</literal> - is installed to provide the default behaviour.
+ <para>
+ By default, <literal>org.exoplatform.portal.application.localization.DefaultLocalePolicyService</literal>, an implementation
+ of <literal>LocalePolicy</literal>, is installed to provide the default behaviour.
This, however, can easily be extended and overriden. A completely new implementation can also be written from scratch.
</para>
- <para><literal>DefaultLocalePolicyService</literal> treats logged-in users slightly differently than anonymous users.
- Logged-in users have a profile that can contain language preference, while anonymous users don't.
+ <para>
+ <literal>DefaultLocalePolicyService</literal> treats logged-in users slightly differently than anonymous users.
+ Logged-in users have a profile that can contain language preference, while anonymous users do not.
</para>
- <para>Here is an algorithm used for anonymous users.</para>
- <procedure>
+ <para>
+ Here is an algorithm used for anonymous users.
+ </para>
+ <procedure id="proc-Reference_Guide-Portal_Development-Default_LocalePolicy-anonymous_users">
<title>An algorithm for anonymous users</title>
<step>
<para>
@@ -105,29 +103,33 @@
</itemizedlist>
</step>
<step>
- <para>Get each property's value - if it's a collection, get the first value.
+ <para>
+ Get each property's value. If it's a collection, get the first value.
</para>
</step>
<step>
- <para>If value is one of the supported locales return it as a result.
+ <para>
+ If value is one of the supported locales return it as a result.
</para>
</step>
<step>
- <para>If value is not in the supported locales set, try to remove country information,
- and check if a language matching locale is in the list of supported locales.
- If so, return it as a result.
+ <para>
+ If the value is not in the supported locales set, try to remove country information and check if a language matching locale is in the list of supported locales. If so, return it as a result.
</para>
</step>
<step>
- <para>Otherwise, continue with the next property.
+ <para>
+ Otherwise, continue with the next property.
</para>
</step>
</procedure>
- <para>If no supported locale is found the return locale eventually defaults to <literal>portalLocale</literal>.
+ <para>
+ If no supported locale is found the return locale eventually defaults to <literal>portalLocale</literal>.
</para>
- <para>The algorithm for logged-in users is virtually the same except that the first <literal>Locale</literal>
+ <para>
+ The algorithm for logged-in users is virtually the same except that the first <literal>Locale</literal>
source checked is user's profile.</para>
- <procedure>
+ <procedure id="proc-Reference_Guide-Portal_Development-Default_LocalePolicy-logged-in_users">
<title>An algorithm for logged-in users</title>
<step>
<para>
@@ -152,20 +154,23 @@
</itemizedlist>
</step>
<step>
- <para>The rest is the same as for anonymous users ...</para>
+ <para>
+ Perform the rest of the steps in <xref linkend="proc-Reference_Guide-Portal_Development-Default_LocalePolicy-anonymous_users"/>.
+ </para>
</step>
</procedure>
+ </section>
- </section>
- <section>
+ <section id="sect-Reference_Guide-Portal_Development-Custom_LocalePolicy">
<title>Custom <literal>LocalePolicy</literal></title>
- <para>The easiest way to customize the <literal>LocalePolicy</literal> is to extend <literal>DefaultLocalePolicyService</literal>.
- The study of its source code will be required. There is ample JavaDoc that provides thorough information.
+ <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>
+ <para>
Most customizations will involve simply overriding one or more of its protected methods.
</para>
<para>
- An example of a customization is an already provided <literal>NoBrowserLocalePolicyService</literal>.
- By overriding just one method, it skips any use of browser language preference.
+ An example of a customization is an already provided <literal>NoBrowserLocalePolicyService</literal>. By overriding just one method, it skips any use of browser language preference.
</para>
<programlisting language="Java" role="Java"><![CDATA[public class NoBrowserLocalePolicyService extends DefaultLocalePolicyService
{
@@ -184,61 +189,70 @@
</programlisting>
</section>
- <section>
+ <section id="sect-Reference_Guide-Portal_Development-LocalePolicy_Configuration">
<title>LocalePolicy Configuration</title>
- <para>The <literal>LocalePolicy</literal> framework is enabled for portlets by configuring LocalizationLifecycle class in portal's webui configuration file:
- <filename>gatein.ear/02portal.war/WEB-INF/webui-configuration.xml</filename>:</para>
+ <para>
+ The <literal>LocalePolicy</literal> framework is enabled for portlets by configuring <literal>LocalizationLifecycle</literal> class in portal's webui configuration file: <filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable><PROFILE></replaceable>/deploy/gatein.ear/02portal.war/WEB-INF/webui-configuration.xml</filename>:
+ </para>
-<programlisting language="XML" role="XML"><![CDATA[ <application-lifecycle-listeners>
+<programlisting language="XML" role="XML"><![CDATA[<application-lifecycle-listeners>
...
<listener>org.exoplatform.portal.application.localization.LocalizationLifecycle</listener>
- </application-lifecycle-listeners>]]>
+</application-lifecycle-listeners>]]>
</programlisting>
- <para>The default <literal>LocalePolicy</literal> implementation is installed as GateIn Kernel portal service via
- <filename>gatein.ear/lib/exo.portal.webui.portal-VERSION.jar/conf/portal/configuration.xml</filename>.
+ <para>
+ The default <literal>LocalePolicy</literal> implementation is installed as GateIn Kernel portal service via <filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable><PROFILE></replaceable>/deploy/gatein.ear/lib/exo.portal.webui.portal-VERSION.jar/conf/portal/configuration.xml</filename>.
</para>
- <para>The following fragment is responsible for installing the service:
+ <para>
+ The following excerpt is responsible for installing the service:
</para>
-<programlisting language="XML" role="XML"><![CDATA[ <component>
+<programlisting language="XML" role="XML"><![CDATA[<component>
<key>org.exoplatform.services.resources.LocalePolicy</key>
<type>org.exoplatform.portal.application.localization.DefaultLocalePolicyService</type>
</component>]]>
</programlisting>
- <para>Besides implementing <literal>LocalePolicy</literal>, the service class also needs to implement
- <literal>org.picocontainer.Startable</literal> interface in order to get installed.
+ <para>
+ Besides implementing <literal>LocalePolicy</literal>, the service class also needs to implement <literal>org.picocontainer.Startable</literal> interface in order to get installed.
</para>
- <para>This configuration file should not be changed. The configuration in it can be overriden by placing it into portal's .war file:
- <filename>gatein.ear/02portal.war/WEB-INF/conf/configuration.xml</filename> (usually as another file included into this one).
+ <para>
+ This configuration file should not be changed. The configuration in it can be overridden by placing it into portal's .war file:
+ <filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable><PROFILE></replaceable>/deploy/gatein.ear/02portal.war/WEB-INF/conf/configuration.xml</filename> (usually as another file included into this one).
</para>
</section>
- <section>
+ <section id="sect-Reference_Guide-Portal_Development-non-bridged_sync">
<title>Keeping non-bridged resources in sync with current Locale</title>
- <para>In portals all the resources that are not portlets themselves but are accessed through portlets - reading
+ <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 'non-bridged'.
</para>
- <para>Non-bridged servlets, and .jsps have no access to <literal>PortalRequest</literal>. They don't use
+ <para>
+ Non-bridged servlets, and .jsps have no access to <literal>PortalRequest</literal>. They don't use
<literal>PortletRequest.getLocale()</literal> to determine current <literal>Locale</literal>.
Instead, they use <literal>ServletRequest.getLocale()</literal> which is subject to precise semantics
defined by Servlet specification - it reflects browser's language preference.
</para>
- <para>In other words, non-bridged resources don't have a notion of current <literal>Locale</literal>
+ <para>
+ In other words, non-bridged resources do not have a notion of current <literal>Locale</literal>
in the same sense that portlets do. The result is that when mixing portlets and non-bridged resources there
- may be a localization mismatch - an inconsistency in the language used by different resources composing your portal
+ may be a localization mismatch, an inconsistency in the language used by different resources composing your portal
page.
</para>
- <para>This problem is addressed by <literal>LocalizationFilter</literal>. This is a filter that changes the behaviour
- of <literal>ServletRequest.getLocale()</literal> method so that it behaves the same way as
- <literal>PortletRequest.getLocale()</literal>. That way even localization of servlets, and .jsps
- accessed in a non-bridged manner can stay in sync with portlet localization.
+ <para>
+ This problem is addressed by <literal>LocalizationFilter</literal>. This is a filter that changes the behavior
+ of <literal>ServletRequest.getLocale()</literal> method so that it behaves the same way as <literal>PortletRequest.getLocale()</literal>.
</para>
- <para><literal>LocalizationFilter</literal> is installed through portal's web.xml file: <filename>gatein.ear/02portal.war/WEB-INF/web.xml</filename>
+ <para>
+ That way even localization of servlets, and .jsps accessed in a non-bridged manner can stay in sync with portlet localization.
</para>
-<programlisting language="XML" role="XML"><![CDATA[ <filter>
+ <para>
+ <literal>LocalizationFilter</literal> is installed through the portal's web.xml file: <filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable><PROFILE></replaceable>/deploy/gatein.ear/02portal.war/WEB-INF/web.xml</filename>.
+ </para>
+<programlisting language="XML" role="XML"><![CDATA[<filter>
<filter-name>LocalizationFilter</filter-name>
<filter-class>org.exoplatform.portal.application.localization.LocalizationFilter</filter-class>
</filter>
@@ -254,11 +268,10 @@
<dispatcher>ERROR</dispatcher>
</filter-mapping>]]>
</programlisting>
- <para>There is a tiny limitation with this mechanism in that it is unable to determine the current portal,
- and consequently its default language. As a result the portalLocale defaults to <literal>English</literal>, but can be configured
- to something else by using filter's <literal>PortalLocale</literal> init param. For example:
+ <para>
+ There is a minor limitation with this mechanism in that it is unable to determine the current portal,and consequently, its default language. As a result the portalLocale defaults to <literal>English</literal>, but can be configured to something else by using the filter's <literal>PortalLocale</literal> init param. For example:
</para>
-<programlisting language="XML" role="XML"><![CDATA[ <filter>
+<programlisting language="XML" role="XML"><![CDATA[<filter>
<filter-name>LocalizationFilter</filter-name>
<filter-class>org.exoplatform.portal.application.localization.LocalizationFilter</filter-class>
<init-param>
@@ -267,13 +280,18 @@
</init-param>
</filter> ]]>
</programlisting>
- <para>By default, <literal>LocalizationFilter</literal> is applied very broadly to cover all the resources automatically.
- &PRODUCT; uses some non-bridged .jsps that require <literal>LocalizationFilter</literal>, so narrowing
- the mapping to *.jsp is enough for &PRODUCT; to still function correctly. Additionally deployed portlets,
- and portal applications, however, may require broader mapping to cover their non-bridged resources.
+ <para>
+ By default, <literal>LocalizationFilter</literal> is applied very broadly to cover all the resources automatically.
</para>
- <para>Narrowing the mapping might improve performance. This is something to consider, when optimizing for speed.
+ <para>
+ &PRODUCT; uses some non-bridged .jsps that require <literal>LocalizationFilter</literal>, so narrowing the mapping to *.jsp is enough for &PRODUCT; to function correctly.
</para>
+ <para>
+ Additionally deployed portlets, and portal applications, however, may require broader mapping to cover their non-bridged resources.
+ </para>
+ <para>
+ Narrowing the mapping might improve performance. This is something to consider, when optimizing for speed.
+ </para>
</section>
</section>
</chapter>
\ No newline at end of file
Modified: epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge/gettingstarted.xml
===================================================================
--- epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge/gettingstarted.xml 2010-11-30 05:06:37 UTC (rev 5371)
+++ epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge/gettingstarted.xml 2010-11-30 06:00:01 UTC (rev 5372)
@@ -110,7 +110,7 @@
The embedded version in the &PRODUCT; is made to be compatible with the JSF implementation, portal and application server that compose the product. You will find the binaries embedded in <filename>jboss-epp-5.0/portletbridge</filename>
</para>
<para>
- You can run a provided archetype (See <xref linkend="sect-Reference_Guide-Getting_started_with_JBoss_Portlet_Bridge-Maven_Archetypes" />) and deploy the generated <literal>war</literal> in a few easy steps.
+ You can run a provided archetype (See <xref linkend="sect-Reference_Guide-Getting_started_with_JBoss_Portlet_Bridge-Maven_Archetypes" />) and deploy the generated <literal>war</literal> or <literal>ear</literal> in a few easy steps.
</para>
</section>
@@ -118,7 +118,9 @@
<section id="sect-Reference_Guide-Getting_started_with_JBoss_Portlet_Bridge-Maven_Archetypes">
<title>Maven Archetypes</title>
<para>
- This product utilizes <ulink url="http://maven.apache.org/guides/introduction/introduction-to-archetypes.html">Maven archetypes</ulink> which allow you get up and running with different flavors of the bridge quickly.
+ This product utilizes <ulink url="http://maven.apache.org/guides/introduction/introduction-to-archetypes.html">Maven archetypes</ulink> which allow you get up and running with different flavors of the bridge quickly.
+ </para>
+<!--DOC NOTE: Branching issue -->
<table frame="all" id="tabl-Reference_Guide-Maven_Archetypes-Available_Archetypes">
<title>Available Archetypes</title>
<tgroup align="left" cols="5" colsep="1" rowsep="1">
@@ -137,6 +139,11 @@
</row>
</thead>
<tbody>
+ <row>
+ <entry align="left" nameend="c5" namest="c1">
+ <emphasis role="bold">For PortletBridge 2.0.0 as shipped with &PRODUCT; 5.0</emphasis>.
+ </entry>
+ </row>
<row class="table-odd" style="background-color:#D6DEE0;border:1px solid #E1E9EB;color:#334558;">
<entry align="left">
JSF 1.2 Basic
@@ -167,10 +174,23 @@
</entry>
</row>
+ <row>
+ <entry align="left" nameend="c5" namest="c1">
+ <emphasis role="bold">For PortletBridge 2.1.0 as shipped with &PRODUCT; &VERSION_MINOR;</emphasis>.
+ </entry>
+ </row>
+ <row>
+ <entry>
+ Any combination JSF 1.2, RichFaces, or Seam.
+ </entry>
+ <entry align="left" nameend="c5" namest="c2">
+<programlisting >mvn archetype:generate -DarchetypeCatalog=http://anonsvn.jboss.org/repos/portletbridge/trunk/archetypes/archetype-catalog.xml
+</programlisting>
+ </entry>
+ </row>
</tbody>
</tgroup>
</table>
- </para>
</section>
Modified: epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge/portlet_development.xml
===================================================================
--- epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge/portlet_development.xml 2010-11-30 05:06:37 UTC (rev 5371)
+++ epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge/portlet_development.xml 2010-11-30 06:00:01 UTC (rev 5372)
@@ -210,8 +210,8 @@
</section>
- <section id="sect-Reference_Guide-Developing_Portlets_with_the_Bridge-Linking_to_PortletJSF_Pages_Using_houtputink">
- <title>Linking to Portlet/JSF Pages Using h:outputink</title>
+ <section id="sect-Reference_Guide-Developing_Portlets_with_the_Bridge-Linking_to_PortletJSF_Pages_Using_houtputlink">
+ <title>Linking to Portlet/JSF Pages Using h:outputlink</title>
<para>
For linking to any JSF/Facelets page within your portlet web application, you can use the following.
</para>
Modified: epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/WSRP.xml
===================================================================
--- epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/WSRP.xml 2010-11-30 05:06:37 UTC (rev 5371)
+++ epp/docs/branches/EPP_5_1_Branch/Reference_Guide/en-US/modules/WSRP.xml 2010-11-30 06:00:01 UTC (rev 5372)
@@ -77,7 +77,7 @@
<term><replaceable>EPP_HOME</replaceable></term>
<listitem>
<para>
- <replaceable>EPP_HOME</replaceable> refers to the directory that your instance of &PRODUCT; has been extracted/installed to. For example: <filename>/home/<replaceable>USERNAME</replaceable>/jboss-epp-5.0/</filename>
+ <replaceable>EPP_HOME</replaceable> refers to the directory that your instance of &PRODUCT; has been extracted/installed to. For example: <filename>/home/<replaceable>USERNAME</replaceable>/jboss-epp-<replaceable><VERSION></replaceable>/</filename>
</para>
</listitem>
</varlistentry>
More information about the gatein-commits
mailing list