From do-not-reply at jboss.org Tue May 31 05:44:41 2011
Content-Type: multipart/mixed; boundary="===============1267490631832332372=="
MIME-Version: 1.0
From: do-not-reply at jboss.org
To: gatein-commits at lists.jboss.org
Subject: [gatein-commits] gatein SVN: r6580 - in
 portal/trunk/docs/reference-guide/en-US/modules: PortletDevelopment and 1
 other directory.
Date: Tue, 31 May 2011 05:44:41 -0400
Message-ID: <201105310944.p4V9ifmr013210@svn01.web.mwc.hst.phx2.redhat.com>

--===============1267490631832332372==
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: quoted-printable

Author: ndkhoiits
Date: 2011-05-31 05:44:40 -0400 (Tue, 31 May 2011)
New Revision: 6580

Added:
   portal/trunk/docs/reference-guide/en-US/modules/PortletDevelopment/Globa=
l_portlet.xml
Modified:
   portal/trunk/docs/reference-guide/en-US/modules/PortletDevelopment.xml
Log:
GTNPORTAL-1906 Update Reference Guide for Global Portlet feature

Added: portal/trunk/docs/reference-guide/en-US/modules/PortletDevelopment/G=
lobal_portlet.xml
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
--- portal/trunk/docs/reference-guide/en-US/modules/PortletDevelopment/Glob=
al_portlet.xml	                        (rev 0)
+++ portal/trunk/docs/reference-guide/en-US/modules/PortletDevelopment/Glob=
al_portlet.xml	2011-05-31 09:44:40 UTC (rev 6580)
@@ -0,0 +1,95 @@
+<?xml version=3D'1.0' encoding=3D'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">
+        %BOOK_ENTITIES;
+        ]>
+<section id=3D"sect-Reference_Guide-Global_Portlet">
+  <title>Global porlet.xml file</title>
+  <section id=3D"sect-Reference_Guide-Global_Portlet-Global_usecase">
+      <title>Global portlet.xml usecase</title>
+      <para>The Portlet Specification introduces PortletFilter as a standa=
rd approach to extend the behaviors of portlet
+          objects. For example, a filter can transform the content of port=
let requests and portlet responses.
+          According to the Portlet Specification, normally there are three=
 steps in setting up a portlet filter:
+      </para>
+      <orderedlist>
+          <listitem>
+              <para>Implement a PortletFilter object</para>
+          </listitem>
+          <listitem>
+              <para>Define the filter in portlet application deployment de=
scriptor</para>
+          </listitem>
+          <listitem>
+              <para>Define the filter mapping in portlet definitions</para>
+          </listitem>
+      </orderedlist>
+      <para>Two first steps are quite simple and easy to be done, however,=
 at the step 3, developers/administrators
+          need to replicate the filter mapping in many portlet definitions=
, that makes work error and tedious in
+          several use cases.
+          The global portlet feature is designed to compensate such limita=
tion.
+      </para>
+  </section>
+  <section id=3D"sect-Reference_Guide-Global_Portlet-Global_metadata">
+    <title>Global metadata</title>
+    <para>The Global metadata is declared in the
+            <emphasis role=3D"italic">portlet.xml</emphasis> file conformi=
ng with Portlet 2.0 &apos;s XSD.
+        </para>
+    <programlisting role=3D"XML">&lt;portlet-app version=3D&quot;1.0&quot;=
 xmlns=3D&quot;http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd&quot;
+             xmlns:xsi=3D&quot;http://www.w3.org/2001/XMLSchema-instance&q=
uot;
+             xsi:schemaLocation=3D&quot;http://java.sun.com/xml/ns/portlet=
/portlet-app_2_0.xsd http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd=
&quot;&gt;
+
+&lt;/portlet-app&gt;</programlisting>
+    <section id=3D"sect-Reference_Guide-Global_Portlet-Location">
+      <title>Location</title>
+      <para>The path to the global <emphasis role=3D"italic">portlet.xml</=
emphasis> is value of <emphasis role=3D"italic">gatein.portlet.config</emph=
asis> in the <emphasis role=3D"italic">configuration.properties</emphasis> =
file and varied by hosting
+            application servers.
+        </para>
+      <para><emphasis role=3D"bold">For Tomcat</emphasis>: <emphasis role=
=3D"italic">TOMCAT_HOME/gatein/conf/portlet.xml</emphasis></para>
+      <para><emphasis role=3D"bold">For JBoss</emphasis>: <emphasis role=
=3D"italic">JBOSS_HOME/server/default/conf/gatein/portlet.xml</emphasis></p=
ara>
+    </section>
+    <section id=3D"sect-Reference_Guide-Global_Portlet-Global_metadata_ele=
ments">
+      <title>Global metadata elements</title>
+      <para>The global <emphasis role=3D"italic">portlet.xml</emphasis> fi=
le conforms to the schema of the portlet deployment descriptor defined in t=
he Portlet
+            Specification with some restrictions. In this file, the follow=
ing elements are supported:
+        </para>
+      <orderedlist>
+        <listitem>
+          <para>Portlet Filter</para>
+        </listitem>
+        <listitem>
+          <para>Portlet Mode</para>
+        </listitem>
+        <listitem>
+          <para>Window State</para>
+        </listitem>
+      </orderedlist>
+      <section id=3D"sect-Reference_Guide-Global_metadata_elements-Global_=
Portlet-Portlet_filter">
+        <title>Portlet filter</title>
+        <para>Portlet filter mappings declared in the global<emphasis role=
=3D"italic"> portlet.xml</emphasis> file are applied across portlet applica=
tions. With
+                the XML configuration below, the filter ApplicationMonitor=
ingFilter involves in request handling on any
+                deployed portlet.
+        </para>
+        <programlisting role=3D"XML">&lt;filter&gt;
+     &lt;filter-name&gt;org.exoplatform.portal.application.ApplicationMoni=
toringFilter&lt;/filter-name&gt;
+    &lt;filter-class&gt;org.exoplatform.portal.application.ApplicationMoni=
toringFilter&lt;/filter-class&gt;
+    &lt;lifecycle&gt;ACTION_PHASE&lt;/lifecycle&gt;
+    &lt;lifecycle&gt;RENDER_PHASE&lt;/lifecycle&gt;
+    &lt;lifecycle&gt;EVENT_PHASE&lt;/lifecycle&gt;
+    &lt;lifecycle&gt;RESOURCE_PHASE&lt;/lifecycle&gt;
+&lt;/filter&gt;</programlisting>
+          <para>
+              <emphasis role=3D"bold">Application Monitoring Filter</empha=
sis>
+              supports four lifecycle phases as the order below:
+              <emphasis role=3D"italic">ACTION_PHASE/ EVENT_PHASE/ RENDER_=
PHASE/ RESOURCE_PHASE</emphasis>
+              and
+              records statistic information on deployed portlets.
+              The filter alternates actual monitoring mechanism in WebUI F=
ramework.
+          </para>
+      </section>
+      <section id=3D"sect-Reference_Guide-Global_metadata_elements-Global_=
Portlet-Portlet_mode">
+        <title>Portlet Mode and Window State</title>
+        <para>The global <emphasis role=3D"italic">portlet.xml</emphasis> =
file is considered as an alternative place to declare custom Portlet Modes =
and Window States.
+            </para>
+      </section>
+    </section>
+  </section>
+</section>

Modified: portal/trunk/docs/reference-guide/en-US/modules/PortletDevelopmen=
t.xml
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
--- portal/trunk/docs/reference-guide/en-US/modules/PortletDevelopment.xml	=
2011-05-30 17:28:39 UTC (rev 6579)
+++ portal/trunk/docs/reference-guide/en-US/modules/PortletDevelopment.xml	=
2011-05-31 09:44:40 UTC (rev 6580)
@@ -6,7 +6,8 @@
 <chapter id=3D"chap-Reference_Guide-Portlet_development">
 	<title>Portlet development</title>
 =

-	<xi:include href=3D"PortletDevelopment/Standard.xml" xmlns:xi=3D"http://w=
ww.w3.org/2001/XInclude" />
+	<xi:include xmlns:xi=3D"http://www.w3.org/2001/XInclude" href=3D"PortletD=
evelopment/Standard.xml" />
+	<xi:include xmlns:xi=3D"http://www.w3.org/2001/XInclude" href=3D"PortletD=
evelopment/Global_portlet.xml"/>
 =

 </chapter>
 =



--===============1267490631832332372==--