You are viewing a plain text version of this content. The canonical link for it is here.
Posted to pluto-scm@portals.apache.org by zh...@apache.org on 2006/01/19 12:47:12 UTC
svn commit: r370461 - in /portals/pluto/trunk/pluto-site/src/site: ./
resources/ resources/css/ resources/images/v101/ xdoc/ xdoc/v101/developer/
xdoc/v101/userguide/
Author: zheng
Date: Thu Jan 19 03:46:34 2006
New Revision: 370461
URL: http://svn.apache.org/viewcvs?rev=370461&view=rev
Log:
Updated v1.0.1 documentation
Added:
portals/pluto/trunk/pluto-site/src/site/resources/images/v101/default_portal_layout.jpg (with props)
portals/pluto/trunk/pluto-site/src/site/xdoc/download.xml
Removed:
portals/pluto/trunk/pluto-site/src/site/resources/images/v101/defaultPortalLayout.gif
portals/pluto/trunk/pluto-site/src/site/resources/images/v101/defaultPortalLayoutThumb.gif
portals/pluto/trunk/pluto-site/src/site/resources/images/v101/jw-0801-RI_deploy-thumb.jpg
portals/pluto/trunk/pluto-site/src/site/resources/images/v101/jw-0801-pluto_arch-thumb.jpg
portals/pluto/trunk/pluto-site/src/site/resources/images/v101/jw-0801-portal_arch-thumb.jpg
portals/pluto/trunk/pluto-site/src/site/resources/mirrors.cgi
portals/pluto/trunk/pluto-site/src/site/xdoc/mirrors.xml
Modified:
portals/pluto/trunk/pluto-site/src/site/resources/css/site.css
portals/pluto/trunk/pluto-site/src/site/resources/images/v101/jw-0801-RI_deploy.jpg
portals/pluto/trunk/pluto-site/src/site/resources/images/v101/jw-0801-pluto_arch.jpg
portals/pluto/trunk/pluto-site/src/site/site.xml
portals/pluto/trunk/pluto-site/src/site/xdoc/v101/developer/arch.xml
portals/pluto/trunk/pluto-site/src/site/xdoc/v101/developer/integrate.xml
portals/pluto/trunk/pluto-site/src/site/xdoc/v101/userguide/portal.xml
Modified: portals/pluto/trunk/pluto-site/src/site/resources/css/site.css
URL: http://svn.apache.org/viewcvs/portals/pluto/trunk/pluto-site/src/site/resources/css/site.css?rev=370461&r1=370460&r2=370461&view=diff
==============================================================================
--- portals/pluto/trunk/pluto-site/src/site/resources/css/site.css (original)
+++ portals/pluto/trunk/pluto-site/src/site/resources/css/site.css Thu Jan 19 03:46:34 2006
@@ -100,10 +100,8 @@
}
#leftColumn {
- margin: 10px 0 10px 0;
- padding: 0px 5px 0px 5px;
background-color: #FFFFFF;
- border-width: 1px 1px 1px 0px;
+ border-width: 1px;
border-style: solid;
border-color: #CCCCCC;
}
@@ -124,7 +122,9 @@
font-family: "Trebuchet MS", Trebuchet, Arial, Verdana, Sans-serif;
font-weight: bold;
white-space: nowrap;
- border-width: 0px;
+ border-width: 0px 0px 1px 0px;
+ border-style: solid;
+ border-color: #8DB7DF;
}
/**
Added: portals/pluto/trunk/pluto-site/src/site/resources/images/v101/default_portal_layout.jpg
URL: http://svn.apache.org/viewcvs/portals/pluto/trunk/pluto-site/src/site/resources/images/v101/default_portal_layout.jpg?rev=370461&view=auto
==============================================================================
Binary file - no diff available.
Propchange: portals/pluto/trunk/pluto-site/src/site/resources/images/v101/default_portal_layout.jpg
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Modified: portals/pluto/trunk/pluto-site/src/site/resources/images/v101/jw-0801-RI_deploy.jpg
URL: http://svn.apache.org/viewcvs/portals/pluto/trunk/pluto-site/src/site/resources/images/v101/jw-0801-RI_deploy.jpg?rev=370461&r1=370460&r2=370461&view=diff
==============================================================================
Binary files - no diff available.
Modified: portals/pluto/trunk/pluto-site/src/site/resources/images/v101/jw-0801-pluto_arch.jpg
URL: http://svn.apache.org/viewcvs/portals/pluto/trunk/pluto-site/src/site/resources/images/v101/jw-0801-pluto_arch.jpg?rev=370461&r1=370460&r2=370461&view=diff
==============================================================================
Binary files - no diff available.
Modified: portals/pluto/trunk/pluto-site/src/site/site.xml
URL: http://svn.apache.org/viewcvs/portals/pluto/trunk/pluto-site/src/site/site.xml?rev=370461&r1=370460&r2=370461&view=diff
==============================================================================
--- portals/pluto/trunk/pluto-site/src/site/site.xml (original)
+++ portals/pluto/trunk/pluto-site/src/site/site.xml Thu Jan 19 03:46:34 2006
@@ -21,7 +21,7 @@
<bannerLeft>
<name>Pluto</name>
<src>http://portals.apache.org/pluto/images/apache-portals.gif</src>
- <href>http://portals.apache.org/pluto</href>
+ <href>http://portals.apache.org/pluto/</href>
</bannerLeft>
<bannerRight>
<src>http://portals.apache.org/pluto/images/banner.png</src>
@@ -38,7 +38,7 @@
<menu name="The Pluto Project">
<item name="About Pluto" href="/index.html"/>
<item name="Mission" href="/mission.html"/>
- <iten name="Download" href="http://www.apache.org/dyn/closer.cgi/portals/pluto/"/>
+ <iten name="Download" href="/download.html"/>
<item name="News" href="/news.html"/>
<item name="FAQ" href="/faq.html"/>
<item name="Powered By Pluto" href="/powered.html"/>
@@ -55,7 +55,7 @@
<item name="Architecture" href="/v101/developer/arch.html"/>
<item name="Obtaining Source" href="/v101/developer/subversion.html"/>
<item name="Building From Source" href="/v101/developer/build_source.html"/>
- <item name="Integrating/Embedding" href="/v101/developer/integrate.html"/>
+ <item name="Integrating" href="/v101/developer/integrate.html"/>
</menu>
</menu>
Added: portals/pluto/trunk/pluto-site/src/site/xdoc/download.xml
URL: http://svn.apache.org/viewcvs/portals/pluto/trunk/pluto-site/src/site/xdoc/download.xml?rev=370461&view=auto
==============================================================================
--- portals/pluto/trunk/pluto-site/src/site/xdoc/download.xml (added)
+++ portals/pluto/trunk/pluto-site/src/site/xdoc/download.xml Thu Jan 19 03:46:34 2006
@@ -0,0 +1,44 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+Copyright 2004 The Apache Software Foundation
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+implied.
+
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
+
+<document>
+
+ <properties>
+ <title>Apache Pluto Downloads</title>
+ </properties>
+
+ <body>
+
+ <section name="Download Pluto">
+ <p>
+ The Apache Pluto source and binary distributions can be downloaded form
+ <a href="http://www.apache.org/dyn/closer.cgi/portals/pluto/">a Pluto
+ distribution mirror</a>.
+ </p>
+ </section>
+
+ <section name="Browse Distribution Archives">
+ <p>
+ You can browse and download our distribution archive
+ <a href="http://archive.apache.org/dist/portals/pluto/">from here</a>.
+ </p>
+ </section>
+
+ </body>
+
+</document>
Modified: portals/pluto/trunk/pluto-site/src/site/xdoc/v101/developer/arch.xml
URL: http://svn.apache.org/viewcvs/portals/pluto/trunk/pluto-site/src/site/xdoc/v101/developer/arch.xml?rev=370461&r1=370460&r2=370461&view=diff
==============================================================================
--- portals/pluto/trunk/pluto-site/src/site/xdoc/v101/developer/arch.xml (original)
+++ portals/pluto/trunk/pluto-site/src/site/xdoc/v101/developer/arch.xml Thu Jan 19 03:46:34 2006
@@ -1,4 +1,4 @@
-<?xml version="1.0"?>
+<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright 2004 The Apache Software Foundation
Licensed under the Apache License, Version 2.0 (the "License");
@@ -61,7 +61,10 @@
<blockquote>
<div align="center">
- <p><a href="../../images/v101/jw-0801-portal_arch.jpg"><img src="../../images/v101/jw-0801-portal_arch-thumb.jpg" alt="Portal Architecture" height="160" width="250" border="0"/></a></p>
+ <p>
+ <a href="../../images/v101/jw-0801-portal_arch.jpg">
+ <img src="../../images/v101/jw-0801-portal_arch.jpg"
+ alt="Portal Architecture" width="500"/></a></p>
<p><b><i><font size="-1">Figure 1. The simple portal included with Pluto. Click on the picture to enlarge it</font></i></b></p>
</div>
</blockquote>
@@ -127,7 +130,10 @@
<blockquote>
<div align="center">
- <p><a href="../../images/v101/jw-0801-pluto_arch.jpg"><img src="../../images/v101/jw-0801-pluto_arch-thumb.jpg" alt="Pluto Architecture" height="144" width="250" border="0"/></a></p>
+ <p>
+ <a href="../../images/v101/jw-0801-pluto_arch.jpg">
+ <img src="../../images/v101/jw-0801-pluto_arch.jpg"
+ alt="Pluto Architecture" width="500"/></a></p>
<p><b><i><font size="-1">Figure 2. The portlet container's architecture. Click on the picture to enlarge it</font></i></b></p>
</div>
</blockquote>
@@ -148,7 +154,9 @@
<blockquote>
<div align="center">
- <p><a href="../../images/v101/jw-0801-RI_deploy.jpg"><img src="../../images/v101/jw-0801-RI_deploy-thumb.jpg" alt="Deployment" height="170" width="250" border="0"/></a></p>
+ <p><a href="../../images/v101/jw-0801-RI_deploy.jpg">
+ <img src="../../images/v101/jw-0801-RI_deploy.jpg"
+ alt="Deployment" width="500"/></a></p>
<p><b><i><font size="-1">Figure 3. Portlet deployment in the RI. Click on thumbnail to view full-size image.</font></i></b></p>
</div>
</blockquote>
Modified: portals/pluto/trunk/pluto-site/src/site/xdoc/v101/developer/integrate.xml
URL: http://svn.apache.org/viewcvs/portals/pluto/trunk/pluto-site/src/site/xdoc/v101/developer/integrate.xml?rev=370461&r1=370460&r2=370461&view=diff
==============================================================================
--- portals/pluto/trunk/pluto-site/src/site/xdoc/v101/developer/integrate.xml (original)
+++ portals/pluto/trunk/pluto-site/src/site/xdoc/v101/developer/integrate.xml Thu Jan 19 03:46:34 2006
@@ -1,4 +1,4 @@
-<?xml version="1.0"?>
+<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright 2004 The Apache Software Foundation
Licensed under the Apache License, Version 2.0 (the "License");
@@ -15,133 +15,254 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
+
<document>
+
<properties>
<author email="sthepper@apache.org">Stefan Hepper</author>
<author email="shesmer@apache.org">Stephan Hesmer</author>
- <title/>
+ <title>Integrating Pluto Into Your Container</title>
</properties>
+
<body>
<section name="Integrating Pluto Into Your Container">
- <p align="center">Stefan Hepper (sthepper@apache.org)</p>
- <p align="center">Stephan Hesmer (shesmer@apache.org)</p>
+
+ <div align="center">
+ Stefan Hepper (sthepper@apache.org)<br/>
+ Stephan Hesmer (shesmer@apache.org)<br/>
+ </div>
+
<subsection name="1 Introduction">
<p>
- <a href="http://jakarta.apache.org/pluto">Pluto.</a> is a project at Apache Jakarta (http://jakarta.apache.org/pluto) that provides the reference implementation of the Java⢠Portlet Specification. The first version of this specification is available as <a href="http://jcp.org/en/jsr/detail?id=168">JSR 168</a>. The pluto project contains two parts: the portlet container and a simple test portal driver. This document is about how to use the pluto portlet container and replace the sample portal driver with your own portal.
-</p>
- <div align="center">
- <p>
- <a href="../../images/v101/jw-0801-portal_arch.jpg">
- <img src="../../images/v101/jw-0801-portal_arch-thumb.jpg" alt="Portal Architecture" border="0"/>
- </a>
- </p>
- <p>
- <b>
- <i>
- <font size="-1">Figure 1. Basic portal architecture. Click on the picture to enlarge it</font>
- </i>
- </b>
- </p>
- </div>
+ <a href="http://portals.apache.org/pluto/">Pluto</a> is a project at
+ Apache Portals (http://portals.apache.org/pluto) that provides the
+ reference implementation of the Java Portlet Specification. The first
+ version of this specification is available as
+ <a href="http://jcp.org/en/jsr/detail?id=168">JSR 168</a>.
+ The pluto project contains two parts: the portlet container and
+ a simple test portal driver. This document is about how to use the
+ pluto portlet container and replace the sample portal driver with your
+ own portal.
+ </p>
+ <div align="center">
+ <p>
+ <a href="../../images/v101/jw-0801-portal_arch.jpg">
+ <img src="../../images/v101/jw-0801-portal_arch.jpg"
+ alt="Portal Architecture" width="500"/>
+ </a>
+ </p>
+ <p>
+ <b><i>Figure 1. Basic portal architecture. Click on the picture to
+ enlarge it</i></b>
+ </p>
+ </div>
<p>
-Figure 1 depicts a portal's basic architecture. The portalâs web application processes the client request, retrieves the portlets on the user's current page, and then calls the portlet container to retrieve each portletâs content. The portal accesses the Portlet Container by using the Portlet Container Invoker API. This interface represents the main interface of the portlet container supporting request-base methods to call portlets from a portal's point of view. The Container Provider SPI (Service Provider Interface) is a callback interface of the Portlet Container which needs to be implemented by the portal to get portal related information, the container cannot know about, like URL creation. Finally, the portlet container calls all portlets via the Portlet API.
-</p>
- </subsection>
- <subsection name="2 Portlet container pluto">
- <p>The portlet container provides the runtime environment for the portlets. It is a core component of each portal, requires knowledge about the portal itself and has a need to reuse common code of the portal. Due to these requirements the pluto portlet container is built in a manner that completely separates the container from every other portal component. Said that, the portlet container is a standalone component that can be embedded in any portal by complying with the requirements of the portlet container, such as implementing all SPIs. The interfaces of the portlet container and its internal components are described in more detail in the next paragraphs.</p>
+ Figure 1 depicts a portal's basic architecture. The portal's web
+ application processes the client request, retrieves the portlets on
+ the user's current page, and then calls the portlet container to
+ retrieve each portlet's content. The portal accesses the Portlet
+ Container by using the Portlet Container Invoker API. This interface
+ represents the main interface of the portlet container supporting
+ request-base methods to call portlets from a portal's point of view.
+ The Container Provider SPI (Service Provider Interface) is a callback
+ interface of the Portlet Container which needs to be implemented by
+ the portal to get portal related information, the container cannot
+ know about, like URL creation. Finally, the portlet container calls
+ all portlets via the Portlet API.
+ </p>
+ </subsection>
+
+ <subsection name="2 Portlet container pluto">
+ <p>
+ The portlet container provides the runtime environment for the
+ portlets. It is a core component of each portal, requires knowledge
+ about the portal itself and has a need to reuse common code of the
+ portal. Due to these requirements the pluto portlet container is built
+ in a manner that completely separates the container from every other
+ portal component. Said that, the portlet container is a standalone
+ component that can be embedded in any portal by complying with the
+ requirements of the portlet container, such as implementing all SPIs.
+ The interfaces of the portlet container and its internal components
+ are described in more detail in the next paragraphs.
+ </p>
<div align="center">
+ <p>
+ <a href="../../images/v101/jw-0801-pluto_arch.jpg">
+ <img src="../../images/v101/jw-0801-pluto_arch.jpg"
+ alt="Pluto Architecture" width="500"/>
+ </a>
+ </p>
+ <p>
+ <b><i>Figure 2. The portlet container's architecture. Click on the
+ picture to enlarge it</i></b>
+ </p>
+ </div>
+ <p>
+ The Portlet Container Invoker API, also called entrance point, is the
+ main calling interface of a portlet container. It combines the
+ lifecycle (init, destroy) of a portlet container as well as the
+ request based calling methods (processAction, render). Due to its
+ nature of calling a portlet in the end, the method signature looks
+ similar to the main portlet interface of the Portlet API except that
+ a portlet identifier needs to be passed additionally. With this
+ additional parameter the container is able to determine the portlet
+ and call it accordingly.
+ </p>
+ <p>
+ Besides of the application programming interfaces the portlet
+ container can be instrumented by providing different implementations
+ through service provider interfaces. Therefore, the reference
+ implementation introduces a concept called Container Services.
+ This concept will be described in more detail in a later chapter.
+ </p>
+ </subsection>
+
+ <subsection name="3 How to integrate pluto with a portal framework">
+
+ <p>
+ This section covers in detail how the portal can call the container
+ and which SPIs needs to be implemented by the portal in order to
+ re-use pluto. The portal calls the pluto container via the portlet
+ container entrance point and needs to provide implementations for the
+ SPIs container services and the portlet object model.
+ </p>
+
+ <subsection name="3.1 Portlet Container Entrance Point">
+ <p>
+ The portlet container entrance point
+ <code>org.apache.pluto.PortletContainer</code>, is the main
+ interface between the portal's framework / aggregation and the
+ portlet environment. This interface is used to call the portlet
+ environment and execute portlets. It doesn't match exactly to the
+ Portlet API methods (init, processAction, render, destroy) but
+ generalizes the interface wherever possible.
+ </p>
+ <p>
+ The entrance point has methods with different scopes:
+ <ul>
+ <li>
+ <p>Lifecycle methods are called only <b>once</b> (init/shutdown).</p>
+ <p>These methods are normally called directly from the service interfaces.</p>
+ </li>
+ <li>
+ <p>Request-based methods are called for each request, but only
+ once for all portlets (portletLoad).</p>
+ <p>These methods must be called before the page aggregation
+ actually starts and after aggregating the page, affecting all
+ portlets being rendered on the page. Currently the only method
+ in this category is portletLoad that ensures that the portlet is
+ loaded and initialized before the request processing starts.</p>
+ </li>
+ <li>
+ <p>Request-based methods are called for each request and for
+ each portlet (processPortletAction, renderPortlet).</p>
+ <p>These methods are normally called during the page aggregation
+ as each portlet is being rendered.</p>
+ </li>
+ </ul>
+ </p>
<p>
- <a href="../../images/v101/jw-0801-pluto_arch.jpg">
- <img src="../../images/v101/jw-0801-pluto_arch-thumb.jpg" alt="Pluto Architecture" height="144" width="250" border="0"/>
- </a>
- </p>
+ The contract defined by this interface must be fulfilled by the
+ calling party to guarantee that the portlet environment will work
+ correctly.
+ </p>
+ </subsection>
+
+ <subsection name="3.2 Container Services">
+ <p>
+ ContainerServices are a generic plug-in concept for extending the
+ core portlet container with additional functionality.
+ A ContainerService is defined by an interface, accessed by the
+ portlet container and provided by the calling party (mostly
+ portal/framework). In some cases the flow goes in the other
+ direction, from container to portal. The nature of a service can be
+ viewed as a service made available for the portlet container:
+ The container needs it to run, but cannot implement the service
+ itself.
+ </p>
<p>
- <b>
- <i>
- <font size="-1">Figure 2. The portlet container's architecture. Click on the picture to enlarge it</font>
- </i>
- </b>
- </p>
- </div>
- <p>The Portlet Container Invoker API, also called entrance point, is the main calling interface of a portlet container. It combines the lifecycle (init, destroy) of a portlet container as well as the request based calling methods (processAction, render). Due to its nature of calling a portlet in the end, the method signature looks similar to the main portlet interface of the Portlet API except that a portlet identifier needs to be passed additionally. With this additional parameter the container is able to determine the portlet and call it accordingly.</p>
- <p/>
- <p>Besides of the application programming interfaces the portlet container can be instrumented by providing different implementations through service provider interfaces. Therefore, the reference implementation introduces a concept called Container Services. This concept will be described in more detail in a later chapter.</p>
- </subsection>
- <subsection name="3 How to integrate pluto with a portal framework">
- <p>This section covers in detail how the portal can call the container and which SPIs needs to be implemented by the portal in order to re-use pluto. The portal calls the pluto container via the portlet container entrance point and needs to provide implementations for the SPIs container services and the portlet object model.</p>
- <subsection name="3.1 Portlet Container Entrance Point">
- <p>The portlet container entrance point org.apache.pluto.PortletContainer, is the main interface between the portalâs framework / aggregation and the portlet environment. This interface is used to call the portlet environment and execute portlets. It doesnât match exactly to the Portlet API methods (init, processAction, render, destroy) but generalizes the interface wherever possible. </p>
- <p/>
- <p>The entrance point has methods with different scopes:</p>
- <ul>
- <li>
- <p>Lifecycle methods are called only <strong>once</strong> (init/shutdown).</p>
- <p>These methods are normally called directly from the service interfaces.</p>
- </li>
- <li>
- <p>Request-based methods are called for each request, but only once for all portlets (portletLoad).</p>
- <p>These methods must be called before the page aggregation actually starts and after aggregating the page, affecting all portlets being rendered on the page. Currently the only method in this category is portletLoad that ensures that the portlet is loaded and initialized before the request processing starts.</p>
- </li>
- <li>
- <p>Request-based methods are called for each request and for each portlet (processPortletAction, renderPortlet).</p>
- <p>These methods are normally called during the page aggregation as each portlet is being rendered.</p>
- </li>
- </ul>
- <p>The contract defined by this interface must be fulfilled by the calling party to guarantee that the portlet environment will work correctly. </p>
- </subsection>
- <subsection name="3.2 Container Services">
- <p>ContainerServices are a generic plug-in concept for extending the core portlet container with additional functionality. A ContainerService is defined by an interface, accessed by the portlet container and provided by the calling party (mostly portal / framework). In some cases the flow goes in the other direction, from container to portal. The nature of a service can be viewed as a service made available for the portlet container: The container needs it to run, but cannot implement the service itself.</p>
- <p/>
- <p>The Container Service concept makes the portlet container independent of portal functions so that it can be used by different portals and furthermore new services can be plugged in to get a richer portlet container experience. A ContainerServiceEnvironment describing all services must be created and passed to the portlet environment during initialization.</p>
- <p/>
- <p>Container Services can be split into two different categories:</p>
- <ul>
- <li>
- <p>
- <strong>Mandatory Base Services</strong>
- </p>
- <p>ContainerServices that must be provided by the calling party so that the portlet container is able to run.</p>
- <ul>
- <li>
- <p>Information Provider Service</p>
- <p>described in the next sub section</p>
- </li>
- <li>
- <p>Factory Manager Service</p>
- <p>Factory Service enables the portlet container to get implementation objects through a factory concept.</p>
- </li>
- <li>
- <p>Log Service</p>
- <p>This interface defines a logging facility.</p>
- </li>
- </ul>
- </li>
- <li>
- <p>
- <strong>Optional Base Services</strong>
- </p>
- <p>ContainerServices that can be provided by the calling party, but the container can run without it.</p>
- <ul>
- <li>
- <p>Property Manager Service</p>
- <p>The implementation of the Property Service interface enables a portal to deal with properties as defined in the JSR 168 specification.</p>
- </li>
- <li>
- <p>DynamicTitleService</p>
- <p>Allows to support dynamic titles.</p>
- </li>
- </ul>
- </li>
- </ul>
- <subsection name="3.2.1 Information Provider Service">
- <p>The Information Provider is a callback mechanism for the portlet environment into the calling party (mostly framework), to get hold of necessary information that can only be known by the portal, like hostname and URL generation. To differentiate between the scopes of the requested information, the portlet environment defines two interfaces: the DynamicInformationProvider and the StaticInformationProvider.</p>
- <p>The DynamicInformationProvider provides request-based information, which changes for each request. Consequently a new DynamicInformationProvider needs to be passed to the portlet environment for each request. Typical information provided by this Information Provider is a URL to a portlet. Additional provider interfaces retrieved via getter methods of the DynamicInformationProvider are PortletURLProvider and PortletActionProvider.</p>
- <p/>
- <p>The StaticInformationProvider on the other hand provides non-request-based information, which is constant across all requests. Therefore only one StaticInformationProvider needs to be provided to the portlet environment (singleton). Typical information provided by this Information Provider is the root context of the portal. An additional provider interface retrieved via a getter method of the StaticInformationProvider is the PortalContextProvider that contains further information about the portal, which need to be provided to the portlet.</p>
- <p/>
- <p>Both Information Providers are not actively passed by the calling party to the environment. Instead they are made available to the portlet environment through the Container Service mechanism described in the next section. Basically, the portlet environment asks the calling party for an instance of one of the Information Providers and the calling party returns the correct Information Provider.</p>
- </subsection>
- <subsection name="3.3 Portlet Object Model">
+ The Container Service concept makes the portlet container
+ independent of portal functions so that it can be used by different
+ portals and furthermore new services can be plugged in to get a
+ richer portlet container experience. A ContainerServiceEnvironment
+ describing all services must be created and passed to the portlet
+ environment during initialization.
+ </p>
+ <p>
+ Container Services can be split into two different categories:
+ <ul>
+ <li>
+ <p><b>Mandatory Base Services</b></p>
+ <p>ContainerServices that must be provided by the calling party
+ so that the portlet container is able to run.</p>
+ <ul>
+ <li><b>Information Provider Service:</b> described in the next
+ sub section</li>
+ <li><b>Factory Manager Service:</b> Factory Service enables
+ the portlet container to get implementation objects through a
+ factory concept.</li>
+ <li><b>Log Service:</b> This interface defines a logging
+ facility.</li>
+ </ul>
+ </li>
+ <li>
+ <p><b>Optional Base Services</b></p>
+ <p>ContainerServices that can be provided by the calling party,
+ but the container can run without it.</p>
+ <ul>
+ <li><b>Property Manager Service:</b> The implementation of the
+ Property Service interface enables a portal to deal with
+ properties as defined in the JSR 168 specification.</li>
+ <li><b>Dynamic Title Service:</b> Allows to support dynamic
+ titles.</li>
+ </ul>
+ </li>
+ </ul>
+ </p>
+
+ <subsection name="3.2.1 Information Provider Service">
+ <p>
+ The Information Provider is a callback mechanism for the portlet
+ environment into the calling party (mostly framework), to get hold
+ of necessary information that can only be known by the portal,
+ like hostname and URL generation. To differentiate between the
+ scopes of the requested information, the portlet environment
+ defines two interfaces: the DynamicInformationProvider and the
+ StaticInformationProvider.
+ </p>
+ <p>
+ The DynamicInformationProvider provides request-based information,
+ which changes for each request. Consequently a new
+ DynamicInformationProvider needs to be passed to the portlet
+ environment for each request. Typical information provided by this
+ Information Provider is a URL to a portlet. Additional provider
+ interfaces retrieved via getter methods of the
+ DynamicInformationProvider are PortletURLProvider and
+ PortletActionProvider.
+ </p>
+ <p>
+ The StaticInformationProvider on the other hand provides
+ non-request-based information, which is constant across all
+ requests. Therefore only one StaticInformationProvider needs to be
+ provided to the portlet environment (singleton). Typical
+ information provided by this Information Provider is the root
+ context of the portal. An additional provider interface retrieved
+ via a getter method of the StaticInformationProvider is the
+ PortalContextProvider that contains further information about the
+ portal, which need to be provided to the portlet.
+ </p>
+ <p>
+ Both Information Providers are not actively passed by the calling
+ party to the environment. Instead they are made available to the
+ portlet environment through the Container Service mechanism
+ described in the next section. Basically, the portlet environment
+ asks the calling party for an instance of one of the Information
+ Providers and the calling party returns the correct Information
+ Provider.
+ </p>
+ </subsection>
+
+ <subsection name="3.3 Portlet Object Model">
<p>The Portlet Object Model interfaces are defined in the package org.apache.pluto.om. These interfaces should be seen as an internal interface that can be used by other components of the portal. The portlet environment only defines the interfaces that are necessary to execute the object model the portal that uses the portlet environment must implement the object model. </p>
<p>The object model represents the information available on different levels about portlets and the portlet application, like the deployment descriptors and customization data. </p>
<p>The following definitions are used to represent the different levels of information:</p>
@@ -180,13 +301,12 @@
<div align="center">
<p>
<a href="../../images/v101/Relations.jpg">
- <img src="../../images/v101/Relations.jpg" alt="Portal Architecture" height="144" width="250" border="0"/>
+ <img src="../../images/v101/Relations.jpg" alt="Portal Architecture"/>
</a>
</p>
<p>
<b>
- <i>
- <font size="-1">Figure 3. Relations between the different application and portlet representations</font>
+ <i>Figure 3. Relations between the different application and portlet representations
</i>
</b>
</p>
Modified: portals/pluto/trunk/pluto-site/src/site/xdoc/v101/userguide/portal.xml
URL: http://svn.apache.org/viewcvs/portals/pluto/trunk/pluto-site/src/site/xdoc/v101/userguide/portal.xml?rev=370461&r1=370460&r2=370461&view=diff
==============================================================================
--- portals/pluto/trunk/pluto-site/src/site/xdoc/v101/userguide/portal.xml (original)
+++ portals/pluto/trunk/pluto-site/src/site/xdoc/v101/userguide/portal.xml Thu Jan 19 03:46:34 2006
@@ -1,4 +1,4 @@
-<?xml version="1.0"?>
+<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright 2004 The Apache Software Foundation
Licensed under the Apache License, Version 2.0 (the "License");
@@ -20,6 +20,7 @@
<author email="nlothian.AT.apache.DOT.org">Nick Lothian</author>
<author email="ddewolf.AT.apache.DOT.org">David DeWolf</author>
<author email="cdoremus.AT.apache.DOT.org">Craig Doremus</author>
+ <author email="zheng.AT.apache.DOT.org">ZHENG Zhong</author>
<title>User Guide: Pluto Portal Driver</title>
</properties>
@@ -294,7 +295,9 @@
<div align="center">
<p>
- <a href="../../images/v101/defaultPortalLayout.gif"><img src="../../images/v101/defaultPortalLayoutThumb.gif" alt="Default Portal Layout" border="0"/></a>
+ <a href="../../images/v101/default_portal_layout.jpg">
+ <img src="../../images/v101/default_portal_layout.jpg"
+ alt="Default Portal Layout" width="500"/></a>
</p>
<p>
<i><b><font size="-1">Figure 1. Default Portal Layout. Click on the picture to enlarge it</font></b></i>