Author: smumford
Date: 2011-09-12 23:41:42 -0400 (Mon, 12 Sep 2011)
New Revision: 7366
Added:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortletDevelopment/Global_Portlet.xml
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortletDevelopment.xml
epp/docs/branches/5.2/Reference_Guide/publican.cfg
Log:
JBEPP-1159: Incorporated changes from GTNPORTAL-1906
Added:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortletDevelopment/Global_Portlet.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortletDevelopment/Global_Portlet.xml
(rev 0)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortletDevelopment/Global_Portlet.xml 2011-09-13
03:41:42 UTC (rev 7366)
@@ -0,0 +1,118 @@
+<?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">
+%BOOK_ENTITIES;
+]>
+<chapter id="chap-Reference_Guide-Global_Portlet_Data_Data">
+ <title>Global Portlet Data</title>
+ <section
id="sect-Reference_Guide-Global_Portlet_Data-The_Global_Data_File">
+ <title>The Global Data File</title>
+ <para>
+ The Java Portlet Specification introduces
<literal>PortletFilter</literal> as a standard approach to extend the
behaviors of portlet objects. For example, a filter can transform the content of portlet
requests and portlet responses.
+ </para>
+ <para>
+ According to the Portlet Specification, there are normally three steps in setting
up a portlet filter:
+ </para>
+ <procedure>
+ <step>
+ <para>Implement a <literal>PortletFilter</literal>
object.</para>
+ </step>
+ <step>
+ <para>Define the filter in portlet application deployment
descriptor.</para>
+ </step>
+ <step>
+ <para>Define the filter mapping in portlet definitions.</para>
+ </step>
+ </procedure>
+ <para>
+ While the first two steps are quite straightforward, the third requires
developers or administrators to replicate the filter mapping in many portlet definitions.
This can be tedious and opens the potential for input errors. The global portlet feature
is designed to mitigate these concerns.
+ </para>
+ </section>
+ <section
id="sect-Reference_Guide-Global_Portlet_Data-Global_Metadata">
+ <title>Global Metadata</title>
+ <para>
+ Global portlet metadata is declared in the
<filename>portlet.xml</filename> file and conforms with the Portlet 2.0 XSD.
+ </para>
+<programlisting role="XML"
language="XML"><![CDATA[<portlet-app version="1.0"
xmlns="http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd&am...
+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+
xsi:schemaLocation="http://java.sun.com/xml/ns/portlet/portlet-a...
http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd">
+
+</portlet-app>
+]]></programlisting>
+
+ <section id="sect-Reference_Guide-Global_Portlet_Data-Location">
+ <title>Location</title>
+ <para>
+ The path to the global <filename>portlet.xml</filename> is the
value of <literal>gatein.portlet.config</literal> in the
<filename>configuration.properties.xml</filename> file (this can vary
depending on the hosting application server).
+ </para>
+ <para>
+ <emphasis role="bold">For JBoss</emphasis>: The file path
is
<filename><replaceable><JBOSS_HOME></replaceable>/server/default/conf/gatein/portlet.xml</filename>.
+ </para>
+ </section>
+
+ <section
id="sect-Reference_Guide-Global_Portlet_Data-Global_Metadata_Elements">
+ <title>Global Metadata Elements</title>
+ <para>
+ The global <filename>portlet.xml</filename> file conforms, with
some restrictions, to the portlet deployment descriptor schema defined in the Portlet
Specification. In this file, the following 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="sect-Reference_Guide-Global_Metadata_Elements-Global_Portlet-Portlet_Filter">
+ <title>Portlet Filter</title>
+ <para>
+ Portlet filter mappings declared in the global
<filename>portlet.xml</filename> file are applied across portlet
applications.
+ </para>
+ <para>
+ With the XML configuration below, the filter
<literal>ApplicationMonitoringFilter</literal> involves in request handling on
any deployed portlet.
+ </para>
+<programlisting role="XML"
language="XML"><![CDATA[<filter>
+<filter-name>org.exoplatform.portal.application.ApplicationMonitoringFilter</filter-name>
+<filter-class>org.exoplatform.portal.application.ApplicationMonitoringFilter</filter-class>
+ <lifecycle>ACTION_PHASE</lifecycle>
+ <lifecycle>RENDER_PHASE</lifecycle>
+ <lifecycle>EVENT_PHASE</lifecycle>
+ <lifecycle>RESOURCE_PHASE</lifecycle>
+</filter>
+]]></programlisting>
+ <para>
+ <emphasis role="bold">Application Monitoring
Filter</emphasis> supports four lifecycle phases in the order below:
+ </para>
+ <orderedlist>
+ <listitem>
+ <para>
+ ACTION_PHASE
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ EVENT_PHASE
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ RENDER_PHASE
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ RESOURCE_PHASE
+ </para>
+ </listitem>
+ </orderedlist>
+ <para>
+ It also records statistic information on deployed portlets. The filter
alternates the actual monitoring mechanism in WebUI Framework.
+ </para>
+ </section>
+ </section>
+ </section>
+</chapter>
Modified: epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortletDevelopment.xml
===================================================================
--- epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortletDevelopment.xml 2011-09-13
00:35:38 UTC (rev 7365)
+++ epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortletDevelopment.xml 2011-09-13
03:41:42 UTC (rev 7366)
@@ -4,7 +4,8 @@
%BOOK_ENTITIES;
]>
<part id="part-Reference_Guide-Portlet_development">
- <title>Portlet development</title>
- <xi:include href="PortletDevelopment/Standard.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="PortletDevelopment/PortletBridge.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <title>Portlet development</title>
+ <xi:include href="PortletDevelopment/Standard.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="PortletDevelopment/Global_Portlet.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="PortletDevelopment/PortletBridge.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
</part>
Modified: epp/docs/branches/5.2/Reference_Guide/publican.cfg
===================================================================
--- epp/docs/branches/5.2/Reference_Guide/publican.cfg 2011-09-13 00:35:38 UTC (rev 7365)
+++ epp/docs/branches/5.2/Reference_Guide/publican.cfg 2011-09-13 03:41:42 UTC (rev 7366)
@@ -8,4 +8,4 @@
#show_remarks: 1
cvs_branch: DOCS-RHEL-6
cvs_root: :ext:cvs.devel.redhat.com:/cvs/dist
-cvs_pkg: JBoss_Enterprise_Portal_Platform-Reference_Guide-5.1-web-__LANG__
\ No newline at end of file
+cvs_pkg: JBoss_Enterprise_Portal_Platform-Reference_Guide-5.2-web-__LANG__
\ No newline at end of file