9:29 p.m.
Author: smumford
Date: 2011-11-09 22:29:26 -0500 (Wed, 09 Nov 2011)
New Revision: 8019
Removed:
epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/Advanced/Foundations/JNDI_Naming.xml
epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/Advanced/eXoJCR/kernel.xml
epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/Advanced/eXoJCR/kernel/
Modified:
epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/Advanced/Foundations.xml
epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/Advanced/eXoJCR.xml
epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/PortletDevelopment/Global_Portlet.xml
Log:
Removed eXoJCR/kernel/ as content moved to Foundations/. Removed JNDI_Naming.xml as per
advice from theute
Deleted:
epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/Advanced/Foundations/JNDI_Naming.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/Advanced/Foundations/JNDI_Naming.xml 2011-11-10
02:39:06 UTC (rev 8018)
+++
epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/Advanced/Foundations/JNDI_Naming.xml 2011-11-10
03:29:26 UTC (rev 8019)
@@ -1,290 +0,0 @@
-<?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_eXo_JCR_1.14.ent">
-%BOOK_ENTITIES;
-]>
-<section id="sect-Reference_Guide_eXo_JCR_1.14-JNDI_naming">
- <title>JNDI naming</title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-JNDI_naming-Prerequisites">
- <title>Prerequisites</title>
- <para>
- We need to configure JNDI environment properties and Reference binding with the eXo
container standard mechanism.
- </para>
- <para>
- The Naming service covers:
- </para>
- <para>
- <itemizedlist>
- <listitem>
- <para>
- Configuring the current Naming Context Factory implemented as an ExoContainer
Component
<envar>org.exoplatform.services.naming.InitialContextInitializer</envar>.
- </para>
-
- </listitem>
- <listitem>
- <para>
- Binding Objects (References) to the current Context using
<envar>org.exoplatform.services.naming.BindReferencePlugin</envar> component
plugin.
- </para>
-
- </listitem>
-
- </itemizedlist>
-
- </para>
-
- </section>
-
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-JNDI_naming-How_it_works">
- <title>How it works</title>
- <para>
- Make sure you understand the <ulink
url="http://java.sun.com/products/jndi/1.2/javadoc/index.html"&... Naming
and Directory InterfaceTM (JNDI)</ulink> concepts before using this service.
- </para>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-How_it_works-JNDI_System_property_initialization">
- <title>JNDI System property initialization</title>
- <para>
- After the start time the Context Initializer
(org.exoplatform.services.naming.InitialContextInitializer) traverses all initial
parameters (that concern the Naming Context) configured in
<envar>default-properties</envar> and
<envar>mandatory-properties</envar> (see Configuration examples) and:
- </para>
- <itemizedlist>
- <listitem>
- <para>
- For <envar>default-properties</envar>: Check if this property is
already set as a System property (<envar>System.getProperty(name)</envar>) and
set this property if it's not found. Using those properties is recommended with a
third party Naming service provider.
- </para>
-
- </listitem>
- <listitem>
- <para>
- For <envar>mandatory-properties</envar>: Set the property without
checking.
- </para>
-
- </listitem>
-
- </itemizedlist>
- <para>
- Standard JNDI properties:
- </para>
- <itemizedlist>
- <listitem>
- <para>
- <envar>java.naming.factory.initial</envar>
- </para>
-
- </listitem>
- <listitem>
- <para>
- <envar>java.naming.provider.url</envar>
- </para>
-
- </listitem>
-
- </itemizedlist>
- <para>
- and others (see JNDI docs)
- </para>
-
- </section>
-
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-How_it_works-JNDI_reference_binding">
- <title>JNDI reference binding</title>
- <para>
- Another responsibility of Context Initializer
<envar>org.exoplatform.services.naming.InitialContextInitializer</envar> is
binding of preconfigured references to the naming context. For this purpose, it uses a
standard eXo component plugin mechanism and in particular the
<envar>org.exoplatform.services.naming.BindReferencePlugin</envar> component
plugin. The configuration of this plugin includes three mandatory value parameters:
- </para>
- <itemizedlist>
- <listitem>
- <para>
- <envar>bind-name</envar>: the name of binding reference.
- </para>
-
- </listitem>
- <listitem>
- <para>
- <envar>class-name</envar>: the type of binding reference.
- </para>
-
- </listitem>
- <listitem>
- <para>
- <envar>factory</envar>: the object factory type.
- </para>
-
- </listitem>
-
- </itemizedlist>
- <para>
- And also <envar>ref-addresses</envar> property parameter with a set of
references' properties. (see Configuration examples) Context Initializer uses those
parameters to bind the necessary reference automatically.
- </para>
-
- </section>
-
-
- </section>
-
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-JNDI_naming-Configuration_examples">
- <title>Configuration examples</title>
- <para>
- The <envar>InitialContextInitializer</envar> configuration example:
- </para>
-
-<programlisting language="XML" role="XML">
<component>
-
<type>org.exoplatform.services.naming.InitialContextInitializer</type>
- <init-params>
- <value-param>.
- <name>bindings-store-path</name>.
- <value>bind-references.xml</value>.
- </value-param>.
- <value-param>
- <name>overload-context-factory</name>
- <value>true</value>
- </value-param>
- <properties-param>
- <name>default-properties</name>
- <description>Default initial context
properties</description>
- <property name="java.naming.factory.initial"
value="org.exoplatform.services.naming.SimpleContextFactory"/>
- </properties-param>
- <properties-param>
- <name>mandatory-properties</name>
- <description>Mandatory initial context
properties</description>
- <property name="java.naming.provider.url"
value="rmi://localhost:9999"/>
- </properties-param>
- </init-params>
- </component></programlisting>
- <para>
- where
- </para>
- <para>
- <emphasis role="bold">binding-store-path</emphasis> is file path
which stores binded datasources in runtime
- </para>
- <para>
- <emphasis role="bold">overload-context-factory</emphasis> allows
to overload the default initial context factory by a context factory that is ExoContainer
aware and that is able to delegate to the original initial context factory if it detects
that it is not in the eXo scope. By default the feature is disabled since it is only
required on AS that don't share the objects by default like tomcat but unlike JBoss
AS
- </para>
- <para>
- The <envar>BindReferencePlugin</envar> component plugin configuration
example (for JDBC datasource):
- </para>
-
-<programlisting language="XML" role="XML">
<component-plugins>
- <component-plugin>
- <name>bind.datasource</name>
- <set-method>addPlugin</set-method>
-
<type>org.exoplatform.services.naming.BindReferencePlugin</type>
- <init-params>
- <value-param>
- <name>bind-name</name>
- <value>jdbcjcr</value>
- </value-param>
- <value-param>
- <name>class-name</name>
- <value>javax.sql.DataSource</value>
- </value-param>
- <value-param>
- <name>factory</name>
-
<value>org.apache.commons.dbcp.BasicDataSourceFactory</value>
- </value-param>
- <properties-param>
- <name>ref-addresses</name>
- <description>ref-addresses</description>
- <property name="driverClassName"
value="org.hsqldb.jdbcDriver"/>
- <property name="url"
value="jdbc:hsqldb:file:target/temp/data/portal"/>
- <property name="username" value="sa"/>
- <property name="password" value=""/>
- </properties-param>
- </init-params>
- </component-plugin></programlisting>
-
- </section>
-
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-JNDI_naming-Recommendations_for_Application_Developers">
- <title>Recommendations for Application Developers</title>
- <para>
- <itemizedlist>
- <listitem>
- <para>
- <envar>SimpleContextFactory</envar> is created for testing purposes
only, do not use it for production.
- </para>
-
- </listitem>
- <listitem>
- <para>
- In J2EE environment use Naming Factory objects provided with the Application
Server.
- </para>
-
- </listitem>
-
- </itemizedlist>
-
- </para>
-
- </section>
-
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-JNDI_naming-InitialContextInitializer_API">
- <title>InitialContextInitializer API</title>
- <para>
- <envar>InitialContextInitalizer</envar> also provides feature of
references binding in runtime. References have bind in runtime will be persisted and
automatically rebinded on a next system start.
- </para>
- <para>
- Service provides methods for binding reference.
- </para>
-
-<programlisting language="Java" role="Java">
- public void bind(String bindName,
- String className,
- String factory,
- String factoryLocation,
- Map<String, String> refAddr)
- throws NamingException, FileNotFoundException,
XMLStreamException;</programlisting>
- <itemizedlist>
- <listitem>
- <para>
- <envar>bindName</envar>: name of binding.
- </para>
-
- </listitem>
- <listitem>
- <para>
- <envar>className</envar>: the fully-qualified name of the class of the
object to which this Reference refers.
- </para>
-
- </listitem>
- <listitem>
- <para>
- <envar>factory</envar>: the name of the factory class for creating an
instance of the object to which this Reference refers.
- </para>
-
- </listitem>
- <listitem>
- <para>
- <envar>factoryLocation</envar>: the location of the factory class.
- </para>
-
- </listitem>
- <listitem>
- <para>
- <envar>refAddr</envar>: object's properties map.
- </para>
-
- </listitem>
-
- </itemizedlist>
- <para>
- Example of usage:
- </para>
-
-<programlisting language="Java" role="Java">
- // obtain InitialContextInitializer instance from ExoContainer (e.g.
PortalContainer)
- InitialContextInitializer initContext =
(InitialContextInitializer)container.getComponentInstanceOfType(InitialContextInitializer.class);
-
- Map<String, String> refAddr = new HashMap<String,
String>();
- refAddr.put("driverClassName", "oracle.jdbc.OracleDriver");
- refAddr.put("url", "jdbc:oracle:thin:@oraclehost:1521:orcl");
- refAddr.put("username", "exouser");
- refAddr.put("password", "exopassword");
-
- initContext.bind("jdbcexco", "javax.sql.DataSource",
"org.apache.commons.dbcp.BasicDataSourceFactory", null, refAddr);
-
- // try to get just bound DataSource
- DataSource ds = (DataSource)new
InitialContext().lookup("jdbcexo");</programlisting>
-
- </section>
-
-
-</section>
-
-
Modified:
epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/Advanced/Foundations.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/Advanced/Foundations.xml 2011-11-10
02:39:06 UTC (rev 8018)
+++
epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/Advanced/Foundations.xml 2011-11-10
03:29:26 UTC (rev 8019)
@@ -4,20 +4,18 @@
%BOOK_ENTITIES;
]>
<chapter id="chap-Reference_Guide_eXo_JCR_1.14-Foundations_">
- <!-- This document was created with Syntext Serna Free. -->
<title><remark>Foundations</remark>
- </title>
- <xi:include href="Foundations/Kernel.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="Foundations/JNDI_Naming.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="Foundations/Config_Retrieval.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="Foundations/Advanced_Concepts.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="Foundations/Profiles.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="Foundations/Requests.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="Foundations/Configuring_Services.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="Foundations/Specific_Services.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="Foundations/Configuring_Containers.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="Foundations/System_Properties.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="Foundations/Extensions_And_Multiple_Portals.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="Foundations/Management.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <title><remark>Foundations</remark></title>
+ <xi:include href="Foundations/Kernel.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="Foundations/Config_Retrieval.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="Foundations/Advanced_Concepts.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="Foundations/Profiles.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="Foundations/Requests.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="Foundations/Configuring_Services.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="Foundations/Specific_Services.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="Foundations/Configuring_Containers.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="Foundations/System_Properties.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="Foundations/Extensions_And_Multiple_Portals.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="Foundations/Management.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
</chapter>
Deleted:
epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/Advanced/eXoJCR/kernel.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/Advanced/eXoJCR/kernel.xml 2011-11-10
02:39:06 UTC (rev 8018)
+++
epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/Advanced/eXoJCR/kernel.xml 2011-11-10
03:29:26 UTC (rev 8019)
@@ -1,29 +0,0 @@
-<?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_eXo_JCR_1.14.ent">
-%BOOK_ENTITIES;
-]>
-<section id="sect-Reference_Guide_eXo_JCR_1.14-eXoKernel">
- <title>eXoKernel</title>
- <xi:include href="kernel/kernel.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="kernel/exo-container.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="kernel/service-configuration-for-beginners.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="kernel/service-configuration-in-detail.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="kernel/container-configuration.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="kernel/inversion-of-control.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="kernel/services-wiring.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="kernel/component-plugin-priority.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="kernel/understanding-listnerservice.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="kernel/initialcontext-binder-service.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="kernel/job-scheduler-service.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="kernel/cache.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="kernel/transaction-service.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="kernel/data-source-provider.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="kernel/jndi-naming.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="kernel/logging.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="kernel/manageability.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="kernel/listener-service.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="kernel/rpc-service.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
-</section>
-
-
Modified:
epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/Advanced/eXoJCR.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/Advanced/eXoJCR.xml 2011-11-10
02:39:06 UTC (rev 8018)
+++
epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/Advanced/eXoJCR.xml 2011-11-10
03:29:26 UTC (rev 8019)
@@ -7,8 +7,6 @@
<title><remark>eXo JCR</remark>
</title>
<xi:include href="eXoJCR/jcr.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
- <!--DOC NOTE, Kernel content ported to Advanced.xml/Advanced/*.xml
- <xi:include href="eXoJCR/kernel.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" /> -->
<xi:include href="eXoJCR/core.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="eXoJCR/ws.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="eXoJCR/jcr-with-gatein.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
Modified:
epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/PortletDevelopment/Global_Portlet.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/PortletDevelopment/Global_Portlet.xml 2011-11-10
02:39:06 UTC (rev 8018)
+++
epp/docs/branches/5.2/Reference_Guide-eXoJCR-1.14/en-US/modules/PortletDevelopment/Global_Portlet.xml 2011-11-10
03:29:26 UTC (rev 8019)
@@ -3,103 +3,97 @@
<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent">
%BOOK_ENTITIES;
]>
-<chapter id="chap-Reference_Guide_eXo_JCR_1.14-Global_Portlet_Data">
- <title><remark>Global Portlet Data</remark>
- </title>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-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>
+<chapter id="chap-Reference_Guide_eXo_JCR_1.14-Shared_portlet.xml">
+ <title><remark>Shared
<filename>portlet.xml</filename></remark></title>
- </step>
- <step>
- <para>
- Define the filter in portlet application deployment descriptor.
- </para>
+ <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 mapping in portlet definitions.
- </para>
+ </step>
+ <step>
+ <para>
+ Define the filter in portlet application deployment descriptor.
+ </para>
- </step>
+ </step>
+ <step>
+ <para>
+ Define the filter mapping in portlet definitions.
+ </para>
- </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>
+ </step>
- </section>
-
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-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>
-
+ </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>
+
+ <para>
+ Global portlet metadata is declared in the
<filename>portlet.xml</filename> file and conforms with the Portlet 2.0 XSD.
+ </para>
+
<programlisting language="XML" role="XML"><portlet-app
version="1.0"
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...
http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd">
-
</portlet-app>
-</programlisting>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Global_Metadata-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>
+</programlisting>
- </section>
-
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Global_Metadata-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>
+ <section
id="sect-Reference_Guide_eXo_JCR_1.14-Global_Metadata-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. By default The file
path is
<filename>/<replaceable><JBOSS_HOME></replaceable>/server/<replaceable><PROFILE></replaceable>/conf/gatein/portlet.xml</filename>
+ </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>
- </listitem>
- <listitem>
- <para>
- Portlet Mode
- </para>
+ </section>
+
+ <section
id="sect-Reference_Guide_eXo_JCR_1.14-Global_Metadata-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>
- Window State
- </para>
+ </listitem>
+ <listitem>
+ <para>
+ Portlet Mode
+ </para>
- </listitem>
+ </listitem>
+ <listitem>
+ <para>
+ Window State
+ </para>
- </orderedlist>
- <section
id="sect-Reference_Guide_eXo_JCR_1.14-Global_Metadata_Elements-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>
-
+ </listitem>
+
+ </orderedlist>
+ <section
id="sect-Reference_Guide_eXo_JCR_1.14-Global_Metadata_Elements-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 language="XML"
role="XML"><filter>
<filter-name>org.exoplatform.portal.application.ApplicationMonitoringFilter</filter-name>
<filter-class>org.exoplatform.portal.application.ApplicationMonitoringFilter</filter-class>
@@ -109,48 +103,48 @@
<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>
+ <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>
+ EVENT_PHASE
+ </para>
- </listitem>
- <listitem>
- <para>
- RENDER_PHASE
- </para>
+ </listitem>
+ <listitem>
+ <para>
+ RENDER_PHASE
+ </para>
- </listitem>
- <listitem>
- <para>
- RESOURCE_PHASE
- </para>
+ </listitem>
+ <listitem>
+ <para>
+ RESOURCE_PHASE
+ </para>
- </listitem>
+ </listitem>
- </orderedlist>
- <para>
- It also records statistic information on deployed portlets. The filter alternates
the actual monitoring mechanism in WebUI Framework.
- </para>
+ </orderedlist>
+ <para>
+ The Application Monitoring Filter records statistic information about
deployed portlets. The filter alternates the actual monitoring mechanism in WebUI
Framework.
+ </para>
- </section>
-
+ </section>
+
- </section>
-
+ </section>
+
- </section>
-
+ </section>
+
</chapter>