[gatein-commits] gatein SVN: r8778 - in epp/docs/branches/5.2/Reference_Guide/en-US: code_samples and 3 other directories.
do-not-reply at jboss.org
do-not-reply at jboss.org
Sun Jul 8 20:39:40 EDT 2012
Author: jaredmorgs
Date: 2012-07-08 20:39:39 -0400 (Sun, 08 Jul 2012)
New Revision: 8778
Added:
epp/docs/branches/5.2/Reference_Guide/en-US/extras/Advanced_Development_JCR_Configuration/jcr-configuration.xml_code
Removed:
epp/docs/branches/5.2/Reference_Guide/en-US/code_samples/jcr-configuration.xml_code
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/Book_Info.xml
epp/docs/branches/5.2/Reference_Guide/en-US/Reference_Guide.ent
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortletDevelopment/Standard.xml
epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/configuration/exo-jcr-configuration.xml
Log:
BZ#812412 cumulative commit
Modified: epp/docs/branches/5.2/Reference_Guide/en-US/Book_Info.xml
===================================================================
--- epp/docs/branches/5.2/Reference_Guide/en-US/Book_Info.xml 2012-07-06 10:59:53 UTC (rev 8777)
+++ epp/docs/branches/5.2/Reference_Guide/en-US/Book_Info.xml 2012-07-09 00:39:39 UTC (rev 8778)
@@ -5,7 +5,7 @@
]>
<bookinfo id="book-Reference_Guide-Reference_Guide">
<title>Reference Guide</title>
- <subtitle>An in-depth guide to Enterprise Portal Platform 5.2, and its patch releases.</subtitle>
+ <subtitle>An in-depth guide to Enterprise Portal Platform 5.2, and its patch releases.f</subtitle>
<productname>JBoss Enterprise Portal Platform</productname>
<productnumber>5.2</productnumber>
<edition>5.2.2</edition>
Modified: epp/docs/branches/5.2/Reference_Guide/en-US/Reference_Guide.ent
===================================================================
--- epp/docs/branches/5.2/Reference_Guide/en-US/Reference_Guide.ent 2012-07-06 10:59:53 UTC (rev 8777)
+++ epp/docs/branches/5.2/Reference_Guide/en-US/Reference_Guide.ent 2012-07-09 00:39:39 UTC (rev 8778)
@@ -10,11 +10,11 @@
<!ENTITY BZURL "<ulink url='https://bugzilla.redhat.com/enter_bug.cgi?product=JBoss%20Enterprise%20Portal%20Platform%205&component=docs-Reference_Guide&version=5.2'>http://bugzilla.redhat.com/</ulink>">
<!-- Corporate Specifics: -->
-<!ENTITY YEAR "2011">
+<!ENTITY YEAR "2012">
<!ENTITY HOLDER "Red Hat, Inc">
<!-- Version Specifcs: -->
<!ENTITY VX "5">
<!ENTITY VY "5.2">
-<!ENTITY VZ "5.2.0">
-<!ENTITY WSRP_VERSION "2.1.0-GA">
\ No newline at end of file
+<!ENTITY VZ "5.2.2">
+<!ENTITY WSRP_VERSION "2.1.0-GA">
Deleted: epp/docs/branches/5.2/Reference_Guide/en-US/code_samples/jcr-configuration.xml_code
===================================================================
--- epp/docs/branches/5.2/Reference_Guide/en-US/code_samples/jcr-configuration.xml_code 2012-07-06 10:59:53 UTC (rev 8777)
+++ epp/docs/branches/5.2/Reference_Guide/en-US/code_samples/jcr-configuration.xml_code 2012-07-09 00:39:39 UTC (rev 8778)
@@ -1,83 +0,0 @@
- <component>
- <key>org.exoplatform.services.jcr.RepositoryService</key>
- <type>org.exoplatform.services.jcr.impl.RepositoryServiceImpl</type>
- <component-plugins>
- <component-plugin>
- <name>add.namespaces</name>
- <set-method>addPlugin</set-method>
- <type>org.exoplatform.services.jcr.impl.AddNamespacesPlugin</type>
- <init-params>
- <properties-param>
- <name>namespaces</name>
- <property name="test" value="http://www.apache.org/jackrabbit/test"/>
- <property name="exojcrtest" value="http://www.exoplatform.org/jcr/test/1.0"/>
- <property name="rma" value="http://www.rma.com/jcr/"/>
- <property name="metadata" value="http://www.exoplatform.com/jcr/metadata/1.1/"/>
- <property name="dc" value="http://purl.org/dc/elements/1.1/"/>
- <property name="publication" value="http://www.exoplatform.com/jcr/publication/1.1/"/>
- </properties-param>
- </init-params>
- </component-plugin>
- <component-plugin>
- <name>add.nodeType</name>
- <set-method>addPlugin</set-method>
- <type>org.exoplatform.services.jcr.impl.AddNodeTypePlugin</type>
- <init-params>
- <values-param>
- <name>autoCreatedInNewRepository</name>
- <description>Node types configuration file</description>
- <value>jar:/conf/test/nodetypes-tck.xml</value>
- <value>jar:/conf/test/nodetypes-impl.xml</value>
- <value>jar:/conf/test/nodetypes-usecase.xml</value>
- <value>jar:/conf/test/nodetypes-config.xml</value>
- <value>jar:/conf/test/nodetypes-config-extended.xml</value>
- <value>jar:/conf/test/wcm-nodetypes.xml</value>
- <value>jar:/conf/test/nodetypes-publication-config.xml</value>
- <value>jar:/conf/test/publication-plugins-nodetypes-config.xml</value>
- </values-param>
-
- <values-param>
- <name>testInitNodeTypesRepository</name>
- <description>
- Node types configuration file for repository with name testInitNodeTypesRepository
- </description>
- <value>jar:/conf/test/nodetypes-test.xml</value>
- </values-param>
-
- <values-param>
- <name>testInitNodeTypesRepositoryTest2</name>
- <description>
- Node types configuration file for repository with name testInitNodeTypesRepositoryTest2
- </description>
- <value>jar:/conf/test/nodetypes-test2.xml</value>
- </values-param>
-
- <!--values-param>
- <name>testInitNodeTypesRepositoryTest3</name>
- <description>Node types from ext. Needed bacause core starup earlie than ext</description>
- <value>jar:/conf/test/nodetypes-test3_ext.xml</value>
- </values-param-->
-
- </init-params>
- </component-plugin>
- </component-plugins>
- </component>
-
- <component>
- <key>org.exoplatform.services.jcr.config.RepositoryServiceConfiguration</key>
- <type>org.exoplatform.services.jcr.impl.config.RepositoryServiceConfigurationImpl</type>
- <init-params>
- <value-param>
- <name>conf-path</name>
- <description>JCR configuration file</description>
- <value>jar:/conf/standalone/test-jcr-config-jbc.xml</value>
- </value-param>
- <properties-param>
- <name>working-conf</name>
- <description>working-conf</description>
- <property name="dialect" value="auto" />
- <property name="source-name" value="jdbcjcr"/>
- <property name="persister-class-name" value="org.exoplatform.services.jcr.impl.config.JDBCConfigurationPersister"/>
- </properties-param>
- </init-params>
- </component>
Copied: epp/docs/branches/5.2/Reference_Guide/en-US/extras/Advanced_Development_JCR_Configuration/jcr-configuration.xml_code (from rev 8776, epp/docs/branches/5.2/Reference_Guide/en-US/code_samples/jcr-configuration.xml_code)
===================================================================
--- epp/docs/branches/5.2/Reference_Guide/en-US/extras/Advanced_Development_JCR_Configuration/jcr-configuration.xml_code (rev 0)
+++ epp/docs/branches/5.2/Reference_Guide/en-US/extras/Advanced_Development_JCR_Configuration/jcr-configuration.xml_code 2012-07-09 00:39:39 UTC (rev 8778)
@@ -0,0 +1,83 @@
+ <component>
+ <key>org.exoplatform.services.jcr.RepositoryService</key>
+ <type>org.exoplatform.services.jcr.impl.RepositoryServiceImpl</type>
+ <component-plugins>
+ <component-plugin>
+ <name>add.namespaces</name>
+ <set-method>addPlugin</set-method>
+ <type>org.exoplatform.services.jcr.impl.AddNamespacesPlugin</type>
+ <init-params>
+ <properties-param>
+ <name>namespaces</name>
+ <property name="test" value="http://www.apache.org/jackrabbit/test"/>
+ <property name="exojcrtest" value="http://www.exoplatform.org/jcr/test/1.0"/>
+ <property name="rma" value="http://www.rma.com/jcr/"/>
+ <property name="metadata" value="http://www.exoplatform.com/jcr/metadata/1.1/"/>
+ <property name="dc" value="http://purl.org/dc/elements/1.1/"/>
+ <property name="publication" value="http://www.exoplatform.com/jcr/publication/1.1/"/>
+ </properties-param>
+ </init-params>
+ </component-plugin>
+ <component-plugin>
+ <name>add.nodeType</name>
+ <set-method>addPlugin</set-method>
+ <type>org.exoplatform.services.jcr.impl.AddNodeTypePlugin</type>
+ <init-params>
+ <values-param>
+ <name>autoCreatedInNewRepository</name>
+ <description>Node types configuration file</description>
+ <value>jar:/conf/test/nodetypes-tck.xml</value>
+ <value>jar:/conf/test/nodetypes-impl.xml</value>
+ <value>jar:/conf/test/nodetypes-usecase.xml</value>
+ <value>jar:/conf/test/nodetypes-config.xml</value>
+ <value>jar:/conf/test/nodetypes-config-extended.xml</value>
+ <value>jar:/conf/test/wcm-nodetypes.xml</value>
+ <value>jar:/conf/test/nodetypes-publication-config.xml</value>
+ <value>jar:/conf/test/publication-plugins-nodetypes-config.xml</value>
+ </values-param>
+
+ <values-param>
+ <name>testInitNodeTypesRepository</name>
+ <description>
+ Node types configuration file for repository with name testInitNodeTypesRepository
+ </description>
+ <value>jar:/conf/test/nodetypes-test.xml</value>
+ </values-param>
+
+ <values-param>
+ <name>testInitNodeTypesRepositoryTest2</name>
+ <description>
+ Node types configuration file for repository with name testInitNodeTypesRepositoryTest2
+ </description>
+ <value>jar:/conf/test/nodetypes-test2.xml</value>
+ </values-param>
+
+ <!--values-param>
+ <name>testInitNodeTypesRepositoryTest3</name>
+ <description>Node types from ext. Needed bacause core starup earlie than ext</description>
+ <value>jar:/conf/test/nodetypes-test3_ext.xml</value>
+ </values-param-->
+
+ </init-params>
+ </component-plugin>
+ </component-plugins>
+ </component>
+
+ <component>
+ <key>org.exoplatform.services.jcr.config.RepositoryServiceConfiguration</key>
+ <type>org.exoplatform.services.jcr.impl.config.RepositoryServiceConfigurationImpl</type>
+ <init-params>
+ <value-param>
+ <name>conf-path</name>
+ <description>JCR configuration file</description>
+ <value>jar:/conf/standalone/test-jcr-config-jbc.xml</value>
+ </value-param>
+ <properties-param>
+ <name>working-conf</name>
+ <description>working-conf</description>
+ <property name="dialect" value="auto" />
+ <property name="source-name" value="jdbcjcr"/>
+ <property name="persister-class-name" value="org.exoplatform.services.jcr.impl.config.JDBCConfigurationPersister"/>
+ </properties-param>
+ </init-params>
+ </component>
Modified: epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortletDevelopment/Standard.xml
===================================================================
--- epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortletDevelopment/Standard.xml 2012-07-06 10:59:53 UTC (rev 8777)
+++ epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortletDevelopment/Standard.xml 2012-07-09 00:39:39 UTC (rev 8778)
@@ -1,748 +1,588 @@
-<?xml version='1.0' encoding='utf-8' ?>
+<?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">
%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">
- <title>JSR-168 and JSR-286 overview</title>
- <para>
+ <title>Portlet Primer</title>
+ <section id="sect-Reference_Guide-Portlet_Primer-JSR_168_and_JSR_286_overview">
+ <title>JSR-168 and JSR-286 overview</title>
+ <para>
The Java Community Process (<literal>JCP</literal>) uses Java Specification Requests (<literal>JSR</literal>s) to define proposed specifications and technologies designed for the Java platform.
</para>
- <para>
+ <para>
The Portlet Specifications aim at defining portlets that can be used by any <ulink url="http://www.jcp.org/en/jsr/detail?id=168">JSR-168 (Portlet 1.0)</ulink> or <ulink url="http://www.jcp.org/en/jsr/detail?id=286">JSR-286 (Portlet 2.0)</ulink> portlet container.
</para>
- <para>
+ <para>
Most Java EE (Enterprise Edition) portals include at least one compliant portlet container, and JBoss Enterprise Portal Platform is no exception. In fact, JBoss Enterprise Portal Platform includes a container that supports both versions.
</para>
- <para>
+ <para>
This chapter gives a brief overview of the Portlet Specifications but portlet developers are strongly encouraged to read the <ulink url="http://www.jcp.org/en/jsr/detail?id=286">JSR-286 Portlet Specification</ulink> .
</para>
- <para>
+ <para>
JBoss Enterprise Portal Platform is fully JSR-286 compliant. Any JSR-168 or JSR-286 portlet operates as it is mandated by the respective specifications inside the portal.
</para>
- <section id="sect-Reference_Guide-JSR_168_and_JSR_286_overview-Portal_Pages">
- <title>Portal Pages</title>
- <para>
+ <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 a <emphasis>portlet</emphasis>:
</para>
- <para>
+ <para>
The diagram below visually represents this nesting:
</para>
- <mediaobject>
- <imageobject role="html">
- <imagedata align="center" fileref="images/PortletDevelopment/Standard/SpecPortalDef.png" format="PNG" scale="95" width="444" />
- </imageobject>
- <imageobject role="fo">
- <imagedata align="center" contentwidth="140mm" fileref="images/PortletDevelopment/Standard/SpecPortalDef.png" format="PNG" width="444" />
- </imageobject>
-
- </mediaobject>
-
- </section>
-
- <section id="sect-Reference_Guide-JSR_168_and_JSR_286_overview-Rendering_Modes">
- <title>Rendering Modes</title>
- <para>
+ <mediaobject>
+ <imageobject role="html">
+ <imagedata width="444" align="center" scale="95" fileref="images/PortletDevelopment/Standard/SpecPortalDef.png" format="PNG"/>
+ </imageobject>
+ <imageobject role="fo">
+ <imagedata width="444" contentwidth="140mm" align="center" fileref="images/PortletDevelopment/Standard/SpecPortalDef.png" format="PNG"/>
+ </imageobject>
+ </mediaobject>
+ </section>
+ <section id="sect-Reference_Guide-JSR_168_and_JSR_286_overview-Rendering_Modes">
+ <title>Rendering Modes</title>
+ <para>
A portlet can have different view modes. Three modes are defined by the JSR-286 specification:
</para>
- <variablelist>
- <varlistentry>
- <term>View</term>
- <listitem>
- <para>
+ <variablelist>
+ <varlistentry>
+ <term>View</term>
+ <listitem>
+ <para>
Generates markup reflecting the current state of the portlet.
</para>
-
- </listitem>
-
- </varlistentry>
- <varlistentry>
- <term>Edit</term>
- <listitem>
- <para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Edit</term>
+ <listitem>
+ <para>
Allows a user to customize the behavior of the portlet.
</para>
-
- </listitem>
-
- </varlistentry>
- <varlistentry>
- <term>Help</term>
- <listitem>
- <para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Help</term>
+ <listitem>
+ <para>
Provides information to the user as to how to use the portlet.
</para>
-
- </listitem>
-
- </varlistentry>
-
- </variablelist>
-
- </section>
-
- <section id="sect-Reference_Guide-JSR_168_and_JSR_286_overview-Window_States">
- <title>Window States</title>
- <para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </section>
+ <section id="sect-Reference_Guide-JSR_168_and_JSR_286_overview-Window_States">
+ <title>Window States</title>
+ <para>
Window states are an indicator of how much page space a portlet consumes on any given page. The three states defined by the JSR-286 specification are:
</para>
- <variablelist>
- <varlistentry>
- <term>Normal</term>
- <listitem>
- <para>
+ <variablelist>
+ <varlistentry>
+ <term>Normal</term>
+ <listitem>
+ <para>
A portlet shares this page with other portlets.
</para>
-
- </listitem>
-
- </varlistentry>
- <varlistentry>
- <term>Minimized</term>
- <listitem>
- <para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Minimized</term>
+ <listitem>
+ <para>
A portlet may show very little information, or none at all.
</para>
-
- </listitem>
-
- </varlistentry>
- <varlistentry>
- <term>Maximized</term>
- <listitem>
- <para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Maximized</term>
+ <listitem>
+ <para>
A portlet may be the only portlet displayed on this page.
</para>
-
- </listitem>
-
- </varlistentry>
-
- </variablelist>
-
- </section>
-
-
+ </listitem>
+ </varlistentry>
+ </variablelist>
</section>
-
- <section id="sect-Reference_Guide-Portlet_Primer-Tutorials">
- <title>Tutorials</title>
- <para>
+ </section>
+ <section id="sect-Reference_Guide-Portlet_Primer-Tutorials">
+ <title>Tutorials</title>
+ <para>
The tutorials contained in this chapter are targeted toward portlet developers. It is also recommended that developers read and understand the <ulink url="http://www.jcp.org/en/jsr/detail?id=286"> JSR-286 Portlet Specification </ulink> .
</para>
- <note>
- <title>Maven</title>
- <para>
+ <note>
+ <title>Maven</title>
+ <para>
This example is using Maven to compile and build the web archive. Maven versions can be downloaded from <ulink url="http://maven.apache.org/download.html">maven.apache.org</ulink>
</para>
-
- </note>
- <section id="sect-Reference_Guide-Tutorials-Deploying_your_first_Portlet">
- <title>Deploying your first portlet</title>
- <para>
+ </note>
+ <section id="sect-Reference_Guide-Tutorials-Deploying_your_first_Portlet">
+ <title>Deploying your first portlet</title>
+ <para>
This section describes how to deploy a portlet in JBoss Enterprise Portal Platform.
</para>
- <para>
- An example portlet called <filename>SimplestHelloWorld</filename> is available in the <filename>/jboss-epp-<VERSION>-src/portal/examples/portlets/</filename> directory of the JBoss Enterprise Portal Platform sources package or the <filename>jboss-epp-<VERSION>-docs/epp-doc/examples/portlets</filename> directory of the documentation package.
+ <para>
+ An example portlet called <filename>SimplestHelloWorld</filename> is available in the <filename>/jboss-epp-<VERSION>-src/portal/examples/portlets/</filename> directory of the JBoss Enterprise Portal Platform sources package.
</para>
- <section id="sect-Reference_Guide-Deploying_your_first_Portlet-Compiling">
- <title>Compiling</title>
- <para>
+ <section id="sect-Reference_Guide-Deploying_your_first_Portlet-Compiling">
+ <title>Compiling</title>
+ <para>
To compile and package the application:
</para>
- <procedure>
- <step>
- <para>
+ <procedure>
+ <step>
+ <para>
Navigate to the application directory and execute:
</para>
-
-<programlisting language="Java" role="Java"><xi:include href="../../extras/PortletDevelopment_Standard/default243.java" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting>
-
- </step>
- <step>
- <para>
+ <programlisting language="Java" role="Java"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/PortletDevelopment_Standard/default243.java" parse="text"/></programlisting>
+ </step>
+ <step>
+ <para>
If the example is successfully packaged, the result will be available in: <filename>gatein-simplest-helloworld-&VZ;.GA.war </filename>.
</para>
-
- </step>
- <step>
- <para>
+ </step>
+ <step>
+ <para>
Copy the package file into <literal>JBOSS_HOME/server/default/deploy</literal>.
</para>
-
- </step>
- <step>
- <para>
+ </step>
+ <step>
+ <para>
Start JBoss Application Server (if it is not already running).
</para>
-
- </step>
- <step>
- <para>
+ </step>
+ <step>
+ <para>
Add the new portlet to the Application Registry.
</para>
-
- </step>
- <step>
- <para>
+ </step>
+ <step>
+ <para>
Create a new portal page and add the portlet to it.
</para>
- <mediaobject>
- <imageobject role="html">
- <imagedata align="center" fileref="images/PortletDevelopment/Standard/first_portlet/deployed.png" format="PNG" scale="100" width="444" />
- </imageobject>
- <imageobject role="fo">
- <imagedata align="center" contentwidth="120mm" fileref="images/PortletDevelopment/Standard/first_portlet/deployed.png" format="PNG" width="444" />
- </imageobject>
-
- </mediaobject>
-
- </step>
-
- </procedure>
-
-
- </section>
-
- <section id="sect-Reference_Guide-Deploying_your_first_Portlet-Package_Structure">
- <title>Package Structure</title>
- <para>
+ <mediaobject>
+ <imageobject role="html">
+ <imagedata width="444" align="center" scale="100" fileref="images/PortletDevelopment/Standard/first_portlet/deployed.png" format="PNG"/>
+ </imageobject>
+ <imageobject role="fo">
+ <imagedata width="444" contentwidth="120mm" align="center" fileref="images/PortletDevelopment/Standard/first_portlet/deployed.png" format="PNG"/>
+ </imageobject>
+ </mediaobject>
+ </step>
+ </procedure>
+ </section>
+ <section id="sect-Reference_Guide-Deploying_your_first_Portlet-Package_Structure">
+ <title>Package Structure</title>
+ <para>
Like other Java EE applications, JBoss Enterprise Portal Platform 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>
+ <para>
The following is an example of the directory structure of the <filename>SimplestHelloWorld</filename> portlet:
</para>
- <programlistingco>
- <areaspec>
- <area coords="9" id="area-Reference_Guide-Deploying_your_first_Portlet-Package_Structure-javaclass" />
- <area coords="10" id="area-Reference_Guide-Deploying_your_first_Portlet-Package_Structure-portlet" />
- <area coords="11" id="area-Reference_Guide-Deploying_your_first_Portlet-Package_Structure-web" />
-
- </areaspec>
-
-<programlisting language="Java" role="Java"><xi:include href="../../extras/PortletDevelopment_Standard/default244.java" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting>
- <calloutlist>
- <callout arearefs="area-Reference_Guide-Deploying_your_first_Portlet-Package_Structure-javaclass">
- <para>
+ <programlistingco>
+ <areaspec>
+ <area coords="9" id="area-Reference_Guide-Deploying_your_first_Portlet-Package_Structure-javaclass"/>
+ <area coords="10" id="area-Reference_Guide-Deploying_your_first_Portlet-Package_Structure-portlet"/>
+ <area coords="11" id="area-Reference_Guide-Deploying_your_first_Portlet-Package_Structure-web"/>
+ </areaspec>
+ <programlisting language="Java" role="Java"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/PortletDevelopment_Standard/default244.java" parse="text"/></programlisting>
+ <calloutlist>
+ <callout arearefs="area-Reference_Guide-Deploying_your_first_Portlet-Package_Structure-javaclass">
+ <para>
The compiled Java class implementing <emphasis>javax.portlet.Portlet</emphasis> (through <emphasis>javax.portlet.GenericPortlet </emphasis> )
</para>
-
- </callout>
- <callout arearefs="area-Reference_Guide-Deploying_your_first_Portlet-Package_Structure-portlet">
- <para>
+ </callout>
+ <callout arearefs="area-Reference_Guide-Deploying_your_first_Portlet-Package_Structure-portlet">
+ <para>
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">
- <para>
+ </callout>
+ <callout arearefs="area-Reference_Guide-Deploying_your_first_Portlet-Package_Structure-web">
+ <para>
This is the mandatory descriptor for web applications.
</para>
-
- </callout>
-
- </calloutlist>
-
- </programlistingco>
-
-
- </section>
-
- <section id="sect-Reference_Guide-Deploying_your_first_Portlet-Portlet_Class">
- <title>Portlet Class</title>
- <para>
- Below is the Java source for an example portlet named <filename>simplesthelloworld/src/main/java/org/jboss/portal/portlet/samples</filename>:
+ </callout>
+ </calloutlist>
+ </programlistingco>
+ </section>
+ <section id="sect-Reference_Guide-Deploying_your_first_Portlet-Portlet_Class">
+ <title>Portlet Class</title>
+ <para>
+ Below is the Java source for an example portlet named <filename>SimplestHelloWorldPortlet</filename>:
</para>
- <programlistingco>
- <areaspec>
- <area coords="6 80" id="area-Reference_Guide-Deploying_your_first_Portlet-Portlet_Class-extends" />
- <area coords="12 80" id="area-Reference_Guide-Deploying_your_first_Portlet-Portlet_Class-doview" />
- <area coords="14 80" id="area-Reference_Guide-Deploying_your_first_Portlet-Portlet_Class-writer" />
- <area coords="15 80" id="area-Reference_Guide-Deploying_your_first_Portlet-Portlet_Class-write" />
- <area coords="16 80" id="area-Reference_Guide-Deploying_your_first_Portlet-Portlet_Class-close" />
-
- </areaspec>
-
-<programlisting language="Java" role="Java"><xi:include href="../../extras/PortletDevelopment_Standard/SimplestHelloWorldPortlet.java" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting>
- <calloutlist>
- <callout arearefs="area-Reference_Guide-Deploying_your_first_Portlet-Portlet_Class-extends">
- <para>
- All portlets must implement the <literal>javax.portlet.Portlet</literal> interface. The portlet API provides a convenient implementation of this interface.
+ <programlistingco>
+ <areaspec>
+ <area coords="6 80" id="area-Reference_Guide-Deploying_your_first_Portlet-Portlet_Class-extends"/>
+ <area coords="12 80" id="area-Reference_Guide-Deploying_your_first_Portlet-Portlet_Class-doview"/>
+ <area coords="14 80" id="area-Reference_Guide-Deploying_your_first_Portlet-Portlet_Class-writer"/>
+ <area coords="15 80" id="area-Reference_Guide-Deploying_your_first_Portlet-Portlet_Class-write"/>
+ <area coords="16 80" id="area-Reference_Guide-Deploying_your_first_Portlet-Portlet_Class-close"/>
+ </areaspec>
+ <programlisting language="Java" role="Java"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/PortletDevelopment_Standard/SimplestHelloWorldPortlet.java" parse="text"/></programlisting>
+ <calloutlist>
+ <callout arearefs="area-Reference_Guide-Deploying_your_first_Portlet-Portlet_Class-extends">
+ <remark>BZ#812412 - adjusted the description for this based on feedback in the ticket.</remark>
+ <para>
+ All portlets must implement the <literal>javax.portlet.Portlet</literal> interface. The <classname>GenericPortlet</classname> class provides a default implementation for the Portlet interface.
</para>
- <para>
- The <literal>javax.portlet.Portlet</literal> interface uses the <literal>javax.portlet.GenericPortlet</literal> class which implements the <literal>Portlet render</literal> method to dispatch to abstract mode-specific methods. This makes it easier to support the standard portlet modes.
+ <para>
+ The <classname>javax.portlet.GenericPortlet</classname> class implements the <methodname>render</methodname> method to dispatch to abstract mode-specific methods. This makes it easier to support the standard portlet modes.
</para>
- <para>
- <literal>Portlet render</literal> also provides a default implementation for the <literal>processAction</literal>, <literal>init</literal> and <literal>destroy</literal> methods. It is recommended to extend <literal>GenericPortlet</literal> for most cases.
+ <para><classname> GenericPortlet</classname> also provides a default implementation for the <methodname>processAction</methodname>, <methodname>init</methodname> and <methodname>destroy</methodname> methods. It is recommended to extend <literal>GenericPortlet</literal> for most cases.
</para>
-
- </callout>
- <callout arearefs="area-Reference_Guide-Deploying_your_first_Portlet-Portlet_Class-doview">
- <para>
- If only the <literal>view</literal> mode is required, then only the <literal>doView</literal> method needs to be implemented. The <literal>GenericPortlet</literal> render implementation calls our implementation when the <literal>view</literal> mode is requested.
+ </callout>
+ <callout arearefs="area-Reference_Guide-Deploying_your_first_Portlet-Portlet_Class-doview">
+ <para>
+ If only the <literal>view</literal> mode is required, then only the <literal>doView</literal> method needs to be implemented. The <classname>GenericPortlet</classname> render implementation calls our implementation when the <literal>view</literal> mode is requested.
</para>
-
- </callout>
- <callout arearefs="area-Reference_Guide-Deploying_your_first_Portlet-Portlet_Class-writer">
- <para>
- Use the <emphasis>RenderResponse</emphasis> to obtain a writer to be used to produce content.
+ </callout>
+ <callout arearefs="area-Reference_Guide-Deploying_your_first_Portlet-Portlet_Class-writer">
+ <para>
+ Use the <methodname>RenderResponse</methodname> method to obtain a writer to be used to produce content.
</para>
-
- </callout>
- <callout arearefs="area-Reference_Guide-Deploying_your_first_Portlet-Portlet_Class-write">
- <para>
+ </callout>
+ <callout arearefs="area-Reference_Guide-Deploying_your_first_Portlet-Portlet_Class-write">
+ <para>
Write the markup to display.
</para>
-
- </callout>
- <callout arearefs="area-Reference_Guide-Deploying_your_first_Portlet-Portlet_Class-close">
- <para>
+ </callout>
+ <callout arearefs="area-Reference_Guide-Deploying_your_first_Portlet-Portlet_Class-close">
+ <para>
Closing the writer.
</para>
-
- </callout>
-
- </calloutlist>
-
- </programlistingco>
-
- <para>
+ </callout>
+ </calloutlist>
+ </programlistingco>
+ <para>
<note>
- <title>Markup Fragments</title>
- <para>
+ <title>Markup Fragments</title>
+ <para>
Portlets are responsible for generating markup fragments, as they are included on a page and are surrounded by other portlets. This means that a portlet outputting HTML must not output any markup that cannot be found in a <literal><body></literal> element.
</para>
+ </note>
- </note>
-
</para>
-
- </section>
-
- <section id="sect-Reference_Guide-Deploying_your_first_Portlet-Application_Descriptors">
- <title>Application Descriptors</title>
- <para>
+ </section>
+ <section id="sect-Reference_Guide-Deploying_your_first_Portlet-Application_Descriptors">
+ <title>Application Descriptors</title>
+ <para>
JBoss Enterprise Portal Platform requires certain descriptors to be included in a portlet <literal>WAR</literal> file. These descriptors are defined by the Java EE (<filename>web.xml</filename>) and Portlet Specification (<filename>portlet.xml</filename>).
</para>
- <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:
</para>
- <programlistingco>
- <areaspec>
- <area coords="6 80" id="area-Reference_Guide-Deploying_your_first_Portlet-Application_Descriptors-portletname" />
- <area coords="8 80" id="area-Reference_Guide-Deploying_your_first_Portlet-Application_Descriptors-portletclass" />
- <area coords="10 80" id="area-Reference_Guide-Deploying_your_first_Portlet-Application_Descriptors-supports" />
- <area coords="13 80" id="area-Reference_Guide-Deploying_your_first_Portlet-Application_Descriptors-portletinfo" />
-
- </areaspec>
-
-<programlisting language="XML" role="XML"><xi:include href="../../extras/PortletDevelopment_Standard/default245.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting>
- <calloutlist>
- <callout arearefs="area-Reference_Guide-Deploying_your_first_Portlet-Application_Descriptors-portletname">
- <para>
+ <programlistingco>
+ <areaspec>
+ <area coords="6 80" id="area-Reference_Guide-Deploying_your_first_Portlet-Application_Descriptors-portletname"/>
+ <area coords="8 80" id="area-Reference_Guide-Deploying_your_first_Portlet-Application_Descriptors-portletclass"/>
+ <area coords="10 80" id="area-Reference_Guide-Deploying_your_first_Portlet-Application_Descriptors-supports"/>
+ <area coords="13 80" id="area-Reference_Guide-Deploying_your_first_Portlet-Application_Descriptors-portletinfo"/>
+ </areaspec>
+ <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/PortletDevelopment_Standard/default245.xml" parse="text"/></programlisting>
+ <calloutlist>
+ <callout arearefs="area-Reference_Guide-Deploying_your_first_Portlet-Application_Descriptors-portletname">
+ <para>
Define the portlet name. It does not have to be the class name.
</para>
-
- </callout>
- <callout arearefs="area-Reference_Guide-Deploying_your_first_Portlet-Application_Descriptors-portletclass">
- <para>
+ </callout>
+ <callout arearefs="area-Reference_Guide-Deploying_your_first_Portlet-Application_Descriptors-portletclass">
+ <para>
The Fully Qualified Name (<literal>FQN</literal>) of your portlet class must be declared here.
</para>
-
- </callout>
- <callout arearefs="area-Reference_Guide-Deploying_your_first_Portlet-Application_Descriptors-supports">
- <para>
+ </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.
</para>
- <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.
</para>
- <para>
+ <para>
This does not have to be declared as all portlets must support the <literal>view</literal> portlet mode.
</para>
- <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 <literal>HTML</literal>.
</para>
-
- </callout>
- <callout arearefs="area-Reference_Guide-Deploying_your_first_Portlet-Application_Descriptors-portletinfo">
- <para>
- When rendered, the portlet's title is displayed as the header in the portlet window, unless it is overridden programmatically. In the example above the title would be <literal>Simplest Hello World Portlet</literal> .
+ </callout>
+ <callout arearefs="area-Reference_Guide-Deploying_your_first_Portlet-Application_Descriptors-portletinfo">
+ <para>
+ When rendered, the portlet's title is displayed as the header in the portlet window, unless it is overridden programmatically. In the example above the title would be <literal>Simplest Hello World Portlet</literal> .
</para>
-
- </callout>
-
- </calloutlist>
-
- </programlistingco>
-
-
- </section>
-
-
- </section>
-
- <section id="sect-Reference_Guide-Tutorials-JavaServer_Pages_Portlet_Example">
- <title>JavaServer Pages Portlet Example</title>
- <para>
+ </callout>
+ </calloutlist>
+ </programlistingco>
+ </section>
+ </section>
+ <section id="sect-Reference_Guide-Tutorials-JavaServer_Pages_Portlet_Example">
+ <title>JavaServer Pages Portlet Example</title>
+ <para>
This section discusses:
</para>
- <orderedlist numeration="arabic">
- <listitem>
- <para>
+ <orderedlist numeration="arabic">
+ <listitem>
+ <para>
Adding more features to the previous example.
</para>
-
- </listitem>
- <listitem>
- <para>
+ </listitem>
+ <listitem>
+ <para>
Using a JSP page to render the markup.
</para>
-
- </listitem>
- <listitem>
- <para>
+ </listitem>
+ <listitem>
+ <para>
Using the portlet tag library to generate links to the portlet in different ways.
</para>
-
- </listitem>
- <listitem>
- <para>
+ </listitem>
+ <listitem>
+ <para>
Using the other standard portlet modes.
</para>
-
- </listitem>
-
- </orderedlist>
- <formalpara id="form-Reference_Guide-JavaServer_Pages_Portlet_Example-Compiling_the_example">
- <title>Compiling the example</title>
- <para>
- The example used in this section is available in the <filename>/jboss-epp-<VERSION>-src/portal/examples/portlets/</filename> directory of the JBoss Enterprise Portal Platform sources package or the <filename>/jboss-epp-<VERSION>-docs/epp-doc/examples/portlets</filename> directory of the documentation package.
+ </listitem>
+ </orderedlist>
+ <formalpara id="form-Reference_Guide-JavaServer_Pages_Portlet_Example-Compiling_the_example">
+ <title>Compiling the example</title>
+ <para>
+ The example used in this section is available in the directory of the JBoss Enterprise Portal Platform sources package.
</para>
-
- </formalpara>
- <para>
+ </formalpara>
+ <para>
Compile the example as so:
</para>
- <procedure>
- <step>
- <para>
- Execute:
- </para>
-
-<programlisting language="XML" role="XML"><xi:include href="../../extras/PortletDevelopment_Standard/default246.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting>
- <para>
- in the <filename>jsphellouser</filename> directory.
- </para>
-
- </step>
- <step>
- <para>
+ <procedure>
+ <title>Compile JavaServer Pages Portlet</title>
+ <step>
+ <para>Obtain the JBoss Enterprise Portal Platform sources package from the Customer Support portal.</para>
+ </step>
+ <step>
+ <para>Move to <filename>/jboss-epp-<VERSION>-src/portal/examples/portlets/jsphellouser</filename> </para>
+ </step>
+ <step>
+ <para>
+ Execute <code>mvn package</code>. </para>
+ </step>
+ <step>
+ <para>
Copy <filename>jsphellouser/target/gatein-jsp-hellouser-&VZ;.GA.war</filename> to the <literal>deploy</literal> directory of JBoss Application Server.
</para>
-
- </step>
- <step>
- <para>
+ </step>
+ <step>
+ <para>
Add the new portlet to the Application Registry.
</para>
-
- </step>
- <step>
- <para>
+ </step>
+ <step>
+ <para>
Create a new portal page and add the portlet to it.
</para>
-
- </step>
-
- </procedure>
-
- <mediaobject>
- <imageobject role="html">
- <imagedata align="center" fileref="images/PortletDevelopment/Standard/jsp_portlet/output.png" format="PNG" scale="100" width="444" />
- </imageobject>
- <imageobject role="fo">
- <imagedata align="center" contentwidth="120mm" fileref="images/PortletDevelopment/Standard/jsp_portlet/output.png" format="PNG" width="444" />
- </imageobject>
-
- </mediaobject>
- <!-- Does not seem to appear any longer
+ </step>
+ </procedure>
+ <mediaobject>
+ <imageobject role="html">
+ <imagedata width="444" align="center" scale="100" fileref="images/PortletDevelopment/Standard/jsp_portlet/output.png" format="PNG"/>
+ </imageobject>
+ <imageobject role="fo">
+ <imagedata width="444" contentwidth="120mm" align="center" fileref="images/PortletDevelopment/Standard/jsp_portlet/output.png" format="PNG"/>
+ </imageobject>
+ </mediaobject>
+<!-- Does not seem to appear any longer
<note>
<para>
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>
+</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 which are detailed later.
</para>
- <para>
+ <para>
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 language="Java" role="Java"><xi:include href="../../extras/PortletDevelopment_Standard/default247.java" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting>
-
- </section>
-
- <section id="sect-Reference_Guide-JavaServer_Pages_Portlet_Example-Portlet_Class">
- <title>Portlet Class</title>
- <para>
+ <programlisting language="Java" role="Java"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/PortletDevelopment_Standard/default247.java" parse="text"/></programlisting>
+ </section>
+ <section id="sect-Reference_Guide-JavaServer_Pages_Portlet_Example-Portlet_Class">
+ <title>Portlet Class</title>
+ <para>
The code below is from the <filename> jsphellouser/src/main/java/org/jboss/portal/portlet/samples/JSPHelloUserPortlet.java</filename> Java source. It is split in different pieces.
</para>
- <programlistingco>
- <areaspec>
- <area coords="17 60" id="area-Reference_Guide-JavaServer_Pages_Portlet_Example-Portlet_Class-doView" />
- <area coords="20" id="area-Reference_Guide-JavaServer_Pages_Portlet_Example-Portlet_Class-renderParameter" />
- <area coords="24" id="area-Reference_Guide-JavaServer_Pages_Portlet_Example-Portlet_Class-requestDispatcher" />
- <area coords="25" id="area-Reference_Guide-JavaServer_Pages_Portlet_Example-Portlet_Class-include" />
-
- </areaspec>
-
-<programlisting language="Java" role="Java"><xi:include href="../../extras/PortletDevelopment_Standard/JSPHelloUserPortlet.java" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting>
- <calloutlist>
- <callout arearefs="area-Reference_Guide-JavaServer_Pages_Portlet_Example-Portlet_Class-doView">
- <para>
+ <programlisting language="Java" linenumbering="numbered"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/PortletDevelopment_Standard/JSPHelloUserPortlet.java" parse="text"/></programlisting>
+ <para>
Override the <emphasis>doView</emphasis> method (as in the first tutorial).
</para>
-
- </callout>
- <callout arearefs="area-Reference_Guide-JavaServer_Pages_Portlet_Example-Portlet_Class-renderParameter">
- <para>
+ <para>
This entry attempts to obtain the value of the render parameter named <literal>yourname</literal>. If defined it should redirect to the <filename>hello.jsp</filename> JSP page, otherwise to the <filename>welcome.jsp</filename> JSP page.
</para>
-
- </callout>
- <callout arearefs="area-Reference_Guide-JavaServer_Pages_Portlet_Example-Portlet_Class-requestDispatcher">
- <para>
+ <para>
Get a request dispatcher on a file located within the web archive.
</para>
-
- </callout>
- <callout arearefs="area-Reference_Guide-JavaServer_Pages_Portlet_Example-Portlet_Class-include">
- <para>
+ <para>
Perform the inclusion of the markup obtained from the JSP.
</para>
-
- </callout>
-
- </calloutlist>
-
- </programlistingco>
-
- <para>
+ <para>
As well as the <literal>VIEW</literal> portlet mode, the specification defines two other modes; <literal>EDIT</literal> and <literal>HELP</literal>.
</para>
- <para>
- These modes need to be defined in the <filename>portlet.xml</filename> descriptor. This will enable the corresponding buttons on the portlet's window.
+ <para>
+ These modes need to be defined in the <filename>portlet.xml</filename> descriptor. This will enable the corresponding buttons on the portlet's window.
</para>
- <para>
+ <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"><xi:include href="../../extras/PortletDevelopment_Standard/default248.java" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting>
- <para>
+ <programlisting language="Java" role="Java"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/PortletDevelopment_Standard/default248.java" parse="text"/></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>
+ <para>
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>
+ <para>
The code to be executed during an action has to be implemented in the <emphasis>processAction</emphasis> method of the portlet.
</para>
- <programlistingco>
- <areaspec>
- <area coords="2 80" id="area-Reference_Guide-JavaServer_Pages_Portlet_Example-Portlet_Class-processAction" />
- <area coords="5 80" id="area-Reference_Guide-JavaServer_Pages_Portlet_Example-Portlet_Class-getActionParameter" />
- <area coords="6 80" id="area-Reference_Guide-JavaServer_Pages_Portlet_Example-Portlet_Class-setRenderParameter" />
-
- </areaspec>
-
-<programlisting language="Java" role="Java"><xi:include href="../../extras/PortletDevelopment_Standard/default249.java" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting>
- <calloutlist>
- <callout arearefs="area-Reference_Guide-JavaServer_Pages_Portlet_Example-Portlet_Class-processAction">
- <para>
+ <programlistingco>
+ <areaspec>
+ <area coords="2 80" id="area-Reference_Guide-JavaServer_Pages_Portlet_Example-Portlet_Class-processAction"/>
+ <area coords="5 80" id="area-Reference_Guide-JavaServer_Pages_Portlet_Example-Portlet_Class-getActionParameter"/>
+ <area coords="6 80" id="area-Reference_Guide-JavaServer_Pages_Portlet_Example-Portlet_Class-setRenderParameter"/>
+ </areaspec>
+ <programlisting language="Java" role="Java"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/PortletDevelopment_Standard/default249.java" parse="text"/></programlisting>
+ <calloutlist>
+ <callout arearefs="area-Reference_Guide-JavaServer_Pages_Portlet_Example-Portlet_Class-processAction">
+ <para>
<literal>processAction</literal> is the method from <literal>GenericPortlet</literal> to override for the <emphasis>action</emphasis> phase.
</para>
-
- </callout>
- <callout arearefs="area-Reference_Guide-JavaServer_Pages_Portlet_Example-Portlet_Class-getActionParameter">
- <para>
+ </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>.
</para>
-
- </callout>
- <callout arearefs="area-Reference_Guide-JavaServer_Pages_Portlet_Example-Portlet_Class-setRenderParameter">
- <para>
+ </callout>
+ <callout arearefs="area-Reference_Guide-JavaServer_Pages_Portlet_Example-Portlet_Class-setRenderParameter">
+ <para>
The value of <literal>yourname</literal> is kept to make it available in the rendering phase. The previous line simply copies an action parameter to a render parameter for this example.
</para>
-
- </callout>
-
- </calloutlist>
-
- </programlistingco>
-
-
- </section>
-
- <section id="sect-Reference_Guide-JavaServer_Pages_Portlet_Example-JSP_files_and_the_Portlet_Tag_Library">
- <title>JSP files and the Portlet Tag Library</title>
- <para>
+ </callout>
+ </calloutlist>
+ </programlistingco>
+ </section>
+ <section id="sect-Reference_Guide-JavaServer_Pages_Portlet_Example-JSP_files_and_the_Portlet_Tag_Library">
+ <title>JSP files and the Portlet Tag Library</title>
+ <para>
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 language="XML" role="XML"><xi:include href="../../extras/PortletDevelopment_Standard/default250.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting>
-
-<programlisting language="XML" role="XML"><xi:include href="../../extras/PortletDevelopment_Standard/default251.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting>
- <para>
+ <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/PortletDevelopment_Standard/default250.xml" parse="text"/></programlisting>
+ <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/PortletDevelopment_Standard/default251.xml" parse="text"/></programlisting>
+ <para>
The landing page contains the links and form to call our portlet:
</para>
- <programlistingco>
- <areaspec>
- <area coords="1 80" id="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSP_files_and_the_Portlet_Tag_Library-taglib" />
- <area coords="14 80" id="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSP_files_and_the_Portlet_Tag_Library-method1" />
- <area coords="20 80" id="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSP_files_and_the_Portlet_Tag_Library-method2.1" />
- <area coords="24 80" id="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSP_files_and_the_Portlet_Tag_Library-method2.2" />
- <area coords="30 80" id="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSP_files_and_the_Portlet_Tag_Library-method3.1" />
- <area coords="31 80" id="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSP_files_and_the_Portlet_Tag_Library-method3.2" />
-
- </areaspec>
-
-<programlisting language="XML" role="XML"><xi:include href="../../extras/PortletDevelopment_Standard/default252.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting>
- <calloutlist>
- <callout arearefs="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSP_files_and_the_Portlet_Tag_Library-taglib">
- <para>
+ <programlistingco>
+ <areaspec>
+ <area coords="1 80" id="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSP_files_and_the_Portlet_Tag_Library-taglib"/>
+ <area coords="14 80" id="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSP_files_and_the_Portlet_Tag_Library-method1"/>
+ <area coords="20 80" id="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSP_files_and_the_Portlet_Tag_Library-method2.1"/>
+ <area coords="24 80" id="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSP_files_and_the_Portlet_Tag_Library-method2.2"/>
+ <area coords="30 80" id="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSP_files_and_the_Portlet_Tag_Library-method3.1"/>
+ <area coords="31 80" id="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSP_files_and_the_Portlet_Tag_Library-method3.2"/>
+ </areaspec>
+ <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/PortletDevelopment_Standard/default252.xml" parse="text"/></programlisting>
+ <calloutlist>
+ <callout arearefs="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSP_files_and_the_Portlet_Tag_Library-taglib">
+ <para>
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">
- <para>
+ </callout>
+ <callout arearefs="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSP_files_and_the_Portlet_Tag_Library-method1">
+ <para>
The first method showed here is the simplest one. <literal>portlet:renderURL</literal> will create a URL that calls the render phase of the current portlet and append the result at the place of the markup (within a tag). A parameter is also added directly to the URL.
</para>
-
- </callout>
- <callout arearefs="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSP_files_and_the_Portlet_Tag_Library-method2.1">
- <para>
+ </callout>
+ <callout arearefs="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSP_files_and_the_Portlet_Tag_Library-method2.1">
+ <para>
In this method the <literal>var</literal> attribute is used. This avoids having one XML tag within another. Instead of printing the url the <literal>portlet:renderURL</literal> tag will store the result in the referenced variable ( <literal>myRenderURL</literal>).
</para>
-
- </callout>
- <callout arearefs="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSP_files_and_the_Portlet_Tag_Library-method2.2">
- <para>
+ </callout>
+ <callout arearefs="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSP_files_and_the_Portlet_Tag_Library-method2.2">
+ <para>
The variable <literal>myRenderURL</literal> is used like any other JSP variable.
</para>
-
- </callout>
- <callout arearefs="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSP_files_and_the_Portlet_Tag_Library-method3.1">
- <para>
+ </callout>
+ <callout arearefs="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSP_files_and_the_Portlet_Tag_Library-method3.1">
+ <para>
The third method mixes form submission and action request. Again, a temporary variable is used to put the created URL into.
</para>
-
- </callout>
- <callout arearefs="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSP_files_and_the_Portlet_Tag_Library-method3.2">
- <para>
+ </callout>
+ <callout arearefs="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSP_files_and_the_Portlet_Tag_Library-method3.2">
+ <para>
The action URL is used in HTML form.
</para>
-
- </callout>
-
- </calloutlist>
-
- </programlistingco>
-
- <para>
+ </callout>
+ </calloutlist>
+ </programlistingco>
+ <para>
In the third method, the action phase is triggered first then the render phase is triggered, which outputs some content back to the web browser based on the available render parameters.
</para>
- <mediaobject>
- <imageobject role="html">
- <imagedata align="center" fileref="images/PortletDevelopment/Standard/jsp_portlet/process.png" format="PNG" scale="100" width="444" />
- </imageobject>
- <imageobject role="fo">
- <imagedata align="center" contentwidth="140mm" fileref="images/PortletDevelopment/Standard/jsp_portlet/process.png" format="PNG" width="444" />
- </imageobject>
-
- </mediaobject>
-
- </section>
-
- <section id="sect-Reference_Guide-JavaServer_Pages_Portlet_Example-JSF_example_using_the_JBoss_Portlet_Bridge">
- <title>JSF example using the JBoss Portlet Bridge</title>
- <para>
- In order to write a portlet using JSF a 'bridge' is needed. This software allows developers to write a portlet application as if it was a JSF application. The bridge then negotiates the interactions between the two layers.
+ <mediaobject>
+ <imageobject role="html">
+ <imagedata width="444" align="center" scale="100" fileref="images/PortletDevelopment/Standard/jsp_portlet/process.png" format="PNG"/>
+ </imageobject>
+ <imageobject role="fo">
+ <imagedata width="444" contentwidth="140mm" align="center" fileref="images/PortletDevelopment/Standard/jsp_portlet/process.png" format="PNG"/>
+ </imageobject>
+ </mediaobject>
+ </section>
+ <section id="sect-Reference_Guide-JavaServer_Pages_Portlet_Example-JSF_example_using_the_JBoss_Portlet_Bridge">
+ <title>JSF example using the JBoss Portlet Bridge</title>
+ <para>
+ In order to write a portlet using JSF a 'bridge' is needed. This software allows developers to write a portlet application as if it was a JSF application. The bridge then negotiates the interactions between the two layers.
</para>
- <para>
+ <para>
An example using the JBoss Portlet Bridge is available in the <filename>/jboss-epp-<VERSION>-src/portal/examples/portlets/</filename> directory of the JBoss Enterprise Portal Platform sources package or the <filename>/jboss-epp-<VERSION>-docs/epp-doc/examples/portlets</filename> directory of the documentation package. The configuration is slightly different from a JSP application. This example can be used as a base to configure instead of creating a new application.
</para>
- <para>
+ <para>
As in any JSF application, the file <literal>faces-config.xml</literal> is required. It must contain the following information:
</para>
-
-<programlisting language="XML" role="XML"><xi:include href="../../extras/PortletDevelopment_Standard/default253.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting>
- <para>
+ <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/PortletDevelopment_Standard/default253.xml" parse="text"/></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>
+ <para>
The other differences when compared to a regular portlet application are in the portlet descriptor. All the relevant details about this can be found in the JSR-329 specification that the JBoss Portlet Bridge implements.
</para>
- <programlistingco>
- <areaspec>
- <area coords="8 80" id="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSF_example_using_the_JBoss_Portlet_Bridge-portlet" />
- <area coords="21 80" id="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSF_example_using_the_JBoss_Portlet_Bridge-view" />
- <area coords="26 80" id="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSF_example_using_the_JBoss_Portlet_Bridge-edit" />
- <area coords="31 80" id="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSF_example_using_the_JBoss_Portlet_Bridge-help" />
-
- </areaspec>
-
-<programlisting language="XML" role="XML"><xi:include href="../../extras/PortletDevelopment_Standard/default254.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting>
- <calloutlist>
- <callout arearefs="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSF_example_using_the_JBoss_Portlet_Bridge-portlet">
- <para>
+ <programlistingco>
+ <areaspec>
+ <area coords="8 80" id="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSF_example_using_the_JBoss_Portlet_Bridge-portlet"/>
+ <area coords="21 80" id="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSF_example_using_the_JBoss_Portlet_Bridge-view"/>
+ <area coords="26 80" id="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSF_example_using_the_JBoss_Portlet_Bridge-edit"/>
+ <area coords="31 80" id="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSF_example_using_the_JBoss_Portlet_Bridge-help"/>
+ </areaspec>
+ <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/PortletDevelopment_Standard/default254.xml" parse="text"/></programlisting>
+ <calloutlist>
+ <callout arearefs="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSF_example_using_the_JBoss_Portlet_Bridge-portlet">
+ <para>
All JSF portlets define <literal>javax.portlet.faces.GenericFacesPortlet </literal> as portlet class. This class is part of the JBoss Portlet Bridge.
</para>
-
- </callout>
- <callout arearefs="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSF_example_using_the_JBoss_Portlet_Bridge-view">
- <para>
- This is a mandatory parameter to define what's the default page to display.
+ </callout>
+ <callout arearefs="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSF_example_using_the_JBoss_Portlet_Bridge-view">
+ <para>
+ This is a mandatory parameter to define what's the default page to display.
</para>
-
- </callout>
- <callout arearefs="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSF_example_using_the_JBoss_Portlet_Bridge-edit">
- <para>
- This parameter defines which page to display on the 'edit' mode.
+ </callout>
+ <callout arearefs="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSF_example_using_the_JBoss_Portlet_Bridge-edit">
+ <para>
+ This parameter defines which page to display on the 'edit' mode.
</para>
-
- </callout>
- <callout arearefs="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSF_example_using_the_JBoss_Portlet_Bridge-help">
- <para>
- This parameter defines which page to display on the 'help' mode.
+ </callout>
+ <callout arearefs="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSF_example_using_the_JBoss_Portlet_Bridge-help">
+ <para>
+ This parameter defines which page to display on the 'help' mode.
</para>
-
- </callout>
-
- </calloutlist>
-
- </programlistingco>
-
- <note>
- <title>JBoss Portlet Bridge</title>
- <para>
+ </callout>
+ </calloutlist>
+ </programlistingco>
+ <note>
+ <title>JBoss Portlet Bridge</title>
+ <para>
For more information about the JBoss Portlet Bridge, see the dedicated chapter which is part of this document.
</para>
-
- </note>
-
- </section>
-
-
- </section>
-
-
+ </note>
+ </section>
</section>
-
-
+ </section>
</chapter>
-
Modified: epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/configuration/exo-jcr-configuration.xml
===================================================================
--- epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/configuration/exo-jcr-configuration.xml 2012-07-06 10:59:53 UTC (rev 8777)
+++ epp/docs/branches/5.2/Reference_Guide/en-US/modules/eXoJCR/jcr/configuration/exo-jcr-configuration.xml 2012-07-09 00:39:39 UTC (rev 8778)
@@ -56,7 +56,7 @@
<para>
Below is an example configuration from the <filename><replaceable><JBOSS_HOME></replaceable>/server/<replaceable><PROFILE></replaceable>/deploy/gatein.ear/02portal.war/WEB-INF/conf/jcr/jcr-configuration.xml</filename> file.
</para>
- <programlisting linenumbering="numbered" language="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../../../code_samples/jcr-configuration.xml_code" parse="text"/></programlisting>
+ <programlisting linenumbering="numbered" language="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../../../extras/Advanced_Development_JCR_Configuration/jcr-configuration.xml" parse="text"/></programlisting>
<section id="sect-Reference_Guide-Portal_configuration-JCR_Configuration">
<title>JCR Configuration</title>
<para>
More information about the gatein-commits
mailing list