gatein SVN: r3037 - portal/trunk/web/eXoResources/src/main/webapp/javascript/eXo/gadget.
by do-not-reply＠jboss.org
Author: ndkhoiits
Date: 2010-05-11 02:46:23 -0400 (Tue, 11 May 2010)
New Revision: 3037
Modified:
portal/trunk/web/eXoResources/src/main/webapp/javascript/eXo/gadget/UIGadget.js
Log:
GTNPORTAL-1061 Set gadget's height is 800px if current view is canvas and gadget's height is not set
Modified: portal/trunk/web/eXoResources/src/main/webapp/javascript/eXo/gadget/UIGadget.js
===================================================================
--- portal/trunk/web/eXoResources/src/main/webapp/javascript/eXo/gadget/UIGadget.js 2010-05-11 05:03:42 UTC (rev 3036)
+++ portal/trunk/web/eXoResources/src/main/webapp/javascript/eXo/gadget/UIGadget.js 2010-05-11 06:46:23 UTC (rev 3037)
@@ -40,6 +40,10 @@
//-----------------------------------------
var gadget;
if (metadata != null) {
+ // Check if gadget's height is not set and current view is canvas. By default, gadget's height is 800px
+ if(metadata.gadgets[0].height == 0 && view == 'canvas') {
+ metadata.gadgets[0].height = "800px";
+ }
gadget = gadgets.container.createGadget({specUrl: url,height: metadata.gadgets[0].height, secureToken: metadata.gadgets[0].secureToken, view: view});
gadget.metadata = metadata.gadgets[0];
} else {
14 years, 1 month
- 1
- 0
gatein SVN: r3036 - in portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules: GadgetDevelopment and 1 other directory.
by do-not-reply＠jboss.org
Author: smumford
Date: 2010-05-11 01:03:42 -0400 (Tue, 11 May 2010)
New Revision: 3036
Modified:
portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/AuthenticationAndIdentity/AuthenticationTokenConfiguration.xml
portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/AuthenticationAndIdentity/BackendConfiguration.xml
portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/AuthenticationAndIdentity/PredefinedUserConfiguration.xml
portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/GadgetDevelopment/SetupGadgetServer.xml
Log:
Minor edits
Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/AuthenticationAndIdentity/AuthenticationTokenConfiguration.xml
===================================================================
--- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/AuthenticationAndIdentity/AuthenticationTokenConfiguration.xml 2010-05-11 04:15:40 UTC (rev 3035)
+++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/AuthenticationAndIdentity/AuthenticationTokenConfiguration.xml 2010-05-11 05:03:42 UTC (rev 3036)
@@ -5,26 +5,29 @@
]>
<section id="sect-Reference_Guide-Authentication_Token_Configuration">
<title>Authentication Token Configuration</title>
- <section id="sect-Reference_Guide-Authentication_Token_Configuration-What_is_Token_Service">
- <title>What is Token Service?</title>
+ <section id="sect-Reference_Guide-Authentication_Token_Configuration-The_Token_Service">
+ <title>The Token Service</title>
<para>
- <emphasis>Token Service</emphasis> is used in authentication.
+ The <emphasis>Token Service</emphasis> is used in authentication.
</para>
<para>
The token system prevents user account information being sent in clear text mode within inbound requests. This increases authentication security.
</para>
<para>
- Token service allows administrators to create, delete, retrieve and clean tokens as required. The service also defines a validity period of any given token. The token becomes invalid once this period expires.
+ The token service allows administrators to create, delete, retrieve and clean tokens as required. The service also defines a validity period of any given token. The token becomes invalid once this period expires.
</para>
</section>
<section id="sect-Reference_Guide-Authentication_Token_Configuration-Implementing_the_Token_Service_API">
<title>Implementing the Token Service API</title>
<para>
- All token services used in &PRODUCT; authentication must be implemented by subclassing an <emphasis role="bold">AbstractTokenService</emphasis> abstract class. The following <emphasis role="bold">AbstractTokenService</emphasis> methods represent the contract between authentication runtime, and a token service implementation.
+ All token services used in &PRODUCT; authentication must be implemented by subclassing an <emphasis role="bold">AbstractTokenService</emphasis> abstract class.
</para>
+ <para>
+ The following <emphasis role="bold">AbstractTokenService</emphasis> methods represent the contract between authentication runtime, and a token service implementation.
+ </para>
-<programlisting role="JAVA">
+<programlisting language="Java" role="JAVA">
public Token getToken(String id) throws PathNotFoundException, RepositoryException;
public Token deleteToken(String id) throws PathNotFoundException, RepositoryException;
public String[] getAllTokens();
@@ -37,9 +40,9 @@
</section>
<section id="sect-Reference_Guide-Authentication_Token_Configuration-Configuring_token_services">
- <title>Configuring token services</title>
+ <title>Configuring Token Services</title>
<para>
- Token services configuration includes specifying the token validity period. The token service is configured as a portal component (in portal scope, as opposed to root scope - more about that in Foundations chapter).
+ Token services configuration includes specifying the token validity period. The token service is configured as a portal component.
</para>
<para>
In the example below, <emphasis>CookieTokenService</emphasis> is a subclass of <emphasis role="bold">AbstractTokenService</emphasis> so it has a property which specifies the validity period of the token.
@@ -57,19 +60,18 @@
<area coords="9" id="area-Reference_Guide-Authentication_Token_Configuration-Configure_token_services-unit" />
</areaspec>
-<programlisting><component>
- <key>org.exoplatform.web.security.security.CookieTokenService</key>
- <type>org.exoplatform.web.security.security.CookieTokenService</type>
- <init-params>
- <values-param>
- <name>service.configuration</name>
- <value>jcr-token</value>
- <value>7</value>
- <value>DAY</value>
- </values-param>
- </init-params>
-</component>
-</programlisting>
+<programlisting language="XML" role="XML"><![CDATA[<component>
+ <key>org.exoplatform.web.security.security.CookieTokenService</key>
+ <type>org.exoplatform.web.security.security.CookieTokenService</type>
+ <init-params>
+ <values-param>
+ <name>service.configuration</name>
+ <value>jcr-token</value>
+ <value>7</value>
+ <value>DAY</value>
+ </values-param>
+ </init-params>
+</component>]]></programlisting>
<calloutlist>
<callout arearefs="area-Reference_Guide-Authentication_Token_Configuration-Configure_token_services-name">
<para>
Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/AuthenticationAndIdentity/BackendConfiguration.xml
===================================================================
--- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/AuthenticationAndIdentity/BackendConfiguration.xml 2010-05-11 04:15:40 UTC (rev 3035)
+++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/AuthenticationAndIdentity/BackendConfiguration.xml 2010-05-11 05:03:42 UTC (rev 3036)
@@ -9,7 +9,7 @@
&PRODUCT; uses PicketLink IDM component to keep the necessary identity information (users, groups, memberships, etc.). While legacy interfaces are still used (org.exoplatform.services.organization) for identity management, there is a wrapper implementation that delegates to PicketLink IDM framework.
</para>
<para>
- This section doesn't provide information about PicketLink IDM and its configuration. Please, refer to the appropriate project documentation (<ulink url="http://jboss.org/picketlink/IDM.html" />) for further information.
+ This section does not provide information about PicketLink IDM and its configuration. Please, refer to the appropriate project documentation (<ulink url="http://jboss.org/picketlink/IDM.html" />) for further information.
</para>
<note>
<para>
Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/AuthenticationAndIdentity/PredefinedUserConfiguration.xml
===================================================================
--- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/AuthenticationAndIdentity/PredefinedUserConfiguration.xml 2010-05-11 04:15:40 UTC (rev 3035)
+++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/AuthenticationAndIdentity/PredefinedUserConfiguration.xml 2010-05-11 05:03:42 UTC (rev 3036)
@@ -8,21 +8,24 @@
<section id="sect-Reference_Guide-Predefined_User_Configuration-Overview">
<title>Overview</title>
<para>
- To specify the initial Organization configuration, the content of <literal>02portal.war:/WEB-INF/conf/organization/organization-configuration.xml </literal> should be edited. This file uses the portal XML configuration schema. It lists several configuration plugins.
+ The initial Organization configuration should be specified by editing the content of <literal>02portal.war:/WEB-INF/conf/organization/organization-configuration.xml</literal>. This file uses the portal XML configuration schema. It lists several configuration plugins.
</para>
</section>
<section id="sect-Reference_Guide-Predefined_User_Configuration-Plugin_for_adding_users_groups_and_membership_types">
<title>Plugin for adding users, groups and membership types</title>
<para>
- The plugin of type <literal>org.exoplatform.services.organization.OrganizationDatabaseInitializer</literal> is used to specify a list of membership types, a list of groups, and a list of users to be created.
+ The plugin type <literal>org.exoplatform.services.organization.OrganizationDatabaseInitializer</literal> is used to specify a list of membership types, a list of groups and a list of users to be created.
</para>
<para>
The <emphasis role="bold">checkDatabaseAlgorithm</emphasis> initialization parameter determines how the database update is performed.
</para>
<para>
- If its value is set to <emphasis role="bold">entry</emphasis> it means that each user, group and membership listed in the configuration is checked each time &PRODUCT; is started. If the entry doesn't yet exist in the database, it is created. If <emphasis role="bold">checkDatabaseAlgorithm</emphasis> parameter value is set to <emphasis role="bold">empty</emphasis>, the configuration data will be updated to the database only if the database is empty.
+ If its value is set to <emphasis role="bold">entry</emphasis> it means that each user, group and membership listed in the configuration is checked each time &PRODUCT; is started. If the entry doesn't yet exist in the database, it is created.
</para>
+ <para>
+ If <emphasis role="bold">checkDatabaseAlgorithm</emphasis> parameter value is set to <emphasis role="bold">empty</emphasis>, the configuration data will be updated to the database only if the database is empty.
+ </para>
</section>
<section id="sect-Reference_Guide-Predefined_User_Configuration-Membership_types">
@@ -153,47 +156,50 @@
<section id="sect-Reference_Guide-Predefined_User_Configuration-Plugin_for_monitoring_user_creation">
<title>Plugin for monitoring user creation</title>
<para>
- The plugin of type <literal>org.exoplatform.services.organization.impl.NewUserEventListener </literal> specifies which groups all the newly created users should become members of. It specifies the groups and the memberships to use (while group is just a set of users, a membership type represents a user's role within a group). It also specifies a list of users that should not be processed (i.e. administrative users like 'root').
+ The plugin type <literal>org.exoplatform.services.organization.impl.NewUserEventListener</literal> specifies which groups all the newly created users should become members of.
</para>
+ <para>
+ It specifies the group memberships and the membership types to use (while a <emphasis>group</emphasis> is just a set of users, a membership <emphasis>type</emphasis> represents a user's role within a group). It also specifies a list of users that should not be processed (such as administrative users like '<literal>root</literal>').
+ </para>
<note>
+ <title>Terminology</title>
<para>
- The terms 'membership' and 'membership type' refer to the same thing, and are used interchangeably.
+ The terms '<emphasis role="bold">membership</emphasis>' and '<emphasis role="bold">membership type</emphasis>' refer to the same thing, and are used interchangeably.
</para>
</note>
-<programlisting role="XML"><component-plugin>
- <name>new.user.event.listener</name>
- <set-method>addListenerPlugin</set-method>
- <type>org.exoplatform.services.organization.impl.NewUserEventListener</type>
- <description>this listener assign group and membership to a new created user</description>
- <init-params>
- <object-param>
- <name>configuration</name>
- <description>description</description>
- <object type="org.exoplatform.services.organization.impl.NewUserConfig">
- <field name="group">
- <collection type="java.util.ArrayList">
- <value>
- <object type="org.exoplatform.services.organization.impl.NewUserConfig$JoinGroup">
- <field name="groupId"><string>/user</string></field>
- <field name="membership"><string>member</string></field>
- </object>
- </value>
- </collection>
- </field>
- <field name="ignoredUser">
- <collection type="java.util.HashSet">
- <value><string>exo</string></value>
- <value><string>root</string></value>
- <value><string>company</string></value>
- <value><string>community</string></value>
- </collection>
- </field>
- </object>
- </object-param>
- </init-params>
-</component-plugin>
-</programlisting>
+<programlisting language="XML" role="XML"><![CDATA[<component-plugin>
+ <name>new.user.event.listener</name>
+ <set-method>addListenerPlugin</set-method>
+ <type>org.exoplatform.services.organization.impl.NewUserEventListener</type>
+ <description>this listener assign group and membership to a new created user</description>
+ <init-params>
+ <object-param>
+ <name>configuration</name>
+ <description>description</description>
+ <object type="org.exoplatform.services.organization.impl.NewUserConfig">
+ <field name="group">
+ <collection type="java.util.ArrayList">
+ <value>
+ <object type="org.exoplatform.services.organization.impl.NewUserConfig$JoinGroup">
+ <field name="groupId"><string>/user</string></field>
+ <field name="membership"><string>member</string></field>
+ </object>
+ </value>
+ </collection>
+ </field>
+ <field name="ignoredUser">
+ <collection type="java.util.HashSet">
+ <value><string>exo</string></value>
+ <value><string>root</string></value>
+ <value><string>company</string></value>
+ <value><string>community</string></value>
+ </collection>
+ </field>
+ </object>
+ </object-param>
+ </init-params>
+</component-plugin>]]></programlisting>
</section>
</section>
Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/GadgetDevelopment/SetupGadgetServer.xml
===================================================================
--- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/GadgetDevelopment/SetupGadgetServer.xml 2010-05-11 04:15:40 UTC (rev 3035)
+++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/GadgetDevelopment/SetupGadgetServer.xml 2010-05-11 05:03:42 UTC (rev 3036)
@@ -57,7 +57,7 @@
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>.
</para>
-<programlisting>"gadgets.content-rewrite" : {
+<programlisting language="Java" role="JAVA">"gadgets.content-rewrite" : {
"include-urls": ".*",
"exclude-urls": "",
"include-tags": ["link", "script", "embed", "img", "style"],
14 years, 1 month
- 1
- 0
gatein SVN: r3035 - portal/trunk/web/eXoResources/src/main/webapp/javascript/eXo/core.
by do-not-reply＠jboss.org
Author: thanh_tung_do
Date: 2010-05-11 00:15:40 -0400 (Tue, 11 May 2010)
New Revision: 3035
Modified:
portal/trunk/web/eXoResources/src/main/webapp/javascript/eXo/core/DOMUtil.js
Log:
GTNPORTAL-1175: disable save button after onclick
Modified: portal/trunk/web/eXoResources/src/main/webapp/javascript/eXo/core/DOMUtil.js
===================================================================
--- portal/trunk/web/eXoResources/src/main/webapp/javascript/eXo/core/DOMUtil.js 2010-05-11 04:06:39 UTC (rev 3034)
+++ portal/trunk/web/eXoResources/src/main/webapp/javascript/eXo/core/DOMUtil.js 2010-05-11 04:15:40 UTC (rev 3035)
@@ -454,7 +454,7 @@
}
DOMUtil.prototype.disableOnClick = function(el) {
- el.onClick = new Function("return false;");
+ el.onclick = new Function("return false;");
}
/****************************************************************************/
14 years, 1 month
- 1
- 0
gatein SVN: r3034 - portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Release_Notes/en-US.
by do-not-reply＠jboss.org
Author: smumford
Date: 2010-05-11 00:06:39 -0400 (Tue, 11 May 2010)
New Revision: 3034
Modified:
portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Release_Notes/en-US/Book_Info.xml
portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Release_Notes/en-US/Release_Notes.ent
portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Release_Notes/en-US/Release_Notes.xml
Log:
JBEPP-279: First check in of draft document
Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Release_Notes/en-US/Book_Info.xml
===================================================================
--- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Release_Notes/en-US/Book_Info.xml 2010-05-11 02:41:02 UTC (rev 3033)
+++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Release_Notes/en-US/Book_Info.xml 2010-05-11 04:06:39 UTC (rev 3034)
@@ -17,7 +17,7 @@
<corpauthor>
<inlinemediaobject>
<imageobject>
- <imagedata fileref="Common_Content/images/redhat-logo.svg" format="SVG" />
+ <imagedata fileref="Common_Content/images/title_logo.svg" format="SVG" />
</imageobject>
</inlinemediaobject>
</corpauthor>
Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Release_Notes/en-US/Release_Notes.ent
===================================================================
--- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Release_Notes/en-US/Release_Notes.ent 2010-05-11 02:41:02 UTC (rev 3033)
+++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Release_Notes/en-US/Release_Notes.ent 2010-05-11 04:06:39 UTC (rev 3034)
@@ -1,4 +1,4 @@
<!ENTITY HOLDER "Red Hat, Inc">
<!ENTITY YEAR "2010">
<!ENTITY PRODUCT "JBoss Enterprise Portal Platform">
-<!ENTITY VERSION "5.0 Beta">
+<!ENTITY VERSION "5.0.0">
Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Release_Notes/en-US/Release_Notes.xml
===================================================================
--- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Release_Notes/en-US/Release_Notes.xml 2010-05-11 02:41:02 UTC (rev 3033)
+++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Release_Notes/en-US/Release_Notes.xml 2010-05-11 04:06:39 UTC (rev 3034)
@@ -4,7 +4,7 @@
<article>
<xi:include href="Book_Info.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<section id="sect-Release_Notes-_Introduction_">
- <title> Introduction </title>
+ <title>Overview</title>
<para>
These release notes contain important information related to &PRODUCT; &VERSION;. New features, known problems, resources, and other current issues are addressed here.
</para>
@@ -12,67 +12,92 @@
<para>
This release is early access software and should not be used in production.
</para>
- <!-- <para>
- Red Hat will provide Developer Support (2-day SLA) for existing customers for this release as long as your support issue is within the context of applications running on or with JBoss Enterprise Application Platform.
- </para> -->
<para>
Bugs, potential bugs, and development issues and questions should be filed as JBoss support cases via the JBoss Customer Support Portal.
</para>
</important>
- <section id="sect-Release_Notes-_Introduction_-Overview">
- <title>Overview</title>
- <para>
- &PRODUCT; is the merge of two mature Java projects; JBoss Portal and eXo Portal. This new project takes the best of both offerings and incorporates them into a single j2ee deployment archive. The aim is to provide an intuitive user-friendly portal and a framework to address the needs of today's Web 2.0 applications.
- </para>
- <para>
- Further, by integrating best-of-breed open source frameworks such as JBoss Seam, Hibernate, Tomcat, and JBoss Cache the Platform takes advantage of innovations in the open source community. As well, &PRODUCT; is fully tested and supported by Red Hat, and is certified to work on many leading enterprise hardware and software products.
- </para>
- </section>
-
+ <para>
+ &PRODUCT; is the merge of two mature Java projects; JBoss Portal and eXo Portal. This new project takes the best of both offerings and incorporates them into a single j2ee deployment archive. The aim is to provide an intuitive user-friendly portal and a framework to address the needs of today's Web 2.0 applications.
+ </para>
+ <para>
+ Further, by integrating best-of-breed open source frameworks such as JBoss Seam, Hibernate, Tomcat, and JBoss Cache the Platform takes advantage of innovations in the open source community. As well, &PRODUCT; is fully tested and supported by Red Hat, and is certified to work on many leading enterprise hardware and software products.
+ </para>
</section>
-
- <section id="sect-Release_Notes-Architecture_of_PRODUCT_VERSION">
- <title>Architecture of &PRODUCT; &VERSION;</title>
+
+ <section>
+ <title>New Features</title>
<para>
- This is beta software and the final component manifest and exact component versions are subject to change prior to General Availability.
+ ==> TODO: Input from Jason here
</para>
- <figure id="figu-Release_Notes-Features_in_PRODUCT_VERSION-EPP_5_Architecture">
- <title>EPP 5 Architecture</title>
- <mediaobject>
- <imageobject role="html">
- <imagedata align="center" fileref="images/epp5_architecture.png" format="PNG" scale="100" width="444" />
- </imageobject>
- <imageobject role="fo">
- <imagedata align="center" contentwidth="150mm" fileref="images/epp5_architecture.png" format="PNG" width="444" />
- </imageobject>
- </mediaobject>
- </figure>
</section>
-<!-- <section id="sect-Release_Notes-Components_in_PRODUCT_VERSION">
- <title>Components in &PRODUCT; &VERSION;</title>
+
+ <section id="sect-Release_Notes-Architecture_of_PRODUCT_VERSION">
+ <title>Component Versions</title>
<para>
- This is beta software and the final component manifest and exact component versions are subject to change prior to General Availability.
+ This section details the versions of the components which create the JBoss Enterprise Portal Platform 5.0.0.
</para>
- <section id="sect-Release_Notes-Components_in_PRODUCT_VERSION-Component_1">
- <title>Component_1</title>
- <para>
- Description Component_1
- </para>
- </section>
-
- <section id="sect-Release_Notes-Components_in_PRODUCT_VERSION-Component_2">
- <title>Component_2</title>
- <para>
- Description of Component_2
- </para>
- </section>
- </section> -->
+ <table>
+ <title>JBoss Enterprise Portal Platform Component Versions</title>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>
+ Component
+ </entry>
+ <entry>
+ Version
+ </entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>
+ GateIn
+ </entry>
+ <entry>
+ ??
+ </entry>
+ </row>
+ <row>
+ <entry>
+ Portlet Bridge
+ </entry>
+ <entry>
+ ???
+ </entry>
+ </row>
+ <row>
+ <entry>
+ Site Publisher
+ </entry>
+ <entry>
+ With link to Tech Preview section.
+ </entry>
+ </row>
+ <row>
+ <entry>
+ ==> TODO: Input from Luc/Thomas here
+ </entry>
+ <entry>
+ Please. :D
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ </section>
<section id="sect-Release_Notes-Certified_Environments">
- <title>Certified Environments</title>
+ <title>Installation</title>
<para>
- This section details the environments &PRODUCT; &VERSION; is certified to run on.
+ The JBoss Enterprise Portal Platform Installation Guide contains details of software and hardware requirements as well as detailed installation instructions.
</para>
+ <para>
+ The Installation Guide can be found online at <ulink type="http" url="http://www.redhat.com/docs/en-US/JBoss_Enterprise_Portal_Platform/">www.redhat.com</ulink>
+ </para>
+<!-- <para>
+ The environments &PRODUCT; &VERSION; is certified to run on are:
+ </para>
<table id="tabl-Release_Notes-Certified_Environments-Java_Virtual_Machine_Support">
<title>Java Virtual Machine Support</title>
<tgroup cols="2">
@@ -373,255 +398,56 @@
</row>
</tbody>
</tgroup>
- </table>
+ </table> -->
</section>
-
- <section id="sect-Release_Notes-Installation_Notes">
- <title>Installing and Running</title>
- <para>
- You must have adequate disk space to install JDK and &PRODUCT; while also allowing enough space for your applications. You must have a working installation of JDK 1.6.
- </para>
- <!-- <para>
- For the latest information on supported Operating System / JVM combinations, supported Database platforms and current information on the revision level of included components, refer to the installation guide available online from <ulink url="http://www.redhat.com/docs/en-US/JBoss_Enterprise_Application_Platform/">http://www.redhat.com/docs/en-US/JBoss_Enterprise_Application_Platform/</ulink>. The installation guide also details instructions to install and verify the installation of the JBoss Enterprise Application Platform.
- </para> --><!-- <important>
- <formalpara>
- <title>Microsoft Windows</title>
- <para>
- When running the command <command>service.bat install</command> the following output may occur:
-<screen>
-'jbosssvc.exe' is not recognized as an internal or external command, operable program or batch file.
-Service JBoss Application Server 5.1 installed
-</screen>
- This is misleading as the service was not installed correctly. To be able to install correctly run the following commands in sequence:
-<programlisting>
-set PATH=D:\jcastro\EAP\CR2\jboss-eap-5.0.0.CR2\jboss-eap-5.0\native\sbin;%PATH%;
-
-service.bat install
-</programlisting>
- The message indicating that the service was installed will appear again but without an error. In this case the service has been correctly installed. This will be fixed in the General Availability release.
- </para>
- </formalpara>
- </important> -->
- <procedure>
- <step>
- <para>
- Unzip the downloaded <filename>.zip</filename> file to the directory of your choice on any operating system that supports the zip format.
- </para>
-
-<programlisting>unzip jboss-epp-5.0.0-Beta.zip
-</programlisting>
- <para>
- Extract the archive contents into the location of your choice. You can do this using the JDK jar tool (or any other ZIP extraction tool). In the example below it is assumed that you downloaded the <filename>.zip</filename> file to the <filename>/jboss</filename> directory.
- </para>
-<programlisting>[usr]$ cd /jboss
-
-[usr]$ jar -xvf jboss-epp-5.0.0-Beta.zip
-</programlisting>
+ <section id="sect-Release_Notes-Product_Support_and_License_Website_Links">
+ <title> Product Support and License Website Links </title>
+ <formalpara id="form-Release_Notes-Product_Support_and_License_Website_Links-Support_Processes">
+ <title>Support Processes</title>
<para>
- You should now have a directory called <filename>jboss-epp-5.0</filename>.
+ <ulink url="http://www.redhat.com/support/process/">http://www.redhat.com/support/process/</ulink>
</para>
- </step>
- <step>
+ </formalpara>
+ <formalpara id="form-Release_Notes-Product_Support_and_License_Website_Links-Production_Support_Scope_of_Coverage">
+ <title> Production Support Scope of Coverage </title>
<para>
- The <literal>JBOSS_HOME</literal> environment variable will now need to be set:
+ <ulink url="http://www.redhat.com/support/policy/soc/production">http://www.redhat.com/support/policy/soc/production</ulink>
</para>
- <formalpara id="form-Release_Notes-Install-On_a_Linux_Platform">
- <title>On a Linux Platform</title>
- <para>
- Create an environment variable that points to the installation directory called <filename>jboss-as</filename> and name it <literal>JBOSS_HOME</literal>.
- </para>
- </formalpara>
-<!--
-<para>
- Add <literal>$JBOSS_HOME/bin</literal> to the system path to be able to run the server from the command line. You can do this by adding the following lines to the <filename>.bashrc</filename> file in your home directory.
- </para>
--->
-<programlisting># In this example /jboss/jboss-epp-5.0/jboss-as/ is the install directory
-
-JBOSS_HOME=/jboss/jboss-epp-5.0/jboss-as/
-export JBOSS_HOME
-</programlisting>
+ </formalpara>
+ <formalpara id="form-Release_Notes-Product_Support_and_License_Website_Links-Production_Support_Service_Level_Agreement">
+ <title> Production Support Service Level Agreement </title>
<para>
- Set this variable for the user accounts that will run the server.
+ <ulink url="http://www.redhat.com/support/policy/sla/production/">http://www.redhat.com/support/policy/sla/production/</ulink>
</para>
- <formalpara id="form-Release_Notes-Install-On_Microsoft_Windows">
- <title>On Microsoft Windows</title>
- <para>
- Create an environment variable that points to the installation directory (for example, <filename>C:\jboss\jboss-epp-5.0\jboss-as\</filename>) and name it <literal>JBOSS_HOME</literal>.
- </para>
- </formalpara>
-<!--
- <para>
- Add <filename>bin</filename> to the path to be able to run the server from the command line (for example, <filename>C:\Program Files\jboss\jboss-epp-5.0\jboss-as\bin</filename>). To do this, open the <guimenu>Control Panel</guimenu> from the <guimenu>Start Menu</guimenu>, switch to <guimenuitem>Classic View</guimenuitem> if necessary, open the <guimenuitem>System Control Panel</guimenuitem> applet, select the <guimenuitem>Advanced</guimenuitem> Tab, and click on the <guibutton>Environment Variables</guibutton> button.
- </para>
--->
- </step>
- <step>
+ </formalpara>
+ <formalpara id="form-Release_Notes-Product_Support_and_License_Website_Links-Developer_Support_Scope_of_Coverage">
+ <title> Developer Support Scope of Coverage </title>
<para>
- To start &PRODUCT; run the following commands depending on your environment:
+ <ulink url="http://www.redhat.com/support/policy/soc/developer/">http://www.redhat.com/support/policy/soc/developer/</ulink>
</para>
- <formalpara id="form-Release_Notes-run-On_a_Linux_Platform">
- <title>On a Linux Platform</title>
- <para>
-<programlisting>[usr]:/$ cd $JBOSS_HOME/bin/
-
-[usr]:~/jboss/jboss-epp-5.0/jboss-as/bin$ ./run.sh
-</programlisting>
- </para>
- </formalpara>
- <formalpara id="form-Release_Notes-run-On_Microsoft_Windows">
- <title>On Microsoft Windows</title>
- <para>
-<programlisting>c:\>cd %JBOSS_HOME%/bin
-
-c:\jboss\jboss-epp-5.0\jboss-as\bin$ run.bat
-</programlisting>
- </para>
- </formalpara>
- </step>
- </procedure>
-
- <para>
- The bootstrap sequence should appear as follows:
- </para>
-<programlisting>=========================================================================
-
- JBoss Bootstrap Environment
-
- JBOSS_HOME: /jboss/jboss-epp-5.0/jboss-as
-
- JAVA: /usr/java/jdk1.6.0_18/bin/java
-
- JAVA_OPTS: -Dprogram.name=run.sh -server -Xms1303m -Xmx1303m -XX:MaxPermSize=256m -Dorg.jboss.resolver.warning=true -Dsun.rmi.dgc.client.gcInterval=3600000 -Dsun.rmi.dgc.server.gcInterval=3600000 -Dsun.lang.ClassLoader.allowArraySyntax=true -Djava.net.preferIPv4Stack=true
-
- CLASSPATH: /jboss/jboss-epp-5.0/jboss-as/bin/run.jar:/usr/java/jdk1.6.0_18/lib/tools.jar
-
-=========================================================================
-
-16:11:21,373 INFO [ServerImpl] Starting JBoss (Microcontainer)...
-16:11:21,374 INFO [ServerImpl] Release ID: JBoss [EAP] 5.0.0.GA (build: SVNTag=JBPAPP_5_0_0_GA date=200910202128)
-...
-[lots of logs here]
-...
-16:13:29,023 INFO [AjpProtocol] Starting Coyote AJP/1.3 on ajp-127.0.0.1-8009
-16:13:29,043 INFO [ServerImpl] JBoss (Microcontainer) [5.0.0.GA (build: SVNTag=JBPAPP_5_0_0_GA date=200910202128)] Started in 0m:24s:396ms
-</programlisting>
- <para>
- You can now access the portal in your preferred web browser with this address: <ulink url="http://localhost:8080/portal">http://localhost:8080/portal</ulink>. Enjoy!
- </para>
-
- </section>
-
- <!-- <section id="upgrade">
- <title>Upgrading from JBoss Enterprise Application Platform 4.3.0.CP05</title>
- <formalpara>
- <title>Using CSP/JON</title>
- <para>Refer to <ulink url="https://network.jboss.com/confluence/display/DOC/Installing+a+Patch">https://network.jboss.com/confluence/display/DOC/Installing+a+Patch</ulink> for instructions on installing a Cumulative Patch.</para>
- </formalpara>
- </section> --><!-- <section id="Important_Notes">
- <title>Important Notes</title> --><!-- <section id="Seam_Applications">
- <title>
- Running the example Seam Applications
- </title>
+ </formalpara>
+ <formalpara id="form-Release_Notes-Product_Support_and_License_Website_Links-Developer_Support_Service_Level_Agreement">
+ <title> Developer Support Service Level Agreement </title>
<para>
- It is recommended to run the example Seam applications that are included with the documentation using the production configuration. Using another configuration may result in memory issues. Note that the default configuration for the server to start with, if no other configuration is specified, is the production configuration.
+ <ulink url="http://www.redhat.com/support/policy/sla/developer/">http://www.redhat.com/support/policy/sla/developer/</ulink>
</para>
- <warning>
- <para>
- To avoid memory issues, adjust the memory settings before deploying the applications. You can do this by updating <literal>JAVA_OPTS</literal> settings in the file <filename>JBOSS_DIST/jboss-as/server/production/run.conf</filename> with these recommended values:
-<programlisting>
--Xms1303m -Xmx1303m -XX:PermSize=256m -XX:MaxPermSize=256m
-</programlisting>
- </para>
- </warning>
+ </formalpara>
+ <formalpara id="form-Release_Notes-Product_Support_and_License_Website_Links-Product_Update_and_Support_Policy_by_Product">
+ <title> Product Update and Support Policy by Product </title>
<para>
- Refer to the "Seam Reference Guide" included in the documentation set (<filename>JBOSS_DIST/doc/seam/Seam_Reference_Guide.pdf</filename>) for important information regarding the deployment of Seam examples and detailed information on developing applications using Seam.
- <note>
- <para>Seam version used in this release is 1.2.1.GA.</para>
- </note>
+ <ulink url="http://www.redhat.com/security/updates/jboss_notes/">http://www.redhat.com/security/updates/jboss_notes/</ulink>
</para>
- </section> --><!-- </section> --><!-- <section id="Default_Startup_Profile">
- <title>
- Default Startup Profile
- </title>
- <para>
- The default startup profile is <filename>default</filename> which is a base Java EE 5 server profile containing a default set of services. It contains the most frequently used services required to deploy a Java EE 5 application. It does not include the JAXR service, the IIOP service, or any of the clustering services.
- </para>
- <para>
- The <filename>default</filename> profile is not intended for production use or for the running of load, stress, availability or performance tests. In addition, the performance of this Beta2 release does not necessarily represent the final release.
- </para>
- </section> -->
-
-<!-- <section id="sect-Release_Notes-_Source_Files_">
- <title> Source Files </title>
- <formalpara id="form-Release_Notes-_Source_Files_-SRPMs">
- <title>SRPMs</title>
- <para>
- <itemizedlist>
- <listitem>
- <para>
- <ulink url="ftp://ftp.redhat.com/pub/redhat/linux/updates/enterprise/5AS/en/JBEAP/SRPMS">New Link Here?</ulink>
- </para>
- </listitem>
- <listitem>
- <para>
- <ulink url="ftp://ftp.redhat.com/pub/redhat/linux/updates/enterprise/5ES/en/JBEAP/SRPMS">New Link Here?</ulink>
- </para>
- </listitem>
- <listitem>
- <para>
- <ulink url="ftp://ftp.redhat.com/pub/redhat/linux/enterprise/5Server/en/JBEAP/SRPMS">New Link Here?</ulink>
- </para>
- </listitem>
- </itemizedlist>
- </para>
</formalpara>
- <formalpara id="form-Release_Notes-_Source_Files_-Source_ZIP">
- <title>Source ZIP</title>
+ <formalpara id="form-Release_Notes-Product_Support_and_License_Website_Links-JBoss_End_User_License_Agreement">
+ <title> JBoss End User License Agreement </title>
<para>
- <itemizedlist>
- <listitem>
- <para>
- <ulink url="ftp://ftp.redhat.com/pub/redhat/jbeap/5.0.0/en/source/jboss-eap-src-5.0.0...">New Link Here?</ulink>
- </para>
- </listitem>
- </itemizedlist>
+ <ulink url="http://www.redhat.com/licenses/jboss_eula.html">http://www.redhat.com/licenses/jboss_eula.html</ulink>
</para>
</formalpara>
- </section> -->
- <section id="sect-Release_Notes-_Product_Support_">
- <title> Product Support </title>
- <para>
- This release is beta software. This release should not be used in production.
- </para>
- <!-- <para>
- Red Hat will provide Developer Support (2-day SLA) for existing customers for this release as long as your support issue is within the context of applications running on or with JBoss Enterprise Application Platform.
-
- </para>
- <para>
- The software is only available for download by existing customers from the JBoss Customer Support Portal (https://www.redhat.com/apps/support/).
- </para> -->
- <para>
- Bugs, potential bugs, and development issues and/or questions should be filed as JBoss support cases via the JBoss Customer Support Portal. You may access the CSP at <ulink url="https://www.redhat.com/wapps/sso/jboss/login.html">https://www.redhat.com/wapps/sso/jboss/login.html</ulink>
- </para>
- <!-- <important>
- <formalpara>
- <title>Red Hat Enterprise Linux</title>
- <para>
- The provided <filename>run.sh</filename> start script will not find JBoss Web Native libraries on Red Hat Enterprise Linux distributions due to a bug in this Beta release. It is recommended for this Beta release that you download and replace this <filename>run.sh</filename> file with the fixed version located here: <ulink url="https://jira.jboss.org/jira/browse/JBPAPP-2439">https://jira.jboss.org/jira/browse/JBPAPP-2439</ulink>. This issue will be fixed for the General Availability release.
- </para>
- </formalpara>
- <formalpara>
- <title>Microsoft Windows</title>
- <para>
- When running this Beta release on windows an error will occur upon running the server. This is due to two small spelling errors in the <filename>run.bat</filename> file. It is recommended for this Beta release that you download and replace this <filename>run.bat</filename> file with the fixed version located here: <ulink url="https://jira.jboss.org/jira/browse/JBPAPP-2438">https://jira.jboss.org/jira/browse/JBPAPP-2438</ulink>. This fix will be included in the General Availability release.
- </para>
- </formalpara>
- </important> -->
</section>
-
-<!-- <section id="sect-Release_Notes-_Documentation_">
+
+ <section id="sect-Release_Notes-_Documentation_">
<title> Documentation </title>
<para>
Visit <ulink url="http://www.redhat.com/docs/en-US/">http://www.redhat.com/docs/en-US</ulink> for further documentation regarding &PRODUCT;.
@@ -660,10 +486,11 @@
<para>
The online documentation will be updated as necessary so be sure to check back, especially when a new version of the &PRODUCT; is released.
</para>
- </section> -->
+ </section>
+
-<!-- <section id="Issues-fixed-in-this-release">
+ <section id="Issues-fixed-in-this-release">
<title>
Issues fixed in this release
</title>
@@ -672,162 +499,50 @@
Following is a list of issues fixed in this release:
</para>
<formalpara>
- <title>JBoss Messaging</title>
+ <title>Component 1</title>
<para>
<itemizedlist>
<listitem>
<para>
-
+ Issues fixed.
</para>
</listitem>
</itemizedlist>
</para>
</formalpara>
<formalpara>
- <title>JBoss Cache</title>
+ <title>Component 2</title>
<para>
<itemizedlist>
<listitem>
<para>
-
+ Issues fixed.
</para>
</listitem>
</itemizedlist>
</para>
</formalpara>
<formalpara>
- <title>JBoss Remoting</title>
+ <title>Etc</title>
<para>
<itemizedlist>
<listitem>
<para>
-
+ Issues fixed.
</para>
</listitem>
</itemizedlist>
</para>
</formalpara>
- <formalpara>
- <title>JBoss Web</title>
- <para>
- <itemizedlist>
- <listitem>
- <para>
-
- </para>
- </listitem>
- </itemizedlist>
- </para>
- </formalpara>
- <formalpara>
- <title>JBoss Web Services</title>
- <para>
- <itemizedlist>
- <listitem>
- <para>
-
- </para>
- </listitem>
- </itemizedlist>
- </para>
- </formalpara>
- <formalpara>
- <title>JBoss Seam</title>
- <para>
- <itemizedlist>
- <listitem>
- <para>
-
- </para>
- </listitem>
- </itemizedlist>
- </para>
- </formalpara>
- <formalpara>
- <title>JBoss Hibernate</title>
- <para>
- <itemizedlist>
- <listitem>
- <para>
- </para>
- </listitem>
- </itemizedlist>
- </para>
- </formalpara>
- <formalpara>
- <title>JBoss Transaction Service (JBossTS)</title>
- <para>
- <itemizedlist>
- <listitem>
- <para>
-
- </para>
- </listitem>
- </itemizedlist>
- </para>
- </formalpara>
- <formalpara>
- <title>Security Issues</title>
- <para>
- <itemizedlist>
- <listitem>
- <para>
-
- </para>
- </listitem>
- </itemizedlist>
- </para>
- </formalpara>
- <formalpara>
- <title>Documentation</title>
- <para>
- <itemizedlist>
- <listitem>
- <para>
-
- </para>
- </listitem>
- <listitem>
- <para>
-
- </para>
- </listitem>
- <listitem>
- <para>
-
- </para>
- </listitem>
- <listitem>
- <para>
-
- </para>
- </listitem>
- </itemizedlist>
- </para>
- </formalpara>
- <formalpara>
- <title>Core Server</title>
- <para>
- <itemizedlist>
- <listitem>
- <para>
-
- </para>
- </listitem>
- </itemizedlist>
- </para>
- </formalpara>
- </section> -->
+ </section>
+
<section id="sect-Release_Notes-_Known_Issues_with_this_release_">
<title> Known Issues with this release </title>
<para>
- The link below provides a list of issues (Bugs and Features) being tracked at the time of release:
+ The list below provides a list of issues being tracked at the time of release:
</para>
- <para>
- <ulink url="https://jira.jboss.org/jira/secure/IssueNavigator.jspa?reset=true&&am...">JIRA Issue Tracker</ulink>
- </para>
-<!-- <formalpara id="form-Release_Notes-_Known_Issues_with_this_release_-General_Known_Issues">
+ <formalpara id="form-Release_Notes-_Known_Issues_with_this_release_-General_Known_Issues">
<title>General Known Issues</title>
<para>
<itemizedlist>
@@ -870,9 +585,46 @@
</listitem>
</itemizedlist>
</para>
- </formalpara>-->
- </section>
-
+ </formalpara>
+ </section>
+
+ <section>
+ <title>Migration from JBoss Portal 4.3</title>
+ <para>
+ -- This is a real issue for EPP 5.0.
+ -- Need PM type overview of types of challenges, context,
+ and such with diplomatic wording.
+ -- Also need either technical details, or pointer to where
+ KBase or other help will be, or recommendation to
+ pay for professional services, or...
+ -- Ref: SOA500 RN has a chapter 9 like this.
+ ==> TODO: Jason can you offer guidance on this section?
+ </para>
+ </section>
+
+ <section id="Tech-previews">
+ <title>Technology Previews</title>
+
+ <para>
+ This section describes the Technology Preview features released alongside JBoss Enterprise Web Platform, their installation, and any known issues.
+ </para>
+
+ <warning>
+ <title>Technology Preview</title>
+ <para>
+ Technology Preview features are not fully supported under Red Hat subscription level agreements (SLAs), may not be functionally complete, and are not intended for production use. However, these features provide early access to upcoming product innovations, enabling customers to test functionality and provide feedback during the development process. As Red Hat considers making future iterations of Technology Preview features generally available, we will provide commercially reasonable efforts to resolve any reported issues that customers experience when using these features.
+ </para>
+ </warning>
+ <section>
+ <title>Site Publisher</title>
+ <para>
+ -- Required if Site Publisher Tech Preview included
+ -- Ref: EAP500 [1] has chapter 9 for CXFF and mod_cluster
+ ==> TODO: Jason guidance
+
+ </para>
+ </section>
+ </section>
<xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</article>
14 years, 1 month
- 1
- 0
gatein SVN: r3033 - in portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US: modules/AuthenticationAndIdentity and 3 other directories.
by do-not-reply＠jboss.org
Author: smumford
Date: 2010-05-10 22:41:02 -0400 (Mon, 10 May 2010)
New Revision: 3033
Modified:
portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/Book_Info.xml
portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/AuthenticationAndIdentity/PredefinedUserConfiguration.xml
portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/GadgetDevelopment/SetupGadgetServer.xml
portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge/configuration.xml
portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortletDevelopment/Standard.xml
Log:
JBEPP-276: Check in with Publican workaround. Issue: https://bugzilla.redhat.com/show_bug.cgi?id=590933
Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/Book_Info.xml
===================================================================
--- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/Book_Info.xml 2010-05-10 22:39:07 UTC (rev 3032)
+++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/Book_Info.xml 2010-05-11 02:41:02 UTC (rev 3033)
@@ -12,7 +12,7 @@
<pubsnumber>1.0</pubsnumber>
<abstract>
<para>
- This Reference Guide is a high-level usage document. It deals with more advanced topics than the Install and User guides, adding new content or taking concepts discussed in the earlier documents further. It aims to provide supporting documentation for advanced users of the &PRODUCT; product. Its primary focus is on advanced use of the product and it assumes an intermediate or advanced knowledge of the technology and terms.
+ This Reference Guide is a high-level usage document. It deals with more advanced topics than the Installation and User Guides, adding new content or taking concepts discussed in the earlier documents further. It aims to provide supporting documentation for advanced users of the &PRODUCT; product. Its primary focus is on advanced use of the product and it assumes an intermediate or advanced knowledge of the technology and terms.
</para>
</abstract>
<corpauthor>
Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/AuthenticationAndIdentity/PredefinedUserConfiguration.xml
===================================================================
--- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/AuthenticationAndIdentity/PredefinedUserConfiguration.xml 2010-05-10 22:39:07 UTC (rev 3032)
+++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/AuthenticationAndIdentity/PredefinedUserConfiguration.xml 2010-05-11 02:41:02 UTC (rev 3033)
@@ -36,41 +36,40 @@
</para>
</note>
-<programlisting role="XML"><field name="membershipType">
- <collection type="java.util.ArrayList">
- <value>
- <object type="org.exoplatform.services.organization.OrganizationConfig$MembershipType">
- <field name="type">
- <string>member</string>
- </field>
- <field name="description">
- <string>member membership type</string>
- </field>
- </object>
- </value>
- <value>
- <object type="org.exoplatform.services.organization.OrganizationConfig$MembershipType">
- <field name="type">
- <string>owner</string>
- </field>
- <field name="description">
- <string>owner membership type</string>
- </field>
- </object>
- </value>
- <value>
- <object type="org.exoplatform.services.organization.OrganizationConfig$MembershipType">
- <field name="type">
- <string>validator</string>
- </field>
- <field name="description">
- <string>validator membership type</string>
- </field>
- </object>
- </value>
- </collection>
-</field>
-</programlisting>
+<programlisting language="XML" role="XML"><![CDATA[<field name="membershipType">
+ <collection type="java.util.ArrayList">
+ <value>
+ <object type="org.exoplatform.services.organization.OrganizationConfig$MembershipType">
+ <field name="type">
+ <string>member</string>
+ </field>
+ <field name="description">
+ <string>member membership type</string>
+ </field>
+ </object>
+ </value>
+ <value>
+ <object type="org.exoplatform.services.organization.OrganizationConfig$MembershipType">
+ <field name="type">
+ <string>owner</string>
+ </field>
+ <field name="description">
+ <string>owner membership type</string>
+ </field>
+ </object>
+ </value>
+ <value>
+ <object type="org.exoplatform.services.organization.OrganizationConfig$MembershipType">
+ <field name="type">
+ <string>validator</string>
+ </field>
+ <field name="description">
+ <string>validator membership type</string>
+ </field>
+ </object>
+ </value>
+ </collection>
+</field>]]></programlisting>
</section>
<section id="sect-Reference_Guide-Predefined_User_Configuration-Groups">
@@ -79,44 +78,43 @@
The predefined groups are specified in the <emphasis role="bold">group</emphasis> field of the <emphasis role="bold">OrganizationConfig</emphasis> plugin parameter.
</para>
-<programlisting role="XML"><field name="group">
- <collection type="java.util.ArrayList">
- <value>
- <object type="org.exoplatform.services.organization.OrganizationConfig$Group">
- <field name="name">
- <string>portal</string>
- </field>
- <field name="parentId">
- <string></string>
- </field>
- <field name="type">
- <string>hierachy</string>
- </field>
- <field name="description">
- <string>the /portal group</string>
- </field>
- </object>
- </value>
- <value>
- <object type="org.exoplatform.services.organization.OrganizationConfig$Group">
- <field name="name">
- <string>community</string>
- </field>
- <field name="parentId">
- <string>/portal</string>
- </field>
- <field name="type">
- <string>hierachy</string>
- </field>
- <field name="description">
- <string>the /portal/community group</string>
- </field>
- </object>
- </value>
+<programlisting language="XML" role="XML"><![CDATA[<field name="group">
+ <collection type="java.util.ArrayList">
+ <value>
+ <object type="org.exoplatform.services.organization.OrganizationConfig$Group">
+ <field name="name">
+ <string>portal</string>
+ </field>
+ <field name="parentId">
+ <string></string>
+ </field>
+ <field name="type">
+ <string>hierachy</string>
+ </field>
+ <field name="description">
+ <string>the /portal group</string>
+ </field>
+ </object>
+ </value>
+ <value>
+ <object type="org.exoplatform.services.organization.OrganizationConfig$Group">
+ <field name="name">
+ <string>community</string>
+ </field>
+ <field name="parentId">
+ <string>/portal</string>
+ </field>
+ <field name="type">
+ <string>hierachy</string>
+ </field>
+ <field name="description">
+ <string>the /portal/community group</string>
+ </field>
+ </object>
+ </value>
...
- </collection>
-</field>
-</programlisting>
+ </collection>
+</field>]]></programlisting>
</section>
<section id="sect-Reference_Guide-Predefined_User_Configuration-Users">
@@ -125,32 +123,31 @@
The predefined users are specified in the <emphasis role="bold">membershipType</emphasis> field of the <emphasis role="bold">OrganizationConfig</emphasis> plugin parameter.
</para>
-<programlisting role="XML"><field name="user">
- <collection type="java.util.ArrayList">
- <value>
- <object type="org.exoplatform.services.organization.OrganizationConfig$User">
- <field name="userName"><string>root</string></field>
- <field name="password"><string>exo</string></field>
- <field name="firstName"><string>root</string></field>
- <field name="lastName"><string>root</string></field>
- <field name="email"><string>exoadmin@localhost</string></field>
- <field name="groups"><string>member:/admin,member:/user,owner:/portal/admin</string></field>
- </object>
- </value>
- <value>
- <object type="org.exoplatform.services.organization.OrganizationConfig$User">
- <field name="userName"><string>exo</string></field>
- <field name="password"><string>exo</string></field>
- <field name="firstName"><string>site</string></field>
- <field name="lastName"><string>site</string></field>
- <field name="email"><string>exo@localhost</string></field>
- <field name="groups"><string>member:/user</string></field>
- </object>
- </value>
+<programlisting language="XML" role="XML"><![CDATA[<field name="user">
+ <collection type="java.util.ArrayList">
+ <value>
+ <object type="org.exoplatform.services.organization.OrganizationConfig$User">
+ <field name="userName"><string>root</string></field>
+ <field name="password"><string>exo</string></field>
+ <field name="firstName"><string>root</string></field>
+ <field name="lastName"><string>root</string></field>
+ <field name="email"><string>exoadmin@localhost</string></field>
+ <field name="groups"><string>member:/admin,member:/user,owner:/portal/admin</string></field>
+ </object>
+ </value>
+ <value>
+ <object type="org.exoplatform.services.organization.OrganizationConfig$User">
+ <field name="userName"><string>exo</string></field>
+ <field name="password"><string>exo</string></field>
+ <field name="firstName"><string>site</string></field>
+ <field name="lastName"><string>site</string></field>
+ <field name="email"><string>exo@localhost</string></field>
+ <field name="groups"><string>member:/user</string></field>
+ </object>
+ </value>
...
- </collection>
-</field>
-</programlisting>
+ </collection>
+</field>]]></programlisting>
</section>
<section id="sect-Reference_Guide-Predefined_User_Configuration-Plugin_for_monitoring_user_creation">
Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/GadgetDevelopment/SetupGadgetServer.xml
===================================================================
--- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/GadgetDevelopment/SetupGadgetServer.xml 2010-05-10 22:39:07 UTC (rev 3032)
+++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/GadgetDevelopment/SetupGadgetServer.xml 2010-05-11 02:41:02 UTC (rev 3033)
@@ -17,18 +17,17 @@
To do this, configure a parameter called <emphasis>gadgets.hostName</emphasis>. The value is the <emphasis>path/to/gadgetServer</emphasis> in <literal>GadgetRegisteryService</literal>:
</para>
-<programlisting><component>
- <key>org.exoplatform.application.gadget.GadgetRegistryService</key>
- <type>org.exoplatform.application.gadget.jcr.GadgetRegistryServiceImpl</type>
- <init-params>
- <value-param>
- <name>gadgets.hostName</name>
- <description>Gadget server url</description>
- <value>http://localhost:8080/GateInGadgetServer/gadgets/</value>
- </value-param>
- </init-params>
-</component>
-</programlisting>
+<programlisting language="XML" role="XML"><![CDATA[<component>
+ <key>org.exoplatform.application.gadget.GadgetRegistryService</key>
+ <type>org.exoplatform.application.gadget.jcr.GadgetRegistryServiceImpl</type>
+ <init-params>
+ <value-param>
+ <name>gadgets.hostName</name>
+ <description>Gadget server url</description>
+ <value>http://localhost:8080/GateInGadgetServer/gadgets/</value>
+ </value-param>
+ </init-params>
+</component>]]></programlisting>
<para>
It is also possible to have multiple rendering servers. This helps to balance the rendering load across multiple servers.
</para>
Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge/configuration.xml
===================================================================
--- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge/configuration.xml 2010-05-10 22:39:07 UTC (rev 3032)
+++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge/configuration.xml 2010-05-11 02:41:02 UTC (rev 3033)
@@ -86,9 +86,9 @@
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd"
version="2.4">
- ...-->
+ ...
<!-- This is optional parameters for a facelets based application -->
- <!-- <context-param>
+ <context-param>
<param-name>org.ajax4jsf.VIEW_HANDLERS</param-name>
<param-value>org.jboss.portletbridge.application.FaceletPortletViewHandler</param-value>
</context-param>
Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortletDevelopment/Standard.xml
===================================================================
--- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortletDevelopment/Standard.xml 2010-05-10 22:39:07 UTC (rev 3032)
+++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortletDevelopment/Standard.xml 2010-05-11 02:41:02 UTC (rev 3033)
@@ -3,6 +3,8 @@
<!ENTITY % BOOK_ENTITIES SYSTEM "../../Reference_Guide.ent">
%BOOK_ENTITIES;
]>
+
+
<chapter id="chap-Reference_Guide-Portlet_Primer">
<title>Portlet Primer</title>
<section id="sect-Reference_Guide-Portlet_Primer-JSR_168_and_JSR_286_overview">
@@ -157,7 +159,7 @@
<para>
Create a new portal page and add the portlet to it.
</para>
-<!-- This image needs to be updated to RH skinned version of Portal. Unable to do this. SM -->
+
<mediaobject>
<imageobject role="html">
<imagedata fileref="images/PortletDevelopment/Standard/first_portlet/deployed.png" format="PNG" align="center" scale="100" />
@@ -305,6 +307,7 @@
<para>
Below is an example of the <filename>SimplestHelloWorldPortlet/WEB-INF/portlet.xml</filename> file. This file must adhere to its definition in the JSR-286 Portlet Specification. More than one portlet application may be defined in this file:
</para>
+
<programlistingco>
<areaspec>
<area coords="8" id="area-Reference_Guide-Deploying_your_first_Portlet-Application_Descriptors.portletname" />
@@ -312,11 +315,10 @@
<area coords="12" id="area-Reference_Guide-Deploying_your_first_Portlet-Application_Descriptors.supports" />
<area coords="15" id="area-Reference_Guide-Deploying_your_first_Portlet-Application_Descriptors.portletinfo" />
</areaspec>
-
-<programlisting language="XML" role="XML"><![CDATA[<portlet-app xmlns="http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd"
+<!-- TODO XML highlight once issue https://bugzilla.redhat.com/show_bug.cgi?id=590933 resolved-->
+<programlisting><![CDATA[<portlet-app xmlns="http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xsi:schemaLocation="http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd
- http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd"
+ xsi:schemaLocation="http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd"
version="2.0">
<portlet>
<portlet-name>SimplestHelloWorldPortlet</portlet-name>
@@ -427,7 +429,6 @@
</para>
</step>
</procedure>
-<!-- This Image needs to be updated with RH Portal skin. Unable to action this. SM -->
<mediaobject>
<imageobject role="html">
<imagedata fileref="images/PortletDevelopment/Standard/jsp_portlet/output.png" format="PNG" align="center" scale="100" />
@@ -483,8 +484,8 @@
<area coords="25" id="area-Reference_Guide-JavaServer_Pages_Portlet_Example-Portlet_Class.requestDispatcher" />
<area coords="26" id="area-Reference_Guide-JavaServer_Pages_Portlet_Example-Portlet_Class.include" />
</areaspec>
-
-<programlisting language="Java" role="JAVA"><![CDATA[package org.gatein.portal.examples.portlets;
+<!-- TODO JAVA highlight once issue https://bugzilla.redhat.com/show_bug.cgi?id=590933 resolved-->
+<programlisting><![CDATA[package org.gatein.portal.examples.portlets;
import java.io.IOException;
@@ -551,8 +552,8 @@
<para>
The generic portlet that is inherited dispatches the different views to the methods: <literal>doView</literal> , <literal>doHelp</literal> and <literal>doEdit</literal>.
</para>
-
-<programlisting language="Java" role="JAVA"><![CDATA[...
+<!-- TODO JAVA highlight once issue https://bugzilla.redhat.com/show_bug.cgi?id=590933 resolved-->
+<programlisting><![CDATA[...
protected void doHelp(RenderRequest rRequest, RenderResponse rResponse) throws PortletException, IOException,
UnavailableException
{
@@ -584,8 +585,8 @@
<area coords="5" id="area-Reference_Guide-JavaServer_Pages_Portlet_Example-Portlet_Class.getActionParameter" />
<area coords="6" id="area-Reference_Guide-JavaServer_Pages_Portlet_Example-Portlet_Class.setRenderParameter" />
</areaspec>
-
-<programlisting language="Java" role="JAVA"><![CDATA[...
+<!-- TODO JAVA highlight once issue https://bugzilla.redhat.com/show_bug.cgi?id=590933 resolved-->
+<programlisting><![CDATA[...
public void processAction(ActionRequest aRequest, ActionResponse aResponse) throws PortletException, IOException,
UnavailableException
{
@@ -755,13 +756,12 @@
<area coords="21" id="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSF_example_using_the_JBoss_Portlet_Bridge.view" />
<area coords="26" id="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSF_example_using_the_JBoss_Portlet_Bridge.edit" />
<area coords="31" id="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSF_example_using_the_JBoss_Portlet_Bridge.help" />
- </areaspec>
-
-<programlisting language="XML" role="XML"><![CDATA[<?xml version="1.0" encoding="UTF-8"?>
+ </areaspec>
+<!-- TODO XML highlight once issue https://bugzilla.redhat.com/show_bug.cgi?id=590933 resolved-->
+<programlisting><![CDATA[<?xml version="1.0" encoding="UTF-8"?>
<portlet-app xmlns="http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xsi:schemaLocation="http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd
- http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd"
+ xsi:schemaLocation="http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd"
version="2.0">
<portlet>
<portlet-name>JSFHelloUserPortlet</portlet-name>
14 years, 1 month
- 1
- 0
gatein SVN: r3032 - in portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US: modules and 8 other directories.
by do-not-reply＠jboss.org
Author: smumford
Date: 2010-05-10 18:39:07 -0400 (Mon, 10 May 2010)
New Revision: 3032
Modified:
portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/Author_Group.xml
portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/Feedback.xml
portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced.xml
portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced/Foundations.xml
portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced/JCR.xml
portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced/JCR/architecture.xml
portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced/JCR/cluster-config.xml
portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced/JCR/configuration-persister.xml
portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced/JCR/configuration.xml
portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced/JCR/external-value-storages.xml
portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced/JCR/intro.xml
portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced/JCR/jbosscache-configuration-templates.xml
portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced/JCR/jbossts-transaction-service.xml
portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced/JCR/jdbc-data-container-config.xml
portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced/JCR/lock-manager-config.xml
portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced/JCR/multilanguage-support.xml
portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced/JCR/query-handler-config.xml
portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced/JCR/search-configuration.xml
portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced/JCR/statistics.xml
portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced/JCR/transaction-manager-lookup.xml
portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/AuthenticationAndIdentity.xml
portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/AuthenticationAndIdentity/AccessingUserProfile.xml
portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/AuthenticationAndIdentity/AuthenticationTokenConfiguration.xml
portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/AuthenticationAndIdentity/BackendConfiguration.xml
portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/AuthenticationAndIdentity/OrganizationAPI.xml
portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/AuthenticationAndIdentity/PredefinedUserConfiguration.xml
portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/AuthenticationAndIdentity/SSO.xml
portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Configuration.xml
portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Configuration/DatabaseConfiguration.xml
portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Configuration/EMailServiceConfiguration.xml
portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/GadgetDevelopment.xml
portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/GadgetDevelopment/Gadgets.xml
portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/GadgetDevelopment/SetupGadgetServer.xml
portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Introduction.xml
portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment.xml
portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalConfiguration.xml
portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalNavigationConfiguration.xml
portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalPermissionConfiguration.xml
portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/InternationalizationConfiguration.xml
portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/JavascriptConfiguration.xml
portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/JavascriptInterApplicationCommunication.xml
portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/PortalLifecycle.xml
portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/RTLFramework.xml
portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/Skinning.xml
portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/XMLResourceBundles.xml
portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortletDevelopment.xml
portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge.xml
portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge/configuration.xml
portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge/gettingstarted.xml
portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge/overview.xml
portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge/portlet_development.xml
portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortletDevelopment/Standard.xml
portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/WSRP.xml
Log:
JBEPP-276: Checking in broken version for Publican troubleshooting
Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/Author_Group.xml
===================================================================
--- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/Author_Group.xml 2010-05-10 16:57:51 UTC (rev 3031)
+++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/Author_Group.xml 2010-05-10 22:39:07 UTC (rev 3032)
@@ -23,6 +23,15 @@
<email>theute(a)redhat.com</email>
</editor>
<editor>
+ <firstname>Wesley</firstname>
+ <surname>Hales</surname>
+ <affiliation>
+ <shortaffil>Red Hat</shortaffil>
+ <orgdiv></orgdiv>
+ </affiliation>
+ <email>whales(a)redhat.com</email>
+ </editor>
+ <editor>
<firstname>Scott</firstname>
<surname>Mumford</surname>
<affiliation>
@@ -36,7 +45,7 @@
<orgname><emphasis role="bold"><ulink type="http" url="http://www.jboss.org/gatein/">GateIn</ulink></emphasis> and <emphasis role="bold"><ulink type="http" url="http://www.exoplatform.com/portal/public/website/">Exo Platform</ulink></emphasis></orgname>
<orgdiv>Documentation Teams</orgdiv>
</affiliation>
- <contrib>Original product documentation by:</contrib>
+ <contrib>Based on original product documentation by:</contrib>
</othercredit>
</authorgroup>
Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/Feedback.xml
===================================================================
--- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/Feedback.xml 2010-05-10 16:57:51 UTC (rev 3031)
+++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/Feedback.xml 2010-05-10 22:39:07 UTC (rev 3032)
@@ -10,7 +10,7 @@
<secondary>contact information for this manual</secondary>
</indexterm>
<para>
- If you find a typographical error in this manual, or if you have thought of a way to make this manual better, we would love to hear from you! Please submit a report in Bugzilla: <ulink url="http://bugzilla.redhat.com/bugzilla/">http://bugzilla.redhat.com/bugzilla/</ulink> against the product <application>&PRODUCT;.</application>
+ If you find a typographical error in this manual, or if you have thought of a way to make this manual better, we would love to hear from you! Please submit a report in Bugzilla: <ulink url="http://bugzilla.redhat.com/bugzilla/">http://bugzilla.redhat.com/bugzilla/</ulink> against the product <application>&PRODUCT;</application>.
</para>
<para>
When submitting a bug report, be sure to mention the manual's identifier: <citetitle>&BOOKID;</citetitle>
Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced/Foundations.xml
===================================================================
--- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced/Foundations.xml 2010-05-10 16:57:51 UTC (rev 3031)
+++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced/Foundations.xml 2010-05-10 22:39:07 UTC (rev 3032)
@@ -1,6 +1,6 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "../../Reference_Guide.ent">
%BOOK_ENTITIES;
]>
<chapter id="chap-Reference_Guide-Foundations">
Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced/JCR/architecture.xml
===================================================================
--- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced/JCR/architecture.xml 2010-05-10 16:57:51 UTC (rev 3031)
+++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced/JCR/architecture.xml 2010-05-10 22:39:07 UTC (rev 3032)
@@ -1,6 +1,6 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "../../../Reference_Guide.ent">
%BOOK_ENTITIES;
]>
<section id="sect-Reference_Guide-Basic_concepts_of_eXoJCR">
Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced/JCR/cluster-config.xml
===================================================================
--- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced/JCR/cluster-config.xml 2010-05-10 16:57:51 UTC (rev 3031)
+++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced/JCR/cluster-config.xml 2010-05-10 22:39:07 UTC (rev 3032)
@@ -1,6 +1,6 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "../../../Reference_Guide.ent">
%BOOK_ENTITIES;
]>
<section id="sect-Reference_Guide-Configuring_JBoss_AS_with_eXo_JCR_in_cluster">
Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced/JCR/configuration-persister.xml
===================================================================
--- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced/JCR/configuration-persister.xml 2010-05-10 16:57:51 UTC (rev 3031)
+++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced/JCR/configuration-persister.xml 2010-05-10 22:39:07 UTC (rev 3032)
@@ -1,6 +1,6 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "../../../Reference_Guide.ent">
%BOOK_ENTITIES;
]>
<section id="sect-Reference_Guide-JCR_Configuration_persister">
Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced/JCR/configuration.xml
===================================================================
--- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced/JCR/configuration.xml 2010-05-10 16:57:51 UTC (rev 3031)
+++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced/JCR/configuration.xml 2010-05-10 22:39:07 UTC (rev 3032)
@@ -1,6 +1,6 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "../../../Reference_Guide.ent">
%BOOK_ENTITIES;
]>
<section id="sect-Reference_Guide-eXo_JCR_configuration">
Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced/JCR/external-value-storages.xml
===================================================================
--- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced/JCR/external-value-storages.xml 2010-05-10 16:57:51 UTC (rev 3031)
+++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced/JCR/external-value-storages.xml 2010-05-10 22:39:07 UTC (rev 3032)
@@ -1,6 +1,6 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "../../../Reference_Guide.ent">
%BOOK_ENTITIES;
]>
<section id="sect-Reference_Guide-External_Value_Storages">
Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced/JCR/intro.xml
===================================================================
--- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced/JCR/intro.xml 2010-05-10 16:57:51 UTC (rev 3031)
+++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced/JCR/intro.xml 2010-05-10 22:39:07 UTC (rev 3032)
@@ -1,6 +1,6 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "../../../Reference_Guide.ent">
%BOOK_ENTITIES;
]>
<section id="sect-Reference_Guide-Introduction_in_eXoJCR">
Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced/JCR/jbosscache-configuration-templates.xml
===================================================================
--- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced/JCR/jbosscache-configuration-templates.xml 2010-05-10 16:57:51 UTC (rev 3031)
+++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced/JCR/jbosscache-configuration-templates.xml 2010-05-10 22:39:07 UTC (rev 3032)
@@ -1,6 +1,6 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "../../../Reference_Guide.ent">
%BOOK_ENTITIES;
]>
<section id="sect-Reference_Guide-JBoss_Cache_configuration">
Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced/JCR/jbossts-transaction-service.xml
===================================================================
--- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced/JCR/jbossts-transaction-service.xml 2010-05-10 16:57:51 UTC (rev 3031)
+++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced/JCR/jbossts-transaction-service.xml 2010-05-10 22:39:07 UTC (rev 3032)
@@ -1,6 +1,6 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "../../../Reference_Guide.ent">
%BOOK_ENTITIES;
]>
<section id="sect-Reference_Guide-JBossTransactionsService">
Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced/JCR/jdbc-data-container-config.xml
===================================================================
--- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced/JCR/jdbc-data-container-config.xml 2010-05-10 16:57:51 UTC (rev 3031)
+++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced/JCR/jdbc-data-container-config.xml 2010-05-10 22:39:07 UTC (rev 3032)
@@ -1,6 +1,6 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "../../../Reference_Guide.ent">
%BOOK_ENTITIES;
]>
<section id="sect-Reference_Guide-JDBC_Data_Container_Config">
Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced/JCR/lock-manager-config.xml
===================================================================
--- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced/JCR/lock-manager-config.xml 2010-05-10 16:57:51 UTC (rev 3031)
+++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced/JCR/lock-manager-config.xml 2010-05-10 22:39:07 UTC (rev 3032)
@@ -1,6 +1,6 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "../../../Reference_Guide.ent">
%BOOK_ENTITIES;
]>
<section id="sect-Reference_Guide-LockManager_configuration">
Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced/JCR/multilanguage-support.xml
===================================================================
--- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced/JCR/multilanguage-support.xml 2010-05-10 16:57:51 UTC (rev 3031)
+++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced/JCR/multilanguage-support.xml 2010-05-10 22:39:07 UTC (rev 3032)
@@ -1,6 +1,6 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "../../../Reference_Guide.ent">
%BOOK_ENTITIES;
]>
<section id="sect-Reference_Guide-Multilanguage_support_in_eXo_JCR_RDB_backend">
Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced/JCR/query-handler-config.xml
===================================================================
--- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced/JCR/query-handler-config.xml 2010-05-10 16:57:51 UTC (rev 3031)
+++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced/JCR/query-handler-config.xml 2010-05-10 22:39:07 UTC (rev 3032)
@@ -1,6 +1,6 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "../../../Reference_Guide.ent">
%BOOK_ENTITIES;
]>
<section id="sect-Reference_Guide-QueryHandler_configuration">
Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced/JCR/search-configuration.xml
===================================================================
--- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced/JCR/search-configuration.xml 2010-05-10 16:57:51 UTC (rev 3031)
+++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced/JCR/search-configuration.xml 2010-05-10 22:39:07 UTC (rev 3032)
@@ -1,6 +1,6 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "../../../Reference_Guide.ent">
%BOOK_ENTITIES;
]>
<section id="sect-Reference_Guide-Search_Configuration">
Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced/JCR/statistics.xml
===================================================================
--- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced/JCR/statistics.xml 2010-05-10 16:57:51 UTC (rev 3031)
+++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced/JCR/statistics.xml 2010-05-10 22:39:07 UTC (rev 3032)
@@ -1,6 +1,6 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "../../../Reference_Guide.ent">
%BOOK_ENTITIES;
]>
<section id="sect-Reference_Guide-eXo_JCR_statistics">
Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced/JCR/transaction-manager-lookup.xml
===================================================================
--- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced/JCR/transaction-manager-lookup.xml 2010-05-10 16:57:51 UTC (rev 3031)
+++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced/JCR/transaction-manager-lookup.xml 2010-05-10 22:39:07 UTC (rev 3032)
@@ -1,6 +1,6 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "../../../Reference_Guide.ent">
%BOOK_ENTITIES;
]>
<section id="sect-Reference_Guide-TransactionManagerLookup">
Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced/JCR.xml
===================================================================
--- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced/JCR.xml 2010-05-10 16:57:51 UTC (rev 3031)
+++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced/JCR.xml 2010-05-10 22:39:07 UTC (rev 3032)
@@ -1,6 +1,6 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "../../Reference_Guide.ent">
%BOOK_ENTITIES;
]>
<chapter id="chap-Reference_Guide-eXoJCR">
Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced.xml
===================================================================
--- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced.xml 2010-05-10 16:57:51 UTC (rev 3031)
+++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Advanced.xml 2010-05-10 22:39:07 UTC (rev 3032)
@@ -1,6 +1,6 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE part PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "../Reference_Guide.ent">
%BOOK_ENTITIES;
]>
<part id="part-Reference_Guide-Advanced_Development">
Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/AuthenticationAndIdentity/AccessingUserProfile.xml
===================================================================
--- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/AuthenticationAndIdentity/AccessingUserProfile.xml 2010-05-10 16:57:51 UTC (rev 3031)
+++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/AuthenticationAndIdentity/AccessingUserProfile.xml 2010-05-10 22:39:07 UTC (rev 3032)
@@ -1,6 +1,6 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "../../Reference_Guide.ent">
%BOOK_ENTITIES;
]>
<section id="sect-Reference_Guide-Accessing_User_Profile">
Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/AuthenticationAndIdentity/AuthenticationTokenConfiguration.xml
===================================================================
--- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/AuthenticationAndIdentity/AuthenticationTokenConfiguration.xml 2010-05-10 16:57:51 UTC (rev 3031)
+++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/AuthenticationAndIdentity/AuthenticationTokenConfiguration.xml 2010-05-10 22:39:07 UTC (rev 3032)
@@ -1,6 +1,6 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "../../Reference_Guide.ent">
%BOOK_ENTITIES;
]>
<section id="sect-Reference_Guide-Authentication_Token_Configuration">
Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/AuthenticationAndIdentity/BackendConfiguration.xml
===================================================================
--- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/AuthenticationAndIdentity/BackendConfiguration.xml 2010-05-10 16:57:51 UTC (rev 3031)
+++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/AuthenticationAndIdentity/BackendConfiguration.xml 2010-05-10 22:39:07 UTC (rev 3032)
@@ -1,6 +1,6 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "../../Reference_Guide.ent">
%BOOK_ENTITIES;
]>
<section id="sect-Reference_Guide-PicketLink_IDM_integration">
Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/AuthenticationAndIdentity/OrganizationAPI.xml
===================================================================
--- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/AuthenticationAndIdentity/OrganizationAPI.xml 2010-05-10 16:57:51 UTC (rev 3031)
+++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/AuthenticationAndIdentity/OrganizationAPI.xml 2010-05-10 22:39:07 UTC (rev 3032)
@@ -1,6 +1,6 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "../../Reference_Guide.ent">
%BOOK_ENTITIES;
]>
<section id="sect-Reference_Guide-Organization_API">
Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/AuthenticationAndIdentity/PredefinedUserConfiguration.xml
===================================================================
--- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/AuthenticationAndIdentity/PredefinedUserConfiguration.xml 2010-05-10 16:57:51 UTC (rev 3031)
+++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/AuthenticationAndIdentity/PredefinedUserConfiguration.xml 2010-05-10 22:39:07 UTC (rev 3032)
@@ -1,6 +1,6 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "../../Reference_Guide.ent">
%BOOK_ENTITIES;
]>
<section id="sect-Reference_Guide-Predefined_User_Configuration">
Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/AuthenticationAndIdentity/SSO.xml
===================================================================
--- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/AuthenticationAndIdentity/SSO.xml 2010-05-10 16:57:51 UTC (rev 3031)
+++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/AuthenticationAndIdentity/SSO.xml 2010-05-10 22:39:07 UTC (rev 3032)
@@ -1,6 +1,6 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "../../Reference_Guide.ent">
%BOOK_ENTITIES;
]>
<section id="sect-Reference_Guide-SSO_Single_Sign_On">
Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/AuthenticationAndIdentity.xml
===================================================================
--- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/AuthenticationAndIdentity.xml 2010-05-10 16:57:51 UTC (rev 3031)
+++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/AuthenticationAndIdentity.xml 2010-05-10 22:39:07 UTC (rev 3032)
@@ -1,6 +1,6 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "../Reference_Guide.ent">
%BOOK_ENTITIES;
]>
<chapter id="chap-Reference_Guide-Authentication_and_Identity">
Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Configuration/DatabaseConfiguration.xml
===================================================================
--- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Configuration/DatabaseConfiguration.xml 2010-05-10 16:57:51 UTC (rev 3031)
+++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Configuration/DatabaseConfiguration.xml 2010-05-10 22:39:07 UTC (rev 3032)
@@ -1,6 +1,6 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "../../Reference_Guide.ent">
%BOOK_ENTITIES;
]>
<section id="sect-Reference_Guide-Database_Configuration">
Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Configuration/EMailServiceConfiguration.xml
===================================================================
--- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Configuration/EMailServiceConfiguration.xml 2010-05-10 16:57:51 UTC (rev 3031)
+++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Configuration/EMailServiceConfiguration.xml 2010-05-10 22:39:07 UTC (rev 3032)
@@ -1,6 +1,6 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "../../Reference_Guide.ent">
%BOOK_ENTITIES;
]>
<section id="sect-Reference_Guide-E_Mail_Service_Configuration">
Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Configuration.xml
===================================================================
--- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Configuration.xml 2010-05-10 16:57:51 UTC (rev 3031)
+++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Configuration.xml 2010-05-10 22:39:07 UTC (rev 3032)
@@ -1,6 +1,6 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "../Reference_Guide.ent">
%BOOK_ENTITIES;
]>
<chapter id="chap-Reference_Guide-Configuration">
Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/GadgetDevelopment/Gadgets.xml
===================================================================
--- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/GadgetDevelopment/Gadgets.xml 2010-05-10 16:57:51 UTC (rev 3031)
+++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/GadgetDevelopment/Gadgets.xml 2010-05-10 22:39:07 UTC (rev 3032)
@@ -1,6 +1,6 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "../../Reference_Guide.ent">
%BOOK_ENTITIES;
]>
<section id="sect-Reference_Guide-Gadgets">
Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/GadgetDevelopment/SetupGadgetServer.xml
===================================================================
--- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/GadgetDevelopment/SetupGadgetServer.xml 2010-05-10 16:57:51 UTC (rev 3031)
+++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/GadgetDevelopment/SetupGadgetServer.xml 2010-05-10 22:39:07 UTC (rev 3032)
@@ -1,6 +1,6 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "../../Reference_Guide.ent">
%BOOK_ENTITIES;
]>
<section id="sect-Reference_Guide-Setup_a_Gadget_Server">
Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/GadgetDevelopment.xml
===================================================================
--- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/GadgetDevelopment.xml 2010-05-10 16:57:51 UTC (rev 3031)
+++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/GadgetDevelopment.xml 2010-05-10 22:39:07 UTC (rev 3032)
@@ -1,6 +1,6 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "../Reference_Guide.ent">
%BOOK_ENTITIES;
]>
<chapter id="chap-Reference_Guide-Gadget_development">
Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Introduction.xml
===================================================================
--- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Introduction.xml 2010-05-10 16:57:51 UTC (rev 3031)
+++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/Introduction.xml 2010-05-10 22:39:07 UTC (rev 3032)
@@ -1,6 +1,6 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "../Reference_Guide.ent">
%BOOK_ENTITIES;
]>
<chapter id="chap-Reference_Guide-Introduction">
@@ -38,7 +38,7 @@
</para>
<mediaobject>
<imageobject role="html">
- <imagedata fileref="images/Common/Non-tech-docs.png" format="PNG" align="center" scale="100" />
+ <imagedata fileref="images/Common/Non-tech-docs.png" format="PNG" align="center" scale="90" />
</imageobject>
<imageobject role="fo">
<imagedata fileref="images/Common/Non-tech-docs.png" format="PNG" align="center" contentwidth="150mm" />
@@ -54,7 +54,7 @@
</para>
<mediaobject>
<imageobject role="html">
- <imagedata fileref="images/Common/Videos.png" format="PNG" align="center" scale="100" />
+ <imagedata fileref="images/Common/Videos.png" format="PNG" align="center" scale="90" />
</imageobject>
<imageobject role="fo">
<imagedata fileref="images/Common/Videos.png" format="PNG" align="center" contentwidth="150mm" />
Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalConfiguration.xml
===================================================================
--- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalConfiguration.xml 2010-05-10 16:57:51 UTC (rev 3031)
+++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalConfiguration.xml 2010-05-10 22:39:07 UTC (rev 3032)
@@ -1,6 +1,6 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "../../Reference_Guide.ent">
%BOOK_ENTITIES;
]>
<chapter id="chap-Reference_Guide-Default_Portal_Configuration">
@@ -8,10 +8,10 @@
<section id="sect-Reference_Guide-Default_Portal_Configuration-Overview">
<title>Overview</title>
<para>
- &PRODUCT; default home page URL is <literal>http://{hostname}:{port}/portal/</literal>. There may be multiple independent portals deployed in parallel at any given time, each of which has its root context (i.e.: <literal>http://{hostname}:{port}/sample-portal/</literal>).
+ &PRODUCT;'s default home page URL is <literal>http://{hostname}:{port}/portal/</literal>. There may be multiple independent portals deployed in parallel at any given time, each of which has its root context (i.e.: <literal>http://{hostname}:{port}/sample-portal/</literal>).
</para>
<para>
- Each portal is internally composed of one or more 'portals'. This is because there needs to be at least one such portal available. The default one is called 'classic'. When accessing &PRODUCT;'s default home page URL, you are automatically directed to the 'classic' portal.
+ Each portal is internally composed of one or more 'portals'. This is because there needs to be at least one such portal available. The default portal is called '<emphasis>Classic</emphasis>'. When accessing &PRODUCT;'s default URL, you are automatically directed to the '<emphasis>Classic</emphasis>' portal.
</para>
<para>
The default portal performs another important task. When starting up &PRODUCT; for the first time, its JCR database (where portal runtime-configurable settings are stored) will be empty . The default portal detects this and triggers automatic data initialization.
@@ -24,32 +24,31 @@
The following example configuration can be found at: "<filename>02portal.war:/WEB-INF/conf/portal/portal-configuration.xml</filename>".
</para>
-<programlisting role="XML"><component>
- <key>org.exoplatform.portal.config.UserPortalConfigService</key>
- <type>org.exoplatform.portal.config.UserPortalConfigService</type>
- <component-plugins>
- <component-plugin>
- <name>new.portal.config.user.listener</name>
- <set-method>initListener</set-method>
- <type>org.exoplatform.portal.config.NewPortalConfigListener</type>
- <description>this listener init the portal configuration</description>
- <init-params>
- <value-param>
- <name>default.portal</name>
- <description>The default portal for checking db is empty or not</description>
- <value>classic</value>
- </value-param>
+<programlisting language="XML" role="XML"><![CDATA[<component>
+ <key>org.exoplatform.portal.config.UserPortalConfigService</key>
+ <type>org.exoplatform.portal.config.UserPortalConfigService</type>
+ <component-plugins>
+ <component-plugin>
+ <name>new.portal.config.user.listener</name>
+ <set-method>initListener</set-method>
+ <type>org.exoplatform.portal.config.NewPortalConfigListener</type>
+ <description>this listener init the portal configuration</description>
+ <init-params>
+ <value-param>
+ <name>default.portal</name>
+ <description>The default portal for checking db is empty or not</description>
+ <value>classic</value>
+ </value-param>
...
- </init-params>
- </component-plugin>
- </component-plugins>
- </component>
-</programlisting>
+ </init-params>
+ </component-plugin>
+ </component-plugins>
+ </component>]]></programlisting>
<para>
- In this example the <emphasis role="bold">classic</emphasis> portal has been set as the default.
+ In this example the <emphasis>Classic</emphasis> portal has been set as the default.
</para>
<para>
- Notice that the <literal>NewPortalConfigListener</literal> <emphasis>component-plugin</emphasis> is used to add configuration to <literal>UserPortalConfigService</literal>, which is designed in this way to allow other components to add configuration to it.
+ 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.
Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalNavigationConfiguration.xml
===================================================================
--- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalNavigationConfiguration.xml 2010-05-10 16:57:51 UTC (rev 3031)
+++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalNavigationConfiguration.xml 2010-05-10 22:39:07 UTC (rev 3032)
@@ -1,6 +1,6 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "../../Reference_Guide.ent">
%BOOK_ENTITIES;
]>
<chapter id="chap-Reference_Guide-Portal_Navigation_Configuration">
@@ -30,72 +30,72 @@
<para>
These navigations are configured using standard XML syntax in the file; "<filename>02portal.war:/WEB-INF/conf/portal/portal-configuration.xml</filename>".
</para>
-
-<programlisting role="XML"><component>
- <key>org.exoplatform.portal.config.UserPortalConfigService</key>
- <type>org.exoplatform.portal.config.UserPortalConfigService</type>
- <component-plugins>
- <component-plugin>
- <name>new.portal.config.user.listener</name>
- <set-method>initListener</set-method>
- <type>org.exoplatform.portal.config.NewPortalConfigListener</type>
- <description>this listener init the portal configuration</description>
- <init-params>
- <value-param>
- <name>default.portal</name>
- <description>The default portal for checking db is empty or not</description>
- <value>classic</value>
- </value-param>
- <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>
- <value><string>webos</string></value>
- </collection>
- </field>
- <field name="ownerType"><string>portal</string></field>
- <field name="templateLocation"><string>war:/conf/portal</string></field>
- </object>
- </object-param>
- <object-param>
- <name>group.configuration</name>
- <description>description</description>
- <object type="org.exoplatform.portal.config.NewPortalConfig">
- <field name="predefinedOwner">
- <collection type="java.util.HashSet">
- <value><string>platform/administrators</string></value>
- <value><string>platform/users</string></value>
- <value><string>platform/guests</string></value>
- <value><string>organization/management/executive-board</string></value>
- </collection>
- </field>
- <field name="ownerType"><string>group</string></field>
- <field name="templateLocation"><string>war:/conf/portal</string></field>
- </object>
- </object-param>
- <object-param>
- <name>user.configuration</name>
- <description>description</description>
- <object type="org.exoplatform.portal.config.NewPortalConfig">
- <field name="predefinedOwner">
- <collection type="java.util.HashSet">
- <value><string>root</string></value>
- <value><string>john</string></value>
- <value><string>mary</string></value>
- <value><string>demo</string></value>
- </collection>
- </field>
- <field name="ownerType"><string>user</string></field>
- <field name="templateLocation"><string>war:/conf/portal</string></field>
- </object>
- </object-param>
- </init-params>
- </component-plugin>
-</component-plugins>
-</programlisting>
+
+<programlisting language="XML" role="XML"><![CDATA[<component>
+ <key>org.exoplatform.portal.config.UserPortalConfigService</key>
+ <type>org.exoplatform.portal.config.UserPortalConfigService</type>
+ <component-plugins>
+ <component-plugin>
+ <name>new.portal.config.user.listener</name>
+ <set-method>initListener</set-method>
+ <type>org.exoplatform.portal.config.NewPortalConfigListener</type>
+ <description>this listener init the portal configuration</description>
+ <init-params>
+ <value-param>
+ <name>default.portal</name>
+ <description>The default portal for checking db is empty or not</description>
+ <value>classic</value>
+ </value-param>
+ <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>
+ <value><string>webos</string></value>
+ </collection>
+ </field>
+ <field name="ownerType"><string>portal</string></field>
+ <field name="templateLocation"><string>war:/conf/portal</string></field>
+ </object>
+ </object-param>
+ <object-param>
+ <name>group.configuration</name>
+ <description>description</description>
+ <object type="org.exoplatform.portal.config.NewPortalConfig">
+ <field name="predefinedOwner">
+ <collection type="java.util.HashSet">
+ <value><string>platform/administrators</string></value>
+ <value><string>platform/users</string></value>
+ <value><string>platform/guests</string></value>
+ <value><string>organization/management/executive-board</string></value>
+ </collection>
+ </field>
+ <field name="ownerType"><string>group</string></field>
+ <field name="templateLocation"><string>war:/conf/portal</string></field>
+ </object>
+ </object-param>
+ <object-param>
+ <name>user.configuration</name>
+ <description>description</description>
+ <object type="org.exoplatform.portal.config.NewPortalConfig">
+ <field name="predefinedOwner">
+ <collection type="java.util.HashSet">
+ <value><string>root</string></value>
+ <value><string>john</string></value>
+ <value><string>mary</string></value>
+ <value><string>demo</string></value>
+ </collection>
+ </field>
+ <field name="ownerType"><string>user</string></field>
+ <field name="templateLocation"><string>war:/conf/portal</string></field>
+ </object>
+ </object-param>
+ </init-params>
+ </component-plugin>
+</component-plugins>]]></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>
@@ -107,10 +107,10 @@
<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 are used when a company owns multiple trademarks, and sets up a web site for each of them.
+ 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 role="bold">classic</emphasis> portal is configured by four XML files in the <filename>02portal.war:/WEB-INF/conf/portal/portal/classic</filename> directory:
+ The <emphasis>Classic</emphasis> portal is configured by four XML files in the <filename>02portal.war:/WEB-INF/conf/portal/portal/classic</filename> directory:
</para>
<variablelist>
<varlistentry>
@@ -120,41 +120,41 @@
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. &PRODUCT; is extremely configurable as every view element (even the banner and footer) is a portlet.
</para>
-<programlisting role="XML"><?xml version="1.0" encoding="ISO-8859-1"?>
-<portal-config>
- <portal-name>classic</portal-name>
- <locale>en</locale>
- <factory-id>office</factory-id>
- <access-permissions>Everyone</access-permissions>
- <edit-permission>*:/platform/administrators</edit-permission>
- <creator>root</creator>
+<programlisting language="XML" role="XML"><![CDATA[<?xml version="1.0" encoding="ISO-8859-1"?>
+<portal-config>
+ <portal-name>classic</portal-name>
+ <locale>en</locale>
+ <factory-id>office</factory-id>
+ <access-permissions>Everyone</access-permissions>
+ <edit-permission>*:/platform/administrators</edit-permission>
+ <creator>root</creator>
- <portal-layout>
- <application>
- <instance-id>portal#classic:/web/BannerPortlet/banner</instance-id>
- <show-info-bar>false</show-info-bar>
- </application>
- <application>
- <instance-id>portal#classic:/web/NavigationPortlet/toolbar</instance-id>
- <show-info-bar>false</show-info-bar>
- </application>
+ <portal-layout>
+ <application>
+ <instance-id>portal#classic:/web/BannerPortlet/banner</instance-id>
+ <show-info-bar>false</show-info-bar>
+ </application>
+ <application>
+ <instance-id>portal#classic:/web/NavigationPortlet/toolbar</instance-id>
+ <show-info-bar>false</show-info-bar>
+ </application>
- <application>
- <instance-id>portal#classic:/web/BreadcumbsPortlet/breadcumbs</instance-id>
- <show-info-bar>false</show-info-bar>
- </application>
+ <application>
+ <instance-id>portal#classic:/web/BreadcumbsPortlet/breadcumbs</instance-id>
+ <show-info-bar>false</show-info-bar>
+ </application>
- <page-body> </page-body>
+ <page-body> </page-body>
- <application>
- <instance-id>portal#classic:/web/FooterPortlet/footer</instance-id>
- <show-info-bar>false</show-info-bar>
- </application>
- </portal-layout>
+ <application>
+ <instance-id>portal#classic:/web/FooterPortlet/footer</instance-id>
+ <show-info-bar>false</show-info-bar>
+ </application>
+ </portal-layout>
-</portal-config>
-</programlisting>
+</portal-config>]]></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>
@@ -165,7 +165,7 @@
Use the <literal>page-body</literal> tag to define where &PRODUCT; should render the current page.
</para>
<para>
- The defined <emphasis role="bold">classic</emphasis> portal is accessible to "Everyone" (at <literal>/portal/public/classic</literal>) but only members of the group <literal>/platform/administrators</literal> can edit it.
+ The defined <emphasis>classic</emphasis> portal is accessible to "Everyone" (at <literal>/portal/public/classic</literal>) but only members of the group <literal>/platform/administrators</literal> can edit it.
</para>
</listitem>
</varlistentry>
@@ -179,27 +179,26 @@
When the <literal>#{...}</literal> syntax is used, the enclosed property name serves as a key that is automatically passed to internationalization mechanism so the literal property name is replaced by a localized value taken from the associated properties file matching the current locale.
</para>
-<programlisting role="XML"><?xml version="1.0" encoding="UTF-8"?>
-<node-navigation>
- <owner-type>portal</owner-type>
- <owner-id>classic</owner-id>
- <priority>1</priority>
- <page-nodes>
- <node>
- <uri>home</uri>
- <name>home</name>
- <label>#{portal.classic.home}</label>
- <page-reference>portal::classic::homepage</page-reference>
- </node>
- <node>
- <uri>webexplorer</uri>
- <name>webexplorer</name>
- <label>#{portal.classic.webexplorer}</label>
- <page-reference>portal::classic::webexplorer</page-reference>
- </node>
- </page-nodes>
-</node-navigation>
-</programlisting>
+<programlisting language="XML" role="XML"><![CDATA[<?xml version="1.0" encoding="UTF-8"?>
+<node-navigation>
+ <owner-type>portal</owner-type>
+ <owner-id>classic</owner-id>
+ <priority>1</priority>
+ <page-nodes>
+ <node>
+ <uri>home</uri>
+ <name>home</name>
+ <label>#{portal.classic.home}</label>
+ <page-reference>portal::classic::homepage</page-reference>
+ </node>
+ <node>
+ <uri>webexplorer</uri>
+ <name>webexplorer</name>
+ <label>#{portal.classic.webexplorer}</label>
+ <page-reference>portal::classic::webexplorer</page-reference>
+ </node>
+ </page-nodes>
+</node-navigation>]]></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>
@@ -220,41 +219,41 @@
This configuration file structure is very similar to <filename>portal.xml</filename> and it can also contain container tags. Each application can decide whether to render the portlet border, the window state, the icons or portlet's mode.
</para>
-<programlisting role="XML"><?xml version="1.0" encoding="ISO-8859-1"?>
-<page-set>
- <page>
- <page-id>portal::classic::homepage</page-id>
- <owner-type>portal</owner-type>
- <owner-id>classic</owner-id>
- <name>homepage</name>
- <title>Home Page</title>
- <access-permissions>Everyone</access-permissions>
- <edit-permission>*:/platform/administrators</edit-permission>
- <application>
- <instance-id>portal#classic:/web/HomePagePortlet/homepageportlet</instance-id>
- <title>Home Page portlet</title>
- <show-info-bar>false</show-info-bar>
- <show-application-state>false</show-application-state>
- <show-application-mode>false</show-application-mode>
- </application>
- </page>
+<programlisting language="XML" role="XML"><![CDATA[<?xml version="1.0" encoding="ISO-8859-1"?>
+<page-set>
+ <page>
+ <page-id>portal::classic::homepage</page-id>
+ <owner-type>portal</owner-type>
+ <owner-id>classic</owner-id>
+ <name>homepage</name>
+ <title>Home Page</title>
+ <access-permissions>Everyone</access-permissions>
+ <edit-permission>*:/platform/administrators</edit-permission>
+ <application>
+ <instance-id>portal#classic:/web/HomePagePortlet/homepageportlet</instance-id>
+ <title>Home Page portlet</title>
+ <show-info-bar>false</show-info-bar>
+ <show-application-state>false</show-application-state>
+ <show-application-mode>false</show-application-mode>
+ </application>
+ </page>
- <page>
- <page-id>portal::classic::webexplorer</page-id>
- <owner-type>portal</owner-type>
- <owner-id>classic</owner-id>
- <name>webexplorer</name>
- <title>Web Explorer</title>
- <access-permissions>*:/platform/users</access-permissions>
- <edit-permission>*:/platform/administrators</edit-permission>
- <application>
- <instance-id>group#platform/users:/web/BrowserPortlet/WebExplorer</instance-id>
- <title>Web Explorer</title>
- <show-info-bar>false</show-info-bar>
- </application>
- </page>
-</page-set>
-</programlisting>
+ <page>
+ <page-id>portal::classic::webexplorer</page-id>
+ <owner-type>portal</owner-type>
+ <owner-id>classic</owner-id>
+ <name>webexplorer</name>
+ <title>Web Explorer</title>
+ <access-permissions>*:/platform/users</access-permissions>
+ <edit-permission>*:/platform/administrators</edit-permission>
+ <application>
+ <instance-id>group#platform/users:/web/BrowserPortlet/WebExplorer</instance-id>
+ <title>Web Explorer</title>
+ <show-info-bar>false</show-info-bar>
+ </application>
+ </page>
+</page-set>]]></programlisting>
+
</listitem>
</varlistentry>
<varlistentry>
@@ -264,52 +263,52 @@
Porlet instances can be associated with <literal>portlet-preferences</literal> that override the ones defined in <filename>portlet.xml</filename> of the portlet application <literal>war</literal>.
</para>
-<programlisting role="XML"><?xml version="1.0" encoding="ISO-8859-1"?>
-<portlet-preferences-set>
- <portlet-preferences>
- <owner-type>portal</owner-type>
- <owner-id>classic</owner-id>
- <window-id>portal#classic:/web/BannerPortlet/banner</window-id>
- <preference>
- <name>template</name>
- <value>par:/groovy/groovy/webui/component/UIBannerPortlet.gtmpl</value>
- <read-only>false</read-only>
- </preference>
- </portlet-preferences>
- <portlet-preferences>
- <owner-type>portal</owner-type>
- <owner-id>classic</owner-id>
- <window-id>portal#classic:/web/NavigationPortlet/toolbar</window-id>
- <preference>
- <name>useAJAX</name>
- <value>true</value>
- <read-only>false</read-only>
- </preference>
- </portlet-preferences>
- <portlet-preferences>
- <owner-type>portal</owner-type>
- <owner-id>classic</owner-id>
- <window-id>portal#classic:/web/FooterPortlet/footer</window-id>
- <preference>
- <name>template</name>
- <value>par:/groovy/groovy/webui/component/UIFooterPortlet.gtmpl</value>
- <read-only>false</read-only>
- </preference>
- </portlet-preferences>
+<programlisting language="XML" role="XML"><![CDATA[<?xml version="1.0" encoding="ISO-8859-1"?>
+<portlet-preferences-set>
+ <portlet-preferences>
+ <owner-type>portal</owner-type>
+ <owner-id>classic</owner-id>
+ <window-id>portal#classic:/web/BannerPortlet/banner</window-id>
+ <preference>
+ <name>template</name>
+ <value>par:/groovy/groovy/webui/component/UIBannerPortlet.gtmpl</value>
+ <read-only>false</read-only>
+ </preference>
+ </portlet-preferences>
+ <portlet-preferences>
+ <owner-type>portal</owner-type>
+ <owner-id>classic</owner-id>
+ <window-id>portal#classic:/web/NavigationPortlet/toolbar</window-id>
+ <preference>
+ <name>useAJAX</name>
+ <value>true</value>
+ <read-only>false</read-only>
+ </preference>
+ </portlet-preferences>
+ <portlet-preferences>
+ <owner-type>portal</owner-type>
+ <owner-id>classic</owner-id>
+ <window-id>portal#classic:/web/FooterPortlet/footer</window-id>
+ <preference>
+ <name>template</name>
+ <value>par:/groovy/groovy/webui/component/UIFooterPortlet.gtmpl</value>
+ <read-only>false</read-only>
+ </preference>
+ </portlet-preferences>
- <portlet-preferences>
- <owner-type>portal</owner-type>
- <owner-id>classic</owner-id>
- <window-id>portal#classic:/web/GroovyPortlet/groovyportlet</window-id>
- <preference>
- <name>template</name>
- <value>par:/groovy/groovy/webui/component/UIGroovyPortlet.gtmpl</value>
- <read-only>false</read-only>
- </preference>
- </portlet-preferences>
-</portlet-preferences-set>
-</programlisting>
+ <portlet-preferences>
+ <owner-type>portal</owner-type>
+ <owner-id>classic</owner-id>
+ <window-id>portal#classic:/web/GroovyPortlet/groovyportlet</window-id>
+ <preference>
+ <name>template</name>
+ <value>par:/groovy/groovy/webui/component/UIGroovyPortlet.gtmpl</value>
+ <read-only>false</read-only>
+ </preference>
+ </portlet-preferences>
+</portlet-preferences-set>]]></programlisting>
+
</listitem>
</varlistentry>
</variablelist>
@@ -506,6 +505,7 @@
</portlet-preferences-set>
</programlisting>
</section> -->
+
<section id="sect-Reference_Guide-Portal_Navigation_Configuration-Group_Navigation">
<title>Group Navigation</title>
<para>
@@ -534,41 +534,41 @@
The user's workspace is located at the left hand side of the page and access is restricted to some privileged users, see <xref linkend="sect-Reference_Guide-Predefined_User_Configuration" />
</para>
-<programlisting role="XML"><?xml version="1.0" encoding="ISO-8859-1"?>
-<widgets>
- <owner-type>user</owner-type>
- <owner-id>root</owner-id>
+<programlisting language="XML" role="XML"><![CDATA[<?xml version="1.0" encoding="ISO-8859-1"?>
+<widgets>
+ <owner-type>user</owner-type>
+ <owner-id>root</owner-id>
- <container id="Information">
- <name>Information</name>
- <description>Information's Description</description>
- <application>
- <instance-id>user#root:/GateInWidgetWeb/WelcomeWidget/WelcomeWidget1</instance-id>
- <application-type>GateInWidget</application-type>
- </application>
+ <container id="Information">
+ <name>Information</name>
+ <description>Information's Description</description>
+ <application>
+ <instance-id>user#root:/GateInWidgetWeb/WelcomeWidget/WelcomeWidget1</instance-id>
+ <application-type>GateInWidget</application-type>
+ </application>
- <application>
- <instance-id>user#root:/GateInWidgetWeb/StickerWidget/StickerWidget</instance-id>
- <application-type>GateInWidget</application-type>
- </application>
+ <application>
+ <instance-id>user#root:/GateInWidgetWeb/StickerWidget/StickerWidget</instance-id>
+ <application-type>GateInWidget</application-type>
+ </application>
- <application>
- <instance-id>user#root:/GateInWidgetWeb/InfoWidget/InfoWidget1</instance-id>
- <application-type>GateInWidget</application-type>
- </application>
- </container>
+ <application>
+ <instance-id>user#root:/GateInWidgetWeb/InfoWidget/InfoWidget1</instance-id>
+ <application-type>GateInWidget</application-type>
+ </application>
+ </container>
- <container id="Calendar">
- <name>Calendar</name>
- <description>Calendar's Description</description>
- <application>
- <instance-id>user#root:/GateInWidgetWeb/CalendarWidget/CalendarWidget</instance-id>
- <application-type>GateInWidget</application-type>
- </application>
- </container>
+ <container id="Calendar">
+ <name>Calendar</name>
+ <description>Calendar's Description</description>
+ <application>
+ <instance-id>user#root:/GateInWidgetWeb/CalendarWidget/CalendarWidget</instance-id>
+ <application-type>GateInWidget</application-type>
+ </application>
+ </container>
-</widgets>
-</programlisting>
+</widgets>]]></programlisting>
+
<!-- <para>
Note that when you develop a portal, we advise you to use the XML instead of the User Interface as XML will allow you to provide a preconfigured package to your customer. But as each time you start the server the first time, the XML files are stored in the JCR, it will be necessary to remove the database (the jcr leverages a database). During the development phase using tomcat it simply means to delete the directory: exo-tomcat/temp
</para> -->
@@ -579,7 +579,7 @@
<section id="sect-Reference_Guide-Tips-Direct_External_Links">
<title>Direct External Links</title>
<para>
- If you wish to add a link to a URL outside the portal you must first define a "page" that will only serve as a navigation placeholder for an external redirect. This page will not be used for any portlets. Then add the URL to the navigation. (TODO: check for correctness)
+ If you wish to add a link to a URL outside the portal you must first define a "page" that will only serve as a navigation placeholder for an external redirect. This page will not be used for any portlets. Then add the URL to the navigation.
</para>
<variablelist>
<varlistentry>
@@ -587,15 +587,14 @@
<listitem>
<para>
-<programlisting><page>
- <owner-type>portal</owner-type>
- <owner-id>website</owner-id>
- <name>documentation</name>
- <title>Documentation</title>
- <access-permissions>Everyone</access-permissions>
- <edit-permission>*:/platform/administrators</edit-permission>
-</page>
-</programlisting>
+<programlisting language="XML" role="XML"><![CDATA[<page>
+ <owner-type>portal</owner-type>
+ <owner-id>website</owner-id>
+ <name>documentation</name>
+ <title>Documentation</title>
+ <access-permissions>Everyone</access-permissions>
+ <edit-permission>*:/platform/administrators</edit-permission>
+</page>]]></programlisting>
</para>
</listitem>
</varlistentry>
@@ -604,13 +603,12 @@
<listitem>
<para>
-<programlisting><node>
- <uri>http://wiki.exoplatform.com/xwiki/bin/view/Main/WebHome</uri>
- <name>documentation</name>
- <label>#{portal.classic.documentation}</label>
- <page-reference>portal::website::documentation</page-reference>
-</node>
-</programlisting>
+<programlisting language="XML" role="XML"><![CDATA[<node>
+ <uri>http://wiki.exoplatform.com/xwiki/bin/view/Main/WebHome</uri>
+ <name>documentation</name>
+ <label>#{portal.classic.documentation}</label>
+ <page-reference>portal::website::documentation</page-reference>
+</node>]]></programlisting>
</para>
</listitem>
</varlistentry>
Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalPermissionConfiguration.xml
===================================================================
--- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalPermissionConfiguration.xml 2010-05-10 16:57:51 UTC (rev 3031)
+++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalPermissionConfiguration.xml 2010-05-10 22:39:07 UTC (rev 3032)
@@ -1,6 +1,6 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "../../Reference_Guide.ent">
%BOOK_ENTITIES;
]>
<chapter id="chap-Reference_Guide-Portal_Default_Permission_Configuration">
@@ -8,10 +8,10 @@
<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 file <filename>02portal.war:/WEB-INF/conf/portal/portal-configuration.xml</filename>.
+ 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.
</para>
<para>
- It defines 8 permissions types:
+ It defines eight permissions types:
</para>
<variablelist>
<varlistentry>
@@ -79,40 +79,40 @@
</listitem>
</varlistentry>
</variablelist>
-<programlisting role="XML"><component>
- <key>org.exoplatform.portal.config.UserACL</key>
- <type>org.exoplatform.portal.config.UserACL</type>
- <init-params>
- <value-param>
- <name>super.user</name>
- <description>administrator</description>
- <value>root</value>
- </value-param>
+
+<programlisting language="XML" role="XML"><![CDATA[<component>
+ <key>org.exoplatform.portal.config.UserACL</key>
+ <type>org.exoplatform.portal.config.UserACL</type>
+ <init-params>
+ <value-param>
+ <name>super.user</name>
+ <description>administrator</description>
+ <value>root</value>
+ </value-param>
- <value-param>
- <name>portal.creator.groups</name>
- <description>groups with membership type have permission to manage portal</description>
- <value>*:/platform/administrators,*:/organization/management/executive-board</value>
- </value-param>
+ <value-param>
+ <name>portal.creator.groups</name>
+ <description>groups with membership type have permission to manage portal</description>
+ <value>*:/platform/administrators,*:/organization/management/executive-board</value>
+ </value-param>
- <value-param>
- <name>navigation.creator.membership.type</name>
- <description>specific membership type have full permission with group navigation</description>
- <value>manager</value>
- </value-param>
- <value-param>
- <name>guests.group</name>
- <description>guests group</description>
- <value>/platform/guests</value>
- </value-param>
- <value-param>
- <name>access.control.workspace</name>
- <description>groups with memberships that have the right to access the User Control Workspace</description>
- <value>*:/platform/administrators,*:/organization/management/executive-board</value>
- </value-param>
- </init-params>
-</component>
-</programlisting>
+ <value-param>
+ <name>navigation.creator.membership.type</name>
+ <description>specific membership type have full permission with group navigation</description>
+ <value>manager</value>
+ </value-param>
+ <value-param>
+ <name>guests.group</name>
+ <description>guests group</description>
+ <value>/platform/guests</value>
+ </value-param>
+ <value-param>
+ <name>access.control.workspace</name>
+ <description>groups with memberships that have the right to access the User Control Workspace</description>
+ <value>*:/platform/administrators,*:/organization/management/executive-board</value>
+ </value-param>
+ </init-params>
+</component>]]></programlisting>
</section>
<section id="sect-Reference_Guide-Portal_Default_Permission_Configuration-Overwrite_Portal_Default_Permissions">
@@ -121,28 +121,27 @@
When creating custom portals and portal extensions it is possible to override the default configuration by using <literal>org.exoplatform.portal.config.PortalACLPlugin</literal>, configuring it as an external-plugin of <literal>org.exoplatform.portal.config.UserACL</literal> service:
</para>
-<programlisting role="XML"><external-component-plugins>
- <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>
- <values-param>
- <name>access.control.workspace.roles</name>
- <value>*:/platform/administrators</value>
- <value>*:/organization/management/executive-board</value>
- </values-param>
- <values-param>
- <name>portal.creation.roles</name>
- <value>*:/platform/administrators</value>
- <value>*:/organization/management/executive-board</value>
- </values-param>
- </init-params>
- </component-plugin>
- </external-component-plugins>
-</programlisting>
+<programlisting language="XML" role="XML"><![CDATA[<external-component-plugins>
+ <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>
+ <values-param>
+ <name>access.control.workspace.roles</name>
+ <value>*:/platform/administrators</value>
+ <value>*:/organization/management/executive-board</value>
+ </values-param>
+ <values-param>
+ <name>portal.creation.roles</name>
+ <value>*:/platform/administrators</value>
+ <value>*:/organization/management/executive-board</value>
+ </values-param>
+ </init-params>
+ </component-plugin>
+ </external-component-plugins>]]></programlisting>
</section>
</chapter>
Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/InternationalizationConfiguration.xml
===================================================================
--- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/InternationalizationConfiguration.xml 2010-05-10 16:57:51 UTC (rev 3031)
+++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/InternationalizationConfiguration.xml 2010-05-10 22:39:07 UTC (rev 3032)
@@ -1,6 +1,6 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "../../Reference_Guide.ent">
%BOOK_ENTITIES;
]>
<chapter id="chap-Reference_Guide-Internationalization_Configuration">
@@ -42,8 +42,7 @@
Inside those file are typical <literal>key=value</literal> Java EE properties. For example; in the <literal>French</literal> file:
</para>
-<programlisting>javax.portlet.title=Portlet Navigation
-</programlisting>
+<programlisting language="Java" role="JAVA"><![CDATA[javax.portlet.title=Portlet Navigation]]></programlisting>
<para>
There are also properties files in the portal itself. They form the <emphasis role="bold">portal resource bundle</emphasis>.
</para>
@@ -67,23 +66,23 @@
<section id="sect-Reference_Guide-Internationalization_Configuration-Locales_configuration">
<title>Locales Configuration</title>
<para>
- Various languages are available in the portal package. The configuration below will define which languages are shown in the "Change Language" section and made available to users.
+ 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>
<para>
The <filename>02portal.war:/WEB-INF/conf/common/common-configuration.xml</filename> file of your installation contains the following section:
</para>
-<programlisting role="XML"><component>
- <key>org.exoplatform.services.resources.LocaleConfigService</key>
- <type>org.exoplatform.services.resources.impl.LocaleConfigServiceImpl</type>
- <init-params>
- <value-param>
- <name>locale.config.file</name>
- <value>war:/conf/common/locales-config.xml</value>
- </value-param>
- </init-params>
-</component>
-</programlisting>
+<programlisting language="XML" role="XML"><![CDATA[<component>
+ <key>org.exoplatform.services.resources.LocaleConfigService</key>
+ <type>org.exoplatform.services.resources.impl.LocaleConfigServiceImpl</type>
+ <init-params>
+ <value-param>
+ <name>locale.config.file</name>
+ <value>war:/conf/common/locales-config.xml</value>
+ </value-param>
+ </init-params>
+</component>]]></programlisting>
+
<para>
This configuration points to the locale configuration file.
</para>
@@ -99,55 +98,55 @@
<area coords="22" id="area-Reference_Guide-i18n.locales.configuration.orientation" />
</areaspec>
-<programlisting><?xml version="1.0" encoding="UTF-8"?>
-<locales-config>
- <locale-config>
- <locale>en</locale>
- <output-encoding>UTF-8</output-encoding>
- <input-encoding>UTF-8</input-encoding>
- <description>Default configuration for english locale</description>
- </locale-config>
+<programlisting language="XML" role="XML"><![CDATA[<?xml version="1.0" encoding="UTF-8"?>
+<locales-config>
+ <locale-config>
+ <locale>en</locale>
+ <output-encoding>UTF-8</output-encoding>
+ <input-encoding>UTF-8</input-encoding>
+ <description>Default configuration for english locale</description>
+ </locale-config>
- <locale-config>
- <locale>fr</locale>
- <output-encoding>UTF-8</output-encoding>
- <input-encoding>UTF-8</input-encoding>
- <description>Default configuration for the french locale</description>
- </locale-config>
+ <locale-config>
+ <locale>fr</locale>
+ <output-encoding>UTF-8</output-encoding>
+ <input-encoding>UTF-8</input-encoding>
+ <description>Default configuration for the french locale</description>
+ </locale-config>
- <locale-config>
- <locale>ar</locale>
- <output-encoding>UTF-8</output-encoding>
- <input-encoding>UTF-8</input-encoding>
- <description>Default configuration for the arabic locale</description>
- <orientation>rt</orientation>
- </locale-config>
-</locales-config>
-</programlisting>
+ <locale-config>
+ <locale>ar</locale>
+ <output-encoding>UTF-8</output-encoding>
+ <input-encoding>UTF-8</input-encoding>
+ <description>Default configuration for the arabic locale</description>
+ <orientation>rt</orientation>
+ </locale-config>
+</locales-config>]]></programlisting>
+
<calloutlist>
<callout arearefs="area-Reference_Guide-i18n.locales.configuration.locale">
<para>
- <emphasis>locale</emphasis> The locale has to be defined such as defined here <ulink type="http" url="http://ftp.ics.uci.edu-pub-ietf-http-related-iso639.txt" />. In this example "<emphasis>ar</emphasis>" is Arabic.
+ <emphasis>locale</emphasis>: The locale has to be defined such as defined here <ulink type="http" url="http://ftp.ics.uci.edu-pub-ietf-http-related-iso639.txt" />. In this example "<emphasis>ar</emphasis>" is Arabic.
</para>
</callout>
<callout arearefs="area-Reference_Guide-i18n.locales.configuration.output-encoding">
<para>
- <emphasis>output-encoding</emphasis> deals with character encoding. It is recommended that <emphasis role="bold">UTF-8</emphasis> be used.
+ <emphasis>output-encoding</emphasis>: deals with character encoding. It is recommended that <emphasis role="bold">UTF-8</emphasis> be used.
</para>
</callout>
<callout arearefs="area-Reference_Guide-i18n.locales.configuration.input-encoding">
<para>
- <emphasis>input-encoding</emphasis> In the java implementation, the encoding parameters will be used for the request response stream. The input-encoding parameter will be used for request <literal>setCharacterEncoding(..)</literal>.
+ <emphasis>input-encoding</emphasis>: In the java implementation, the encoding parameters will be used for the request response stream. The input-encoding parameter will be used for request <literal>setCharacterEncoding(..)</literal>.
</para>
</callout>
<callout arearefs="area-Reference_Guide-i18n.locales.configuration.description">
<para>
- <emphasis>description</emphasis> A description of the language
+ <emphasis>description</emphasis>: A description of the language
</para>
</callout>
<callout arearefs="area-Reference_Guide-i18n.locales.configuration.orientation">
<para>
- <emphasis>orientation</emphasis> Although the default orientation of text and images is Left-To-Right, &PRODUCT; supports <emphasis role="bold">Right-To-Left</emphasis> orientation. Modifying text orientation is explained in <xref linkend="chap-Reference_Guide-RTL_Right_To_Left_Framework" />.
+ <emphasis>orientation</emphasis>: Although the default orientation of text and images is Left-To-Right, &PRODUCT; supports <emphasis role="bold">Right-To-Left</emphasis> orientation. Modifying text orientation is explained in <xref linkend="chap-Reference_Guide-RTL_Right_To_Left_Framework" />.
</para>
</callout>
</calloutlist>
@@ -166,49 +165,48 @@
<area coords="24" id="area-Reference_Guide-i18n.rb.service.portal_resource_names" />
</areaspec>
-<programlisting><component>
- <key>org.exoplatform.services.resources.ResourceBundleService</key>
- <type>org.exoplatform.services.resources.impl.SimpleResourceBundleService</type>
- <init-params>
- <values-param>
- <name>classpath.resources</name>
- <description>The resources that start with the following package name should be load from file system</description>
- <value>locale.portlet</value>
- </values-param>
- <values-param>
- <name>init.resources</name>
- <description>Initiate the following resources during the first launch</description>
- <value>locale.portal.expression</value>
- <value>locale.portal.services</value>
- <value>locale.portal.webui</value>
- <value>locale.portal.custom</value>
- <value>locale.navigation.portal.classic</value>
- <value>locale.navigation.group.platform.administrators</value>
- <value>locale.navigation.group.platform.users</value>
- <value>locale.navigation.group.platform.guests</value>
- <value>locale.navigation.group.organization.management.executive-board</value>
- </values-param>
- <values-param>
- <name>portal.resource.names</name>
- <description>The properties files of the portal , those file will be merged
- into one ResoruceBundle properties </description>
- <value>locale.portal.expression</value>
- <value>locale.portal.services</value>
- <value>locale.portal.webui</value>
- <value>locale.portal.custom</value>
- </values-param>
- </init-params>
-</component>
-</programlisting>
+<programlisting language="XML" role="XML"><![CDATA[<component>
+ <key>org.exoplatform.services.resources.ResourceBundleService</key>
+ <type>org.exoplatform.services.resources.impl.SimpleResourceBundleService</type>
+ <init-params>
+ <values-param>
+ <name>classpath.resources</name>
+ <description>The resources that start with the following package name should be load from file system</description>
+ <value>locale.portlet</value>
+ </values-param>
+ <values-param>
+ <name>init.resources</name>
+ <description>Initiate the following resources during the first launch</description>
+ <value>locale.portal.expression</value>
+ <value>locale.portal.services</value>
+ <value>locale.portal.webui</value>
+ <value>locale.portal.custom</value>
+ <value>locale.navigation.portal.classic</value>
+ <value>locale.navigation.group.platform.administrators</value>
+ <value>locale.navigation.group.platform.users</value>
+ <value>locale.navigation.group.platform.guests</value>
+ <value>locale.navigation.group.organization.management.executive-board</value>
+ </values-param>
+ <values-param>
+ <name>portal.resource.names</name>
+ <description>The properties files of the portal , those file will be merged
+ into one ResoruceBundle properties </description>
+ <value>locale.portal.expression</value>
+ <value>locale.portal.services</value>
+ <value>locale.portal.webui</value>
+ <value>locale.portal.custom</value>
+ </values-param>
+ </init-params>
+</component>]]></programlisting>
<calloutlist>
<callout arearefs="area-Reference_Guide-i18n.rb.service.classpath_resources">
<para>
- <emphasis>classpath.resources</emphasis> are discussed in a later section.
+ <emphasis>classpath.resources</emphasis>: These are discussed in a later section.
</para>
</callout>
<callout arearefs="area-Reference_Guide-i18n.rb.service.portal_resource_names">
<para>
- <emphasis>portal.resource.names</emphasis> Defines all resources that belong to the <emphasis>Portal Resource Bundle</emphasis>.
+ <emphasis>portal.resource.names</emphasis>: Defines all resources that belong to the <emphasis>Portal Resource Bundle</emphasis>.
</para>
<para>
These resources are merged to a single resource bundle which is accessible from anywhere in &PRODUCT;. All these keys are located in the same bundle, which is separated from the navigation resource bundles.
@@ -257,14 +255,9 @@
All shipped portlet resources are located in the <emphasis role="bold">locale/portlet</emphasis> subfolder. The ResourceBundleService parameter <emphasis role="bold">classpath.resources</emphasis> defines this subfolder. <!-- Doing so the resource file that are in ~~locale/portlet~~ will never be stored in the JCR and reloaded at each start of the application server. -->
</para>
<procedure id="proc-Reference_Guide-_Portlets_-Example">
- <title>Example</title>
+ <title>To add a Spanish translation to the <parameter>GadgetPortlet</parameter></title>
<step>
<para>
- To add a Spanish translation to the <parameter>GadgetPortlet</parameter>.
- </para>
- </step>
- <step>
- <para>
Create the file <literal>GadgetPortlet_es.properties</literal> in: <filename>WEB-INF/classes/locale/portlet/gadget/GadgetPortlet</filename>.
</para>
</step>
@@ -273,10 +266,10 @@
In <filename>portlet.xml</filename>, add <parameter>Spanish</parameter> as a <emphasis role="bold">supported-locale</emphasis> ('<emphasis role="bold">es</emphasis>' is the two letter code for Spanish). The <emphasis role="bold">resource-bundle</emphasis> is already declared and is the same for all languages :
</para>
-<programlisting role="XML"><supported-locale>en</supported-locale>
-<supported-locale>es</supported-locale>
-<resource-bundle>locale.portlet.gadget.GadgetPortlet</resource-bundle>
-</programlisting>
+<programlisting language="XML" role="XML"><![CDATA[<supported-locale>en</supported-locale>
+<supported-locale>es</supported-locale>
+<resource-bundle>locale.portlet.gadget.GadgetPortlet</resource-bundle>]]></programlisting>
+
</step>
</procedure>
@@ -289,10 +282,9 @@
The portlet specifications 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>
-<programlisting> javax.portlet.title=Breadcrumbs Portlet
+<programlisting language="Java" role="JAVA"><![CDATA[javax.portlet.title=Breadcrumbs Portlet
javax.portlet.short-title=Breadcrumbs
- javax.portlet.keywords=Breadcrumbs, Breadcrumb
-</programlisting>
+ javax.portlet.keywords=Breadcrumbs, Breadcrumb]]></programlisting>
</section>
<section id="sect-Reference_Guide-_Portlets_-Debugging_Resource_Bundle_Usage">
Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/JavascriptConfiguration.xml
===================================================================
--- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/JavascriptConfiguration.xml 2010-05-10 16:57:51 UTC (rev 3031)
+++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/JavascriptConfiguration.xml 2010-05-10 22:39:07 UTC (rev 3032)
@@ -1,6 +1,6 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "../../Reference_Guide.ent">
%BOOK_ENTITIES;
]>
<chapter id="chap-Reference_Guide-Javascript_Configuration">
Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/JavascriptInterApplicationCommunication.xml
===================================================================
--- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/JavascriptInterApplicationCommunication.xml 2010-05-10 16:57:51 UTC (rev 3031)
+++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/JavascriptInterApplicationCommunication.xml 2010-05-10 22:39:07 UTC (rev 3032)
@@ -1,6 +1,6 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "../../Reference_Guide.ent">
%BOOK_ENTITIES;
]>
<chapter id="chap-Reference_Guide-JavaScript_Inter_Application_Communication">
@@ -11,7 +11,7 @@
JavaScript Inter Application Communication is designed to allow applications within a page to exchange data. This library is made for broadcasting messages on topic.
</para>
<para>
- It is based on 3 functions:
+ It is based on three functions:
</para>
<itemizedlist>
<listitem>
@@ -47,7 +47,7 @@
<term>/eXo/portal/notification</term>
<listitem>
<para>
- A message is sent on this topic will prompt a popup notification in the top right of the screen.
+ A message is sent on this topic will prompt a pop-up notification in the top right of the screen.
</para>
</listitem>
</varlistentry>
@@ -248,23 +248,23 @@
<section id="sect-Reference_Guide-JavaScript_Inter_Application_Communication-Example_of_Javascript_events_usage">
<title>Example of Javascript events usage</title>
-<programlisting role="HTML"><%@ taglib uri="http://java.sun.com/portlet" prefix="portlet" %>
-<portlet:defineObjects/>
-<div>
- <p>
+<programlisting language="HTML" role="HTML"><![CDATA[<%@ taglib uri="http://java.sun.com/portlet" prefix="portlet" %>
+<portlet:defineObjects/>
+<div>
+ <p>
Received messages:
- <div id="received_<portlet:namespace/>">
+ <div id="received_<portlet:namespace/>">
- </div>
- </p>
+ </div>
+ </p>
- <p>
+ <p>
Send message:
- <input type="text" id="msg_<portlet:namespace/>"/> <a href="#" onclick="send_<portlet:namespace/>();">send</a>
- </p>
-</div>
+ <input type="text" id="msg_<portlet:namespace/>"/> <a href="#" onclick="send_<portlet:namespace/>();">send</a>
+ </p>
+</div>
-<script type="text/javascript">
+<script type="text/javascript">
Function.prototype.bind = function(object) {
var method = this;
@@ -273,29 +273,28 @@
}
}
- function send_<portlet:namespace/>() {
- var msg = document.getElementById("msg_<portlet:namespace/>").value;
- eXo.core.Topic.publish("<portlet:namespace/>", "/demo", msg);
+ function send_<portlet:namespace/>() {
+ var msg = document.getElementById("msg_<portlet:namespace/>").value;
+ eXo.core.Topic.publish("<portlet:namespace/>", "/demo", msg);
}
- function Listener_<portlet:namespace/>(){
+ function Listener_<portlet:namespace/>(){
}
- Listener_<portlet:namespace/>.prototype.receiveMsg = function(event) {
- document.getElementById("received_<portlet:namespace/>").innerHTML =
- document.getElementById("received_<portlet:namespace/>").innerHTML + "<br />* " +
+ Listener_<portlet:namespace/>.prototype.receiveMsg = function(event) {
+ document.getElementById("received_<portlet:namespace/>").innerHTML =
+ document.getElementById("received_<portlet:namespace/>").innerHTML + "<br />* " +
event.senderId + ": " + event.message;
}
- function init_<portlet:namespace/>() {
- var listener_<portlet:namespace/> = new Listener_<portlet:namespace/>();
- eXo.core.Topic.subscribe("/demo", listener_<portlet:namespace/>.receiveMsg.bind(listener_<portlet:namespace/>));
+ function init_<portlet:namespace/>() {
+ var listener_<portlet:namespace/> = new Listener_<portlet:namespace/>();
+ eXo.core.Topic.subscribe("/demo", listener_<portlet:namespace/>.receiveMsg.bind(listener_<portlet:namespace/>));
}
- init_<portlet:namespace/>();
-</script>
-</programlisting>
+ init_<portlet:namespace/>();
+</script>]]></programlisting>
</section>
</chapter>
Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/PortalLifecycle.xml
===================================================================
--- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/PortalLifecycle.xml 2010-05-10 16:57:51 UTC (rev 3031)
+++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/PortalLifecycle.xml 2010-05-10 22:39:07 UTC (rev 3032)
@@ -1,6 +1,6 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "../../Reference_Guide.ent">
%BOOK_ENTITIES;
]>
<chapter id="chap-Reference_Guide-Portal_Lifecycle">
@@ -8,7 +8,7 @@
<section id="sect-Reference_Guide-Portal_Lifecycle-Overview">
<title>Overview</title>
<para>
- This chapter describes the portal life-cycle from the application server start to its stop as well as how requests are handled.
+ This chapter describes the portal life-cycle from the application server start to its stop including how requests are handled.
</para>
</section>
@@ -99,22 +99,21 @@
<note>
<title>Servlet Configuration</title>
<para>
- As the servlet is already configured this example is for information only.
+ <emphasis role="bold">As the servlet is already configured this example is for information only.</emphasis>
</para>
</note>
-<programlisting role="XML">
-<servlet>
- <servlet-name>TomcatGateInServlet</servlet-name>
- <servlet-class>org.gatein.wci.command.CommandServlet</servlet-class>
- <load-on-startup>0</load-on-startup>
-</servlet>
+<programlisting language="XML" role="XML"><![CDATA[<servlet>
+ <servlet-name>TomcatGateInServlet</servlet-name>
+ <servlet-class>org.gatein.wci.command.CommandServlet</servlet-class>
+ <load-on-startup>0</load-on-startup>
+</servlet>
-<servlet-mapping>
- <servlet-name>TomcatGateInServlet</servlet-name>
- <url-pattern>/tomcatgateinservlet</url-pattern>
-</servlet-mapping>
-</programlisting>
+<servlet-mapping>
+ <servlet-name>TomcatGateInServlet</servlet-name>
+ <url-pattern>/tomcatgateinservlet</url-pattern>
+</servlet-mapping>]]></programlisting>
+
<para>
It is possible to filter on the <literal>CommandServlet</literal> by filtering the URL pattern used by the servlet mapping.
</para>
@@ -124,9 +123,7 @@
<para>
The filter class:
</para>
-
-<programlisting role="JAVA">
-package org.example;
+<programlisting language="Java" role="JAVA"><![CDATA[package org.example;
import java.io.IOException;
@@ -156,7 +153,8 @@
}
}
-</programlisting>
+]]></programlisting>
+
<para>
The Java EE web application configuration file (<filename>web.xml</filename>) of the portlet is the file on which we want to know the time to serve a portlet request.
</para>
@@ -164,30 +162,29 @@
As mentioned above nothing specific to &PRODUCT; needs to be included, only the URL pattern to set has to be known.
</para>
-<programlisting role="XML">
-<?xml version="1.0"?>
-<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+<programlisting language="XML" role="XML"><![CDATA[<?xml version="1.0"?>
+<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd"
- version="2.5">
+ version="2.5">
- <filter>
- <filter-name>MyFilter</filter-name>
- <filter-class>org.example.MyFilter</filter-class>
- </filter>
+ <filter>
+ <filter-name>MyFilter</filter-name>
+ <filter-class>org.example.MyFilter</filter-class>
+ </filter>
- <filter-mapping>
- <filter-name>MyFilter</filter-name>
- <url-pattern>/tomcatgateinservlet</url-pattern>
- <dispatcher>INCLUDE</dispatcher>
- </filter-mapping>
+ <filter-mapping>
+ <filter-name>MyFilter</filter-name>
+ <url-pattern>/tomcatgateinservlet</url-pattern>
+ <dispatcher>INCLUDE</dispatcher>
+ </filter-mapping>
-</web-app>
-</programlisting>
+</web-app>]]></programlisting>
+
<para>
<note>
<title>INCLUDE dispatcher</title>
<para>
- It is important to set <literal>INCLUDE</literal> as dispatcher as the portal will always hit the <literal>CommandServlet</literal> through a request dispatcher. Without this, the filter will not be triggered, unless direct access to a resource (such as an image).
+ It is important to set <literal>INCLUDE</literal> as dispatcher as the portal will always hit the <literal>CommandServlet</literal> through a request dispatcher. Without this, the filter will not be triggered, unless direct access to a resource (such as an image) is set.
</para>
</note>
</para>
Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/RTLFramework.xml
===================================================================
--- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/RTLFramework.xml 2010-05-10 16:57:51 UTC (rev 3031)
+++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/RTLFramework.xml 2010-05-10 22:39:07 UTC (rev 3032)
@@ -1,6 +1,6 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "../../Reference_Guide.ent">
%BOOK_ENTITIES;
]>
<chapter id="chap-Reference_Guide-RTL_Right_To_Left_Framework">
@@ -9,18 +9,17 @@
The text orientation depends on the current locale setting. The orientation is a Java 5 enum that provides a set of functionalities:
</para>
-<programlisting>
- LT, // Western Europe
+<programlisting language="Java" role="JAVA"><![CDATA[ LT, // Western Europe
RT, // Middle East (Arabic, Hebrew)
TL, // Japanese, Chinese, Korean
TR; // Mongolian
public boolean isLT() { ... }
public boolean isRT() { ... }
public boolean isTL() { ... }
- public boolean isTR() { ... }
-</programlisting>
+ public boolean isTR() { ... }]]></programlisting>
+
<para>
- The object defining the Orientation for the current request is the <literal>UIPortalApplication</literal>. However it should be accessed at runtime using the <literal>RequestContext</literal> that delegates to the <literal>UIPortalApplication</literal>.
+ The object defining the orientation for the current request is the <literal>UIPortalApplication</literal>. However it should be accessed at runtime using the <literal>RequestContext</literal> that delegates to the <literal>UIPortalApplication</literal>.
</para>
<para>
In the case of a <literal>PortalRequestContext</literal> it is a direct delegate as the <literal>PortalRequestContext</literal> has a reference to the current <literal>UIPortalApplication</literal>.
@@ -83,7 +82,9 @@
<formalpara id="form-Reference_Guide-Stylesheet-Example_1">
<title>Example 1</title>
<para>
- In the example we need to use the orientation to modify the float attribute that will make the horizontal tabs either float on left or on right:
+ In the example we need to use the orientation to modify the float attribute that will make the horizontal tabs either float on left or on right:
+ </para>
+ </formalpara>
<programlisting>
float: left; /* orientation=lt */
float: right; /* orientation=rt */
@@ -91,52 +92,60 @@
text-align: center;
white-space: nowrap;
</programlisting>
- The LT produced output will be:
+ <para>
+ The LT produced output will be:
+ </para>
<programlisting>
float: left; /* orientation=lt */
font-weight: bold;
text-align: center;
white-space: nowrap;
</programlisting>
- The RT produced output will be:
+ <para>
+ The RT produced output will be:
+ </para>
<programlisting>
float: right; /* orientation=rt */
font-weight: bold;
text-align: center;
white-space: nowrap;
</programlisting>
- </para>
- </formalpara>
+
<formalpara id="form-Reference_Guide-Stylesheet-Example_2">
<title>Example 2</title>
<para>
- In this example we need to modify the padding according to the orientation:
+ In this example we need to modify the padding according to the orientation:
+ </para>
+ </formalpara>
<programlisting>
color: white;
line-height: 24px;
padding: 0px 5px 0px 0px; /* orientation=lt */
padding: 0px 0px 0px 5px; /* >orientation=rt */
</programlisting>
- The LT produced output will be:
+ <para>
+ The LT produced output will be:
+ </para>
<programlisting>
color: white;
line-height: 24px;
padding: 0px 5px 0px 0px; /* orientation=lt */
</programlisting>
- The RT produced output will be:
+ <para>
+ The RT produced output will be:
+ </para>
<programlisting>
color: white;
line-height: 24px;
padding: 0px 0px 0px 5px; /* orientation=rt */
</programlisting>
- </para>
- </formalpara>
+
</section>
<section id="sect-Reference_Guide-RTL_Right_To_Left_Framework-Images">
<title>Images</title>
<para>
- Sometimes it is necessary to create an RT version of an image that will be used from a template or from a stylesheet. However symmetric images can be automatically generated avoiding the necessity to create a mirrored version of an image and furthermore avoiding maintenance cost.
+ Sometimes it is necessary to create an RT version of an image that will be used from a template or from a stylesheet. However symmetric images can be automatically generated, avoiding the necessity to create a mirrored version of an image and further maintenance costs.
</para>
<para>
The web resource filter uses the same naming pattern as the skin service. When an image ends with the -rt suffix the portal will attempt to locate the original image and create a mirror of it.
Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/Skinning.xml
===================================================================
--- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/Skinning.xml 2010-05-10 16:57:51 UTC (rev 3031)
+++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/Skinning.xml 2010-05-10 22:39:07 UTC (rev 3032)
@@ -1,6 +1,6 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "../../Reference_Guide.ent">
%BOOK_ENTITIES;
]>
<chapter id="chap-Reference_Guide-Skinning_the_portal">
@@ -8,14 +8,14 @@
<section id="sect-Reference_Guide-Skinning_the_portal-Overview">
<title>Overview</title>
<para>
- &PRODUCT; provides robust skinning support for the entire portal User Interface (UI). This includes support for skinning all of the common portal elements as well as being able to provide custom skins and window decoration for individual portlets. All of this designed with common graphic resource reuse and ease of development in mind.
+ &PRODUCT; provides robust skinning support for the entire portal User Interface (UI). This includes support for skinning all of the common portal elements as well as being able to provide custom skins and window decoration for individual portlets. This has been designed with common graphic resource reuse and ease of development in mind.
</para>
</section>
<section id="sect-Reference_Guide-Skinning_the_portal-Skin_Components">
<title>Skin Components</title>
<para>
- The complete skinning of a page is composed of three main parts:
+ The skinning of a page is composed of three separate parts:
</para>
<variablelist>
<varlistentry>
@@ -30,7 +30,7 @@
<term>Window Styles</term>
<listitem>
<para>
- The CSS styles associated with the porlet window decorators. The window decorators contain the control buttons and borders surrounding each portlet. Individual portlets can have their own window decorator selected, or be rendered without one.
+ The CSS styles associated with the porlet window decorators. The window decorators contain the control buttons and borders surrounding each portlet. Individual portlets can have their own window decorator selected or be rendered without one.
</para>
</listitem>
</varlistentry>
@@ -38,7 +38,7 @@
<term>Portlet Skins</term>
<listitem>
<para>
- The portlet skins effect how portlets are rendered on the page. There are two main ways this can be affected:
+ The portlet skins dictate how portlets are rendered on the page. There are two main ways they can be effected:
</para>
<variablelist>
<varlistentry>
@@ -77,10 +77,10 @@
<section id="sect-Reference_Guide-Skin_Selection-Skin_Selection_Through_the_User_Interface">
<title>Skin Selection Through the User Interface</title>
<para>
- There are a few means in which a skin can be selected to be displayed to the user. The easiest way to change the skin is select it through the user interface. An administrator can change the default skin for the portal, or a logged in user can select which skin they would prefer to be displayed.
+ A skin can be selected to be displayed to the user by multiple means. The easiest way to change the skin is to select it through the user interface. An administrator can change the default skin for the portal, or a logged in user can select which skin they would prefer to be displayed.
</para>
<para>
- Please see the <ulink type="http" url="http://www.redhat.com/docs/en-US/JBoss_Enterprise_Portal_Platform/5.0/htm...">User Guide</ulink> for information on how to change the skin using the user interface.
+ Please see the <ulink type="http" url="http://www.redhat.com/docs/en-US/JBoss_Enterprise_Portal_Platform/">User Guide</ulink> for information on how to change the skin using the user interface.
</para>
</section>
@@ -96,14 +96,13 @@
To change the skin to <literal>MySkin</literal> you would make the following changes:
</para>
-<programlisting role="XML"><portal-config>
- <portal-name>classic</portal-name>
- <locale>en</locale>
- <access-permissions>Everyone</access-permissions>
- <edit-permission>*:/platform/administrators</edit-permission>
- <skin>MySkin</skin>
- ...
-</programlisting>
+<programlisting language="XML" role="XML"><![CDATA[<portal-config>
+ <portal-name>classic</portal-name>
+ <locale>en</locale>
+ <access-permissions>Everyone</access-permissions>
+ <edit-permission>*:/platform/administrators</edit-permission>
+ <skin>MySkin</skin>
+ ...]]></programlisting>
</section>
</section>
@@ -121,7 +120,7 @@
<term>Portal Skin</term>
<listitem>
<para>
- The portal skin will appear as a single link to a CSS file. This link will contain contents from all the portal skin classes merged into one file. This allows the portal skin to be transfered as a single file instead of multiple smaller files. Included with every page render <emphasis>>-- Unsure what this is referring to.</emphasis>
+ The portal skin will appear as a single link to a CSS file. This link will contain contents from all the portal skin classes merged into one file. This allows the portal skin to be transferred as a single file instead of multiple smaller files.
</para>
</listitem>
</varlistentry>
@@ -137,20 +136,20 @@
<para>
In the code fragment below you can see the two types of links:
</para>
-
-<programlisting role="XML"><head>
+<programlisting language="XML" role="XML"><![CDATA[<head>
...
-<!-- The portal skin -->
-<link id="CoreSkin" rel="stylesheet" type="text/CSS" href="/eXoResources/skin/Stylesheet.CSS" />
+<!-- The portal skin -->
+<link id="CoreSkin" rel="stylesheet" type="text/CSS" href="/eXoResources/skin/Stylesheet.CSS" />
-<!-- The portlet skins -->
-<link id="web_FooterPortlet" rel="stylesheet" type="text/CSS" href= "/web/skin/portal/webui/component/UIFooterPortlet/DefaultStylesheet.CSS" />
-<link id="web_NavigationPortlet" rel="stylesheet" type="text/CSS" href= "/web/skin/portal/webui/component/UINavigationPortlet/DefaultStylesheet.CSS" />
-<link id="web_HomePagePortlet" rel="stylesheet" type="text/CSS" href= "/portal/templates/skin/webui/component/UIHomePagePortlet/DefaultStylesheet.CSS" />
-<link id="web_BannerPortlet" rel="stylesheet" type="text/CSS" href= "/web/skin/portal/webui/component/UIBannerPortlet/DefaultStylesheet.CSS" />
+<!-- The portlet skins -->
+<link id="web_FooterPortlet" rel="stylesheet" type="text/CSS" href= "/web/skin/portal/webui/component/UIFooterPortlet/DefaultStylesheet.CSS" />
+<link id="web_NavigationPortlet" rel="stylesheet" type="text/CSS" href= "/web/skin/portal/webui/component/UINavigationPortlet/DefaultStylesheet.CSS" />
+<link id="web_HomePagePortlet" rel="stylesheet" type="text/CSS" href= "/portal/templates/skin/webui/component/UIHomePagePortlet/DefaultStylesheet.CSS" />
+<link id="web_BannerPortlet" rel="stylesheet" type="text/CSS" href= "/web/skin/portal/webui/component/UIBannerPortlet/DefaultStylesheet.CSS" />
...
-</head>
-</programlisting>
+</head>
+]]></programlisting>
+
<note>
<title>CSS Classes</title>
<para>
@@ -162,40 +161,39 @@
<section id="sect-Reference_Guide-Skinning_the_portal-The_Skin_Service">
<title>The Skin Service</title>
<para>
- The skin service is a service which manages the various types of skins. It is reponsible for discovering and deploying the skins into the portal.
+ The skin service manages the various types of skins. It is responsible for discovering and deploying skins into the portal.
</para>
<section id="sect-Reference_Guide-The_Skin_Service-Skin_configuration">
<title>Skin configuration</title>
<para>
- &PRODUCT; automatically discovers web archives that contain a file descriptor for skins (<filename>WEB-INF/gatein-resources.xml</filename>). This file is reponsible for specifying the portal, portlet and window decorators to be deployed into the skin service.
+ &PRODUCT; automatically discovers web archives that contain a file descriptor for skins (<filename>WEB-INF/gatein-resources.xml</filename>). This file is responsible for specifying the portal, portlet and window decorators to be deployed into the skin service.
</para>
<para>
The full schema can be found at: <ulink type="http" url="http://www.gatein.org/xml/ns/gatein_resources_1_0"/>.
</para>
<para>
- Here is an example where we define a skin (<literal>MySkin</literal>) with its CSS location, and specify a few window decorator skins:
+ Below is an example of where to define a skin (<literal>MySkin</literal>) with its CSS location, and specify some window decorator skins:
</para>
-<programlisting role="XML"><gatein-resources>
- <portal-skin>
- <skin-name>MySkin</skin-name>
- <CSS-path>/skin/myskin.CSS</CSS-path>
- <overwrite>false</overwrite>
- </portal-skin>
-</gatein-resources>
+<programlisting language="XML" role="XML"><![CDATA[<gatein-resources>
+ <portal-skin>
+ <skin-name>MySkin</skin-name>
+ <CSS-path>/skin/myskin.CSS</CSS-path>
+ <overwrite>false</overwrite>
+ </portal-skin>
+</gatein-resources>
- <!-- window style -->
- <window-style>
- <style-name>MyThemeCategory</style-name>
- <style-theme>
- <theme-name>MyThemeBlue</theme-name>
- </style-theme>
- <style-theme>
- <theme-name>MyThemeRed</theme-name>
- </style-theme>
- ...
-</programlisting>
+ <!-- window style -->
+ <window-style>
+ <style-name>MyThemeCategory</style-name>
+ <style-theme>
+ <theme-name>MyThemeBlue</theme-name>
+ </style-theme>
+ <style-theme>
+ <theme-name>MyThemeRed</theme-name>
+ </style-theme>
+ ...]]></programlisting>
</section>
<section id="sect-Reference_Guide-The_Skin_Service-Resource_Request_Filter">
@@ -207,16 +205,16 @@
Any new web applications containing skinning CSS files will need to have the following added to their <filename>web.xml</filename> :
</para>
-<programlisting role="XML"><filter>
- <filter-name>ResourceRequestFilter</filter-name>
- <filter-class>org.exoplatform.portal.application.ResourceRequestFilter</filter-class>
- </filter>
+<programlisting language="XML" role="XML"><![CDATA[<filter>
+ <filter-name>ResourceRequestFilter</filter-name>
+ <filter-class>org.exoplatform.portal.application.ResourceRequestFilter</filter-class>
+ </filter>
- <filter-mapping>
- <filter-name>ResourceRequestFilter</filter-name>
- <url-pattern>*.CSS</url-pattern>
- </filter-mapping>
-</programlisting>
+ <filter-mapping>
+ <filter-name>ResourceRequestFilter</filter-name>
+ <url-pattern>*.CSS</url-pattern>
+ </filter-mapping>
+]]></programlisting>
<note>
<title>The <literal>display-name</literal> Element</title>
@@ -232,52 +230,6 @@
<para>
The default skin for &PRODUCT; is located as part of the <literal>01eXoResource.war</literal>. The main files associated with the skin are:
</para>
-<!-- <programlistingco>
- <areaspec>
- <area coords="1" id="area-Reference_Guide-Skin_Configuration-Default_Skin-gatein-resources" />
- <area coords="2" id="area-Reference_Guide-Skin_Configuration-Default_Skin-web" />
- <area coords="3" id="area-Reference_Guide-Skin_Configuration-Default_Skin-skin-Stylesheet" />
- </areaspec>
-
-<programlisting>WEB-INF/gatein-resources.xml
-WEB-INF/web.xml
-skin/Stylesheet.CSS
-</programlisting>
- <calloutlist>
- <callout arearefs="area-Reference_Guide-Skin_Configuration-Default_Skin-gatein-resources">
- <para>
- gatein-resources.xml: defines the skin setup to use
- </para>
- </callout>
- <callout arearefs="area-Reference_Guide-Skin_Configuration-Default_Skin-web">
- <para>
- web.xml: contains the resource filer and has the display-name set
- </para>
- </callout>
- <callout arearefs="area-Reference_Guide-Skin_Configuration-Default_Skin-skin-Stylesheet">
- <para>
- Stylesheet.CSS: contains the CSS class definitions for this skin.
- </para>
- </callout>
- </calloutlist>
- </programlistingco> -->
- <itemizedlist>
- <listitem>
- <para>
- <filename>WEB-INF/gatein-resources.xml</filename>
- </para>
- </listitem>
- <listitem>
- <para>
- <filename>WEB-INF/web.xml</filename>
- </para>
- </listitem>
- <listitem>
- <para>
- <filename>skin/Stylesheet.CSS</filename>
- </para>
- </listitem>
- </itemizedlist>
<variablelist>
<varlistentry>
<term>gatein-resources.xml</term>
@@ -339,7 +291,7 @@
</programlistingco>
<para>
- Instead of defining all the CSS classes in this one file, we are instead importing other CSS stylesheet files, some of which may also import other CSS stylesheets. Splitting the CSS classes between multiple files allows new skins to reuse parts of the default skin.
+ This method imports other CSS stylesheet files (some of which may also import further CSS stylesheets) instead of defining all the CSS classes in this one file. Splitting the CSS classes between multiple files allows new skins to reuse parts of the default skin.
</para>
<para>
To reuse a CSS stylesheet from the default portal skin you would need to reference the default skin from <literal>eXoResources</literal>. For example; to include the window decorators from the default skin within a new portal skin you would need to use this import:
@@ -350,7 +302,7 @@
<note>
<title>Stylesheet Merging</title>
<para>
- When the portal skin is added to the page, it merge all the CSS stylesheets into a single file.
+ When the portal skin is added to the page, it merges all the CSS stylesheets into a single file.
</para>
</note>
</listitem>
@@ -371,14 +323,14 @@
The <filename>gatein-resources.xml</filename> will need to specify the new portal skin. This will include the name of the new skin, where to locate its CSS stylesheet file and whether to overwrite an existing portal theme with the same name.
</para>
-<programlisting role="XML"><gatein-resources>
- <portal-skin>
- <skin-name>MySkin</skin-name>
- <CSS-path>/skin/myskin.CSS</CSS-path>
- <overwrite>false</overwrite>
- </portal-skin>
-</gatein-resources>
-</programlisting>
+<programlisting language="XML" role="XML"><![CDATA[<gatein-resources>
+ <portal-skin>
+ <skin-name>MySkin</skin-name>
+ <CSS-path>/skin/myskin.CSS</CSS-path>
+ <overwrite>false</overwrite>
+ </portal-skin>
+</gatein-resources>]]></programlisting>
+
<para>
The default portal skin and window styles are defined in <filename>01eXoResources.war/WEB-INF/gatein-resources.xml</filename>.
</para>
@@ -393,7 +345,7 @@
<section id="sect-Reference_Guide-Creating_a_New_Portal_Skin-Portal_Skin_Preview_Icon">
<title>Portal Skin Preview Icon</title>
<para>
- When selecting a skin it is possible to see a preview of what the skin will look like. The current skin needs to know about the skin icons for all the available skins, otherwise it will not be able to show the previews.
+ It is possible to see a preview of what the portal will look like when selecting a new skin. This functionality relies on the current skin being updated with skin icons for all other available skins. Otherwise it will not be able to show the previews.
</para>
<para>
It is recommended that preview icons of any other skins are included when creating a new portal skin and that the other skins are updated with your new portal skin preview.
@@ -415,12 +367,14 @@
<programlisting>.UIChangeSkinForm .UIItemSelector .TemplateContainer .<emphasis role="bold">MySkinImage</emphasis>
</programlisting>
+
<para>
- In order for the default skin to know about the skin icon for a new portal skin, the preview screenshot needs to be place in: <filename>01eXoResources.war:/skin/DefaultSkin/portal/webui/component/customization/UIChangeSkinForm/background</filename>.
+ In order for the default skin to display the skin icon for a new portal skin, the preview screenshot needs to be placed in: <filename>01eXoResources.war:/skin/DefaultSkin/portal/webui/component/customization/UIChangeSkinForm/background</filename>.
</para>
<para>
The CSS stylesheet for the default portal needs to have the following updated with the preview icon CSS class. For a skin named <emphasis role="bold">MySkin</emphasis> then the following needs to be updated: <filename>01eXoResources.war:/skin/DefaultSkin/portal/webui/component/customization/UIChangeSkinForm/Stylesheet.CSS</filename>.
</para>
+
<programlisting>.UIChangeSkinForm .UIItemSelector .TemplateContainer .<emphasis role="bold">MySkinImage</emphasis> {
margin: auto;
width: 329px; height:204px;
@@ -435,7 +389,7 @@
<section id="sect-Reference_Guide-Creating_New_Skins-Creating_a_New_Window_Style">
<title>Creating a New Window Style</title>
<para>
- Window styles are the CSS applied to window decorations. An administrator can decide which style of decoration should go around the window when he adds a new application or gadget to a page.
+ Window styles are the CSS applied to window decorations. An administrator can decide which style of decoration should go around the window when they add a new application or gadget to a page.
</para>
<mediaobject>
<imageobject role="html">
@@ -455,24 +409,27 @@
The following <filename>gatein-resource.xml</filename> fragment will add <literal>MyThemeBlue</literal> and <literal>MyThemeRed</literal> to the <literal>MyTheme</literal> category.
</para>
-<programlisting role="XML"><window-style>
- <style-name>MyTheme</style-name>
- <style-theme>
- <theme-name>MyThemeBlue</theme-name>
- </style-theme>
- <style-theme>
- <theme-name>MyThemeRed</theme-name>
- </style-theme>
-</window-style>
-</programlisting>
+<programlisting language="XML" role="XML"><![CDATA[<window-style>
+ <style-name>MyTheme</style-name>
+ <style-theme>
+ <theme-name>MyThemeBlue</theme-name>
+ </style-theme>
+ <style-theme>
+ <theme-name>MyThemeRed</theme-name>
+ </style-theme>
+</window-style>]]></programlisting>
+
<para>
The windows style configuration for the default skin is configured in: <filename>01eXoResources.war/WEB-INF/gatein-resources.xml</filename>.
</para>
<note>
<title>Window Styles and Portal Skins</title>
<para>
- When a window style is defined in <filename>gatein-resources.xml</filename> file, it will be available to all portlets regardless of whether the current portal skin supports the window decorator or not. It is recommended that when a new window decorator is added that it be added to all portal skins or that all portal skins share a common stylesheet for window decorators.
+ When a window style is defined in <filename>gatein-resources.xml</filename> file, it will be available to all portlets regardless of whether the current portal skin supports the window decorator or not.
</para>
+ <para>
+ It is recommended that when a new window decorator is added that it be added to all portal skins or that all portal skins share a common stylesheet for window decorators.
+ </para>
</note>
</section>
@@ -641,32 +598,37 @@
Portlets often require additional styles that may not be defined by the portal skin. &PRODUCT; allows portlets to define additional stylesheets for each portlet and will append the corresponding <literal>link</literal> tags to the <literal>head</literal>.
</para>
<para>
- The link ID will be of the form <parameter>{portletAppName}{PortletName}</parameter>. For example: <literal>ContentPortlet</literal> in <literal>content.war</literal>, will give <parameter>id="content<literal>ContentPortlet"</literal></parameter>
+ The link ID will be of the form <parameter>{portletAppName}{PortletName}</parameter>.
</para>
<para>
+ For example: <literal>ContentPortlet</literal> in <literal>content.war</literal>, will give <parameter>id="content<literal>ContentPortlet"</literal></parameter>
+ </para>
+ <para>
To define a new CSS file to include whenever a portlet is available on a portal page, the following fragment needs to be added in gatein-resources.xml
-<programlisting><portlet-skin>
- <application-name>portletAppName</application-name>
- <portlet-name>PortletName</portlet-name>
- <skin-name>Default</skin-name>
- <CSS-path>/skin/DefaultStylesheet.CSS</CSS-path>
-</portlet-skin>
-
-<portlet-skin>
- <application-name>portletAppName</application-name>
- <portlet-name>PortletName</portlet-name>
- <skin-name>OtherSkin</skin-name>
- <CSS-path>/skin/OtherSkinStylesheet.CSS</CSS-path>
-</portlet-skin>
-</programlisting>
</para>
+
+<programlisting language="XML" role="XML"><![CDATA[<portlet-skin>
+ <application-name>portletAppName</application-name>
+ <portlet-name>PortletName</portlet-name>
+ <skin-name>Default</skin-name>
+ <CSS-path>/skin/DefaultStylesheet.CSS</CSS-path>
+</portlet-skin>
+
+<portlet-skin>
+ <application-name>portletAppName</application-name>
+ <portlet-name>PortletName</portlet-name>
+ <skin-name>OtherSkin</skin-name>
+ <CSS-path>/skin/OtherSkinStylesheet.CSS</CSS-path>
+</portlet-skin>]]></programlisting>
+
<para>
This will load the <literal>DefaultStylesheet.css</literal> when the Default skin is used and the <literal>OtherSkinStylesheet.css</literal> when the <literal>OtherSkin</literal> is used.
</para>
+
<note>
<title>Updating Portlet Skins</title>
<para>
- If the current portal skin is not defined as part of the supported skins, then the portlet CSS class will not be loaded. It is recommended that portlet skins are updated whenever a new portal skin is created.
+ If the current portal skin is not defined as one of the supported skins, then the portlet CSS class will not be loaded. It is recommended that portlet skins are updated whenever a new portal skin is created.
</para>
</note>
<section id="sect-Reference_Guide-How_to_Create_New_Portlet_skins-Change_portlet_icons">
@@ -725,7 +687,7 @@
By default, CSS files are cached and their imports are merged into a single CSS file at the server side. This reduces the number of HTTP requests from the browser to the server.
</para>
<para>
- The optimization code is quite simple as all the CSS files are parsed at the server startup and all the <literal>@import</literal> and <literal>url(...)</literal> references are rewritten to support a single flat file. The result is stored in a cache directly used from the <literal>ResourceRequestFilter</literal>.
+ The optimization code is quite simple as all the CSS files are parsed at the server start and all the <literal>@import</literal> and <literal>url(...)</literal> references are rewritten to support a single flat file. The result is stored in a cache directly used from the <literal>ResourceRequestFilter</literal>.
</para>
<para>
Although the optimization is useful for a production environment, it may be easier to deactivate this optimization while debugging stylesheets. Set the java system property <literal>exo.product.developing</literal> to <literal>true</literal> to disable the optimization.
@@ -739,7 +701,7 @@
<warning>
<para>
- This option may cause display bugs with certain browsers (Internet Explorer, for example).
+ This option may cause display bugs in some browsers.
</para>
</warning>
</section>
@@ -763,26 +725,23 @@
</imageobject>
</mediaobject>
-<programlisting role="HTML">
-<div class="Parent">
- <div class="TopLeft">
- <div class="TopRight">
- <div class="TopCenter"><span></span></div>
- </div>
- </div>
- <div class="CenterLeft">
- <div class="CenterRight">
- <div class="CenterCenter">BODY</div>
- </div>
- </div>
- <div class="BottomLeft">
- <div class="BottomRight">
- <div class="BottomCenter"><span></span></div>
- </div>
- <div>
-</div>
-</programlisting>
- </section>
+<programlisting language="HTML" role="HTML"><![CDATA[<div class="Parent">
+ <div class="TopLeft">
+ <div class="TopRight">
+ <div class="TopCenter"><span></span></div>
+ </div>
+ </div>
+ <div class="CenterLeft">
+ <div class="CenterRight">
+ <div class="CenterCenter">BODY</div>
+ </div>
+ </div>
+ <div class="BottomLeft">
+ <div class="BottomRight">
+ <div class="BottomCenter"><span></span></div>
+ </div>
+ <div>
+</div>]]></programlisting> </section>
<section id="sect-Reference_Guide-Some_CSS_techniques-Left_margin_left_pattern">
<title>Left Margin Left Pattern</title>
@@ -794,16 +753,14 @@
<imagedata fileref="images/PortalDevelopment/Skinning/leftMarginPattern.png" format="PNG" width="303" />
</imageobject>
</mediaobject>
-
-<programlisting role="HTML">
-<div class="Parent">
- <div style="float: left; width: 100px">
- </div>
- <div style="margin-left: 105px;">
- <div>
- <div style="clear: left"><span></span></div>
-</div>
-</programlisting>
+
+<programlisting language="HTML" role="HTML"><![CDATA[<div class="Parent">
+ <div style="float: left; width: 100px">
+ </div>
+ <div style="margin-left: 105px;">
+ <div>
+ <div style="clear: left"><span></span></div>
+</div>]]></programlisting>
</section>
</section>
Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/XMLResourceBundles.xml
===================================================================
--- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/XMLResourceBundles.xml 2010-05-10 16:57:51 UTC (rev 3031)
+++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/XMLResourceBundles.xml 2010-05-10 22:39:07 UTC (rev 3032)
@@ -1,12 +1,12 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "../../Reference_Guide.ent">
%BOOK_ENTITIES;
]>
<chapter id="chap-Reference_Guide-XML_Resources_Bundles">
<title>XML Resources Bundles</title>
<section id="sect-Reference_Guide-XML_Resources_Bundles-Motivation">
- <title>Motivation</title>
+ <title>Overview</title>
<para>
Resource bundles are usually stored in property files. However, as property files are plain files, issues with the encoding of the file may arise. The XML resource bundle format has been developed to provide an alternative to property files.
</para>
@@ -32,7 +32,7 @@
<section id="sect-Reference_Guide-XML_Resources_Bundles-XML_format">
<title>XML format</title>
<para>
- The XML format is very simple and has been developed based on the <emphasis>DRY</emphasis> (Don't Repeat Yourself) principle. Usually resource bundle keys are hierarchically defined and we can leverage the hierarchic nature of the XML for that purpose. Here is an example of turning a property file into an XML resource bundle file:
+ The XML format is very simple and has been developed based on the <emphasis>DRY</emphasis> (<ulink type="http" url="http://www.artima.com/intv/dry.html">Don't Repeat Yourself</ulink>) principle. Usually resource bundle keys are hierarchically defined and we can leverage the hierarchic nature of the XML for that purpose. Here is an example of turning a property file into an XML resource bundle file:
</para>
<programlisting>UIAccountForm.tab.label.AccountInputSet = ...
@@ -46,29 +46,29 @@
UIAccountForm.action.Reset= ...
</programlisting>
-<programlisting role="XML"><?xml version="1.0" encoding="UTF-8"?>
-<bundle>
- <UIAccountForm>
- <tab>
- <label>
- <AccountInputSet>...</AccountInputSet>
- <UIUserProfileInputSet>...</UIUserProfileInputSet>
- </label>
- </tab>
- <label>
- <Profile>...</Profile>
- <HomeInfo>...</HomeInfo>
- <BusinessInfo>...</BusinessInfo>
- <password>...</password>
- <Confirmpassword>...</Confirmpassword>
- <email>...</email>
- </label>
- <action>
- <Reset>...</Reset>
- </action>
- </UIAccountForm>
-</bundle>
-</programlisting>
+<programlisting language="XML" role="XML"><![CDATA[<?xml version="1.0" encoding="UTF-8"?>
+<bundle>
+ <UIAccountForm>
+ <tab>
+ <label>
+ <AccountInputSet>...</AccountInputSet>
+ <UIUserProfileInputSet>...</UIUserProfileInputSet>
+ </label>
+ </tab>
+ <label>
+ <Profile>...</Profile>
+ <HomeInfo>...</HomeInfo>
+ <BusinessInfo>...</BusinessInfo>
+ <password>...</password>
+ <Confirmpassword>...</Confirmpassword>
+ <email>...</email>
+ </label>
+ <action>
+ <Reset>...</Reset>
+ </action>
+ </UIAccountForm>
+</bundle>]]></programlisting>
+
</section>
<section id="sect-Reference_Guide-XML_Resources_Bundles-Portal_Support">
Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment.xml
===================================================================
--- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment.xml 2010-05-10 16:57:51 UTC (rev 3031)
+++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment.xml 2010-05-10 22:39:07 UTC (rev 3032)
@@ -14,6 +14,6 @@
<xi:include href="PortalDevelopment/RTLFramework.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="PortalDevelopment/XMLResourceBundles.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="PortalDevelopment/JavascriptInterApplicationCommunication.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
-<!-- <xi:include href="PortalDevelopment/JavascriptConfiguration.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> -->
+<!-- <xi:include href="PortalDevelopment/JavascriptConfiguration.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> File has not been edited. Noted for later release-->
</part>
Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge/configuration.xml
===================================================================
--- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge/configuration.xml 2010-05-10 16:57:51 UTC (rev 3031)
+++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge/configuration.xml 2010-05-10 22:39:07 UTC (rev 3032)
@@ -1,15 +1,15 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "../../../Reference_Guide.ent">
%BOOK_ENTITIES;
]>
<section id="sect-Reference_Guide-Bridge_Configuration">
<title>Bridge Configuration</title>
<para>
- The 329 specification is aimed at making the developers life as easy as possible with JSF+Portlet development. You will see below that there are minimal settings to getting any JSF web application up and running in the Portal environment.
+ The 329 specification is aimed at making the developer's life as easy as possible with JSF+Portlet development. You will see below that there are minimal settings to getting any JSF web application up and running in the Portal environment.
</para>
<para>
- If you are starting from scratch, we highly recommend you use the <xref linkend="sect-Reference_Guide-Getting_started_with_JBoss_Portlet_Bridge-Maven_Archetypes" />.
+ If you are new to these concepts, we highly recommend you refer to <xref linkend="sect-Reference_Guide-Getting_started_with_JBoss_Portlet_Bridge-Maven_Archetypes" />.
</para>
<section id="sect-Reference_Guide-Bridge_Configuration-Core_Setup_and_Configuration">
<title>Core Setup and Configuration</title>
@@ -19,113 +19,119 @@
The basic JSR-329 portlet configuration.
</para>
-<programlisting role="XML">
- <portlet>
- <portlet-name>yourPortletName</portlet-name>
- <portlet-class>
+<programlisting language="XML" role="XML"><![CDATA[
+ <portlet>
+ <portlet-name>yourPortletName</portlet-name>
+ <portlet-class>
javax.portlet.faces.GenericFacesPortlet
- </portlet-class>
+ </portlet-class>
- <init-param>
- <name>javax.portlet.faces.defaultViewId.view</name>
- <value>/welcome.xhtml</value>
- </init-param>
+ <init-param>
+ <name>javax.portlet.faces.defaultViewId.view</name>
+ <value>/welcome.xhtml</value>
+ </init-param>
- <init-param>
- <name>javax.portlet.faces.defaultViewId.edit</name>
- <value>/jsf/edit.xhtml</value>
- </init-param>
+ <init-param>
+ <name>javax.portlet.faces.defaultViewId.edit</name>
+ <value>/jsf/edit.xhtml</value>
+ </init-param>
- <init-param>
- <name>javax.portlet.faces.defaultViewId.help</name>
- <value>/jsf/help.xhtml</value>
- </init-param>
-</programlisting>
+ <init-param>
+ <name>javax.portlet.faces.defaultViewId.help</name>
+ <value>/jsf/help.xhtml</value>
+ </init-param>
+]]></programlisting>
<para>
- When preserveActionParams is set to TRUE, the bridge must maintain any request parameters assigned during the portlet's action request. The request parameters are maintained in the<emphasis role="italics">"bridge request scope"</emphasis>. When this attribute isn't present or is FALSE the action's request parameters are only maintained for the duration of the <emphasis role="italics">portlet request scope</emphasis>.
+ When <parameter>preserveActionParams</parameter> is set to <parameter>TRUE</parameter>, the bridge must maintain any request parameters assigned during the portlet's action request.
</para>
+ <para>
+ The request parameters are maintained in the<emphasis>"bridge request scope"</emphasis>. When this attribute is not present or is <parameter>FALSE</parameter> the action's request parameters are only maintained for the duration of the <emphasis>portlet request scope</emphasis>.
+ </para>
-<programlisting role="XML">
- <init-param>
- <name>javax.portlet.faces.preserveActionParams</name>
- <value>true</value>
- </init-param>
-</programlisting>
+<programlisting language="XML" role="XML"><![CDATA[
+ <init-param>
+ <name>javax.portlet.faces.preserveActionParams</name>
+ <value>true</value>
+ </init-param>
+]]></programlisting>
</section>
<section id="sect-Reference_Guide-Core_Setup_and_Configuration-faces_config.xml">
<title>faces-config.xml</title>
<para>
- The PortletViewHandler ensures that each JSF portlet instance is properly namespaced.
+ The <parameter>PortletViewHandler</parameter> ensures that each JSF portlet instance is properly namespaced.
</para>
-<programlisting role="XML">
- <faces-config>
- <application>
- <view-handler>
+<programlisting language="XML" role="XML"><![CDATA[
+ <faces-config>
+ <application>
+ <view-handler>
org.jboss.portletbridge.application.PortletViewHandler
- </view-handler>
- <state-manager>org.jboss.portletbridge.application.PortletStateManager</state-manager>
- </application>
+ </view-handler>
+ <state-manager>org.jboss.portletbridge.application.PortletStateManager</state-manager>
+ </application>
...
-</programlisting>
+]]></programlisting>
</section>
<section id="sect-Reference_Guide-Core_Setup_and_Configuration-Facelets_Configuration">
<title>Facelets Configuration</title>
<para>
- The following web.xml setting is only for Facelets based applications
+ The following <filename>web.xml</filename> setting is only for <literal>Facelets</literal> based applications
</para>
<section id="sect-Reference_Guide-Facelets_Configuration-web.xml">
<title>web.xml</title>
-
-<programlisting role="XML">
- <web-app xmlns="http://java.sun.com/xml/ns/j2ee"
+<programlisting language="XML" role="XML"><![CDATA[
+ <web-app xmlns="http://java.sun.com/xml/ns/j2ee"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd"
- version="2.4">
- ...
- <!-- This is optional parameters for a facelets based application -->
- <context-param>
- <param-name>org.ajax4jsf.VIEW_HANDLERS</param-name>
- <param-value>org.jboss.portletbridge.application.FaceletPortletViewHandler</param-value>
- </context-param>
-</programlisting>
- <para>
- </para>
+ version="2.4">
+ ...-->
+ <!-- This is optional parameters for a facelets based application -->
+ <!-- <context-param>
+ <param-name>org.ajax4jsf.VIEW_HANDLERS</param-name>
+ <param-value>org.jboss.portletbridge.application.FaceletPortletViewHandler</param-value>
+ </context-param>
+]]></programlisting>
-<programlisting role="XML">
- <context-param>
- <param-name>javax.portlet.faces.RENDER_POLICY</param-name>
- <param-value>
+<programlisting language="XML" role="XML"><![CDATA[
+ <context-param>
+ <param-name>javax.portlet.faces.RENDER_POLICY</param-name>
+ <param-value>
ALWAYS_DELEGATE
- </param-value>
- </context-param>
+ </param-value>
+ </context-param>
...
- </web-app>
-</programlisting>
- <note>
- <title>RenderPolicy Options</title>
+ </web-app>
+]]></programlisting>
+
+ <variablelist>
+ <title>RenderPolicy Options</title>
+ <varlistentry>
+ <term>ALWAYS_DELEGATE</term>
+ <listitem>
<para>
- <itemizedlist>
- <listitem>
- <para>
- <literal>ALWAYS_DELEGATE</literal> Indicates the bridge should not render the view itself but rather always delegate the rendering.
- </para>
- </listitem>
- <listitem>
- <para>
- <literal>NEVER_DELEGATE</literal> Indicates the bridge should always render the view itself and never delegate.
- </para>
- </listitem>
- <listitem>
- <para>
- <literal>DEFAULT</literal> Directs the bridge to first delegate the render and if and only if an Exception is thrown then render the view based on its own logic. If the configuration parameter is not present or has an invalid value the bridge renders using default behavior. I.e. as if DEFAULT is set.
- </para>
- </listitem>
- </itemizedlist>
+ Indicates the bridge should not render the view itself but rather always delegate the rendering.
</para>
- </note>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>NEVER_DELEGATE</term>
+ <listitem>
+ <para>
+ Indicates the bridge should always render the view itself and never delegate.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>DEFAULT</term>
+ <listitem>
+ <para>
+ Directs the bridge to first delegate the render and if and only if an Exception is thrown then render the view based on its own logic. If the configuration parameter is not present or has an invalid value the bridge renders using default behavior. I.e. as if DEFAULT is set.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</section>
</section>
@@ -133,26 +139,27 @@
<section id="sect-Reference_Guide-Core_Setup_and_Configuration-JSP_Only_Configuration">
<title>JSP Only Configuration</title>
<para>
- The following web.xml setting is only for JSP based applications. Download the demo application <ulink url="http://anonsvn.jboss.org/repos/portletbridge/trunk/examples/jsf-ri/1.2-ba...">here</ulink>.
+ The following <filename>web.xml</filename> setting is only for JSP based applications. Download the demonstration application <ulink url="http://anonsvn.jboss.org/repos/portletbridge/trunk/examples/jsf-ri/1.2-ba...">here</ulink>.
</para>
<section id="sect-Reference_Guide-JSP_Only_Configuration-web.xml">
<title>web.xml</title>
-<programlisting role="XML">
- <web-app xmlns="http://java.sun.com/xml/ns/j2ee"
+<programlisting language="XML" role="XML"><![CDATA[
+ <web-app xmlns="http://java.sun.com/xml/ns/j2ee"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd"
- version="2.4">
+ version="2.4">
- <context-param>
- <param-name>javax.portlet.faces.renderPolicy</param-name>
- <param-value>
+ <context-param>
+ <param-name>javax.portlet.faces.renderPolicy</param-name>
+ <param-value>
NEVER_DELEGATE
- </param-value>
- </context-param>
+ </param-value>
+ </context-param>
...
- </web-app>
-</programlisting>
+ </web-app>
+]]></programlisting>
+
</section>
</section>
@@ -160,16 +167,15 @@
<section id="sect-Reference_Guide-Core_Setup_and_Configuration-JSR_329">
<title>JSR-329</title>
<para>
- The Jboss Portlet Bridge can be used with a any compatible implementation ( for example, MyFaces implementation). Simply put the following into web.xml :
+ The Jboss Portlet Bridge can be used with a any compatible implementation (for example, <literal>MyFaces</literal> implementation). Simply put the following into <filename>web.xml</filename>:
</para>
-<programlisting role="XML">
-
- <context-param>
- <param-name>javax.portlet.faces.BridgeImplClass</param-name>
- <param-value>org.apache.myfaces.portlet.faces.bridge.BridgeImpl</param-value>
- </context-param>
-</programlisting>
+<programlisting language="XML" role="XML"><![CDATA[
+ <context-param>
+ <param-name>javax.portlet.faces.BridgeImplClass</param-name>
+ <param-value>org.apache.myfaces.portlet.faces.bridge.BridgeImpl</param-value>
+ </context-param>
+]]></programlisting>
</section>
</section>
@@ -180,65 +186,69 @@
<section id="sect-Reference_Guide-RichFaces_Setup_and_Configuration_Options-web.xml">
<title>web.xml</title>
<para>
- The following configuration is designated for portlets using the RichFaces library. These settings will vary based on your individual needs. See <ulink url="http://www.jboss.org/file-access/default/members/jbossrichfaces/freezone/..."> this section</ulink> of the RichFaces documentation for more details.
+ The following configuration is designated for portlets using the <application>RichFaces</application> library. These settings will vary based on your individual needs.
</para>
<para>
- Sometimes it is better to use the "ALL" load strategy in portlets so you do not need to worry about loading the "framework.pack.js" and "ui.pack.js" files manually in your portlet header.
+ See <ulink url="http://www.jboss.org/file-access/default/members/jbossrichfaces/freezone/..."> this section</ulink> of the <application>RichFaces</application> documentation for more details.
</para>
-
-<programlisting role="XML">
- <context-param>
- <param-name>org.richfaces.LoadStyleStrategy</param-name>
- <param-value>ALL</param-value>
- </context-param>
- <context-param>
- <param-name>org.richfaces.LoadScriptStrategy</param-name>
- <param-value>ALL</param-value>
- </context-param>
-</programlisting>
+ <para>
+ Sometimes it is better to use the "<parameter>ALL</parameter>" load strategy in portlets so you do not need to worry about loading the "framework.pack.js" and "ui.pack.js" files manually in your portlet header.
+ </para>
+
+<programlisting language="XML" role="XML"><![CDATA[
+ <context-param>
+ <param-name>org.richfaces.LoadStyleStrategy</param-name>
+ <param-value>ALL</param-value>
+ </context-param>
+ <context-param>
+ <param-name>org.richfaces.LoadScriptStrategy</param-name>
+ <param-value>ALL</param-value>
+ </context-param>
+]]></programlisting>
<note>
<para>
- If you use the "NONE" strategy, you must include the following scripts in your portlet or portal page header. If you are using JBoss Portal, you can add this to the jboss-portlet.xml file.
+ If you use the "<parameter>NONE</parameter>" strategy, you must include the following scripts in your portlet or portal page header. If you are using <application>JBoss Portal</application>, you can add this to the <filename>jboss-portlet.xml</filename> file.
</para>
</note>
<para>
- The <literal>org.ajax4jsf.RESOURCE_URI_PREFIX</literal> configuration cross references the path to your scripts below. These settings are required for RichFaces using the "NONE" strategy.
+ The <literal>org.ajax4jsf.RESOURCE_URI_PREFIX</literal> configuration cross-references the path to your scripts below. These settings are required for <application>RichFaces</application> using the "<parameter>NONE</parameter>" strategy.
</para>
-<programlisting role="XML">
- <script src="/faces/rfRes/org/ajax4jsf/framework.pack.js" type="text/javascript"></script>
- <script src="/faces/rfRes/org/richfaces/ui.pack.js" type="text/javascript"></script>
- <link rel="stylesheet" type="text/css" href="/faces/rfRes/org/richfaces/skin.xcss"/>
-</programlisting>
+<programlisting language="XML" role="XML"><![CDATA[
+ <script src="/faces/rfRes/org/ajax4jsf/framework.pack.js" type="text/javascript"></script>
+ <script src="/faces/rfRes/org/richfaces/ui.pack.js" type="text/javascript"></script>
+ <link rel="stylesheet" type="text/css" href="/faces/rfRes/org/richfaces/skin.xcss"/>
+]]></programlisting>
<para>
- Seam automatically configures your Ajax4JSF Filter, so if you are running a Seam portlet, you do not need the following Filter config. (But you do need the RESOURCE_URI_PREFIX no matter what)
+ <application>Seam</application> automatically configures your Ajax4JSF Filter, so if you are running a <application>Seam</application> portlet, you do not need the following Filter configuration (however, you do need the <literal>RESOURCE_URI_PREFIX</literal> no matter what).
</para>
-
-<programlisting role="XML">
- <context-param>
- <param-name>org.ajax4jsf.RESOURCE_URI_PREFIX</param-name>
- <param-value>rfRes</param-value>
- </context-param>
- <filter>
- <display-name>Ajax4jsf Filter</display-name>
- <filter-name>ajax4jsf</filter-name>
- <filter-class>org.ajax4jsf.Filter</filter-class>
- </filter>
+<programlisting language="XML" role="XML"><![CDATA[
+ <context-param>
+ <param-name>org.ajax4jsf.RESOURCE_URI_PREFIX</param-name>
+ <param-value>rfRes</param-value>
+ </context-param>
- <filter-mapping>
- <filter-name>ajax4jsf</filter-name>
- <servlet-name>FacesServlet</servlet-name>
- <dispatcher>FORWARD</dispatcher>
- <dispatcher>REQUEST</dispatcher>
- <dispatcher>INCLUDE</dispatcher>
- </filter-mapping>
+ <filter>
+ <display-name>Ajax4jsf Filter</display-name>
+ <filter-name>ajax4jsf</filter-name>
+ <filter-class>org.ajax4jsf.Filter</filter-class>
+ </filter>
+
+ <filter-mapping>
+ <filter-name>ajax4jsf</filter-name>
+ <servlet-name>FacesServlet</servlet-name>
+ <dispatcher>FORWARD</dispatcher>
+ <dispatcher>REQUEST</dispatcher>
+ <dispatcher>INCLUDE</dispatcher>
+ </filter-mapping>
...
- </web-app>
-</programlisting>
+ </web-app>
+]]></programlisting>
+
</section>
- <!-- <section>
+ <!-- DO NOT UNCOMMENT <section>
<title>jboss-portlet.xml</title>
<para>
To avoid scripts loading more than once from different portlet windows you can define additional scripts in
@@ -255,6 +265,7 @@
]]></programlisting>
</section> -->
+
</section>
<section id="sect-Reference_Guide-Bridge_Configuration-Seam_Setup_and_Configuration_Options">
@@ -262,81 +273,87 @@
<section id="sect-Reference_Guide-Seam_Setup_and_Configuration_Options-Configuration">
<title>Configuration</title>
<para>
- The ExceptionHandler is used to clean Seam contexts and transactions after errors.
+ The <literal>ExceptionHandler</literal> is used to clean <application>Seam</application> contexts and transactions after errors.
</para>
-<programlisting role="XML">
- <context-param>
- <param-name>org.jboss.portletbridge.ExceptionHandler</param-name>
- <param-value>
+<programlisting language="XML" role="XML"><![CDATA[
+ <context-param>
+ <param-name>org.jboss.portletbridge.ExceptionHandler</param-name>
+ <param-value>
org.jboss.portletbridge.SeamExceptionHandlerImpl
- </param-value>
- </context-param>
-</programlisting>
+ </param-value>
+ </context-param>
+]]></programlisting>
<para>
- If you are using this bridge version from 2.0.0.BETA through 2.0.0.CR1, you must define the following web.xml parameter to use the JBoss Portlet Bridge provided Seam Phase Listener. This is done by the bridge automatically (if needed) in 2.0.0.FINAL.
+ If you are using this bridge version from <literal>2.0.0.BETA</literal> through <literal>2.0.0.CR1</literal>, you must define the following <filename>web.xml</filename> parameter to use the JBoss Portlet Bridge provided Seam Phase Listener. This is done by the bridge automatically (if needed) in <literal>2.0.0.FINAL</literal>.
</para>
-<programlisting role="XML">
- <context-param>
- <param-name>javax.faces.LIFECYCLE_ID</param-name>
- <param-value>SEAM_PORTLET</param-value>
- </context-param>
-</programlisting>
+<programlisting language="XML" role="XML"><![CDATA[
+ <context-param>
+ <param-name>javax.faces.LIFECYCLE_ID</param-name>
+ <param-value>SEAM_PORTLET</param-value>
+ </context-param>
+]]></programlisting>
</section>
</section>
<section id="sect-Reference_Guide-Bridge_Configuration-Portlet_2.0_Coordination">
<title>Portlet 2.0 Coordination</title>
- <para>
- One very important thing to note before using either of the following mechanisms, is that you must have the proper 2.0 schema and xsd definition at the top of your portlet.xml.
- </para>
+ <note>
+ <title>Schema and XSD Definitions</title>
+ <para>
+ It is important to ensure, before using either of the following mechanisms, that the proper 2.0 schema and xsd are defined at the top of your <filename>portlet.xml</filename>.
+ </para>
+ </note>
-<programlisting role="XML">
- <portlet-app xmlns="http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd"
+<programlisting language="XML" role="XML"><![CDATA[
+ <portlet-app xmlns="http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd"
version="2.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd
- http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd">
-</programlisting>
+ http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd">
+]]></programlisting>
+
<section id="sect-Reference_Guide-Portlet_2.0_Coordination-Sending_and_Receiving_Events">
<title>Sending and Receiving Events</title>
<section id="sect-Reference_Guide-Sending_and_Receiving_Events-Configuration">
<title>Configuration</title>
<para>
- Just like with any portlet 2.0 event consumer and receiver, you must define them in the portlet.xml. To see a working example, checkout the Seam Booking Demo portlet. <ulink url="http://anonsvn.jboss.org/repos/portletbridge/tags/2.0.0.FINAL/examples/se..." />
+ Just like with any portlet 2.0 event consumer and receiver, you must define them in the <filename>portlet.xml</filename>.
</para>
<para>
- You must also define the following init params in your portlet.xml.
+ To see a working example, checkout the Seam Booking Demo portlet. <ulink url="http://anonsvn.jboss.org/repos/portletbridge/tags/2.0.0.FINAL/examples/se..." />
</para>
+ <para>
+ You must also define the following <emphasis>init params</emphasis> in your <filename>portlet.xml</filename>.
+ </para>
-<programlisting role="XML">
- </init-param>
- <init-param>
- <name>javax.portlet.faces.autoDispatchEvents</name>
- <value>true</value>
- </init-param>
- <init-param>
- <name>javax.portlet.faces.bridgeEventHandler</name>
- <value>org.foo.eventhandler</value>
- </init-param>
-</programlisting>
+<programlisting language="XML" role="XML"><![CDATA[
+ </init-param>
+ <init-param>
+ <name>javax.portlet.faces.autoDispatchEvents</name>
+ <value>true</value>
+ </init-param>
+ <init-param>
+ <name>javax.portlet.faces.bridgeEventHandler</name>
+ <value>org.foo.eventhandler</value>
+ </init-param>
+]]></programlisting>
<para>
- For now, you must dipatch the event in the JSF or Seam backing bean. Future versions on the 2.0 bridge will automate the dispatching and consuming of events.
+ While future versions on the 2.0 bridge will automate the dispatching and consuming of events, at the moments you must dispatch the event in the JSF or Seam backing bean.
</para>
-<programlisting role="XML">
- if (response instanceof StateAwareResponse) {
+<programlisting language="XML" role="XML"><![CDATA[ if (response instanceof StateAwareResponse) {
StateAwareResponse stateResponse = (StateAwareResponse) response;
stateResponse.setEvent(Foo.QNAME, new Bar());
}
-</programlisting>
+]]></programlisting>
<para>
- Then you must also create the event handler class by implementing the BridgeEventHandler interface to process the event payload.
+ You must also create the event handler class by implementing the <literal>BridgeEventHandler</literal> interface to process the event payload.
</para>
-<programlisting role="XML">
+<programlisting language="XML" role="XML"><![CDATA[
public class BookingEventHandler implements BridgeEventHandler
{
public EventNavigationResult handleEvent(FacesContext context, Event event)
@@ -345,7 +362,7 @@
}
}
-</programlisting>
+]]></programlisting>
</section>
</section>
@@ -355,60 +372,63 @@
<section id="sect-Reference_Guide-Public_Render_Parameters-Configuration">
<title>Configuration</title>
<para>
- Public Render Parameters (or PRPs) are one of the most powerful and simple Portlet 2.0 features. Several portlets (JSF or not) can share the same render parameters. This feature can be use to present a cohesive UI to the user across all portlets on the page (i.e. using an employee ID to display relative data).
+ Public Render Parameters (or PRPs) are one of the most powerful and simple Portlet 2.0 features. Several portlets (JSF or otherwise) can share the same render parameters. This feature can be use to present a cohesive UI to the user across all portlets on the page. An example would be using an employee ID to display relative data.
</para>
<para>
- The bridge maps a render parameter to a backing bean using settings in your faces-config.xml and portlet.xml. A clear and working example can be found in the Seam Booking Demo portlet. <ulink url="http://anonsvn.jboss.org/repos/portletbridge/tags/2.0.0.FINAL/examples/se..." />
+ The bridge maps a render parameter to a backing bean using settings in your <filename>faces-config.xml</filename> and <filename>portlet.xml</filename>.
</para>
<para>
- You must define the following init params in your portlet.xml.
+ A clear and working example can be found in the Seam Booking Demo portlet. <ulink url="http://anonsvn.jboss.org/repos/portletbridge/tags/2.0.0.FINAL/examples/se..." />
</para>
+ <para>
+ You must define the following <emphasis>init params</emphasis> in your <filename>portlet.xml</filename>.
+ </para>
-<programlisting role="XML">
- <init-param>
- <name>javax.portlet.faces.bridgePublicRenderParameterHandler</name>
- <value>org.foo.PRPHandler</value>
- </init-param>
+<programlisting language="XML" role="XML"><![CDATA[
+ <init-param>
+ <name>javax.portlet.faces.bridgePublicRenderParameterHandler</name>
+ <value>org.foo.PRPHandler</value>
+ </init-param>
...
- <supported-public-render-parameter>myCoolPRP</supported-public-render-parameter>
-</programlisting>
+ <supported-public-render-parameter>myCoolPRP</supported-public-render-parameter>
+]]></programlisting>
<para>
- Create a managed bean and public-parameter-mappings in your faces-config.xml. This should be a basic bean that you can bind the passed parameter to a string with getter and setter.
+ Create a managed bean and <literal>public-parameter-mappings</literal> in your <filename>faces-config.xml</filename>. This should be a basic bean that you can bind the passed parameter to a string with <emphasis>getter</emphasis> and <emphasis>setter</emphasis>.
</para>
-<programlisting role="XML">
- <managed-bean>
- <managed-bean-name>bookingPRP</managed-bean-name>
- <managed-bean-class>your.class.Name</managed-bean-class>
- <managed-bean-scope>session</managed-bean-scope>
- </managed-bean>
+<programlisting language="XML" role="XML"><![CDATA[
+ <managed-bean>
+ <managed-bean-name>bookingPRP</managed-bean-name>
+ <managed-bean-class>your.class.Name</managed-bean-class>
+ <managed-bean-scope>session</managed-bean-scope>
+ </managed-bean>
- <application>
- <application-extension>
- <bridge:public-parameter-mappings>
- <bridge:public-parameter-mapping>
- <parameter>"the name of your portlet":hotelName</parameter>
- <model-el>#{bookingPRP.hotelName}</model-el>
- </bridge:public-parameter-mapping>
- </bridge:public-parameter-mappings>
- </application-extension>
- </application>
-</programlisting>
+ <application>
+ <application-extension>
+ <bridge:public-parameter-mappings>
+ <bridge:public-parameter-mapping>
+ <parameter>"the name of your portlet":hotelName</parameter>
+ <model-el>#{bookingPRP.hotelName}</model-el>
+ </bridge:public-parameter-mapping>
+ </bridge:public-parameter-mappings>
+ </application-extension>
+ </application>
+]]></programlisting>
<para>
You must set the parameter in the JSF or Seam backing bean, if you are providing one from your portlet.
</para>
-<programlisting role="XML">
+<programlisting language="XML" role="XML"><![CDATA[
if (response instanceof StateAwareResponse) {
StateAwareResponse stateResponse = (StateAwareResponse) response;
stateResponse.setRenderParameter("hotelName",selectedHotel.getName());
}
-</programlisting>
+]]></programlisting>
<para>
- Then you must also implement the BridgePublicRenderParameterHandler interface to process any updates from the received parameter.
+ Then you must also implement the <literal>BridgePublicRenderParameterHandler</literal> interface to process any updates from the received parameter.
</para>
-<programlisting role="XML">
+<programlisting language="XML" role="XML"><![CDATA[
public void processUpdates(FacesContext context)
{
ELContext elContext = context.getELContext();
@@ -420,7 +440,7 @@
}
}
-</programlisting>
+]]></programlisting>
</section>
</section>
@@ -430,29 +450,29 @@
<section id="sect-Reference_Guide-Serving_Your_JSF_Resources_in_a_Portlet-Configuration">
<title>Configuration</title>
<para>
- We have setup a few examples to show you how to use EL and a simple bean that will allow you to use the portlet resource serving mechanism within a JSF portlet.
+ We have setup a few examples to show you how to use <literal>EL</literal> and a simple bean that will allow you to use the portlet resource serving mechanism within a JSF portlet.
</para>
<para>
In <ulink url="http://anonsvn.jboss.org/repos/portletbridge/tags/2.0.0.CR1/examples/rich...">ResourceBean.java</ulink>, you can see a very simple implementations of a Map object that uses the bridge to get and encode a resource url served from the portlets web application.
</para>
<para>
- So, when you have the normal "/images", "/styles" and other resource folders in your web app, you can use the following EL expression to serve them in your JSF application.
+ So, when you have the normal "<filename>/images</filename>", "<filename>/styles</filename>" and other resource folders in your web application, you can use the following <literal>EL</literal> expression to serve them in your JSF application.
</para>
-<programlisting role="XML">
+<programlisting language="XML" role="XML">
#{resource['/img/the-path-to-my-image.png']}
</programlisting>
<para>
- Just copy the ResourceBean.java code above, and add an entry to you faces-config.xml for the bean:
+ Just copy the <literal>ResourceBean.java</literal> code above, and add an entry to your <filename>faces-config.xml</filename> for the bean:
</para>
-<programlisting role="XML">
- <managed-bean>
- <managed-bean-name>resource</managed-bean-name>
- <managed-bean-class>org.richfaces.demo.common.ResourceBean</managed-bean-class>
- <managed-bean-scope>application</managed-bean-scope>
- </managed-bean>
-</programlisting>
+<programlisting language="XML" role="XML"><![CDATA[
+ <managed-bean>
+ <managed-bean-name>resource</managed-bean-name>
+ <managed-bean-class>org.richfaces.demo.common.ResourceBean</managed-bean-class>
+ <managed-bean-scope>application</managed-bean-scope>
+ </managed-bean>
+]]></programlisting>
</section>
</section>
Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge/gettingstarted.xml
===================================================================
--- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge/gettingstarted.xml 2010-05-10 16:57:51 UTC (rev 3031)
+++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge/gettingstarted.xml 2010-05-10 22:39:07 UTC (rev 3032)
@@ -1,21 +1,27 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "../../../Reference_Guide.ent">
%BOOK_ENTITIES;
]>
<section id="sect-Reference_Guide-Getting_started_with_JBoss_Portlet_Bridge">
<title>Getting started with JBoss Portlet Bridge</title>
<para>
- JBoss Portlet Bridge not only gives you the ability to run JSF web applications in a portlet, but also gives you the benefit of running supported JBoss frameworks like Seam and RichFaces.
+ JBoss Portlet Bridge not only gives you the ability to run JSF web applications in a portlet, but also gives you the benefit of running supported JBoss frameworks like <application>Seam</application> and <application>RichFaces</application>.
</para>
<section id="sect-Reference_Guide-Getting_started_with_JBoss_Portlet_Bridge-Whats_New_in_2.0">
<title>What's New in 2.0?</title>
<section id="sect-Reference_Guide-Whats_New_in_2.0-Eventing">
<title>Eventing</title>
<para>
- The bridge considers a portlet event a model event. I.e. the event is targeted to the applications data model not its view. As JSF events primarily concern its view, the bridge processes the portlet events manually, however provisions are made to make sure that any model changes that result from processing the event are updated in the view. Since event payloads are arbitrarily complex, the manual processing of the data, though managed by the bridge, is left to the (portlet) application to support.
+ The bridge considers a portlet event a model event. The event is targeted to the applications data model, not its view.
</para>
<para>
+ As JSF events primarily concern its view, the bridge processes the portlet events manually, however provisions are made to ensure that any model changes resulting from processing the event are updated in the view.
+ </para>
+ <para>
+ Since event payloads are arbitrarily complex, the manual processing of the data, though managed by the bridge, is left to the (portlet) application to support.
+ </para>
+ <para>
See <xref linkend="sect-Reference_Guide-Portlet_2.0_Coordination-Sending_and_Receiving_Events" /> for details and examples.
</para>
</section>
@@ -23,9 +29,15 @@
<section id="sect-Reference_Guide-Whats_New_in_2.0-Portlet_Served_Resources">
<title>Portlet Served Resources</title>
<para>
- The bridge deals with portlet served resources in one of two ways. If the request is for a non-JSF resource, the bridge handles the request by acquiring a request dispatcher and forwarding the request to the named resource. If the request is for a JSF resource, the bridge runs the full JSF lifecycle ensuring that data is processed and the resource (markup) is rendered.
+ The bridge deals with portlet served resources in one of two ways:
</para>
<para>
+ If the request is for a non-JSF resource, the bridge handles the request by acquiring a request dispatcher and forwarding the request to the named resource.
+ </para>
+ <para>
+ If the request is for a JSF resource, the bridge runs the full JSF lifecycle ensuring that data is processed and the resource (markup) is rendered.
+ </para>
+ <para>
See <xref linkend="sect-Reference_Guide-Portlet_2.0_Coordination-Serving_Your_JSF_Resources_in_a_Portlet" /> for details and examples.
</para>
</section>
@@ -33,9 +45,18 @@
<section id="sect-Reference_Guide-Whats_New_in_2.0-Public_Render_Parameters">
<title>Public Render Parameters</title>
<para>
- The bridge automates the processing of public render parameters. A public render parameter can be mapped to an object's accessor (get/set method) designed to handle a String representation of the value via a Faces ValueExpression. When a new public render parameter value is received in a request, the bridge sets the value by calling the ValueExpression's setValue(). At the end of a request, if the current value of any mapped public render parameter doesn't match the current incoming value, the bridge sets the new value in an outgoing public render parameter (if feasible in the given phase).
+ The bridge automates the processing of public render parameters.
</para>
<para>
+ A public render parameter can be mapped to an object's accessor (<literal>get</literal>/<literal>set</literal> method) designed to handle a String representation of the value via a <application>Faces</application> <literal>ValueExpression</literal>.
+ </para>
+ <para>
+ When a new public render parameter value is received in a request, the bridge sets the value by calling the <literal>ValueExpression</literal>'s <parameter>setValue()</parameter>.
+ </para>
+ <para>
+ At the end of a request, if the current value of any mapped public render parameter doesn't match the current incoming value, the bridge sets the new value in an outgoing public render parameter (if feasible in the given phase).
+ </para>
+ <para>
See <xref linkend="sect-Reference_Guide-Portlet_2.0_Coordination-Public_Render_Parameters" /> for details and examples.
</para>
</section>
@@ -45,45 +66,51 @@
<section id="sect-Reference_Guide-Getting_started_with_JBoss_Portlet_Bridge-Bridge_Frameworks_and_Extensions">
<title>Bridge Frameworks and Extensions</title>
<para>
- The JBoss Portlet Bridge currently supports JBoss Portal, GateIn, JSF 1.2, JBoss Seam, and JBoss Richfaces. There are configurations that apply to supporting each framework. See section <xref linkend="sect-Reference_Guide-Bridge_Configuration" /> for instructions.
+ The JBoss Portlet Bridge currently supports &PRODUCT;, <application>GateIn</application>, <application>JSF 1.2</application>, <application>JBoss Seam</application>, and <application>JBoss Richfaces</application>. There are configurations that apply to supporting each framework. See section <xref linkend="sect-Reference_Guide-Bridge_Configuration" /> for instructions.
</para>
<para>
- The JBoss Portlet Bridge project is also actively developing extensions called "Bridgelets". In this current release we decided to bring all of our bridgelets into the impl code base since they are critical in most JSF portlet applications. Now it only takes a single line of configuration to utilize these features.
+ The JBoss Portlet Bridge project is also actively developing extensions called "<emphasis role="bold">Bridgelets</emphasis>".
</para>
+ <para>
+ In this release it was decided to bring all available bridgelets into the impl code base since they are critical in most JSF portlet applications. A single line of configuration utilizes these features.
+ </para>
<section id="sect-Reference_Guide-Bridge_Frameworks_and_Extensions-Seam_Bridgelets">
<title>Seam Bridgelets</title>
<para>
- For example, the PortalIdentity seam component allows you to instantly have SSO between Seam and GateIn or JBoss Portal. This extension is configured in your Seam application's components.xml file as follows.
+ For example, the <literal>PortalIdentity</literal> <application>Seam</application> component allows you to instantly have Single Sign-On (SSO) between <application>Seam</application> and <application>GateIn</application> or <application>&PRODUCT;</application>.
</para>
+ <para>
+ This extension is configured in your <application>Seam</application> application's <filename>components.xml</filename> file as follows.
+ </para>
-<programlisting role="XML">
- <security:portal-identity authenticate-method="#{authenticator.authenticate}"/>
-</programlisting>
+<programlisting language="XML" role="XML"><![CDATA[
+<security:portal-identity authenticate-method="#{authenticator.authenticate}"/>
+]]></programlisting>
</section>
<section id="sect-Reference_Guide-Bridge_Frameworks_and_Extensions-RichFaces_Bridgelets">
<title>RichFaces Bridgelets</title>
<para>
- Richfaces does not account for multiple components on the same portal page by default. This following web.xml renders all RichFaces component javascript to be portal friendly.
+ <application>Richfaces</application> does not account for multiple components on the same portal page by default. This following <filename>web.xml</filename> renders all <application>RichFaces</application> component javascript portal-friendly.
</para>
-<programlisting role="XML">
- <context-param>
- <param-name>org.jboss.portletbridge.WRAP_SCRIPTS</param-name>
- <param-value>true</param-value>
- </context-param>
-</programlisting>
+<programlisting language="XML" role="XML"><![CDATA[
+ <context-param>
+ <param-name>org.jboss.portletbridge.WRAP_SCRIPTS</param-name>
+ <param-value>true</param-value>
+ </context-param>
+]]></programlisting>
</section>
</section>
<section id="sect-Reference_Guide-Getting_started_with_JBoss_Portlet_Bridge-Before_you_start">
- <title>Before you start</title>
+ <title>Before You Start</title>
<para>
- 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 <literal>jboss-epp-5.0/portletbridge</literal>
+ 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 <xref linkend="sect-Reference_Guide-Getting_started_with_JBoss_Portlet_Bridge-Maven_Archetypes" /> and deploy the generated war in a few easy steps. This will also give you an empty project to play around with or start from scratch.
+ 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.
</para>
</section>
@@ -165,24 +192,42 @@
<section id="sect-Reference_Guide-Getting_started_with_JBoss_Portlet_Bridge-Video_Tutorials">
<title>Video Tutorials</title>
+
<para>
- <ulink url="http://www.vimeo.com/3977469">Episode 1: Getting Started With The Bridge</ulink>
+ The following links provide tutorial videos created by the Portlet Bridge developer:
</para>
- <para>
- <ulink url="http://www.vimeo.com/4521877">Episode 2: Portlet 1.0 Advanced Seam and RichFaces</ulink>
- </para>
- <para>
- <ulink url="http://www.vimeo.com/5847864">Episode 3: Seam and Portlet 2.0 Eventing</ulink>
- </para>
- <para>
- <ulink url="http://www.vimeo.com/7255033">Episode 4: Running the 2.0 bridge on GateIn and deploy using JBoss Tools</ulink>
- </para>
- <para>
- <ulink url="http://www.vimeo.com/7255033">Episode 5: GateIn JMX Metrics and Dashboard Demo</ulink>
- </para>
- <para>
- <ulink url="http://www.vimeo.com/wesleyhales/videos">Check here for the latest videos.</ulink>
- </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <ulink url="http://www.vimeo.com/3977469">Episode 1: Getting Started With The Bridge</ulink>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <ulink url="http://www.vimeo.com/4521877">Episode 2: Portlet 1.0 Advanced Seam and RichFaces</ulink>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <ulink url="http://www.vimeo.com/5847864">Episode 3: Seam and Portlet 2.0 Eventing</ulink>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <ulink url="http://www.vimeo.com/7255033">Episode 4: Running the 2.0 bridge on GateIn and deploy using JBoss Tools</ulink>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <ulink url="http://www.vimeo.com/7255033">Episode 5: GateIn JMX Metrics and Dashboard Demo</ulink>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <ulink url="http://www.vimeo.com/wesleyhales/videos">Check here for the latest videos.</ulink>
+ </para>
+ </listitem>
+ </itemizedlist>
</section>
</section>
Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge/overview.xml
===================================================================
--- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge/overview.xml 2010-05-10 16:57:51 UTC (rev 3031)
+++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge/overview.xml 2010-05-10 22:39:07 UTC (rev 3032)
@@ -1,30 +1,58 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "../../../Reference_Guide.ent">
%BOOK_ENTITIES;
]>
<section id="sect-Reference_Guide-JBoss_Portlet_Bridge_Overview">
<title>JBoss Portlet Bridge Overview</title>
- <para>
- To get an idea of the JBoss Portlet Bridge community, the developers, and for wiki information, checkout <ulink url="http://www.jboss.org/portletbridge/">the project page</ulink>.
- </para>
<formalpara id="form-Reference_Guide-JBoss_Portlet_Bridge_Overview-What_is_the_JBoss_Portlet_Bridge">
<title>What is the JBoss Portlet Bridge?</title>
<para>
- The JBoss Portlet Bridge (or JBPB for short) is a non-final draft implementation of the <ulink url="http://jcp.org/en/jsr/detail?id=329">JSR-329</ulink> specification which supports the JSF 1.2 runtime within a JSR 286 portlet and with added enhancements to support other web frameworks (such as <ulink url="http://www.seamframework.org/">Seam</ulink> and <ulink url="http://www.jboss.org/jbossrichfaces/">RichFaces</ulink>). It allows any Java developer to get started quickly with their JSF web application running in a portal environment. The developer no longer needs to worry about the underlying portlet development, portlet concepts, or the API.
+ The JBoss Portlet Bridge (or <literal>JBPB</literal> for short) is a non-final implementation of the <ulink url="http://jcp.org/en/jsr/detail?id=329">JSR-329</ulink> specification.
</para>
</formalpara>
+ <para>
+ It supports the JSF 1.2 runtime within a JSR 286 portlet and with added enhancements to support other web frameworks (such as <ulink url="http://www.seamframework.org/">Seam</ulink> and <ulink url="http://www.jboss.org/jbossrichfaces/">RichFaces</ulink>).
+ </para>
+
+ <para>
+ It allows any Java developer to quickly get started with their JSF web application running in a portal environment. The developer no longer needs to worry about the underlying portlet development, portlet concepts, or the API.
+ </para>
+
+ <para>
+ Find more information about the JBoss Portlet Bridge, the developers, the community at <ulink url="http://www.jboss.org/portletbridge/">the project page</ulink>.
+ </para>
+
<formalpara id="form-Reference_Guide-JBoss_Portlet_Bridge_Overview-Understanding_how_JSF_works_with_Portal">
<title>Understanding how JSF works with Portal</title>
<para>
- The portlet bridge isn't a portlet. It's the mediator between the two environments and allows JSF and Portal to be completely unaware of each other. The bridge is used to execute Faces requests on behalf of the portlet. During each request, the Faces environment is setup and handled by the bridge. Part of this implementation acts as a Faces controller much as the FacesServlet does in the direct client request world. The other part of this implementation is provided by implementating a variety of (standard) Faces extensions.
+ The portlet bridge is not a portlet. It is the mediator between the two environments and allows JSF and Portal to be completely unaware of each other.
</para>
</formalpara>
- <note>
<para>
- This draft specification for the JSR 329 specification is not final. Any final specification that may be published will likely contain differences, some of which may be substantial. Publication of this draft specification is not intended to provide the basis for implementations of the specification. This draft specification is provided AS IS, with all faults. THERE ARE NO WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WARRANTIES OF CONDITION OF TITLE OR NONINFRINGEMENT. You may copy and display this draft specification provided that you include this notice and any existing copyright notice. Except for the limited copyright license granted above, there are no other licenses granted to any intellectual property owned or controlled by any of the authors or developers of this material. No other rights are granted by implication, estoppel or otherwise.
+ The bridge is used to execute <literal>Faces</literal> requests on behalf of the portlet. During each request, the <literal>Faces</literal> environment is setup and handled by the bridge.
</para>
- </note>
+ <para>
+ Part of this implementation acts as a <literal>Faces</literal> controller much as the FacesServlet does in the direct client request environment.
+ </para>
+ <para>
+ The other part of this implementation is provided by implementating a variety of (standard) <literal>Faces</literal> extensions.
+ </para>
+ <important>
+ <title>Disclaimer</title>
+ <para>
+ This draft specification for the JSR 329 specification is not final. Any final specification that may be published will likely contain differences, some of which may be substantial.
+ </para>
+ <para>
+ Publication of this draft specification is not intended to provide the basis for implementations of the specification. This draft specification is provided AS IS.
+ </para>
+ <para>
+ THERE ARE NO WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WARRANTIES OF CONDITION OF TITLE OR NONINFRINGEMENT. You may copy and display this draft specification provided that you include this notice and any existing copyright notice.
+ </para>
+ <para>
+ Except for the limited copyright license granted above, there are no other licenses granted to any intellectual property owned or controlled by any of the authors or developers of this material. No other rights are granted by implication, estoppel or otherwise.
+ </para>
+ </important>
<!-- <figure id="build.fig">
<title>Faces in Portlet Environment</title>
<mediaobject>
Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge/portlet_development.xml
===================================================================
--- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge/portlet_development.xml 2010-05-10 16:57:51 UTC (rev 3031)
+++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge/portlet_development.xml 2010-05-10 22:39:07 UTC (rev 3032)
@@ -1,6 +1,6 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "../../../Reference_Guide.ent">
%BOOK_ENTITIES;
]>
<section id="sect-Reference_Guide-Developing_Portlets_with_the_Bridge">
@@ -11,123 +11,145 @@
<section id="sect-Reference_Guide-Developing_Portlets_with_the_Bridge-Excluding_Attributes_from_the_Bridge_Request_Scope">
<title>Excluding Attributes from the Bridge Request Scope</title>
<para>
- When your application uses request attributes on a per request basis and you do not want that particular attribute to be managed in the extended bridge request scope, you must use the following configuration in your faces-config.xml. Below you will see that any attribute namespaced as foo.bar or any attribute beginning with foo.baz(wildcard) will be excluded from the bridge request scope and only be used per that application's request.
+ When your application uses request attributes on a per request basis and you do not want that particular attribute to be managed in the extended bridge request scope, you must use the following configuration in your <filename>faces-config.xml</filename>.
</para>
+ <para>
+ In the code sample below you can see that any attribute namespaced as <literal>foo.bar</literal> or any attribute beginning with <literal>foo.baz(wildcard)</literal> will be excluded from the bridge request scope and only be used per that application's request.
+ </para>
-<programlisting role="XML">
- <application>
- <application-extension>
- <bridge:excluded-attributes>
- <bridge:excluded-attribute>foo.bar</bridge:excluded-attribute>
- <bridge:excluded-attribute>foo.baz.*</bridge:excluded-attribute>
- </bridge:excluded-attributes>
- </application-extension>
- </application>
-</programlisting>
+<programlisting language="XML" role="XML"><![CDATA[
+ <application>
+ <application-extension>
+ <bridge:excluded-attributes>
+ <bridge:excluded-attribute>foo.bar</bridge:excluded-attribute>
+ <bridge:excluded-attribute>foo.baz.*</bridge:excluded-attribute>
+ </bridge:excluded-attributes>
+ </application-extension>
+ </application>
+]]></programlisting>
</section>
<section id="sect-Reference_Guide-Developing_Portlets_with_the_Bridge-Supporting_PortletMode_Changes">
<title>Supporting PortletMode Changes</title>
<para>
- A PortletMode represents a distinct render path within an application. There are three standard modes: view, edit, and help. The bridge's ExternalContext.encodeActionURL recognizes the query string parameter javax.portlet.faces.PortletMode and uses this parameter's value to set the portlet mode on the underlying portlet actionURL or response. Once processed it then removes this parameter from the query string. This means the following navigation rule causes one to render the \edit.jspx viewId in the portlet edit mode:
+ A <literal>PortletMode</literal> represents a distinct render path within an application. There are three standard modes: <emphasis>view</emphasis>, <emphasis>edit</emphasis>, and <emphasis>help</emphasis>.
</para>
+ <para>
+ The bridge's <literal>ExternalContext.encodeActionURL</literal> recognizes the query string parameter <literal>javax.portlet.faces.PortletMode</literal> and uses this parameter's value to set the portlet mode on the underlying portlet <literal>actionURL</literal> or response.
+ </para>
+ <para>
+ Once processed it then removes this parameter from the query string. This means the following navigation rule causes one to render the \edit.jspx viewId in the portlet edit mode:
+ </para>
-<programlisting role="XML">
- <navigation-rule>
- <from-view-id>/register.jspx</from-view-id>
- <navigation-case>
- <from-outcome>edit</from-outcome>
- <to-view-id>/edit.jspx?javax.portlet.faces.PortletMode=edit</to-view-id>
- </navigation-case>
- </navigation-rule>
-</programlisting>
+<programlisting language="XML" role="XML"><![CDATA[
+ <navigation-rule>
+ <from-view-id>/register.jspx</from-view-id>
+ <navigation-case>
+ <from-outcome>edit</from-outcome>
+ <to-view-id>/edit.jspx?javax.portlet.faces.PortletMode=edit</to-view-id>
+ </navigation-case>
+ </navigation-rule>
+]]></programlisting>
</section>
<section id="sect-Reference_Guide-Developing_Portlets_with_the_Bridge-Navigating_to_a_modes_last_viewId">
<title>Navigating to a mode's last viewId</title>
<para>
- By default a mode change will start in the mode's default view without any (prior) existing state. One common portlet pattern when returning to the mode one left after entering another mode (e.g.. view -> edit -> view) is to return to the last view (and state) of this origin mode. The bridge will explicitly encode the necessary information so that when returning to a prior mode it can target the appropriate view and restore the appropriate state. The session attributes maintained by the bridge are intended to be used by developers to navigate back from a mode to the last location and state of a prior mode. As such a developer needs to describe a dynamic navigation: "from view X return to the last view of mode y". This is most easily expressed via an EL expression. E.g.
+ By default a mode change will start in the mode's default view without any (prior) existing state. One common portlet pattern when returning to a mode left after entering another mode (e.g.. view -> edit -> view) is to return to the last view (and state) of this origin mode.
</para>
+ <para>
+ The bridge will explicitly encode the necessary information so that when returning to a prior mode it can target the appropriate view and restore the appropriate state.
+ </para>
+ <para>
+ The session attributes maintained by the bridge are intended to be used by developers to navigate back from a mode to the last location and state of a prior mode. As such, a developer needs to describe a dynamic navigation: "From view <parameter>X</parameter> return to the last view of mode <parameter>Y</parameter>".
+ </para>
+ <para>
+ This is most easily expressed via an <literal>EL</literal> expression. For example:
+ </para>
-<programlisting role="XML">
- <navigation-rule>
- <from-view-id>/edit.jspx*</from-view-id>
- <navigation-case>
- <from-outcome>view</from-outcome>
- <to-view-id>#{sessionScope['javax.portlet.faces.viewIdHistory.view']}</to-view-id>
- </navigation-case>
- </navigation-rule>
-</programlisting>
- <note>
+<programlisting language="XML" role="XML"><![CDATA[
+ <navigation-rule>
+ <from-view-id>/edit.jspx*</from-view-id>
+ <navigation-case>
+ <from-outcome>view</from-outcome>
+ <to-view-id>#{sessionScope['javax.portlet.faces.viewIdHistory.view']}</to-view-id>
+ </navigation-case>
+ </navigation-rule>
+]]></programlisting>
+ <section>
<title>Note to Portlet Developers</title>
<para>
- Depending on the bridge implementation, when using values from these session scoped attributes or any viewIds which may contain query string parameters it may be necessary to use the wildcard syntax when identifying the rule target. For example, the above
+ Depending on the bridge implementation, when using values from these session scoped attributes or any viewIds which may contain query string parameters it may be necessary to use the wildcard syntax when identifying the rule target. In the above, for example, the
</para>
- </note>
-<programlisting><to-view-id>
-</programlisting>
+<programlisting language="XML" role="XML"><![CDATA[<to-view-id>
+]]></programlisting>
<para>
- expression returns a viewId of the form
+ expression returns a <parameter>viewId</parameter> of the form
</para>
-<programlisting>/viewId?javax.portlet.faces.PortletMode=view&....
-</programlisting>
+<programlisting language="XML" role="XML"><![CDATA[/viewId?javax.portlet.faces.PortletMode=view&....
+]]></programlisting>
<para>
- Without wildcarding, when a subsequent navigation occurs from this new view, the navigation rules wouldn't resolve because there wouldn't be an exact match. Likewise, the above edit.jspx
+ Without wildcarding, when a subsequent navigation occurs from this new view, the navigation rules wouldn't resolve because there wouldn't be an exact match. Likewise, the above <literal>edit.jspx</literal>
</para>
-<programlisting><from-view-id>
-</programlisting>
+<programlisting language="XML" role="XML"><![CDATA[<from-view-id>
+]]></programlisting>
<para>
is wildcarded because there are navigation rules that target it that use a query string:
</para>
-<programlisting><to-view-id> /edit.jspx?javax.portlet.faces.PortletMode=edit </to-view-id>
-</programlisting>
+<programlisting language="XML" role="XML"><![CDATA[
+<to-view-id> /edit.jspx?javax.portlet.faces.PortletMode=edit </to-view-id>
+]]></programlisting>
<para>
Developers are encouraged to use such wildcarding to ensure they execute properly in the broadest set of bridge implementations.
</para>
+ </section>
</section>
<section id="sect-Reference_Guide-Developing_Portlets_with_the_Bridge-Clearing_The_View_History_When_Changing_Portlet_Modes">
<title>Clearing The View History When Changing Portlet Modes</title>
<para>
- By default the bridge remembers the view history when you switch to a different portlet mode (like "Help" or "Edit"). You can use the following parameter in your portlet.xml to use the default viewId each time you switch modes.
+ By default the bridge remembers the view history when you switch to a different portlet mode (like "Help" or "Edit"). You can use the following parameter in your <filename>portlet.xml</filename> to use the default viewId each time you switch modes.
</para>
-<programlisting role="XML">
- <init-param>
- <name>javax.portlet.faces.extension.resetModeViewId</name>
- <value>true</value>
- </init-param>
-</programlisting>
+<programlisting language="XML" role="XML"><![CDATA[
+ <init-param>
+ <name>javax.portlet.faces.extension.resetModeViewId</name>
+ <value>true</value>
+ </init-param>
+]]></programlisting>
</section>
<section id="sect-Reference_Guide-Developing_Portlets_with_the_Bridge-General_Error_Handling">
<title>General Error Handling</title>
<note>
<para>
- If you're developing a Seam portlet you can now use pages.xml for all error handling.
+ If you are developing a <application>Seam</application> portlet you can now use <filename>pages.xml</filename> for all error handling.
</para>
</note>
<para>
- The following configuration may be used to handle exceptions. This is also useful for handling session timeout and ViewExpiredExceptions.
+ The following configuration may be used to handle exceptions. This is also useful for handling session timeout and <literal>ViewExpiredExceptions</literal>.
</para>
- <para>
- Pay attention to the location element. It must contain the /faces/ mapping to work properly.
- </para>
+ <note>
+ <title>The Location Element</title>
+ <para>
+ The location element must contain the <filename>/faces/</filename> mapping to work properly.
+ </para>
+ </note>
-<programlisting role="XML">
- <error-page>
- <exception-type>javax.servlet.ServletException</exception-type>
- <location>/faces/error.xhtml</location>
- </error-page>
- <error-page>
- <exception-type>javax.faces.application.ViewExpiredException</exception-type>
- <location>/faces/error.xhtml</location>
- </error-page>
-</programlisting>
+<programlisting language="XML" role="XML"><![CDATA[
+ <error-page>
+ <exception-type>javax.servlet.ServletException</exception-type>
+ <location>/faces/error.xhtml</location>
+ </error-page>
+ <error-page>
+ <exception-type>javax.faces.application.ViewExpiredException</exception-type>
+ <location>/faces/error.xhtml</location>
+ </error-page>
+]]></programlisting>
</section>
<section id="sect-Reference_Guide-Developing_Portlets_with_the_Bridge-Custom_Ajax_Error_Handling">
@@ -136,8 +158,8 @@
By default, error handling is sent to a standard servlet page for Ajax requests. To handle the error inside the portlet, use the following javascript:
</para>
-<programlisting role="XML">
- <script type="text/javascript">
+<programlisting language="XML" role="XML"><![CDATA[
+ <script type="text/javascript">
A4J.AJAX.onError = function(req,status,message){
window.alert("Custom onError handler "+message);
}
@@ -149,47 +171,59 @@
return false;
}
}
- </script>
-</programlisting>
+ </script>
+]]></programlisting>
<para>
- Also, add the following to web.xml. Read more about these settings here <ulink url="http://docs.jboss.org/richfaces/3.3.3.BETA1/en/devguide/html/Architecture...">Request Errors and Session Expiration Handling</ulink>
+ Also, add the following to <filename>web.xml</filename>.
</para>
-<programlisting role="XML">
- <context-param>
- <param-name>org.ajax4jsf.handleViewExpiredOnClient</param-name>
- <param-value>true</param-value>
- </context-param>
-</programlisting>
+<programlisting language="XML" role="XML"><![CDATA[
+ <context-param>
+ <param-name>org.ajax4jsf.handleViewExpiredOnClient</param-name>
+ <param-value>true</param-value>
+ </context-param>
+]]></programlisting>
+ <para>
+ Read more about these settings here <ulink url="http://docs.jboss.org/richfaces/3.3.3.BETA1/en/devguide/html/Architecture...">Request Errors and Session Expiration Handling</ulink>
+ </para>
</section>
<section id="sect-Reference_Guide-Developing_Portlets_with_the_Bridge-Communication_Between_Your_Portlets">
<title>Communication Between Your Portlets</title>
<para>
- There are roughly 4 different ways to send messages, events, and parameters between portlets which are contained in different ears/wars or contained in the same war. The Portlet Container does not care if you have 2 portlets in the same war or if they are separated, because each portlet has a different HttpSession.
+ There are four different ways to send messages, events, and parameters between portlets which are contained in different <literal>ears/wars</literal> or contained in the same <literal>war</literal>.
</para>
<para>
- Of course, with the Portlet 2.0 spec, the recommended way to share a parameter or event payload between 2 or more portlets are the <xref linkend="sect-Reference_Guide-Portlet_2.0_Coordination-Public_Render_Parameters" /> and <xref linkend="sect-Reference_Guide-Portlet_2.0_Coordination-Sending_and_Receiving_Events" /> mechanisms. This allows you to decouple your application from surgically managing objects in the PortletSession.APPLICATION_SCOPE.
+ Having two portlets in the same <literal>war</literal> or having them separated does not affect the Portlet Container because each portlet has a different <parameter>HttpSession</parameter>.
</para>
<para>
- But, if these do not meet your usecase or you have a different strategy, you can use one of the following methods.
+ The recommended way to share a parameter or event payload between two or more portlets with the Portlet 2.0 specification are the <xref linkend="sect-Reference_Guide-Portlet_2.0_Coordination-Public_Render_Parameters" /> and <xref linkend="sect-Reference_Guide-Portlet_2.0_Coordination-Sending_and_Receiving_Events" /> mechanisms.
</para>
+ <para>
+ This allows you to decouple your application from surgically managing objects in the <parameter>PortletSession.APPLICATION_SCOPE.</parameter>
+ </para>
+ <para>
+ However, if these do not meet your use case or you have a different strategy, you can use one of the following methods.
+ </para>
<section id="sect-Reference_Guide-Communication_Between_Your_Portlets-Storing_Components_in_PortletSession.APPLICATION_SCOPE">
- <title>Storing Components in PortletSession.APPLICATION_SCOPE</title>
+ <title>Storing Components in <parameter>PortletSession.APPLICATION_SCOPE</parameter></title>
<para>
- Sometimes it makes sense to store your Seam components in the portlet APPLICATION_SCOPE. By default, these objects are stored in the PORTLET_SCOPE but with the annotation below, you can fish this class out of the PortletSession and use its values in other portlets across different Seam applications.
+ Sometimes it is beneficial to store your <application>Seam</application> components in the portlet <parameter>APPLICATION_SCOPE</parameter>.
</para>
+ <para>
+ By default, these objects are stored in the <parameter>PORTLET_SCOPE</parameter> but with the annotation below, this class can be pulled out of the <literal>PortletSession</literal> and its values used in other portlets across different <application>Seam</application> applications.
+ </para>
-<programlisting role="XML">
+<programlisting language="XML" role="XML">
@PortletScope(PortletScope.ScopeType.APPLICATION_SCOPE)
</programlisting>
<para>
Then you would pull the statefull object from the session:
</para>
-<programlisting role="java">
- YourSessionClass yourSessionClass = (YourSessionClass)getRenderRequest().getAttribute("javax.portlet.p./default/seamproject/seamprojectPortletWindow?textHolder");
-</programlisting>
+<programlisting language="Java" role="JAVA"><![CDATA[
+YourSessionClass yourSessionClass = (YourSessionClass)getRenderRequest().getAttribute("javax.portlet.p./default/seamproject/seamprojectPortletWindow?textHolder");
+]]></programlisting>
<para>
This method is demonstrated in this video: <ulink url="http://www.vimeo.com/4521877">Lesson 2: Portlet 1.0 Advanced Seam and RichFaces</ulink>
</para>
@@ -198,10 +232,10 @@
<section id="sect-Reference_Guide-Communication_Between_Your_Portlets-Using_the_PortletSession">
<title>Using the PortletSession</title>
<para>
- If you need to access the PortletSession to simply share a parameter/value across multiple portlets, you can use the following to do so.
+ If you need to access the <literal>PortletSession</literal> to simply share a parameter or value across multiple portlets, you can use the following:
</para>
-<programlisting role="java">
+<programlisting language="Java" role="JAVA"><![CDATA[
Object objSession = FacesContext.getCurrentInstance().getExternalContext().getSession(false);
try
{
@@ -210,22 +244,22 @@
PortletSession portalSession = (PortletSession)objSession;
portalSession.setAttribute("your parameter name","parameter value",PortletSession.APPLICATION_SCOPE);
...
-</programlisting>
+]]></programlisting>
<para>
Then, in your JSP or Facelets page, you can use:
</para>
-<programlisting role="XML">
+<programlisting language="XML" role="XML"><![CDATA[
#{httpSessionScope['your parameter name']}
-</programlisting>
+]]></programlisting>
<para>
<note>
<title>Note to Portlet Developers</title>
<para>
- #{httpSessionScope} was implemented after 2.0.0.BETA. If you are using the 1.0 bridge or pre 2.0.0.BETA, you must use the el variable #{sessionApplicationScope}
+ <literal>#{httpSessionScope}</literal> was implemented after <literal>2.0.0.BETA</literal>. If you are using the <literal>1.0</literal> bridge or pre <literal>2.0.0.BETA</literal>, you must use the <literal>EL</literal> variable <literal>#{sessionApplicationScope}</literal>.
</para>
</note>
- For more information about which EL variables are provided by the bridge, read <ulink url="http://jcp.org/aboutJava/communityprocess/edr/jsr329/index2.html">section 6.5.1 of the JSR-329 specification</ulink>.
+ For more information about which <literal>EL</literal> variables are provided by the bridge, read <ulink url="http://jcp.org/aboutJava/communityprocess/edr/jsr329/index2.html">section 6.5.1 of the JSR-329 specification</ulink>.
</para>
</section>
@@ -234,65 +268,63 @@
<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>
<para>
- For linking to any JSF/Facelets page within your portlet web application, you may use the following.
+ For linking to any JSF/Facelets page within your portlet web application, you can use the following.
</para>
-<programlisting role="java">
- <h:outputLink value="#{facesContext.externalContext.requestContextPath}/home.xhtml">
- <f:param name="javax.portlet.faces.ViewLink" value="true"/>
+<programlisting language="Java" role="JAVA"><![CDATA[
+ <h:outputLink value="#{facesContext.externalContext.requestContextPath}/home.xhtml">
+ <f:param name="javax.portlet.faces.ViewLink" value="true"/>
navigate to the test page
- </h:outputLink>
-</programlisting>
+ </h:outputLink>
+]]></programlisting>
</section>
<section id="sect-Reference_Guide-Developing_Portlets_with_the_Bridge-Redirecting_to_an_External_Page_or_Resource">
<title>Redirecting to an External Page or Resource</title>
<para>
- To link to a non JSF view (i.e. jboss.org) you can use the following parameter.
+ To link to a non JSF view (that is, jboss.org) you can use the following parameter.
</para>
-<programlisting role="java">
- <h:commandLink actionListener="#{yourBean.yourListenr}">
- <f:param name="javax.portlet.faces.DirectLink" value="true"/>
+<programlisting language="Java" role="JAVA"><![CDATA[
+ <h:commandLink actionListener="#{yourBean.yourListenr}">
+ <f:param name="javax.portlet.faces.DirectLink" value="true"/>
navigate to the test page
- </h:commandLink>
-</programlisting>
+ </h:commandLink>
+]]></programlisting>
<para>
- Then in your backing bean, you must call a redirect().
+ Then in your backing bean, you must call a <parameter>redirect()</parameter>.
</para>
-<programlisting role="java">
+<programlisting language="Java" role="JAVA"><![CDATA[
FacesContext.getCurrentInstance().getExternalContext().redirect("http://www.jboss.org");
-</programlisting>
+]]></programlisting>
</section>
<section id="sect-Reference_Guide-Developing_Portlets_with_the_Bridge-Using_Provided_EL_Variables">
<title>Using Provided EL Variables</title>
<para>
- All EL variables found in the JSR-329 (Portlet 2.0) specification are available in the JBoss Portlet Bridge. For example, you can use the following to edit the portlet preferences on the UI.
+ All <literal>EL</literal> variables found in the JSR-329 (Portlet 2.0) specification are available in the JBoss Portlet Bridge. For example, you can use the following to edit the portlet preferences on the UI:
</para>
-<programlisting role="xml">
- <h:form>
- <h:inputText id="pref" required="true" value="#{mutablePortletPreferencesValues['userName'].value}" />
- <h:commandButton actionListener="#{myBean.savePref}" value="Save Preferences" />
- </h:form>
-</programlisting>
+<programlisting language="XML" role="XML"><![CDATA[ <h:form>
+ <h:inputText id="pref" required="true" value="#{mutablePortletPreferencesValues['userName'].value}" />
+ <h:commandButton actionListener="#{myBean.savePref}" value="Save Preferences" />
+ </h:form>
+]]></programlisting>
<para>
Then in your backing bean, you must call the PortletPreferences.store() method.
</para>
-<programlisting role="java">
- Object request = FacesContext.getCurrentInstance().getExternalContext().getRequest();
+<programlisting language="Java" role="JAVA"><![CDATA[ Object request = FacesContext.getCurrentInstance().getExternalContext().getRequest();
PortletRequest portletRequest = (PortletRequest)request;
if (request instanceof PortletRequest) {
try {
PortletPreferences portletPreferences = portletRequest.getPreferences();
portletPreferences.store();
-</programlisting>
+]]></programlisting>
</section>
- <!-- EL variables --><!-- using sendRedirect --><!-- FacesContext.getCurrentInstance().getExternalContext().redirect("http://www.google.com"); --><!-- and adding the <f:param name="javax.portlet.faces.DirectLink" value="true"/> to the commandButton, all seems fine. --><!-- <section>
+ <!-- DO NOT UNCOMMENT!! EL variables --><!-- using sendRedirect --><!-- FacesContext.getCurrentInstance().getExternalContext().redirect("http://www.google.com"); --><!-- and adding the <f:param name="javax.portlet.faces.DirectLink" value="true"/> to the commandButton, all seems fine. --><!-- <section>
<title>Integrations with JBoss Tools IDE</title>
<para>
@@ -303,5 +335,3 @@
</section> -->
</section>
-
-
Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge.xml
===================================================================
--- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge.xml 2010-05-10 16:57:51 UTC (rev 3031)
+++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge.xml 2010-05-10 22:39:07 UTC (rev 3032)
@@ -1,6 +1,6 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "../../Reference_Guide.ent">
%BOOK_ENTITIES;
]>
<chapter id="chap-Reference_Guide-Building_JSF_Portlets">
Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortletDevelopment/Standard.xml
===================================================================
--- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortletDevelopment/Standard.xml 2010-05-10 16:57:51 UTC (rev 3031)
+++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortletDevelopment/Standard.xml 2010-05-10 22:39:07 UTC (rev 3032)
@@ -1,6 +1,6 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "../../Reference_Guide.ent">
%BOOK_ENTITIES;
]>
<chapter id="chap-Reference_Guide-Portlet_Primer">
@@ -25,18 +25,19 @@
<section id="sect-Reference_Guide-JSR_168_and_JSR_286_overview-Portal_Pages">
<title>Portal Pages</title>
<para>
- A portal can be considered as a series of web pages with different <emphasis>areas</emphasis> within them. Those areas contain different <emphasis>windows</emphasis> and each <emphasis>window</emphasis> contains portlet:
+ A portal can be considered as a series of web pages with different <emphasis>areas</emphasis> within them. Those areas contain different <emphasis>windows</emphasis> and each <emphasis>window</emphasis> contains a <emphasis>portlet</emphasis>:
</para>
<para>
The diagram below visually represents this nesting:
</para>
- <para>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/PortletDevelopment/Standard/SpecPortalDef.png" format="PNG" scalefit="1" width="444" />
- </imageobject>
- </mediaobject>
- </para>
+ <mediaobject>
+ <imageobject role="html">
+ <imagedata fileref="images/PortletDevelopment/Standard/SpecPortalDef.png" format="PNG" align="center" scale="100" />
+ </imageobject>
+ <imageobject role="fo">
+ <imagedata fileref="images/PortletDevelopment/Standard/SpecPortalDef.png" format="PNG" align="center" contentwidth="140mm" />
+ </imageobject>
+ </mediaobject>
</section>
<section id="sect-Reference_Guide-JSR_168_and_JSR_286_overview-Rendering_Modes">
@@ -139,7 +140,7 @@
</step>
<step>
<para>
- If the compile is successfully packaged the result will be available in: <filename>SimplestHelloWorld/target/SimplestHelloWorld-0.0.1.war </filename>.
+ If the compile is successfully packaged, the result will be available in: <filename>SimplestHelloWorld/target/SimplestHelloWorld-0.0.1.war </filename>.
</para>
</step>
<step>
@@ -156,11 +157,14 @@
<para>
Create a new portal page and add the portlet to it.
</para>
+<!-- This image needs to be updated to RH skinned version of Portal. Unable to do this. SM -->
<mediaobject>
- <imageobject>
- <objectinfo id="obje-Reference_Guide-Compiling-SimplestHelloWorldPortlet_deployed_on_a_new_page"><title>SimplestHelloWorldPortlet deployed on a new page</title>
- </objectinfo><imagedata fileref="images/PortletDevelopment/Standard/first_portlet/deployed.png" format="PNG" width="444" />
+ <imageobject role="html">
+ <imagedata fileref="images/PortletDevelopment/Standard/first_portlet/deployed.png" format="PNG" align="center" scale="100" />
</imageobject>
+ <imageobject role="fo">
+ <imagedata fileref="images/PortletDevelopment/Standard/first_portlet/deployed.png" format="PNG" align="center" contentwidth="120mm" />
+ </imageobject>
</mediaobject>
</step>
</procedure>
@@ -170,7 +174,7 @@
<section id="sect-Reference_Guide-Deploying_your_first_Portlet-Package_Structure">
<title>Package Structure</title>
<para>
- Like other Java EE applications, &PRODUCT; portlets are packaged in WAR files. A typical portlet WAR file can include servlets, resource bundles, images, HTML, JavaServer Pages (JSP), and other static or dynamic files.
+ Like other Java EE applications, &PRODUCT; portlets are packaged in <literal>WAR</literal> files. A typical portlet <literal>WAR</literal> file can include servlets, resource bundles, images, HTML, JavaServer Pages (JSP), and other static or dynamic files.
</para>
<para>
The following is an example of the directory structure of the <filename>SimplestHelloWorld</filename> portlet:
@@ -202,7 +206,7 @@
</callout>
<callout arearefs="area-Reference_Guide-Deploying_your_first_Portlet-Package_Structure.portlet">
<para>
- This is the mandatory descriptor files for portlets. It is used during deployment..
+ This is the mandatory descriptor file for portlets. It is used during deployment.
</para>
</callout>
<callout arearefs="area-Reference_Guide-Deploying_your_first_Portlet-Package_Structure.web">
@@ -229,7 +233,7 @@
<area coords="17" id="area-Reference_Guide-Deploying_your_first_Portlet-Portlet_Class.close" />
</areaspec>
-<programlisting role="JAVA">package org.gatein.portal.examples.portlets;
+<programlisting language="Java" role="JAVA"><![CDATA[package org.gatein.portal.examples.portlets;
import java.io.IOException;
import java.io.PrintWriter;
@@ -247,8 +251,7 @@
writer.write("Hello World !");
writer.close();
}
-}
-</programlisting>
+}]]></programlisting>
<calloutlist>
<callout arearefs="area-Reference_Guide-Deploying_your_first_Portlet-Portlet_Class.extends">
<para>
@@ -297,7 +300,7 @@
<section id="sect-Reference_Guide-Deploying_your_first_Portlet-Application_Descriptors">
<title>Application Descriptors</title>
<para>
- &PRODUCT; requires certain descriptors to be included in a portlet WAR file. These descriptors are defined by the Jave EE (<filename>web.xml</filename>) and Portlet Specification (<filename>portlet.xml</filename>).
+ &PRODUCT; requires certain descriptors to be included in a portlet <literal>WAR</literal> file. These descriptors are defined by the Jave EE (<filename>web.xml</filename>) and Portlet Specification (<filename>portlet.xml</filename>).
</para>
<para>
Below is an example of the <filename>SimplestHelloWorldPortlet/WEB-INF/portlet.xml</filename> file. This file must adhere to its definition in the JSR-286 Portlet Specification. More than one portlet application may be defined in this file:
@@ -310,26 +313,24 @@
<area coords="15" id="area-Reference_Guide-Deploying_your_first_Portlet-Application_Descriptors.portletinfo" />
</areaspec>
-<programlisting>
-<portlet-app xmlns="http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd"
+<programlisting language="XML" role="XML"><![CDATA[<portlet-app xmlns="http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd
http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd"
- version="2.0">
- <portlet>
- <portlet-name>SimplestHelloWorldPortlet</portlet-name>
- <portlet-class>
+ version="2.0">
+ <portlet>
+ <portlet-name>SimplestHelloWorldPortlet</portlet-name>
+ <portlet-class>
org.gatein.portal.examples.portlets.SimplestHelloWorldPortlet
- </portlet-class>
- <supports>
- <mime-type>text/html</mime-type>
- </supports>
- <portlet-info>
- <title>Simplest Hello World Portlet</title>
- </portlet-info>
- </portlet>
-</portlet-app>
-</programlisting>
+ </portlet-class>
+ <supports>
+ <mime-type>text/html</mime-type>
+ </supports>
+ <portlet-info>
+ <title>Simplest Hello World Portlet</title>
+ </portlet-info>
+ </portlet>
+</portlet-app>]]></programlisting>
<calloutlist>
<callout arearefs="area-Reference_Guide-Deploying_your_first_Portlet-Application_Descriptors.portletname">
<para>
@@ -343,7 +344,7 @@
</callout>
<callout arearefs="area-Reference_Guide-Deploying_your_first_Portlet-Application_Descriptors.supports">
<para>
- The <literal><supports> </literal> element declares all of the markup types that a portlet supports in the <literal>render</literal> method. This is accomplished via the <literal><mime-type> </literal> element, which is required for every portlet.
+ The <literal><supports></literal> element declares all of the markup types that a portlet supports in the <literal>render</literal> method. This is accomplished via the <literal><mime-type></literal> element, which is required for every portlet.
</para>
<para>
The declared MIME types must match the capability of the portlet. It allows administrators to pair which modes and window states are supported for each markup type.
@@ -352,7 +353,7 @@
This does not have to be declared as all portlets must support the <literal>view</literal> portlet mode.
</para>
<para>
- Use the <literal><mime-type> </literal> element to define which markup type the portlet supports. In the example above this is <literal>text/html</literal>. This section tells the portal to only output HTML.
+ Use the <literal><mime-type></literal> element to define which markup type the portlet supports. In the example above this is <literal>text/html</literal>. This section tells the portal to only output <literal>HTML</literal>.
</para>
</callout>
<callout arearefs="area-Reference_Guide-Deploying_your_first_Portlet-Application_Descriptors.portletinfo">
@@ -372,7 +373,7 @@
<para>
This section discusses:
</para>
- <orderedlist>
+ <orderedlist numeration="arabic">
<listitem>
<para>
Adding more features to the previous example.
@@ -394,15 +395,25 @@
</para>
</listitem>
</orderedlist>
+
+ <formalpara>
+ <title>Compiling the example</title>
+ <para>
+ The example used in this section can be found in the <filename>JSPHelloUser</filename> directory.
+ </para>
+ </formalpara>
+ <para>
+ Compile the example as so:
+ </para>
<procedure>
<step>
<para>
- The example used in this section can be found in the <literal>JSPHelloUser</literal> directory.
+ Execute:
+<programlisting><command>mvn package</command>
+</programlisting>
</para>
- </step>
- <step>
<para>
- Execute <command>mvn package</command> in this directory.
+ in the <filename>JSPHelloUser</filename> directory.
</para>
</step>
<step>
@@ -416,24 +427,27 @@
</para>
</step>
</procedure>
-
+<!-- This Image needs to be updated with RH Portal skin. Unable to action this. SM -->
<mediaobject>
- <imageobject>
- <imagedata align="center" fileref="images/PortletDevelopment/Standard/jsp_portlet/output.png" format="PNG" scalefit="1" width="444" />
+ <imageobject role="html">
+ <imagedata fileref="images/PortletDevelopment/Standard/jsp_portlet/output.png" format="PNG" align="center" scale="100" />
</imageobject>
+ <imageobject role="fo">
+ <imagedata fileref="images/PortletDevelopment/Standard/jsp_portlet/output.png" format="PNG" align="center" contentwidth="120mm" />
+ </imageobject>
</mediaobject>
<note>
<para>
- The <literal>EDIT</literal> button only appears with logged-in users, which is not the case in the screenshot.
+ The <literal>EDIT</literal> button only appears for logged-in users.
</para>
</note>
<section id="sect-Reference_Guide-JavaServer_Pages_Portlet_Example-Package_Structure">
<title>Package Structure</title>
<para>
- The package structure in this tutorial does not differ greatly from the previous example, with the exception of adding some JSP files detailed later.
+ The package structure in this tutorial does not differ greatly from the previous example, with the exception of adding some JSP files which are detailed later.
</para>
<para>
- The JSPHelloUser portlet contains the mandatory portlet application descriptors. The following is an example of the directory structure of the JSPHelloUser portlet:
+ The <literal>JSPHelloUser</literal> portlet contains the mandatory portlet application descriptors. The following is an example of the directory structure of the <literal>JSPHelloUser</literal> portlet:
</para>
<programlisting>JSPHelloUser-0.0.1.war
@@ -470,7 +484,7 @@
<area coords="26" id="area-Reference_Guide-JavaServer_Pages_Portlet_Example-Portlet_Class.include" />
</areaspec>
-<programlisting role="JAVA">package org.gatein.portal.examples.portlets;
+<programlisting language="Java" role="JAVA"><![CDATA[package org.gatein.portal.examples.portlets;
import java.io.IOException;
@@ -503,8 +517,7 @@
prd.include(request, response);
}
}
-...
-</programlisting>
+...]]></programlisting>
<calloutlist>
<callout arearefs="area-Reference_Guide-JavaServer_Pages_Portlet_Example-Portlet_Class.doView">
<para>
@@ -539,7 +552,7 @@
The generic portlet that is inherited dispatches the different views to the methods: <literal>doView</literal> , <literal>doHelp</literal> and <literal>doEdit</literal>.
</para>
-<programlisting role="JAVA">...
+<programlisting language="Java" role="JAVA"><![CDATA[...
protected void doHelp(RenderRequest rRequest, RenderResponse rResponse) throws PortletException, IOException,
UnavailableException
{
@@ -555,13 +568,12 @@
PortletRequestDispatcher prd = getPortletContext().getRequestDispatcher("/jsp/edit.jsp");
prd.include(rRequest, rResponse);
}
-...
-</programlisting>
+...]]></programlisting>
<para>
Portlet calls happen in one or two phases. One when the portlet is rendered and two when the portlet is actioned <emphasis>then</emphasis> rendered.
</para>
<para>
- An action phase is a phase where some state changes. The render phase will have access to render parameters that will be passed each time the portlet is refreshed (with the exception of caching capabilities).
+ An action phase is a phase where a state changes. The render phase will have access to render parameters that will be passed each time the portlet is refreshed (with the exception of caching capabilities).
</para>
<para>
The code to be executed during an action has to be implemented in the <emphasis>processAction</emphasis> method of the portlet.
@@ -573,15 +585,15 @@
<area coords="6" id="area-Reference_Guide-JavaServer_Pages_Portlet_Example-Portlet_Class.setRenderParameter" />
</areaspec>
-<programlisting role="JAVA">...
+<programlisting language="Java" role="JAVA"><![CDATA[...
public void processAction(ActionRequest aRequest, ActionResponse aResponse) throws PortletException, IOException,
UnavailableException
{
String sYourname = (String) aRequest.getParameter("yourname");
aResponse.setRenderParameter("yourname", sYourname);
}
-...
-</programlisting>
+...]]></programlisting>
+
<calloutlist>
<callout arearefs="area-Reference_Guide-JavaServer_Pages_Portlet_Example-Portlet_Class.processAction">
<para>
@@ -590,7 +602,7 @@
</callout>
<callout arearefs="area-Reference_Guide-JavaServer_Pages_Portlet_Example-Portlet_Class.getActionParameter">
<para>
- Here the parameter is retrieved through an <emphasis>action URL</emphasis> .
+ Here the parameter is retrieved through an <emphasis>action URL</emphasis>.
</para>
</callout>
<callout arearefs="area-Reference_Guide-JavaServer_Pages_Portlet_Example-Portlet_Class.setRenderParameter">
@@ -609,12 +621,12 @@
The <filename>help.jsp</filename> and <filename>edit.jsp</filename> files are very simple. Note that CSS styles are used as defined in the portlet specification. This ensures that the portlet will render well within the theme and across portal vendors.
</para>
-<programlisting role="XHTML"><div class="portlet-section-header">Help mode</div>
-<div class="portlet-section-body">This is the help mode, a convenient place to give the user some help information.</div>
+<programlisting language="HTML" role="HTML"><![CDATA[<div class="portlet-section-header">Help mode</div>
+<div class="portlet-section-body">This is the help mode, a convenient place to give the user some help information.</div>]]>
</programlisting>
-<programlisting role="XHTML"><div class="portlet-section-header">Edit mode</div>
-<div class="portlet-section-body">This is the edit mode, a convenient place to let the user change his portlet preferences.</div>
+<programlisting language="HTML" role="HTML"><![CDATA[<div class="portlet-section-header">Edit mode</div>
+<div class="portlet-section-body">This is the edit mode, a convenient place to let the user change his portlet preferences.</div>]]>
</programlisting>
<para>
The landing page contains the links and form to call our portlet:
@@ -629,47 +641,47 @@
<area coords="31" id="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSP_files_and_the_Portlet_Tag_Library.method3.2" />
</areaspec>
-<programlisting><%@ taglib uri="http://java.sun.com/portlet" prefix="portlet" %>
+<programlisting language="XML" role="XML"><![CDATA[<%@ taglib uri="http://java.sun.com/portlet" prefix="portlet" %>
-<div class="portlet-section-header">Welcome !</div>
+<div class="portlet-section-header">Welcome !</div>
-<br/>
+<br/>
-<div class="portlet-font">Welcome on the JSP Hello User portlet,
-my name is GateIn Portal. What's yours ?</div>
+<div class="portlet-font">Welcome on the JSP Hello User portlet,
+my name is GateIn Portal. What's yours ?</div>
-<br/>
+<br/>
-<div class="portlet-font">Method 1: We simply pass the parameter to the render phase:<br/>
-<a href="<portlet:renderURL><portlet:param name="yourname" value="John Doe"/>
- </portlet:renderURL>">John Doe</a></div>
+<div class="portlet-font">Method 1: We simply pass the parameter to the render phase:<br/>
+<a href="<portlet:renderURL><portlet:param name="yourname" value="John Doe"/>
+ </portlet:renderURL>">John Doe</a></div>
-<br/>
+<br/>
-<div class="portlet-font">Method 2: We pass the parameter to the render phase, using valid XML:
+<div class="portlet-font">Method 2: We pass the parameter to the render phase, using valid XML:
Please check the source code to see the difference with Method 1.
-<portlet:renderURL var="myRenderURL">
- <portlet:param name="yourname" value='John Doe'/>
-</portlet:renderURL>
-<br/>
-<a href="<%= myRenderURL %>">John Doe</a></div>
+<portlet:renderURL var="myRenderURL">
+ <portlet:param name="yourname" value='John Doe'/>
+</portlet:renderURL>
+<br/>
+<a href="<%= myRenderURL %>">John Doe</a></div>
-<br/>
+<br/>
-<div class="portlet-font">Method 3: We use a form:<br/>
+<div class="portlet-font">Method 3: We use a form:<br/>
-<portlet:actionURL var="myActionURL"/>
-<form action="<%= myActionURL %>" method="POST">
- <span class="portlet-form-field-label">Name:</span>
- <input class="portlet-form-input-field" type="text" name="yourname"/>
- <input class="portlet-form-button" type="Submit"/>
-</form>
-</div>
-</programlisting>
+<portlet:actionURL var="myActionURL"/>
+<form action="<%= myActionURL %>" method="POST">
+ <span class="portlet-form-field-label">Name:</span>
+ <input class="portlet-form-input-field" type="text" name="yourname"/>
+ <input class="portlet-form-button" type="Submit"/>
+</form>
+</div>]]></programlisting>
+
<calloutlist>
<callout arearefs="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSP_files_and_the_Portlet_Tag_Library.taglib">
<para>
- The portlet taglib, needs to be declared.
+ The portlet taglib. This needs to be declared.
</para>
</callout>
<callout arearefs="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSP_files_and_the_Portlet_Tag_Library.method1">
@@ -722,20 +734,20 @@
As in any JSF application, the file <literal>faces-config.xml</literal> is required. It must contain the following information:
</para>
-<programlisting role="XML"><faces-config>
+<programlisting language="XML" role="XML"><![CDATA[<faces-config>
...
- <application>
- <view-handler>org.jboss.portletbridge.application.PortletViewHandler</view-handler>
- <state-manager>org.jboss.portletbridge.application.PortletStateManager</state-manager>
- </application>
+ <application>
+ <view-handler>org.jboss.portletbridge.application.PortletViewHandler</view-handler>
+ <state-manager>org.jboss.portletbridge.application.PortletStateManager</state-manager>
+ </application>
...
-</faces-config>
+</faces-config>]]>
</programlisting>
<para>
The portlet bridge libraries must be available and are usually bundled with the <literal>WEB-INF/lib</literal> directory of the web archive.
</para>
<para>
- The other difference compare to a regular portlet application, can be found in the portlet descriptor. All details about it can be found in the JSR-301 specification that the JBoss Portlet Bridge implements.
+ The other difference when compared to a regular portlet application are in the portlet descriptor. All the relevant details about this can be found in the JSR-301 specification that the JBoss Portlet Bridge implements.
</para>
<programlistingco>
<areaspec>
@@ -745,43 +757,43 @@
<area coords="31" id="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSF_example_using_the_JBoss_Portlet_Bridge.help" />
</areaspec>
-<programlisting><?xml version="1.0" encoding="UTF-8"?>
-<portlet-app xmlns="http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd"
+<programlisting language="XML" role="XML"><![CDATA[<?xml version="1.0" encoding="UTF-8"?>
+<portlet-app xmlns="http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd
http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd"
- version="2.0">
- <portlet>
- <portlet-name>JSFHelloUserPortlet</portlet-name>
- <portlet-class>javax.portlet.faces.GenericFacesPortlet</portlet-class>
- <supports>
- <mime-type>text/html</mime-type>
- <portlet-mode>view</portlet-mode>
- <portlet-mode>edit</portlet-mode>
- <portlet-mode>help</portlet-mode>
- </supports>
- <portlet-info>
- <title>JSF Hello User Portlet</title>
- </portlet-info>
+ version="2.0">
+ <portlet>
+ <portlet-name>JSFHelloUserPortlet</portlet-name>
+ <portlet-class>javax.portlet.faces.GenericFacesPortlet</portlet-class>
+ <supports>
+ <mime-type>text/html</mime-type>
+ <portlet-mode>view</portlet-mode>
+ <portlet-mode>edit</portlet-mode>
+ <portlet-mode>help</portlet-mode>
+ </supports>
+ <portlet-info>
+ <title>JSF Hello User Portlet</title>
+ </portlet-info>
- <init-param>
- <name>javax.portlet.faces.defaultViewId.view</name>
- <value>/jsf/welcome.jsp</value>
- </init-param>
+ <init-param>
+ <name>javax.portlet.faces.defaultViewId.view</name>
+ <value>/jsf/welcome.jsp</value>
+ </init-param>
- <init-param>
- <name>javax.portlet.faces.defaultViewId.edit</name>
- <value>/jsf/edit.jsp</value>
- </init-param>
+ <init-param>
+ <name>javax.portlet.faces.defaultViewId.edit</name>
+ <value>/jsf/edit.jsp</value>
+ </init-param>
- <init-param>
- <name>javax.portlet.faces.defaultViewId.help</name>
- <value>/jsf/help.jsp</value>
- </init-param>
+ <init-param>
+ <name>javax.portlet.faces.defaultViewId.help</name>
+ <value>/jsf/help.jsp</value>
+ </init-param>
- </portlet>
-</portlet-app>
-</programlisting>
+ </portlet>
+</portlet-app>]]></programlisting>
+
<calloutlist>
<callout arearefs="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSF_example_using_the_JBoss_Portlet_Bridge.portlet">
<para>
Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortletDevelopment.xml
===================================================================
--- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortletDevelopment.xml 2010-05-10 16:57:51 UTC (rev 3031)
+++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortletDevelopment.xml 2010-05-10 22:39:07 UTC (rev 3032)
@@ -1,6 +1,6 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE part PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "../Reference_Guide.ent">
%BOOK_ENTITIES;
]>
<part id="part-Reference_Guide-Portlet_development">
Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/WSRP.xml
===================================================================
--- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/WSRP.xml 2010-05-10 16:57:51 UTC (rev 3031)
+++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/WSRP.xml 2010-05-10 22:39:07 UTC (rev 3032)
@@ -1,6 +1,6 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "../Reference_Guide.ent">
%BOOK_ENTITIES;
]>
<chapter id="chap-Reference_Guide-Web_Services_for_Remote_Portlets_WSRP">
14 years, 1 month
- 1
- 0
gatein SVN: r3031 - in portal/branches/EPP_5_0_Branch/component/portal/src/main/java/org/exoplatform/portal/pom/config: cache and 1 other directory.
by do-not-reply＠jboss.org
Author: thomas.heute(a)jboss.com
Date: 2010-05-10 12:57:51 -0400 (Mon, 10 May 2010)
New Revision: 3031
Modified:
portal/branches/EPP_5_0_Branch/component/portal/src/main/java/org/exoplatform/portal/pom/config/POMSession.java
portal/branches/EPP_5_0_Branch/component/portal/src/main/java/org/exoplatform/portal/pom/config/POMSessionManager.java
portal/branches/EPP_5_0_Branch/component/portal/src/main/java/org/exoplatform/portal/pom/config/cache/DataCache.java
portal/branches/EPP_5_0_Branch/component/portal/src/main/java/org/exoplatform/portal/pom/config/cache/NullObject.java
Log:
JBEPP-352: Provide mop cache operation trace logging
Modified: portal/branches/EPP_5_0_Branch/component/portal/src/main/java/org/exoplatform/portal/pom/config/POMSession.java
===================================================================
--- portal/branches/EPP_5_0_Branch/component/portal/src/main/java/org/exoplatform/portal/pom/config/POMSession.java 2010-05-10 15:09:15 UTC (rev 3030)
+++ portal/branches/EPP_5_0_Branch/component/portal/src/main/java/org/exoplatform/portal/pom/config/POMSession.java 2010-05-10 16:57:51 UTC (rev 3031)
@@ -364,6 +364,10 @@
{
if (status == SynchronizationStatus.SAVED && staleKeys != null)
{
+ if (log.isTraceEnabled())
+ {
+ log.trace("Session commit about to evict entries " + staleKeys);
+ }
for (Serializable key : staleKeys)
{
mgr.cacheRemove(key);
Modified: portal/branches/EPP_5_0_Branch/component/portal/src/main/java/org/exoplatform/portal/pom/config/POMSessionManager.java
===================================================================
--- portal/branches/EPP_5_0_Branch/component/portal/src/main/java/org/exoplatform/portal/pom/config/POMSessionManager.java 2010-05-10 15:09:15 UTC (rev 3030)
+++ portal/branches/EPP_5_0_Branch/component/portal/src/main/java/org/exoplatform/portal/pom/config/POMSessionManager.java 2010-05-10 16:57:51 UTC (rev 3031)
@@ -26,6 +26,8 @@
import org.exoplatform.services.cache.CacheService;
import org.exoplatform.services.cache.ExoCache;
import org.exoplatform.services.jcr.RepositoryService;
+import org.gatein.common.logging.Logger;
+import org.gatein.common.logging.LoggerFactory;
import org.gatein.mop.core.api.MOPService;
import org.picocontainer.Startable;
@@ -40,6 +42,9 @@
{
/** . */
+ private final Logger log = LoggerFactory.getLogger(POMSessionManager.class);
+
+ /** . */
private MOPService pomService;
/** . */
@@ -69,17 +74,47 @@
public void cachePut(Serializable key, Object value)
{
- cache.put(GlobalKey.wrap(repositoryService, key), value);
+ GlobalKey globalKey = GlobalKey.wrap(repositoryService, key);
+
+ //
+ if (log.isTraceEnabled())
+ {
+ log.trace("Updating cache key=" + globalKey + " with value=" + value);
+ }
+
+ //
+ cache.put(globalKey, value);
}
public Object cacheGet(Serializable key)
{
- return cache.get(GlobalKey.wrap(repositoryService, key));
+ GlobalKey globalKey = GlobalKey.wrap(repositoryService, key);
+
+ //
+ Object value = cache.get(globalKey);
+
+ //
+ if (log.isTraceEnabled())
+ {
+ log.trace("Obtained for cache key=" + globalKey + " value=" + value);
+ }
+
+ //
+ return value;
}
public void cacheRemove(Serializable key)
{
- cache.remove(GlobalKey.wrap(repositoryService, key));
+ GlobalKey globalKey = GlobalKey.wrap(repositoryService, key);
+
+ //
+ if (log.isTraceEnabled())
+ {
+ log.trace("Removing cache key=" + globalKey);
+ }
+
+ //
+ cache.remove(globalKey);
}
public void start()
@@ -109,6 +144,12 @@
public void clearCache()
{
+ if (log.isTraceEnabled())
+ {
+ log.trace("Clearing cache");
+ }
+
+ //
cache.clearCache();
}
Modified: portal/branches/EPP_5_0_Branch/component/portal/src/main/java/org/exoplatform/portal/pom/config/cache/DataCache.java
===================================================================
--- portal/branches/EPP_5_0_Branch/component/portal/src/main/java/org/exoplatform/portal/pom/config/cache/DataCache.java 2010-05-10 15:09:15 UTC (rev 3030)
+++ portal/branches/EPP_5_0_Branch/component/portal/src/main/java/org/exoplatform/portal/pom/config/cache/DataCache.java 2010-05-10 16:57:51 UTC (rev 3031)
@@ -23,6 +23,8 @@
import org.exoplatform.portal.pom.config.POMTask;
import org.exoplatform.portal.pom.config.TaskExecutor;
import org.exoplatform.portal.pom.config.TaskExecutionDecorator;
+import org.gatein.common.logging.Logger;
+import org.gatein.common.logging.LoggerFactory;
import java.io.Serializable;
import java.util.concurrent.atomic.AtomicLong;
@@ -35,6 +37,9 @@
{
/** . */
+ private final Logger log = LoggerFactory.getLogger(DataCache.class);
+
+ /** . */
private final AtomicLong readCount = new AtomicLong();
/** . */
@@ -73,6 +78,10 @@
private <K extends Serializable, V> V remove(POMSession session, CacheableDataTask<K, V> task) throws Exception
{
K key = task.getKey();
+ if (log.isTraceEnabled())
+ {
+ log.trace("Schedule " + key + " for eviction");
+ }
session.scheduleForEviction(key);
return super.execute(session, task);
}
@@ -80,6 +89,10 @@
private <K extends Serializable, V> V write(POMSession session, CacheableDataTask<K, V> task) throws Exception
{
K key = task.getKey();
+ if (log.isTraceEnabled())
+ {
+ log.trace("Schedule " + key + " for eviction");
+ }
session.scheduleForEviction(key);
return super.execute(session, task);
}
@@ -87,21 +100,36 @@
private <K extends Serializable, V> V create(POMSession session, CacheableDataTask<K, V> task) throws Exception
{
K key = task.getKey();
+ if (log.isTraceEnabled())
+ {
+ log.trace("Schedule " + key + " for eviction");
+ }
session.scheduleForEviction(key);
return super.execute(session, task);
}
private <K extends Serializable, V> V read(POMSession session, CacheableDataTask<K, V> task) throws Exception
{
+ K key = task.getKey();
+
+ //
if (!session.isModified())
{
- K key = task.getKey();
Object o = session.getFromCache(key);
+ if (log.isTraceEnabled())
+ {
+ log.trace("Retrieved " + o + " for key " + key);
+ }
+
V v = null;
if (o != null)
{
if (o == NullObject.get())
{
+ if (log.isTraceEnabled())
+ {
+ log.trace("Returning null as found null object marker");
+ }
return null;
}
else
@@ -111,12 +139,20 @@
{
v = type.cast(o);
}
+ else
+ {
+ log.error("Object " + o + " was not of the expected type " + type);
+ }
}
}
//
if (v != null)
{
+ if (log.isTraceEnabled())
+ {
+ log.trace("Returning object " + v + " for key " + key);
+ }
return v;
}
else
@@ -124,17 +160,35 @@
readCount.incrementAndGet();
//
+ if (log.isTraceEnabled())
+ {
+ log.trace("Object not found in cache for key " + key + " about to retrieve it");
+ }
+
+ //
v = super.execute(session, task);
+ if (log.isTraceEnabled())
+ {
+ log.trace("Retrieved object " + v + " key " + key + " that will be returned");
+ }
//
if (!session.isModified())
{
if (v == null)
{
+ if (log.isTraceEnabled())
+ {
+ log.trace("Updating cache with null object for key " + key);
+ }
session.putInCache(key, NullObject.get());
}
else
{
+ if (log.isTraceEnabled())
+ {
+ log.trace("Updating cache with object " + v + " for key " + key);
+ }
session.putInCache(key, v);
}
}
@@ -145,6 +199,12 @@
}
else
{
+ if (log.isTraceEnabled())
+ {
+ log.trace("Session was modified, object for key " + key + " is directly retrieved");
+ }
+
+ //
return super.execute(session, task);
}
}
Modified: portal/branches/EPP_5_0_Branch/component/portal/src/main/java/org/exoplatform/portal/pom/config/cache/NullObject.java
===================================================================
--- portal/branches/EPP_5_0_Branch/component/portal/src/main/java/org/exoplatform/portal/pom/config/cache/NullObject.java 2010-05-10 15:09:15 UTC (rev 3030)
+++ portal/branches/EPP_5_0_Branch/component/portal/src/main/java/org/exoplatform/portal/pom/config/cache/NullObject.java 2010-05-10 16:57:51 UTC (rev 3031)
@@ -52,4 +52,10 @@
{
// Nothing to do
}
+
+ @Override
+ public String toString()
+ {
+ return "NullObject[]";
+ }
}
14 years, 1 month
- 1
- 0
gatein SVN: r3030 - portal/branches/EPP_5_0_Branch/testsuite/selenium-snifftests/src/suite/org/exoplatform/portal/selenium.
by do-not-reply＠jboss.org
Author: mvanco(a)redhat.com
Date: 2010-05-10 11:09:15 -0400 (Mon, 10 May 2010)
New Revision: 3030
Modified:
portal/branches/EPP_5_0_Branch/testsuite/selenium-snifftests/src/suite/org/exoplatform/portal/selenium/Test_VerifyViewRightsPortlet.html
Log:
EPP5 ui test: edited test for verify porltet view rights - check -> uncheck
Modified: portal/branches/EPP_5_0_Branch/testsuite/selenium-snifftests/src/suite/org/exoplatform/portal/selenium/Test_VerifyViewRightsPortlet.html
===================================================================
--- portal/branches/EPP_5_0_Branch/testsuite/selenium-snifftests/src/suite/org/exoplatform/portal/selenium/Test_VerifyViewRightsPortlet.html 2010-05-10 14:46:08 UTC (rev 3029)
+++ portal/branches/EPP_5_0_Branch/testsuite/selenium-snifftests/src/suite/org/exoplatform/portal/selenium/Test_VerifyViewRightsPortlet.html 2010-05-10 15:09:15 UTC (rev 3030)
@@ -162,7 +162,7 @@
<td></td>
</tr>
<tr>
- <td>check</td>
+ <td>uncheck</td>
<td>publicMode</td>
<td></td>
</tr>
14 years, 1 month
- 1
- 0
gatein SVN: r3029 - in portal/branches/EPP_5_0_Branch/testsuite/selenium-snifftests/src: suite/org/exoplatform/portal/selenium and 1 other directory.
by do-not-reply＠jboss.org
Author: mvanco(a)redhat.com
Date: 2010-05-10 10:46:08 -0400 (Mon, 10 May 2010)
New Revision: 3029
Modified:
portal/branches/EPP_5_0_Branch/testsuite/selenium-snifftests/src/main/java/org/exoplatform/portal/selenium/SeleniumTestCaseGenerator.java
portal/branches/EPP_5_0_Branch/testsuite/selenium-snifftests/src/suite/org/exoplatform/portal/selenium/Test_POR_09_002_CreateNewPortalWithValidValue.html
portal/branches/EPP_5_0_Branch/testsuite/selenium-snifftests/src/suite/org/exoplatform/portal/selenium/Test_POR_09_003_CreateNewPortalWithBlankName.html
portal/branches/EPP_5_0_Branch/testsuite/selenium-snifftests/src/suite/org/exoplatform/portal/selenium/Test_POR_09_004_CreateNewPortalWithNameStartNumber.html
portal/branches/EPP_5_0_Branch/testsuite/selenium-snifftests/src/suite/org/exoplatform/portal/selenium/Test_POR_09_008_CreateNewPortalWithNameIsTheSameWithExistingOne.html
portal/branches/EPP_5_0_Branch/testsuite/selenium-snifftests/src/suite/org/exoplatform/portal/selenium/Test_POR_09_009_CreateNewPortalWithPortalNameTheSameWithExistingButDifferentByLowerAndUpperCase.html
portal/branches/EPP_5_0_Branch/testsuite/selenium-snifftests/src/suite/org/exoplatform/portal/selenium/Test_POR_10_002_DeleteCurrentPortalByLegalUser.html
portal/branches/EPP_5_0_Branch/testsuite/selenium-snifftests/src/suite/org/exoplatform/portal/selenium/Test_POR_20_026_CreateSameNamePortalPagesInDifferentPortals.html
portal/branches/EPP_5_0_Branch/testsuite/selenium-snifftests/src/suite/org/exoplatform/portal/selenium/Test_SNF_PRL_18_CreateNewPortal.html
portal/branches/EPP_5_0_Branch/testsuite/selenium-snifftests/src/suite/org/exoplatform/portal/selenium/Test_SNF_PRL_20_DeletePortal.html
portal/branches/EPP_5_0_Branch/testsuite/selenium-snifftests/src/suite/org/exoplatform/portal/selenium/Test_SNF_PRL_21_ChangeUsingPortal.html
portal/branches/EPP_5_0_Branch/testsuite/selenium-snifftests/src/suite/org/exoplatform/portal/selenium/Test_VerifyViewRightsPortlet.html
Log:
EPP5 UI tests: removed function clickOnElement, added command fireEvent - calls default selenium.fireEvent(locator, event), changed usage in tests
Modified: portal/branches/EPP_5_0_Branch/testsuite/selenium-snifftests/src/main/java/org/exoplatform/portal/selenium/SeleniumTestCaseGenerator.java
===================================================================
--- portal/branches/EPP_5_0_Branch/testsuite/selenium-snifftests/src/main/java/org/exoplatform/portal/selenium/SeleniumTestCaseGenerator.java 2010-05-10 13:30:34 UTC (rev 3028)
+++ portal/branches/EPP_5_0_Branch/testsuite/selenium-snifftests/src/main/java/org/exoplatform/portal/selenium/SeleniumTestCaseGenerator.java 2010-05-10 14:46:08 UTC (rev 3029)
@@ -422,9 +422,11 @@
sb.append("if (selenium.isTextPresent(\"" + param2 + "\")) {\n");
} else if (param1.equals("endIfTextPresentCondition")) {
sb.append("}\n");
- } else if (param1.equals("clickOnElement")) {
- sb.append("selenium.click(\"");
+ } else if (param1.equals("fireEvent")) {
+ sb.append("selenium.fireEvent(\"");
sb.append(param2);
+ sb.append("\", \"");
+ sb.append(param3);
sb.append("\");\n");
} else if (param1.length() > 0) {
String message = param1 + " was not translated \"" + param2 + "\"";
Modified: portal/branches/EPP_5_0_Branch/testsuite/selenium-snifftests/src/suite/org/exoplatform/portal/selenium/Test_POR_09_002_CreateNewPortalWithValidValue.html
===================================================================
--- portal/branches/EPP_5_0_Branch/testsuite/selenium-snifftests/src/suite/org/exoplatform/portal/selenium/Test_POR_09_002_CreateNewPortalWithValidValue.html 2010-05-10 13:30:34 UTC (rev 3028)
+++ portal/branches/EPP_5_0_Branch/testsuite/selenium-snifftests/src/suite/org/exoplatform/portal/selenium/Test_POR_09_002_CreateNewPortalWithValidValue.html 2010-05-10 14:46:08 UTC (rev 3029)
@@ -137,11 +137,16 @@
<td></td>
</tr>
<tr>
- <td>clickOnElement</td>
+ <td>check</td>
<td>publicMode</td>
<td></td>
</tr>
<tr>
+ <td>fireEvent</td>
+ <td>publicMode</td>
+ <td>click</td>
+</tr>
+<tr>
<td>waitForElementPresent</td>
<td>link=Edit Permission Setting</td>
<td></td>
Modified: portal/branches/EPP_5_0_Branch/testsuite/selenium-snifftests/src/suite/org/exoplatform/portal/selenium/Test_POR_09_003_CreateNewPortalWithBlankName.html
===================================================================
--- portal/branches/EPP_5_0_Branch/testsuite/selenium-snifftests/src/suite/org/exoplatform/portal/selenium/Test_POR_09_003_CreateNewPortalWithBlankName.html 2010-05-10 13:30:34 UTC (rev 3028)
+++ portal/branches/EPP_5_0_Branch/testsuite/selenium-snifftests/src/suite/org/exoplatform/portal/selenium/Test_POR_09_003_CreateNewPortalWithBlankName.html 2010-05-10 14:46:08 UTC (rev 3029)
@@ -152,11 +152,16 @@
<td></td>
</tr>
<tr>
- <td>clickOnElement</td>
+ <td>check</td>
<td>publicMode</td>
<td></td>
</tr>
<tr>
+ <td>fireEvent</td>
+ <td>publicMode</td>
+ <td>click</td>
+</tr>
+<tr>
<td>echo</td>
<td>--Choose Edit Permission Setting--</td>p
<td></td>
Modified: portal/branches/EPP_5_0_Branch/testsuite/selenium-snifftests/src/suite/org/exoplatform/portal/selenium/Test_POR_09_004_CreateNewPortalWithNameStartNumber.html
===================================================================
--- portal/branches/EPP_5_0_Branch/testsuite/selenium-snifftests/src/suite/org/exoplatform/portal/selenium/Test_POR_09_004_CreateNewPortalWithNameStartNumber.html 2010-05-10 13:30:34 UTC (rev 3028)
+++ portal/branches/EPP_5_0_Branch/testsuite/selenium-snifftests/src/suite/org/exoplatform/portal/selenium/Test_POR_09_004_CreateNewPortalWithNameStartNumber.html 2010-05-10 14:46:08 UTC (rev 3029)
@@ -147,11 +147,16 @@
<td></td>
</tr>
<tr>
- <td>clickOnElement</td>
+ <td>check</td>
<td>publicMode</td>
<td></td>
</tr>
<tr>
+ <td>fireEvent</td>
+ <td>publicMode</td>
+ <td>click</td>
+</tr>
+<tr>
<td>echo</td>
<td>--Choose Edit Permission Setting--</td>
<td></td>
Modified: portal/branches/EPP_5_0_Branch/testsuite/selenium-snifftests/src/suite/org/exoplatform/portal/selenium/Test_POR_09_008_CreateNewPortalWithNameIsTheSameWithExistingOne.html
===================================================================
--- portal/branches/EPP_5_0_Branch/testsuite/selenium-snifftests/src/suite/org/exoplatform/portal/selenium/Test_POR_09_008_CreateNewPortalWithNameIsTheSameWithExistingOne.html 2010-05-10 13:30:34 UTC (rev 3028)
+++ portal/branches/EPP_5_0_Branch/testsuite/selenium-snifftests/src/suite/org/exoplatform/portal/selenium/Test_POR_09_008_CreateNewPortalWithNameIsTheSameWithExistingOne.html 2010-05-10 14:46:08 UTC (rev 3029)
@@ -157,11 +157,16 @@
<td></td>
</tr>
<tr>
- <td>clickOnElement</td>
+ <td>check</td>
<td>publicMode</td>
<td></td>
</tr>
<tr>
+ <td>fireEvent</td>
+ <td>publicMode</td>
+ <td>click</td>
+</tr>
+<tr>
<td>echo</td>
<td>--Choose Edit Permission Setting--</td>
<td></td>
@@ -322,11 +327,16 @@
<td></td>
</tr>
<tr>
- <td>clickOnElement</td>
+ <td>check</td>
<td>publicMode</td>
<td></td>
</tr>
<tr>
+ <td>fireEvent</td>
+ <td>publicMode</td>
+ <td>click</td>
+</tr>
+<tr>
<td>echo</td>
<td>--Choose Edit Permission Setting--</td>
<td></td>
Modified: portal/branches/EPP_5_0_Branch/testsuite/selenium-snifftests/src/suite/org/exoplatform/portal/selenium/Test_POR_09_009_CreateNewPortalWithPortalNameTheSameWithExistingButDifferentByLowerAndUpperCase.html
===================================================================
--- portal/branches/EPP_5_0_Branch/testsuite/selenium-snifftests/src/suite/org/exoplatform/portal/selenium/Test_POR_09_009_CreateNewPortalWithPortalNameTheSameWithExistingButDifferentByLowerAndUpperCase.html 2010-05-10 13:30:34 UTC (rev 3028)
+++ portal/branches/EPP_5_0_Branch/testsuite/selenium-snifftests/src/suite/org/exoplatform/portal/selenium/Test_POR_09_009_CreateNewPortalWithPortalNameTheSameWithExistingButDifferentByLowerAndUpperCase.html 2010-05-10 14:46:08 UTC (rev 3029)
@@ -157,11 +157,16 @@
<td></td>
</tr>
<tr>
- <td>clickOnElement</td>
+ <td>check</td>
<td>publicMode</td>
<td></td>
</tr>
<tr>
+ <td>fireEvent</td>
+ <td>publicMode</td>
+ <td>click</td>
+</tr>
+<tr>
<td>echo</td>
<td>--Choose Edit Permission Setting</td>
<td></td>
@@ -327,11 +332,16 @@
<td></td>
</tr>
<tr>
- <td>clickOnElement</td>
+ <td>check</td>
<td>publicMode</td>
<td></td>
</tr>
<tr>
+ <td>fireEvent</td>
+ <td>publicMode</td>
+ <td>click</td>
+</tr>
+<tr>
<td>echo</td>
<td>--Choose Edit Permission Setting--</td>
<td></td>
Modified: portal/branches/EPP_5_0_Branch/testsuite/selenium-snifftests/src/suite/org/exoplatform/portal/selenium/Test_POR_10_002_DeleteCurrentPortalByLegalUser.html
===================================================================
--- portal/branches/EPP_5_0_Branch/testsuite/selenium-snifftests/src/suite/org/exoplatform/portal/selenium/Test_POR_10_002_DeleteCurrentPortalByLegalUser.html 2010-05-10 13:30:34 UTC (rev 3028)
+++ portal/branches/EPP_5_0_Branch/testsuite/selenium-snifftests/src/suite/org/exoplatform/portal/selenium/Test_POR_10_002_DeleteCurrentPortalByLegalUser.html 2010-05-10 14:46:08 UTC (rev 3029)
@@ -157,11 +157,16 @@
<td></td>
</tr>
<tr>
- <td>clickOnElement</td>
+ <td>check</td>
<td>publicMode</td>
<td></td>
</tr>
<tr>
+ <td>fireEvent</td>
+ <td>publicMode</td>
+ <td>click</td>
+</tr>
+<tr>
<td>echo</td>
<td>--Edit Permission Setting--</td>
<td></td>
Modified: portal/branches/EPP_5_0_Branch/testsuite/selenium-snifftests/src/suite/org/exoplatform/portal/selenium/Test_POR_20_026_CreateSameNamePortalPagesInDifferentPortals.html
===================================================================
--- portal/branches/EPP_5_0_Branch/testsuite/selenium-snifftests/src/suite/org/exoplatform/portal/selenium/Test_POR_20_026_CreateSameNamePortalPagesInDifferentPortals.html 2010-05-10 13:30:34 UTC (rev 3028)
+++ portal/branches/EPP_5_0_Branch/testsuite/selenium-snifftests/src/suite/org/exoplatform/portal/selenium/Test_POR_20_026_CreateSameNamePortalPagesInDifferentPortals.html 2010-05-10 14:46:08 UTC (rev 3029)
@@ -252,11 +252,16 @@
<td></td>
</tr>
<tr>
- <td>clickOnElement</td>
+ <td>check</td>
<td>publicMode</td>
<td></td>
</tr>
<tr>
+ <td>fireEvent</td>
+ <td>publicMode</td>
+ <td>click</td>
+</tr>
+<tr>
<td>waitForElementPresent</td>
<td>link=Edit Permission Setting</td>
<td></td>
Modified: portal/branches/EPP_5_0_Branch/testsuite/selenium-snifftests/src/suite/org/exoplatform/portal/selenium/Test_SNF_PRL_18_CreateNewPortal.html
===================================================================
--- portal/branches/EPP_5_0_Branch/testsuite/selenium-snifftests/src/suite/org/exoplatform/portal/selenium/Test_SNF_PRL_18_CreateNewPortal.html 2010-05-10 13:30:34 UTC (rev 3028)
+++ portal/branches/EPP_5_0_Branch/testsuite/selenium-snifftests/src/suite/org/exoplatform/portal/selenium/Test_SNF_PRL_18_CreateNewPortal.html 2010-05-10 14:46:08 UTC (rev 3029)
@@ -102,11 +102,16 @@
<td></td>
</tr>
<tr>
- <td>clickOnElement</td>
+ <td>check</td>
<td>publicMode</td>
<td></td>
</tr>
<tr>
+ <td>fireEvent</td>
+ <td>publicMode</td>
+ <td>click</td>
+</tr>
+<tr>
<td>waitForElementPresent</td>
<td>link=Edit Permission Setting</td>
<td></td>
Modified: portal/branches/EPP_5_0_Branch/testsuite/selenium-snifftests/src/suite/org/exoplatform/portal/selenium/Test_SNF_PRL_20_DeletePortal.html
===================================================================
--- portal/branches/EPP_5_0_Branch/testsuite/selenium-snifftests/src/suite/org/exoplatform/portal/selenium/Test_SNF_PRL_20_DeletePortal.html 2010-05-10 13:30:34 UTC (rev 3028)
+++ portal/branches/EPP_5_0_Branch/testsuite/selenium-snifftests/src/suite/org/exoplatform/portal/selenium/Test_SNF_PRL_20_DeletePortal.html 2010-05-10 14:46:08 UTC (rev 3029)
@@ -112,11 +112,16 @@
<td></td>
</tr>
<tr>
- <td>clickOnElement</td>
+ <td>check</td>
<td>publicMode</td>
<td></td>
</tr>
<tr>
+ <td>fireEvent</td>
+ <td>publicMode</td>
+ <td>click</td>
+</tr>
+<tr>
<td>waitForElementPresent</td>
<td>link=Edit Permission Setting</td>
<td></td>
Modified: portal/branches/EPP_5_0_Branch/testsuite/selenium-snifftests/src/suite/org/exoplatform/portal/selenium/Test_SNF_PRL_21_ChangeUsingPortal.html
===================================================================
--- portal/branches/EPP_5_0_Branch/testsuite/selenium-snifftests/src/suite/org/exoplatform/portal/selenium/Test_SNF_PRL_21_ChangeUsingPortal.html 2010-05-10 13:30:34 UTC (rev 3028)
+++ portal/branches/EPP_5_0_Branch/testsuite/selenium-snifftests/src/suite/org/exoplatform/portal/selenium/Test_SNF_PRL_21_ChangeUsingPortal.html 2010-05-10 14:46:08 UTC (rev 3029)
@@ -102,11 +102,16 @@
<td></td>
</tr>
<tr>
- <td>clickOnElement</td>
+ <td>check</td>
<td>publicMode</td>
<td></td>
</tr>
<tr>
+ <td>fireEvent</td>
+ <td>publicMode</td>
+ <td>click</td>
+</tr>
+<tr>
<td>waitForElementPresent</td>
<td>link=Edit Permission Setting</td>
<td></td>
Modified: portal/branches/EPP_5_0_Branch/testsuite/selenium-snifftests/src/suite/org/exoplatform/portal/selenium/Test_VerifyViewRightsPortlet.html
===================================================================
--- portal/branches/EPP_5_0_Branch/testsuite/selenium-snifftests/src/suite/org/exoplatform/portal/selenium/Test_VerifyViewRightsPortlet.html 2010-05-10 13:30:34 UTC (rev 3028)
+++ portal/branches/EPP_5_0_Branch/testsuite/selenium-snifftests/src/suite/org/exoplatform/portal/selenium/Test_VerifyViewRightsPortlet.html 2010-05-10 14:46:08 UTC (rev 3029)
@@ -147,21 +147,31 @@
<td></td>
</tr>
<tr>
- <td>clickOnElement</td>
+ <td>check</td>
<td>publicMode</td>
<td></td>
</tr>
<tr>
+ <td>fireEvent</td>
+ <td>publicMode</td>
+ <td>click</td>
+</tr>
+<tr>
<td>pause</td>
<td>3000</td>
<td></td>
</tr>
<tr>
- <td>clickOnElement</td>
+ <td>check</td>
<td>publicMode</td>
<td></td>
</tr>
<tr>
+ <td>fireEvent</td>
+ <td>publicMode</td>
+ <td>click</td>
+</tr>
+<tr>
<td>waitForElementPresent</td>
<td>link=Add Permission</td>
<td></td>
14 years, 1 month
- 1
- 0
gatein SVN: r3028 - in portal/trunk/component/portal/src/main/java/org/exoplatform/portal/pom/config: cache and 1 other directory.
by do-not-reply＠jboss.org
Author: julien_viet
Date: 2010-05-10 09:30:34 -0400 (Mon, 10 May 2010)
New Revision: 3028
Modified:
portal/trunk/component/portal/src/main/java/org/exoplatform/portal/pom/config/POMSession.java
portal/trunk/component/portal/src/main/java/org/exoplatform/portal/pom/config/cache/DataCache.java
portal/trunk/component/portal/src/main/java/org/exoplatform/portal/pom/config/cache/NullObject.java
Log:
GTNPORTAL-1176 : Provide mop cache operation trace logging
Modified: portal/trunk/component/portal/src/main/java/org/exoplatform/portal/pom/config/POMSession.java
===================================================================
--- portal/trunk/component/portal/src/main/java/org/exoplatform/portal/pom/config/POMSession.java 2010-05-10 13:16:00 UTC (rev 3027)
+++ portal/trunk/component/portal/src/main/java/org/exoplatform/portal/pom/config/POMSession.java 2010-05-10 13:30:34 UTC (rev 3028)
@@ -364,6 +364,10 @@
{
if (status == SynchronizationStatus.SAVED && staleKeys != null)
{
+ if (log.isTraceEnabled())
+ {
+ log.trace("Session commit about to evict entries " + staleKeys);
+ }
for (Serializable key : staleKeys)
{
mgr.cacheRemove(key);
Modified: portal/trunk/component/portal/src/main/java/org/exoplatform/portal/pom/config/cache/DataCache.java
===================================================================
--- portal/trunk/component/portal/src/main/java/org/exoplatform/portal/pom/config/cache/DataCache.java 2010-05-10 13:16:00 UTC (rev 3027)
+++ portal/trunk/component/portal/src/main/java/org/exoplatform/portal/pom/config/cache/DataCache.java 2010-05-10 13:30:34 UTC (rev 3028)
@@ -23,6 +23,8 @@
import org.exoplatform.portal.pom.config.POMTask;
import org.exoplatform.portal.pom.config.TaskExecutor;
import org.exoplatform.portal.pom.config.TaskExecutionDecorator;
+import org.gatein.common.logging.Logger;
+import org.gatein.common.logging.LoggerFactory;
import java.io.Serializable;
import java.util.concurrent.atomic.AtomicLong;
@@ -35,6 +37,9 @@
{
/** . */
+ private final Logger log = LoggerFactory.getLogger(DataCache.class);
+
+ /** . */
private final AtomicLong readCount = new AtomicLong();
/** . */
@@ -73,6 +78,10 @@
private <K extends Serializable, V> V remove(POMSession session, CacheableDataTask<K, V> task) throws Exception
{
K key = task.getKey();
+ if (log.isTraceEnabled())
+ {
+ log.trace("Schedule " + key + " for eviction");
+ }
session.scheduleForEviction(key);
return super.execute(session, task);
}
@@ -80,6 +89,10 @@
private <K extends Serializable, V> V write(POMSession session, CacheableDataTask<K, V> task) throws Exception
{
K key = task.getKey();
+ if (log.isTraceEnabled())
+ {
+ log.trace("Schedule " + key + " for eviction");
+ }
session.scheduleForEviction(key);
return super.execute(session, task);
}
@@ -87,21 +100,36 @@
private <K extends Serializable, V> V create(POMSession session, CacheableDataTask<K, V> task) throws Exception
{
K key = task.getKey();
+ if (log.isTraceEnabled())
+ {
+ log.trace("Schedule " + key + " for eviction");
+ }
session.scheduleForEviction(key);
return super.execute(session, task);
}
private <K extends Serializable, V> V read(POMSession session, CacheableDataTask<K, V> task) throws Exception
{
+ K key = task.getKey();
+
+ //
if (!session.isModified())
{
- K key = task.getKey();
Object o = session.getFromCache(key);
+ if (log.isTraceEnabled())
+ {
+ log.trace("Retrieved " + o + " for key " + key);
+ }
+
V v = null;
if (o != null)
{
if (o == NullObject.get())
{
+ if (log.isTraceEnabled())
+ {
+ log.trace("Returning null as found null object marker");
+ }
return null;
}
else
@@ -111,12 +139,20 @@
{
v = type.cast(o);
}
+ else
+ {
+ log.error("Object " + o + " was not of the expected type " + type);
+ }
}
}
//
if (v != null)
{
+ if (log.isTraceEnabled())
+ {
+ log.trace("Returning object " + v + " for key " + key);
+ }
return v;
}
else
@@ -124,17 +160,35 @@
readCount.incrementAndGet();
//
+ if (log.isTraceEnabled())
+ {
+ log.trace("Object not found in cache for key " + key + " about to retrieve it");
+ }
+
+ //
v = super.execute(session, task);
+ if (log.isTraceEnabled())
+ {
+ log.trace("Retrieved object " + v + " key " + key + " that will be returned");
+ }
//
if (!session.isModified())
{
if (v == null)
{
+ if (log.isTraceEnabled())
+ {
+ log.trace("Updating cache with null object for key " + key);
+ }
session.putInCache(key, NullObject.get());
}
else
{
+ if (log.isTraceEnabled())
+ {
+ log.trace("Updating cache with object " + v + " for key " + key);
+ }
session.putInCache(key, v);
}
}
@@ -145,6 +199,12 @@
}
else
{
+ if (log.isTraceEnabled())
+ {
+ log.trace("Session was modified, object for key " + key + " is directly retrieved");
+ }
+
+ //
return super.execute(session, task);
}
}
Modified: portal/trunk/component/portal/src/main/java/org/exoplatform/portal/pom/config/cache/NullObject.java
===================================================================
--- portal/trunk/component/portal/src/main/java/org/exoplatform/portal/pom/config/cache/NullObject.java 2010-05-10 13:16:00 UTC (rev 3027)
+++ portal/trunk/component/portal/src/main/java/org/exoplatform/portal/pom/config/cache/NullObject.java 2010-05-10 13:30:34 UTC (rev 3028)
@@ -52,4 +52,10 @@
{
// Nothing to do
}
+
+ @Override
+ public String toString()
+ {
+ return "NullObject[]";
+ }
}
14 years, 1 month
- 1
- 0