Modified: portals/site-live/pluto/v101/developer/integrate.html URL: http://svn.apache.org/viewvc/portals/site-live/pluto/v101/developer/integrate.html?rev=1834161&r1=1834160&r2=1834161&view=diff ============================================================================== --- portals/site-live/pluto/v101/developer/integrate.html (original) +++ portals/site-live/pluto/v101/developer/integrate.html Fri Jun 22 19:35:14 2018 @@ -47,7 +47,7 @@ <div class="xleft"> - Last Published: 2016-12-02 + Last Published: 2018-06-22 | <a href="http://portals.apache.org/pluto"; class="externalLink">Home</a> </div> @@ -105,6 +105,10 @@ </li> <li class="none"> + <a href="../../security.html">Security</a> + </li> + + <li class="none"> <a href="../../status.html">Status</a> </li> @@ -136,27 +140,27 @@ <ul> <li class="none"> - <a href="../../v30/getting-started.html">Getting Started</a> + <a href="../../v301/getting-started.html">Getting Started</a> </li> <li class="none"> - <a href="../../v30/deploying.html">Deploying Portlets</a> + <a href="../../v301/deploying.html">Deploying Portlets</a> </li> <li class="none"> - <a href="../../v30/portlet-api.html">Portlet Concepts</a> + <a href="../../v301/portlet-api.html">Portlet Concepts</a> </li> <li class="none"> - <a href="../../v30/v3Features.html">Version 3 Features</a> + <a href="../../v301/v3Features.html">Version 3 Features</a> </li> <li class="none"> - <a href="../../v30/tck.html">Using the TCK</a> + <a href="../../v301/tck.html">Using the TCK</a> </li> <li class="none"> - <a href="../../v30/release-notes.html">Release Notes</a> + <a href="../../v301/release-notes.html">Release Notes</a> </li> </ul> <h5>Pluto 2.0</h5> @@ -250,8 +254,8 @@ </div> <div id="bodyColumn"> <div id="contentBox"> - <div class="section"><h2><a name="Integrating_Pluto_Into_Your_Container"></a>Integrating Pluto Into Your Container</h2> -<div class="section"><h3><a name="a1_Introduction"></a>1 Introduction</h3> + <div class="section"><h2><a name="Integrating_Pluto_Into_Your_Container"></a>Integrating Pluto Into Your Container</h2> +<div class="section"><h3><a name="a1_Introduction"></a>1 Introduction</h3> <p><a class="externalLink" 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 @@ -261,10 +265,10 @@ 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" /></a></p> + </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" /></a></p> <p><b><i>Figure 1. Basic portal architecture. Click on the picture to - enlarge it</i></b></p> + 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 @@ -278,9 +282,9 @@ 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> -</div> -<div class="section"><h3><a name="a2_Portlet_container_pluto"></a>2 Portlet container pluto</h3> + </p> +</div> +<div class="section"><h3><a name="a2_Portlet_container_pluto"></a>2 Portlet container pluto</h3> <p> The portlet container provides the runtime environment for the portlets. It is a core component of each portal, requires knowledge @@ -292,10 +296,10 @@ 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" /></a></p> + </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" /></a></p> <p><b><i>Figure 2. The portlet container's architecture. Click on the - picture to enlarge it</i></b></p> + 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 @@ -306,24 +310,24 @@ 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> -</div> -<div class="section"><h3><a name="a3_How_to_integrate_pluto_with_a_portal_framework"></a>3 How to integrate pluto with a portal framework</h3> + </p> +</div> +<div class="section"><h3><a name="a3_How_to_integrate_pluto_with_a_portal_framework"></a>3 How to integrate pluto with a portal framework</h3> <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> -<div class="section"><h3><a name="a3.1_Portlet_Container_Entrance_Point"></a>3.1 Portlet Container Entrance Point</h3> + </p> +<div class="section"><h3><a name="a3.1_Portlet_Container_Entrance_Point"></a>3.1 Portlet Container Entrance Point</h3> <p> The portlet container entrance point <code>org.apache.pluto.PortletContainer</code>, is the main @@ -332,31 +336,31 @@ 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: - <ul><li>Lifecycle methods are called only <b>once</b> (init/shutdown).<p>These methods are normally called directly from the service interfaces.</p> -</li> + <ul><li>Lifecycle methods are called only <b>once</b> (init/shutdown).<p>These methods are normally called directly from the service interfaces.</p> +</li> <li>Request-based methods are called for each request, but only once for all portlets (portletLoad).<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> + loaded and initialized before the request processing starts.</p> +</li> <li>Request-based methods are called for each request and for each portlet (processPortletAction, renderPortlet).<p>These methods are normally called during the page aggregation - as each portlet is being rendered.</p> -</li> -</ul> -</p> + as each portlet is being rendered.</p> +</li> +</ul> +</p> <p> The contract defined by this interface must be fulfilled by the calling party to guarantee that the portlet environment will work correctly. - </p> -</div> -<div class="section"><h3><a name="a3.2_Container_Services"></a>3.2 Container Services</h3> + </p> +</div> +<div class="section"><h3><a name="a3.2_Container_Services"></a>3.2 Container Services</h3> <p> ContainerServices are a generic plug-in concept for extending the core portlet container with additional functionality. @@ -367,7 +371,7 @@ 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 @@ -375,32 +379,32 @@ 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: <ul><li><b>Mandatory Base Services</b><p>ContainerServices that must be provided by the calling party - so that the portlet container is able to run.</p> + so that the portlet container is able to run.</p> <ul><li><b>Information Provider Service:</b> described in the next - sub section</li> + sub section</li> <li><b>Factory Manager Service:</b> Factory Service enables the portlet container to get implementation objects through a - factory concept.</li> + factory concept.</li> <li><b>Log Service:</b> This interface defines a logging - facility.</li> -</ul> -</li> + facility.</li> +</ul> +</li> <li><b>Optional Base Services</b><p>ContainerServices that can be provided by the calling party, - but the container can run without it.</p> + 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> + 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> -<div class="section"><h3><a name="a3.2.1_Information_Provider_Service"></a>3.2.1 Information Provider Service</h3> + titles.</li> +</ul> +</li> +</ul> +</p> +<div class="section"><h3><a name="a3.2.1_Information_Provider_Service"></a>3.2.1 Information Provider Service</h3> <p> The Information Provider is a callback mechanism for the portlet environment into the calling party (mostly framework), to get hold @@ -409,7 +413,7 @@ scopes of the requested information, the portlet environment defines two interfaces: the DynamicInformationProvider and the StaticInformationProvider. - </p> + </p> <p> The DynamicInformationProvider provides request-based information, which changes for each request. Consequently a new @@ -419,7 +423,7 @@ 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 @@ -430,7 +434,7 @@ 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 @@ -439,43 +443,43 @@ asks the calling party for an instance of one of the Information Providers and the calling party returns the correct Information Provider. - </p> -</div> -<div class="section"><h3><a name="a3.3_Portlet_Object_Model"></a>3.3 Portlet Object Model</h3> -<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> -<ul><li><strong>WebApplicationDefinition</strong> represents the context for the Portlet Application defined in the web.xml deployment descriptor.</li> -<li><strong>PortletApplicationDefinition</strong> describes a set (either all or a subset) of portlets that participate all in the same WebApplicationDefinition.</li> -<li><strong>PortletApplicationEntity</strong> is an instantiation of a PortletApplicationDefinition that is bound to a portal resource. It contains a set (either all or a subset) of portlets that participate all in the same PortletApplicationDefinition.</li> -<li><strong>ServletDefinition</strong> describes the portlet and its initial read-only properties that is not bound to any portal resource.</li> -<li><strong>Portlet Definition</strong> basic settings defined in the portlet.xml or set by administrators (read-only for users).</li> -<li><strong>Portlet Entity</strong> is a parameterized portlet definition, belonging to a user. </li> + </p> +</div> +<div class="section"><h3><a name="a3.3_Portlet_Object_Model"></a>3.3 Portlet Object Model</h3> +<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> +<ul><li><strong>WebApplicationDefinition</strong> represents the context for the Portlet Application defined in the web.xml deployment descriptor.</li> +<li><strong>PortletApplicationDefinition</strong> describes a set (either all or a subset) of portlets that participate all in the same WebApplicationDefinition.</li> +<li><strong>PortletApplicationEntity</strong> is an instantiation of a PortletApplicationDefinition that is bound to a portal resource. It contains a set (either all or a subset) of portlets that participate all in the same PortletApplicationDefinition.</li> +<li><strong>ServletDefinition</strong> describes the portlet and its initial read-only properties that is not bound to any portal resource.</li> +<li><strong>Portlet Definition</strong> basic settings defined in the portlet.xml or set by administrators (read-only for users).</li> +<li><strong>Portlet Entity</strong> is a parameterized portlet definition, belonging to a user. </li> <li><strong>Portlet Window</strong> is part of an aggregation tree that contains the portlet markup. The portlet window has navigational state attached to it. - </li> -</ul> -<p>Figure 3 depicts the relation between the different definitions and their hierarchical structure. The servlet definitions are embedded in the web application definition. From a web application definition several portlet application definitions can be created that may consist of portlet definitions based on the servlet definitions defined in the web application definition. Using the portlet application definition several portlet application entities can be created that include portlet entities that are based on the corresponding portlet definitions. Finally the portlet windows of a portlet entity are linked to their corresponding portlet entity.</p> -<div align="center"><p><a href="../../images/v101/Relations.jpg"><img src="../../images/v101/Relations.jpg" alt="Portal Architecture" /></a></p> + </li> +</ul> +<p>Figure 3 depicts the relation between the different definitions and their hierarchical structure. The servlet definitions are embedded in the web application definition. From a web application definition several portlet application definitions can be created that may consist of portlet definitions based on the servlet definitions defined in the web application definition. Using the portlet application definition several portlet application entities can be created that include portlet entities that are based on the corresponding portlet definitions. Finally the portlet windows of a portlet entity are linked to their corresponding portlet entity.</p> +<div align="center"><p><a href="../../images/v101/Relations.jpg"><img src="../../images/v101/Relations.jpg" alt="Portal Architecture" /></a></p> <p><b><i>Figure 3. Relations between the different application and portlet representations - </i></b></p> -</div><p>The portlet object model represents these different layers allowing the portlet container to access the information layer-based.</p> -<p>The object model is split into four different sub-packages:</p> -<ul><li>common<p>contains generic interfaces that can be reused</p> -</li> -<li>window<p>contains all interfaces handling with portlet windows</p> -</li> -<li>entity<p>contains all interfaces handling with portlet application entities and portlet entities</p> -</li> -<li>portlet<p>contains all interfaces handling with portlet application definitions and portlet definitions</p> -</li> -<li>servlet<p>contains all interfaces representing the web application definitions and servlet definitions</p> -</li> -</ul> -<p>For the implementation of the different artifacts in the object model the model-view-controller pattern is used and for each artifact a read-only interface exists, and if required an interface with the setter methods and the ending Ctrl is provided.</p> -</div> -</div> -</div> -</div> + </i></b></p> +</div><p>The portlet object model represents these different layers allowing the portlet container to access the information layer-based.</p> +<p>The object model is split into four different sub-packages:</p> +<ul><li>common<p>contains generic interfaces that can be reused</p> +</li> +<li>window<p>contains all interfaces handling with portlet windows</p> +</li> +<li>entity<p>contains all interfaces handling with portlet application entities and portlet entities</p> +</li> +<li>portlet<p>contains all interfaces handling with portlet application definitions and portlet definitions</p> +</li> +<li>servlet<p>contains all interfaces representing the web application definitions and servlet definitions</p> +</li> +</ul> +<p>For the implementation of the different artifacts in the object model the model-view-controller pattern is used and for each artifact a read-only interface exists, and if required an interface with the setter methods and the ending Ctrl is provided.</p> +</div> +</div> +</div> +</div> </div> </div> @@ -484,7 +488,7 @@ </div> <div id="footer"> <div class="xright">© - 2004-2016 + 2004-2018 Apache Software Foundation
Modified: portals/site-live/pluto/v101/developer/subversion.html URL: http://svn.apache.org/viewvc/portals/site-live/pluto/v101/developer/subversion.html?rev=1834161&r1=1834160&r2=1834161&view=diff ============================================================================== --- portals/site-live/pluto/v101/developer/subversion.html (original) +++ portals/site-live/pluto/v101/developer/subversion.html Fri Jun 22 19:35:14 2018 @@ -47,7 +47,7 @@ <div class="xleft"> - Last Published: 2016-12-02 + Last Published: 2018-06-22 | <a href="http://portals.apache.org/pluto"; class="externalLink">Home</a> </div> @@ -105,6 +105,10 @@ </li> <li class="none"> + <a href="../../security.html">Security</a> + </li> + + <li class="none"> <a href="../../status.html">Status</a> </li> @@ -136,27 +140,27 @@ <ul> <li class="none"> - <a href="../../v30/getting-started.html">Getting Started</a> + <a href="../../v301/getting-started.html">Getting Started</a> </li> <li class="none"> - <a href="../../v30/deploying.html">Deploying Portlets</a> + <a href="../../v301/deploying.html">Deploying Portlets</a> </li> <li class="none"> - <a href="../../v30/portlet-api.html">Portlet Concepts</a> + <a href="../../v301/portlet-api.html">Portlet Concepts</a> </li> <li class="none"> - <a href="../../v30/v3Features.html">Version 3 Features</a> + <a href="../../v301/v3Features.html">Version 3 Features</a> </li> <li class="none"> - <a href="../../v30/tck.html">Using the TCK</a> + <a href="../../v301/tck.html">Using the TCK</a> </li> <li class="none"> - <a href="../../v30/release-notes.html">Release Notes</a> + <a href="../../v301/release-notes.html">Release Notes</a> </li> </ul> <h5>Pluto 2.0</h5> @@ -250,7 +254,7 @@ </div> <div id="bodyColumn"> <div id="contentBox"> - <div class="section"><h2><a name="Developer_Guide:_Obtaining_the_Pluto_1.0.1_Source_Code"></a>Developer Guide: Obtaining the Pluto 1.0.1 Source Code</h2> + <div class="section"><h2><a name="Developer_Guide:_Obtaining_the_Pluto_1.0.1_Source_Code"></a>Developer Guide: Obtaining the Pluto 1.0.1 Source Code</h2> <p> There are several reasons why you may want to have access to the Pluto source code. Some may want to participate in @@ -258,52 +262,52 @@ to utilize Pluto as a reference implementation to clarify the Portlet Specification. Whatever the reason, there are two ways to access the source code: - </p> + </p> <p><ol type="1"><li><a href="#Downloading_the_Source_Distribution">Downloading the most recent Source Distribution</a> is the easiest way to access the source. Of course, because this method is reliant on releases, you may not have the most recent source. That said, you do have a better chance at recieving a more stable codebase if you are using a distribution. - </li> + </li> <li><A href="#Using_Subversion">Using Subversion</A> to checkout the absolute up-to-date version of the code is the best way to retrieve the source code. If you plan to submit patches, we ask that you use the Subversion Trunk to create your diffs. - </li> -</ol> -</p> -<div class="section"><h3><a name="Downloading_the_Source_Distribution"></a>Downloading the Source Distribution</h3> -<p>See the <a href="../../mirrors.cgi">download instructions</a></p> -</div> -<div class="section"><h3><a name="Using_Subversion"></a>Using Subversion</h3> + </li> +</ol> +</p> +<div class="section"><h3><a name="Downloading_the_Source_Distribution"></a>Downloading the Source Distribution</h3> +<p>See the <a href="../../mirrors.cgi">download instructions</a></p> +</div> +<div class="section"><h3><a name="Using_Subversion"></a>Using Subversion</h3> <p>The Pluto project uses the <a class="externalLink" href="http://subversion.tigris.org/";>Subversion</a> version control system. If you're new to Subversion, you can check out the <a class="externalLink" href="http://svnbook.red-bean.com/";>online book</a> about Subversion. Note that we are currently using Subversion 1.1.x (there are separate versions of the book covering 1.0 and 1.1). - </p> + </p> <h2>Web Access to Subversion</h2><p> If you just want to browse the Pluto 1.0.1 source code, you can use the <a class="externalLink" href="http://svn.apache.org/viewcvs.cgi/portals/pluto/tags/release-1.0.1?root=Apache-SVN";>ViewCVS web interface</a> to Subversion. This is current at all times. - </p> + </p> <h2>Normal Subversion Access</h2><p>Anyone can check code out of Subversion anonymously. However, you need to specify a username and password in order to update the Subversion repository, and only Pluto committers have the permissions to do that. We run Subversion over standard HTTPS, so hopefully you won't have problems with intervening - firewalls.</p> + firewalls.</p> <h3>Check out from Subversion</h3><p>Again, anyone can do this. To check out Pluto 1.0.1 (general release) to a directory called 'pluto' use this command: - </p> + </p> <pre>svn checkout https://svn.apache.org/repos/asf/portals/pluto/tags/release-1.0.1/ pluto</pre><p>To check out Pluto 1.0.1 (bug fix version) use this command: - </p> + </p> <pre>svn checkout https://svn.apache.org/repos/asf/portals/pluto/branches/pluto-1.0.2/ pluto</pre><p>This code base will become Pluto 1.0.2 if we feel necessary to release a new version. - </p> -</div> -</div> + </p> +</div> +</div> </div> </div> @@ -312,7 +316,7 @@ </div> <div id="footer"> <div class="xright">© - 2004-2016 + 2004-2018 Apache Software Foundation Modified: portals/site-live/pluto/v101/install.html URL: http://svn.apache.org/viewvc/portals/site-live/pluto/v101/install.html?rev=1834161&r1=1834160&r2=1834161&view=diff ============================================================================== --- portals/site-live/pluto/v101/install.html (original) +++ portals/site-live/pluto/v101/install.html Fri Jun 22 19:35:14 2018 @@ -47,7 +47,7 @@ <div class="xleft"> - Last Published: 2017-01-13 + Last Published: 2018-06-22 | <a href="http://portals.apache.org/pluto"; class="externalLink">Home</a> </div> @@ -105,6 +105,10 @@ </li> <li class="none"> + <a href="../security.html">Security</a> + </li> + + <li class="none"> <a href="../status.html">Status</a> </li> @@ -136,27 +140,27 @@ <ul> <li class="none"> - <a href="../v30/getting-started.html">Getting Started</a> + <a href="../v301/getting-started.html">Getting Started</a> </li> <li class="none"> - <a href="../v30/deploying.html">Deploying Portlets</a> + <a href="../v301/deploying.html">Deploying Portlets</a> </li> <li class="none"> - <a href="../v30/portlet-api.html">Portlet Concepts</a> + <a href="../v301/portlet-api.html">Portlet Concepts</a> </li> <li class="none"> - <a href="../v30/v3Features.html">Version 3 Features</a> + <a href="../v301/v3Features.html">Version 3 Features</a> </li> <li class="none"> - <a href="../v30/tck.html">Using the TCK</a> + <a href="../v301/tck.html">Using the TCK</a> </li> <li class="none"> - <a href="../v30/release-notes.html">Release Notes</a> + <a href="../v301/release-notes.html">Release Notes</a> </li> </ul> <h5>Pluto 2.0</h5> @@ -250,57 +254,57 @@ </div> <div id="bodyColumn"> <div id="contentBox"> - <div class="section"><h2><a name="Installation_Guide"></a>Installation Guide</h2> + <div class="section"><h2><a name="Installation_Guide"></a>Installation Guide</h2> <p> This install guide covers the following types of installations: - <ul><li><a href="#Installing_Pluto_Distributions">Installing Pluto Distributions</a></li> -<li><a href="#Installing_Portlets">Installing Portlets</a></li> -<ul><li><a href="#Installing_With_Maven">Installing with Maven</a></li> -<li><a href="#Using_the_Admin_Portlet_Application">Using the Admin Portlet Application</a></li> -</ul> -</ul> -</p> -</div> -<div class="section"><h2><a name="Installing_Pluto_Distributions"></a>Installing Pluto Distributions</h2> -<div class="section"><h3><a name="Binary_Distribution"></a>Binary Distribution</h3> + <ul><li><a href="#Installing_Pluto_Distributions">Installing Pluto Distributions</a></li> +<li><a href="#Installing_Portlets">Installing Portlets</a></li> +<ul><li><a href="#Installing_With_Maven">Installing with Maven</a></li> +<li><a href="#Using_the_Admin_Portlet_Application">Using the Admin Portlet Application</a></li> +</ul> +</ul> +</p> +</div> +<div class="section"><h2><a name="Installing_Pluto_Distributions"></a>Installing Pluto Distributions</h2> +<div class="section"><h3><a name="Binary_Distribution"></a>Binary Distribution</h3> <p> The binary distribution of Pluto is packaged with Tomcat (currently version 5.5.9). Pluto leverages Tomcat to provide the web container in which the Pluto portlet container executes. The binary distribution includes the Pluto Portlet Container, The Portal Driver, the Pluto Testsuite and the Admin Portlet application. - </p> + </p> <p> To install the binary distribution: <ul><li><a href="#mirrors.cgi">Download</a> the current binary - distribution of Pluto</li> + distribution of Pluto</li> <li>Extract the binary distribution to a directory from here forward - refered to as <code>"<PLUTO_HOME>"</code>.</li> + refered to as <code>"<PLUTO_HOME>"</code>.</li> <li>Startup the server by using the appropriate tomcat startup script located at <code><PLUTO_HOME>/bin</code>. For *nix use <code>startup.sh</code>; for windows use - <code>startup.bat</code>.</li> + <code>startup.bat</code>.</li> <li>By default Tomcat 5.5 uses JDK 1.5 (J2SE 5.0). In order to run it with JDK 1.4, a compatibility package needs to be downloaded and installed. See the Running.txt file in the root directory for - details.</li> + details.</li> <li>Point your browser to <code>http://localhost:8080/pluto/portal</code>, - the Pluto Driver, and your ready to go!</li> -</ul> -</p> -</div> -<div class="section"><h3><a name="Library_Distributions"></a>Library Distributions</h3> + the Pluto Driver, and your ready to go!</li> +</ul> +</p> +</div> +<div class="section"><h3><a name="Library_Distributions"></a>Library Distributions</h3> <p> The pluto library distributions are packaged to allow integration with an external portal server. - </p> + </p> <p> To install the library distributions to your portal server, ensure that the pluto-x.x.x.jar is loaded by a classloader to which both the portal and portlet application web apps have access. - </p> -</div> -<div class="section"><h3><a name="Source_Distribution"></a>Source Distribution</h3> + </p> +</div> +<div class="section"><h3><a name="Source_Distribution"></a>Source Distribution</h3> <p> Installing the source distribution requires the most effort, and is recomended only for those individuals who are interested in modifying @@ -308,79 +312,79 @@ source code repository at a given time. Because of this, please see the build instructions, which will provide information about how to build Pluto from scratch. - </p> + </p> <p> To install the source distribution into Tomcat: - <ul><li>Install Java 1.4 or greater</li> -<li>Install Maven 1.0 or greater</li> + <ul><li>Install Java 1.4 or greater</li> +<li>Install Maven 1.0 or greater</li> <li>Install Tomcat 4.x or Tomcat 5.x to a directory from here - forward refered to as <code><TOMCAT_HOME></code></li> + forward refered to as <code><TOMCAT_HOME></code></li> <li>Edit your <code><PLUTO_HOME>/build.properties</code> to include the following properties: - <table class="bodyTable"><tr class="a"><th>Property</th> -<th>Value</th> -<th>Example(s)</th> -</tr> -<tr class="b"><td>maven.tomcat.home</td> -<td>Tomcat Installation Directory</td> + <table class="bodyTable"><tr class="a"><th>Property</th> +<th>Value</th> +<th>Example(s)</th> +</tr> +<tr class="b"><td>maven.tomcat.home</td> +<td>Tomcat Installation Directory</td> <td><code>/usr/local/apache-tomcat.5.0.27</code>, - <code>c:\\apache-tomcat.5.0.27</code></td> -</tr> -<tr class="a"><td>maven.tomcat.version.major</td> -<td>Tomcat Major Version Number</td> -<td>5</td> -</tr> -</table> -</li> + <code>c:\\apache-tomcat.5.0.27</code></td> +</tr> +<tr class="a"><td>maven.tomcat.version.major</td> +<td>Tomcat Major Version Number</td> +<td>5</td> +</tr> +</table> +</li> <li>From <code><PLUTO_HOME></code> issue the command: - <code>maven fullDeployment</code></li> + <code>maven fullDeployment</code></li> <li>Startup the server by using the appropriate Tomcat startup script located at <code><PLUTO_HOME>/bin</code>. For *nix use <code>startup.sh</code>; for windows use - <code>startup.bat</code>.</li> + <code>startup.bat</code>.</li> <li>Point your browser to <code>http://localhost:8080/pluto/portal</code>, the Pluto Driver, - and your ready to go!</li> -</ul> -</p> -</div> -</div> -<div class="section"><h2><a name="Installing_Portlets"></a>Installing Portlets</h2> -<div class="section"><h3><a name="Installing_with_Maven"></a>Installing with Maven</h3> + and your ready to go!</li> +</ul> +</p> +</div> +</div> +<div class="section"><h2><a name="Installing_Portlets"></a>Installing Portlets</h2> +<div class="section"><h3><a name="Installing_with_Maven"></a>Installing with Maven</h3> <p><span style="color: #FF0000;">Currently, to automate the deployment/installation of portlets you must utilize the source distribution of pluto. Alternatively, you could use the <a href="#Using_the_Admin_Portlet_Application">Admin Portlet - Application</a> to install custom portlets.</span></p> + Application</a> to install custom portlets.</span></p> <p> In order to deploy a portlet application to pluto, you must follow the steps below: - </p> + </p> <p><b>Step 1:</b> Assemble your portlet application into a valid war. - </p> + </p> <p><b>Step 2:</b> Run the maven deploy goal on your war. This can be done by running this command line in the deploy subdirectory: <div class="source"><pre> maven deploy -Ddeploy=/MyPathToMyPortlet/target/MyPortlet.war - </pre> -</div> + </pre> +</div> See the <a href="developer/build_source.html">Building From Source</a> document for detailed instructions. - </p> + </p> <p> Alternatively, there is an interactive ant script in the <code>portlet-deploy</code> directory that will perform the same task as the Maven deployment goal. - </p> + </p> <p><b>Step 3:</b> Modify the Portlet Entity Registry and the Page Registry and Portlet Contexts files. These configuration files are located at: - <ul><li><code>[portal-home]/WEB-INF/data/portletentityregistry.xml</code></li> -<li><code>[portal-home]/WEB-INF/data/pageregistry.xml</code></li> -<li><code>[portal-home]/WEB-INF/data/portletcontexts.txt</code></li> -</ul> -</p> + <ul><li><code>[portal-home]/WEB-INF/data/portletentityregistry.xml</code></li> +<li><code>[portal-home]/WEB-INF/data/pageregistry.xml</code></li> +<li><code>[portal-home]/WEB-INF/data/portletcontexts.txt</code></li> +</ul> +</p> <p> The Portlet Entity Registry file requires that you specify an application and a Portlet ID for your new Portlet. The Application ID @@ -389,7 +393,7 @@ maven deploy -Ddeploy=/MyPathToMyPortlet information is used to map the Portlet name to the appropriate class path for loading the class. The following is an example of some additions you can make to the entity registry file: - </p> + </p> <p><div class="source"><pre> <application id="6"> <definition-id>MyPortlet</definition-id> @@ -397,14 +401,14 @@ maven deploy -Ddeploy=/MyPathToMyPortlet <definition-id>MyPortlet.MyPortlet</definition-id> </portlet> </application> - </pre> -</div> -</p> + </pre> +</div> +</p> <p> The Page Registry provides Pluto with the layout information for your Portlet. The names used in the fragments must be unique as done in the following example: - </p> + </p> <p><div class="source"><pre> <fragment name="MyPortlet" type="page"> <navigation> @@ -423,9 +427,9 @@ maven deploy -Ddeploy=/MyPathToMyPortlet ... ... </fragment> - </pre> -</div> -</p> + </pre> +</div> +</p> <p> The Portlet Contexts file (<code>portletcontexts.txt</code>) lists the webapp contexts for each portlet application that runs in Pluto. @@ -434,44 +438,44 @@ maven deploy -Ddeploy=/MyPathToMyPortlet 'path' attribute of the 'Context' element in a context XML descriptor in <code><TOMCAT_HOME>/conf/Catalina/localhost</code> (or another 'conf' subdirectory). - </p> -</div> -<div class="section"><h3><a name="Using_the_Admin_Portlet_Application"></a>Using the Admin Portlet Application</h3> + </p> +</div> +<div class="section"><h3><a name="Using_the_Admin_Portlet_Application"></a>Using the Admin Portlet Application</h3> <p> The Admin Portlet Application allows you to deploy custom portlets using an interface in Pluto's portal. This application automatically places the custom portlets to their proper place and updates the registries. - </p> + </p> <p> Deploying a custom portlet application to Pluto using the Admin Portlet Application requires the following steps: - <ul><li>Assemble your portlet application into a valid war.</li> + <ul><li>Assemble your portlet application into a valid war.</li> <li>Start Pluto and navigate to <code>http://localhost:8080/pluto/portal</code>, the local Pluto - home page.</li> + home page.</li> <li>Click on the Admin navigation link. The Admin Portlet App should - appear.</li> + appear.</li> <li>In the Deploy War Portlet, click on the Browse button and select - your war file</li> -<li>Click on the Submit button of the Deploy War Portlet</li> + your war file</li> +<li>Click on the Submit button of the Deploy War Portlet</li> <li>In the resulting page, fill in the Title, Description (optional), and the number of rows and columns you desire for laying out the - portlets. Click on Submit</li> + portlets. Click on Submit</li> <li>In the resulting page, select from the drop downs which portlet - will be deployed in a particular row and column. Click on Submit.</li> + will be deployed in a particular row and column. Click on Submit.</li> <li>After returning to the Deploy War Portlet 'home page', click on the blue 'Hot deploy ...' link to hot deploy the new portlet app and - get redirected to its page.</li> -</ul> -</p> + get redirected to its page.</li> +</ul> +</p> <p> Check out the Deploy War Portlet's help mode (help link) for information on redeploying and undeploying portlets and troubleshooting problems. - </p> -</div> -</div> + </p> +</div> +</div> </div> </div> @@ -480,7 +484,7 @@ maven deploy -Ddeploy=/MyPathToMyPortlet </div> <div id="footer"> <div class="xright">© - 2004-2017 + 2004-2018 Apache Software Foundation Modified: portals/site-live/pluto/v101/resources.html URL: http://svn.apache.org/viewvc/portals/site-live/pluto/v101/resources.html?rev=1834161&r1=1834160&r2=1834161&view=diff ============================================================================== --- portals/site-live/pluto/v101/resources.html (original) +++ portals/site-live/pluto/v101/resources.html Fri Jun 22 19:35:14 2018 @@ -47,7 +47,7 @@ <div class="xleft"> - Last Published: 2017-01-13 + Last Published: 2018-06-22 | <a href="http://portals.apache.org/pluto"; class="externalLink">Home</a> </div> @@ -105,6 +105,10 @@ </li> <li class="none"> + <a href="../security.html">Security</a> + </li> + + <li class="none"> <a href="../status.html">Status</a> </li> @@ -136,27 +140,27 @@ <ul> <li class="none"> - <a href="../v30/getting-started.html">Getting Started</a> + <a href="../v301/getting-started.html">Getting Started</a> </li> <li class="none"> - <a href="../v30/deploying.html">Deploying Portlets</a> + <a href="../v301/deploying.html">Deploying Portlets</a> </li> <li class="none"> - <a href="../v30/portlet-api.html">Portlet Concepts</a> + <a href="../v301/portlet-api.html">Portlet Concepts</a> </li> <li class="none"> - <a href="../v30/v3Features.html">Version 3 Features</a> + <a href="../v301/v3Features.html">Version 3 Features</a> </li> <li class="none"> - <a href="../v30/tck.html">Using the TCK</a> + <a href="../v301/tck.html">Using the TCK</a> </li> <li class="none"> - <a href="../v30/release-notes.html">Release Notes</a> + <a href="../v301/release-notes.html">Release Notes</a> </li> </ul> <h5>Pluto 2.0</h5> @@ -250,31 +254,31 @@ </div> <div id="bodyColumn"> <div id="contentBox"> - <div class="section"><h2><a name="Resources"></a>Resources</h2> -<p><table class="bodyTable"><tr class="a"><th>Resource</th> -<th>Type</th> -</tr> -<tr class="b"><td><a href="http://jcp.org/en/jsr/detail?id=168"; class="externalLink">JSR 168</a></td> -<td>JCP Request Info</td> -</tr> -<tr class="a"><td><a href="http://jcp.org/en/jsr/detail?id=286"; class="externalLink">JSR 286</a></td> -<td>JCP Request Info</td> -</tr> -<tr class="b"><td><a href="http://jcp.org/aboutJava/communityprocess/final/jsr168/index.html"; class="externalLink">Portlet Specification 1.0</a></td> -<td>Specification</td> -</tr> -<tr class="a"><td><a href="http://people.apache.org/~zheng/pluto/chinese/"; class="externalLink">Chinese translation of Pluto website</a></td> -<td>Documentation</td> -</tr> -<tr class="b"><td><a href="http://today.java.net/pub/a/today/2005/02/18/josso.html"; class="externalLink">Integrating Java Open Single Sign-On in Pluto</a></td> -<td>Documentation</td> -</tr> -<tr class="a"><td><a href="http://www.theserverside.com/articles/article.tss?l=ClusteringTomcat"; class="externalLink">Clustering JSR-168 Portlet Applications in Tomcat</a></td> -<td>Documentation</td> -</tr> -</table> -</p> -</div> + <div class="section"><h2><a name="Resources"></a>Resources</h2> +<p><table class="bodyTable"><tr class="a"><th>Resource</th> +<th>Type</th> +</tr> +<tr class="b"><td><a class="externalLink" href="http://jcp.org/en/jsr/detail?id=168";>JSR 168</a></td> +<td>JCP Request Info</td> +</tr> +<tr class="a"><td><a class="externalLink" href="http://jcp.org/en/jsr/detail?id=286";>JSR 286</a></td> +<td>JCP Request Info</td> +</tr> +<tr class="b"><td><a class="externalLink" href="http://jcp.org/aboutJava/communityprocess/final/jsr168/index.html";>Portlet Specification 1.0</a></td> +<td>Specification</td> +</tr> +<tr class="a"><td><a class="externalLink" href="http://people.apache.org/~zheng/pluto/chinese/";>Chinese translation of Pluto website</a></td> +<td>Documentation</td> +</tr> +<tr class="b"><td><a class="externalLink" href="http://today.java.net/pub/a/today/2005/02/18/josso.html";>Integrating Java Open Single Sign-On in Pluto</a></td> +<td>Documentation</td> +</tr> +<tr class="a"><td><a class="externalLink" href="http://www.theserverside.com/articles/article.tss?l=ClusteringTomcat";>Clustering JSR-168 Portlet Applications in Tomcat</a></td> +<td>Documentation</td> +</tr> +</table> +</p> +</div> </div> </div> @@ -283,7 +287,7 @@ </div> <div id="footer"> <div class="xright">© - 2004-2017 + 2004-2018 Apache Software Foundation Modified: portals/site-live/pluto/v101/userguide/index.html URL: http://svn.apache.org/viewvc/portals/site-live/pluto/v101/userguide/index.html?rev=1834161&r1=1834160&r2=1834161&view=diff ============================================================================== --- portals/site-live/pluto/v101/userguide/index.html (original) +++ portals/site-live/pluto/v101/userguide/index.html Fri Jun 22 19:35:14 2018 @@ -47,7 +47,7 @@ <div class="xleft"> - Last Published: 2016-12-02 + Last Published: 2018-06-22 | <a href="http://portals.apache.org/pluto"; class="externalLink">Home</a> </div> @@ -105,6 +105,10 @@ </li> <li class="none"> + <a href="../../security.html">Security</a> + </li> + + <li class="none"> <a href="../../status.html">Status</a> </li> @@ -136,27 +140,27 @@ <ul> <li class="none"> - <a href="../../v30/getting-started.html">Getting Started</a> + <a href="../../v301/getting-started.html">Getting Started</a> </li> <li class="none"> - <a href="../../v30/deploying.html">Deploying Portlets</a> + <a href="../../v301/deploying.html">Deploying Portlets</a> </li> <li class="none"> - <a href="../../v30/portlet-api.html">Portlet Concepts</a> + <a href="../../v301/portlet-api.html">Portlet Concepts</a> </li> <li class="none"> - <a href="../../v30/v3Features.html">Version 3 Features</a> + <a href="../../v301/v3Features.html">Version 3 Features</a> </li> <li class="none"> - <a href="../../v30/tck.html">Using the TCK</a> + <a href="../../v301/tck.html">Using the TCK</a> </li> <li class="none"> - <a href="../../v30/release-notes.html">Release Notes</a> + <a href="../../v301/release-notes.html">Release Notes</a> </li> </ul> <h5>Pluto 2.0</h5> @@ -250,54 +254,54 @@ </div> <div id="bodyColumn"> <div id="contentBox"> - <div class="section"><h2><a name="User_Guide"></a>User Guide</h2> -<div class="section"><h3><a name="Prerequisites"></a>Prerequisites</h3> + <div class="section"><h2><a name="User_Guide"></a>User Guide</h2> +<div class="section"><h3><a name="Prerequisites"></a>Prerequisites</h3> <p>It is expected that the reader of the user guide documentation should has an understanding of Java Web Application development, and - Java Portlet Development.</p> -</div> -<div class="section"><h3><a name="Pluto_-_The_Pluto_Container"></a>Pluto - The Pluto Container</h3> + Java Portlet Development.</p> +</div> +<div class="section"><h3><a name="Pluto_-_The_Pluto_Container"></a>Pluto - The Pluto Container</h3> <p> Pluto is the reference implementation of the Portlet Specification. It is a portlet container which manages the lifecycle and request processing of portlets which adhere to the specification. -</p> +</p> <p> In an of itself, Pluto is not very usefull to the end user. As a container, it does not have any understanding of portlet invocation, portlet aggregation or other portal specific features. -</p> +</p> <p> For more information on how to integrate Pluto into your portal, please see the <A href="../developer/integration.html">developer guides</A>. -</p> -</div> -<div class="section"><h3><a name="Pluto_Portal_Driver_-_The_Test_Portal"></a>Pluto Portal Driver - The Test Portal</h3> +</p> +</div> +<div class="section"><h3><a name="Pluto_Portal_Driver_-_The_Test_Portal"></a>Pluto Portal Driver - The Test Portal</h3> <p> The Pluto Portal Driver is a simple portal implementation that is provided for convenience sake. It's purpose is to provide aggregation support so that Pluto may be easily tested, and portlets may be easily developed. -</p> +</p> <p> For information on how to use, configure, and customize the Portal Driver, please see the <A href="portal.html">Portal Driver User Guide</A>. -</p> -</div> -<div class="section"><h3><a name="Pluto_TestSuite_-_The_Test_Portlet_Application"></a>Pluto TestSuite - The Test Portlet Application</h3> +</p> +</div> +<div class="section"><h3><a name="Pluto_TestSuite_-_The_Test_Portlet_Application"></a>Pluto TestSuite - The Test Portlet Application</h3> <p> The Pluto TestSuite is a Portlet Application which can be used to test Portlet Implementations. The TestSuite tests several basic portlet functions and is a quick and dirty way to test for Portlet Specification compliance. While a quick test of a portal using the testsuite won't garuntee compliance, it will help flag any notable incompliance. -</p> +</p> <p> For information on how to use and configure the TestSuite, please see - the <A href="testsuite.html">TestSuite User Guide</A></p> -</div> -</div> + the <A href="testsuite.html">TestSuite User Guide</A></p> +</div> +</div> </div> </div> @@ -306,7 +310,7 @@ </div> <div id="footer"> <div class="xright">© - 2004-2016 + 2004-2018 Apache Software Foundation Modified: portals/site-live/pluto/v101/userguide/portal.html URL: http://svn.apache.org/viewvc/portals/site-live/pluto/v101/userguide/portal.html?rev=1834161&r1=1834160&r2=1834161&view=diff ============================================================================== --- portals/site-live/pluto/v101/userguide/portal.html (original) +++ portals/site-live/pluto/v101/userguide/portal.html Fri Jun 22 19:35:14 2018 @@ -47,7 +47,7 @@ <div class="xleft"> - Last Published: 2016-12-02 + Last Published: 2018-06-22 | <a href="http://portals.apache.org/pluto"; class="externalLink">Home</a> </div> @@ -105,6 +105,10 @@ </li> <li class="none"> + <a href="../../security.html">Security</a> + </li> + + <li class="none"> <a href="../../status.html">Status</a> </li> @@ -136,27 +140,27 @@ <ul> <li class="none"> - <a href="../../v30/getting-started.html">Getting Started</a> + <a href="../../v301/getting-started.html">Getting Started</a> </li> <li class="none"> - <a href="../../v30/deploying.html">Deploying Portlets</a> + <a href="../../v301/deploying.html">Deploying Portlets</a> </li> <li class="none"> - <a href="../../v30/portlet-api.html">Portlet Concepts</a> + <a href="../../v301/portlet-api.html">Portlet Concepts</a> </li> <li class="none"> - <a href="../../v30/v3Features.html">Version 3 Features</a> + <a href="../../v301/v3Features.html">Version 3 Features</a> </li> <li class="none"> - <a href="../../v30/tck.html">Using the TCK</a> + <a href="../../v301/tck.html">Using the TCK</a> </li> <li class="none"> - <a href="../../v30/release-notes.html">Release Notes</a> + <a href="../../v301/release-notes.html">Release Notes</a> </li> </ul> <h5>Pluto 2.0</h5> @@ -250,30 +254,30 @@ </div> <div id="bodyColumn"> <div id="contentBox"> - <div class="section"><h2><a name="User_Guide:_Pluto_1.0.1_Portal_Driver"></a>User Guide: Pluto 1.0.1 Portal Driver</h2> -<p><ul><li><A href="#Limitations">Limitations</A></li> -<li><A href="#Configuration">Configuration</A></li> -<li><A href="#Defining_the_Portal_Layout">Defining the Portal Layout</A></li> -<li><A href="#Advanced_Customization">Advanced Customization</A></li> -<li><A href="#Internationalization">Internationalization</A></li> -<li><A href="#Further_Information">Further Information</A></li> -</ul> -</p> -</div> -<div class="section"><h2><a name="Limitations"></a>Limitations</h2> + <div class="section"><h2><a name="User_Guide:_Pluto_1.0.1_Portal_Driver"></a>User Guide: Pluto 1.0.1 Portal Driver</h2> +<p><ul><li><A href="#Limitations">Limitations</A></li> +<li><A href="#Configuration">Configuration</A></li> +<li><A href="#Defining_the_Portal_Layout">Defining the Portal Layout</A></li> +<li><A href="#Advanced_Customization">Advanced Customization</A></li> +<li><A href="#Internationalization">Internationalization</A></li> +<li><A href="#Further_Information">Further Information</A></li> +</ul> +</p> +</div> +<div class="section"><h2><a name="Limitations"></a>Limitations</h2> <p> The Pluto Portal is intended to provide an example implementation of how to integrate Pluto into a portal. Additionally, it may be used for the development of compliant portlets. In some places it lacks the flexibility a true portal supplies. The portal is not designed for maximum performance, but rather simplicity. - </p> + </p> <p> To learn how to embed Pluto in your own portal, see the - "<a href="../developer/integrate.html">Integration Guide</a>" document.</p> -</div> -<div class="section"><h2><a name="Configuration"></a>Configuration</h2> -<div class="section"><h3><a name="Default_Configuration"></a>Default Configuration</h3> + "<a href="../developer/integrate.html">Integration Guide</a>" document.</p> +</div> +<div class="section"><h2><a name="Configuration"></a>Configuration</h2> +<div class="section"><h3><a name="Default_Configuration"></a>Default Configuration</h3> <p> Upon installation of the binary distribution of Pluto 1.0.1, the portal driver is made available at <code>http://localhost:8080/pluto/portal</code>. @@ -282,118 +286,118 @@ portlet for installing custom portlets and viewing the repositories. This configuration is also the default for installations completed from the source distribution (or Subversion repository) and deployed using the Pluto deploy tool. - </p> -<p><table class="bodyTable"><caption><B>Default Configuration for Binary Distributions:</B></caption><tr class="a"><th>Configuration</th> -<th>Platform</th> -<th>Value</th> -<th>Description</th> -</tr> -<tr class="b"><td>Installation Directory</td> -<td>All</td> -<td><PLUTO_HOME></td> -<td>The directory to which you unarchived the distribution</td> -</tr> -<tr class="a"><td>Startup Scripts</td> -<td>*nix</td> -<td><PLUTO_HOME>/bin/startup.sh</td> -<td>The script used to startup the portal driver</td> -</tr> -<tr class="b"><td>Startup Scripts</td> -<td>Windows</td> -<td><PLUTO_HOME>/bin/startup.bat</td> -<td>The script used to startup the portal driver</td> -</tr> -<tr class="a"><td>Context Configuration</td> -<td>All</td> -<td><PLUTO_HOME>/conf/Catalina/localhost/pluto.xml</td> -<td>The Tomcat Context Configuration file</td> -</tr> -</table> -</p> -<p><table class="bodyTable"><caption><B>Default Configuration for Source Distributions:</B></caption><tr class="b"><th>Configuration</th> -<th>Platform</th> -<th>Value</th> -<th>Description</th> -</tr> -<tr class="a"><td>Installation Directory</td> -<td>All</td> -<td>${maven.tomcat.home}</td> -<td>The tomcat installation directory to which pluto has been installed</td> -</tr> -<tr class="b"><td>Startup Scipts</td> -<td>*nix</td> -<td>${maven.tomcat.home}/bin/startup.sh</td> -<td>The script used to startup the portal driver</td> -</tr> -<tr class="a"><td>Startup Scipts</td> -<td>Windows</td> -<td>${maven.tomcat.home}/bin/startup.bat</td> -<td>The script used to startup the portal driver</td> -</tr> -<tr class="b"><td>Context Configuration</td> -<td>Tomcat 5.5</td> -<td>${maven.tomcat.home}/conf/Catalina/localhost/pluto.xml</td> -<td>The Tomcat Context Configuration file</td> -</tr> -</table> -</p> + </p> +<p><table class="bodyTable"><caption><B>Default Configuration for Binary Distributions:</B></caption><tr class="a"><th>Configuration</th> +<th>Platform</th> +<th>Value</th> +<th>Description</th> +</tr> +<tr class="b"><td>Installation Directory</td> +<td>All</td> +<td><PLUTO_HOME></td> +<td>The directory to which you unarchived the distribution</td> +</tr> +<tr class="a"><td>Startup Scripts</td> +<td>*nix</td> +<td><PLUTO_HOME>/bin/startup.sh</td> +<td>The script used to startup the portal driver</td> +</tr> +<tr class="b"><td>Startup Scripts</td> +<td>Windows</td> +<td><PLUTO_HOME>/bin/startup.bat</td> +<td>The script used to startup the portal driver</td> +</tr> +<tr class="a"><td>Context Configuration</td> +<td>All</td> +<td><PLUTO_HOME>/conf/Catalina/localhost/pluto.xml</td> +<td>The Tomcat Context Configuration file</td> +</tr> +</table> +</p> +<p><table class="bodyTable"><caption><B>Default Configuration for Source Distributions:</B></caption><tr class="b"><th>Configuration</th> +<th>Platform</th> +<th>Value</th> +<th>Description</th> +</tr> +<tr class="a"><td>Installation Directory</td> +<td>All</td> +<td>${maven.tomcat.home}</td> +<td>The tomcat installation directory to which pluto has been installed</td> +</tr> +<tr class="b"><td>Startup Scipts</td> +<td>*nix</td> +<td>${maven.tomcat.home}/bin/startup.sh</td> +<td>The script used to startup the portal driver</td> +</tr> +<tr class="a"><td>Startup Scipts</td> +<td>Windows</td> +<td>${maven.tomcat.home}/bin/startup.bat</td> +<td>The script used to startup the portal driver</td> +</tr> +<tr class="b"><td>Context Configuration</td> +<td>Tomcat 5.5</td> +<td>${maven.tomcat.home}/conf/Catalina/localhost/pluto.xml</td> +<td>The Tomcat Context Configuration file</td> +</tr> +</table> +</p> <p>When the Pluto Portal is first installed, it is made available at - the address http://localhost:8080/pluto/portal/.</p> + the address http://localhost:8080/pluto/portal/.</p> <p>This location can be customized, using standard Tomcat functionality. To modify the <i>pluto</i> part of the - location, alter the path mapping in pluto's context configuration file <i>pluto.xml</i></p> + location, alter the path mapping in pluto's context configuration file <i>pluto.xml</i></p> <p>Under Tomcat 5.5, pluto.xml will be located - in the ${TOMCAT_HOME}/conf/Catalina/ directory. </p> -<p>In order to modify the context Pluto is running under, modify the <i>path</i> attribute:</p> + in the ${TOMCAT_HOME}/conf/Catalina/ directory. </p> +<p>In order to modify the context Pluto is running under, modify the <i>path</i> attribute:</p> <p><b>Before:</b><div class="source"><pre> <Context path="/pluto" docBase="pluto" crossContext="true"> </Context> - </pre> -</div> -</p> + </pre> +</div> +</p> <p><b>After:</b><div class="source"><pre> <Context path="/newlocation" docBase="pluto" crossContext="true"> </Context> - </pre> -</div> -</p> + </pre> +</div> +</p> <p>You might also need to modify host.name and portletcontainer.uniquename in ${TOMCAT_HOME}/webapps/pluto/WEB-INF/config/services/ConfigService.properties. - </p> + </p> <p>After this modification (and restarting Tomcat), the Pluto Portal will be available at the address http://servername/newlocation/portal/. Further information on customizing the context configuration is available for <a class="externalLink" href="http://jakarta.apache.org/tomcat/tomcat-5.5-doc/config/context.html";>Tomcat 5.5</a>. - </p> + </p> <p>To modify the <i>portal</i> part of the location, alter the <i>url-pattern</i> for the <i>pluto</i> servlet. This mapping can be found in the <i>web.xml</i> configuration file - for the Pluto web application.</p> + for the Pluto web application.</p> <p><b>Before:</b><div class="source"><pre> <servlet-mapping> <servlet-name>pluto</servlet-name> <url-pattern>/portal/*</url-pattern> </servlet-mapping> - </pre> -</div> -</p> + </pre> +</div> +</p> <p><b>After:</b><div class="source"><pre> <servlet-mapping> <servlet-name>pluto</servlet-name> <url-pattern>/app/*</url-pattern> </servlet-mapping> - </pre> -</div> -</p> + </pre> +</div> +</p> <p>You will also need to modify servlet.insecure in ${TOMCAT_HOME}/webapps/pluto/WEB-INF/config/services/ConfigService.properties. - </p> + </p> <p>After these modifications (and restarting Tomcat), the Pluto Portal will be available at the address http://servername/newlocation/app/ (assuming that the previous modification was also applied). - </p> -</div> -<div class="section"><h3><a name="Registering_Portlets_for_use"></a>Registering Portlets for use</h3> + </p> +</div> +<div class="section"><h3><a name="Registering_Portlets_for_use"></a>Registering Portlets for use</h3> <p>In order to use a Portlet in the Pluto Portal it needs to be registered. The Pluto Portal keeps page registrations in a file named <i>portletentityregistry.xml</i> in the directory - ${TOMCAT_HOME}/webapps/pluto/data.</p> + ${TOMCAT_HOME}/webapps/pluto/data.</p> <p>By default, this file looks like this: <div class="source"><pre> <?xml version="1.0" encoding="UTF-8"?> @@ -421,20 +425,20 @@ </portlet> </application> </portlet-entity-registry> - </pre> -</div> -</p> + </pre> +</div> +</p> <p>Each <application> tag defines one application (corresponding to one web-app on the portal container), which can contain multiple <portlet> tags. - The "id" attribute in this tag identifies the application, and it does not need to be numeric.</p> + The "id" attribute in this tag identifies the application, and it does not need to be numeric.</p> <p>The <definition-id> tag within the <application> refers to the name of the - web-app that contains the portlets in this application.</p> + web-app that contains the portlets in this application.</p> <p>Each <portlet> tag defines one portlet. The "id" attribute in this tag identifies the portlet. Note that the application id concatenated with the portlet id will be mapped to the "value" attribute in the <proprety> tag in pageregistry.xml - (which is explained later).</p> + (which is explained later).</p> <p>Each <preferences> tag within the <portlet> tag defines name/value pairs for - the PorletPreferences.</p> + the PorletPreferences.</p> <p>In the example above two Portlet applications are made available to the portal with the ids of "3" and "4". Both happen to point to the same webapp (<tt><definition-id>testsuite</definition-id></tt>). Both applications define a single Portlet each. Application id 3 uses the Portlet <i>TestPortlet1</i> @@ -442,7 +446,7 @@ the Portlet <i>TestPortlet2</i> (<tt><definition-id>testsuite.TestPortlet2</definition-id></tt>). Note that prefixing the name of the Portlet with the name of web application (<i><b>testsuite</b>.TestPortlet1</i>) is required. - </p> + </p> <p> Since Pluto 1.0.1-rc2, another configuration file, portletcontexts.txt, has been included in the Pluto portal. The Portlet Contexts file ($PLUTO_HOME/WEB-INF/data/portletcontexts.txt) @@ -452,17 +456,17 @@ of the 'path' attribute of the 'Context' element in a context XML descriptor in $TOMCAT_HOME/conf/Catalina/localhost (or another 'conf' subdirectory). - </p> + </p> <p>The Portlets themselves are defined in the portlet.xml configuration file within the testsuite web application. In that file there are two Portlets defined, <i>TestPortlet1</i> and <i>TestPortlet2</i>, both of which point to the same portlet class (<tt>org.apache.pluto.portalImpl.portlet.TestPortlet</tt>). See the javax.portlet specification (JSR-168) for futher details on using the portlet.xml file. - </p> -</div> -<div class="section"><h3><a name="Defining_the_Portal_Layout"></a>Defining the Portal Layout</h3> + </p> +</div> +<div class="section"><h3><a name="Defining_the_Portal_Layout"></a>Defining the Portal Layout</h3> <p>Once the Portlets available have been defined the Portal layout needs to be defined. In the - Pluto Portal the file <i>pageregistry.xml</i> in the directory ${TOMCAT_HOME}/webapps/pluto/data defines this layout.</p> + Pluto Portal the file <i>pageregistry.xml</i> in the directory ${TOMCAT_HOME}/webapps/pluto/data defines this layout.</p> <p>When Pluto is first installed, pageregistry.xml looks like this: <div class="source"><pre> <?xml version="1.0"?> @@ -490,25 +494,25 @@ </fragment> </fragment> </portal> - </pre> -</div> -</p> + </pre> +</div> +</p> <p>This configuration results in the Portal being displayed - (from the url http://servername/pluto/portal/test/) as Figure 1 shows.</p> -<div align="center"><p><a href="../../images/v101/default_portal_layout.jpg"><img src="../../images/v101/default_portal_layout.jpg" alt="Default Portal Layout" /></a></p> -<p><i><b><font size="-1">Figure 1. Default Portal Layout. Click on the picture to enlarge it</font></b></i></p> + (from the url http://servername/pluto/portal/test/) as Figure 1 shows.</p> +<div align="center"><p><a href="../../images/v101/default_portal_layout.jpg"><img src="../../images/v101/default_portal_layout.jpg" alt="Default Portal Layout" /></a></p> +<p><i><b><font size="-1">Figure 1. Default Portal Layout. Click on the picture to enlarge it</font></b></i></p> </div><p>Working from the top of pageregistry.xml down, the first important section we come to is: <div class="source"><pre> <fragment name="navigation" class="org.apache.pluto.portalImpl.aggregation.navigation.TabNavigation"> </fragment> - </pre> -</div> -</p> + </pre> +</div> +</p> <p>This section tells the Portal to add a navigation menu to the user interface. Each fragment of type <i>page</i> will be displayed in the navigation menu, provided the fragment has a <navigation> sub-element. Removing the <tt><fragment name="navigation" ...></fragment></tt> section will result in no navigation menu being displayed. - </p> + </p> <p> The next section is: <div class="source"><pre> @@ -520,20 +524,20 @@ ... ... </fragment> - </pre> -</div> -</p> + </pre> +</div> +</p> <p> This section defines a Portal "page", which is simply a container for one or more Portlets. The <i>name</i> attribute must be unique within the pageregistry.xml file (if this constraint is not met an error message <i>Fragment with this name <duplicated name> already exists in the pageregistry.xml.</i> will be written to your log and your Pluto web application will fail to load). - </p> + </p> <p> The navigation subsection is used by the navigation menu (discussed previously). The <title>...</title> defines the label that will be shown in the navigation menu. The <description>...</description>element is not used. - </p> + </p> <p>Inside the <tt><fragment type="page" .... ></fragment></tt> elements we find <div class="source"><pre> <fragment name="row" type="row"> @@ -548,12 +552,12 @@ </fragment> </fragment> - </pre> -</div> -</p> + </pre> +</div> +</p> <p>This defines the layout of the Portal "page". In this case two Portlets will be laid out in two columns, nested inside a single row. - </p> + </p> <p>The configuration below will give the page a layout of two rows, with a Portlet in each. Note that the names of all fragments need to be unique. <div class="source"><pre> @@ -571,74 +575,74 @@ </fragment> </fragment> </fragment> - </pre> -</div> -</p> + </pre> +</div> +</p> <p>The section <div class="source"><pre> <fragment name="p1" type="portlet"> <property name="portlet" value="3.1"/> </fragment> - </pre> -</div> -</p> + </pre> +</div> +</p> <p>defines which portlet to display. <tt><property name="portlet" value="3.1"/></tt> tells the Portal to lookup the Portlet "3.1" and display it in this location. The value "3.1" means refers to the ids given in <i>portletentityregistry.xml</i> (discussed previously). In this case, it mean application id "3", portlet id "1". - </p> -</div> -</div> -<div class="section"><h2><a name="Advanced_Customization"></a>Advanced Customization</h2> -<div class="section"><h3><a name="JSP_Templates"></a>JSP Templates</h3> + </p> +</div> +</div> +<div class="section"><h2><a name="Advanced_Customization"></a>Advanced Customization</h2> +<div class="section"><h3><a name="JSP_Templates"></a>JSP Templates</h3> <p>It is possible to customize the JSP templates Pluto uses. This is beyond the scope of this document, - but a brief outline follows to get you started.</p> + but a brief outline follows to get you started.</p> <p>By default, Pluto uses JSP templates from the directory ${TOMCAT_HOME}/webapps/pluto/WEB-INF/aggregation directory. This can be overridden by adding a line like <div class="source"><pre> aggregation.base.dir=/WEB-INF/templates/ - </pre> -</div> + </pre> +</div> to the file ${TOMCAT_HOME}/webapps/pluto/WEB-INF/config/services/ConfigService.properties. - </p> + </p> <p>The following JSP files are used by the Portal: - <ul><li>Banner.jsp - The blue title bar which says "Pluto - Reference Implementation". Only called from RootFragment.jsp</li> -<li>ColumnFragment.jsp - Called for each column fragment.</li> -<li>Head.jsp - The HTML header. Only called from RootFragment.jsp</li> -<li>PageFragment.jsp - Called for each Portal page displayed.</li> -<li>PortletFragmentFooter.jsp - The footer of each Portlet.</li> -<li>PortletFragmentHeader.jsp - The header of each Portlet.</li> + <ul><li>Banner.jsp - The blue title bar which says "Pluto - Reference Implementation". Only called from RootFragment.jsp</li> +<li>ColumnFragment.jsp - Called for each column fragment.</li> +<li>Head.jsp - The HTML header. Only called from RootFragment.jsp</li> +<li>PageFragment.jsp - Called for each Portal page displayed.</li> +<li>PortletFragmentFooter.jsp - The footer of each Portlet.</li> +<li>PortletFragmentHeader.jsp - The header of each Portlet.</li> <li>RootFragment.jsp - Defines the layout of the Portal. This is the file to modify if you need - to modify the width of the navigation bar, for instance.</li> -<li>RowFragment.jsp - Called for each row fragment.</li> -<li>TabNavigation.jsp - Displays the navigation menu.</li> -</ul> -</p> + to modify the width of the navigation bar, for instance.</li> +<li>RowFragment.jsp - Called for each row fragment.</li> +<li>TabNavigation.jsp - Displays the navigation menu.</li> +</ul> +</p> <p> Most customization of the Portal can be done in RootFragment.jsp, PortletFragmentHeader.jsp and PortletFragmentFooter.jsp. - </p> -</div> -<div class="section"><h3><a name="Internationalization"></a>Internationalization</h3> + </p> +</div> +<div class="section"><h3><a name="Internationalization"></a>Internationalization</h3> <p>The Pluto portal supports non latin-1 character-sets in its output. To enable this, uncomment the section <div class="source"><pre> <init-param> <param-name>charset</param-name> <param-value>utf-8</param-value> </init-param> - </pre> -</div> + </pre> +</div> - from the "pluto" Servlet section in the file ${TOMCAT_HOME}/webapps/pluto/WEB-INF/web.xml.</p> -</div> -<div class="section"><h3><a name="Further_Information"></a>Further Information</h3> + from the "pluto" Servlet section in the file ${TOMCAT_HOME}/webapps/pluto/WEB-INF/web.xml.</p> +</div> +<div class="section"><h3><a name="Further_Information"></a>Further Information</h3> <p> Further information can be found in the <a href="../faq.html">FAQ</a>, on the <a href="../../mail-lists.html">Mailing Lists</a> - and on the <a href="../../wiki.html">Wiki</a></p> -</div> -</div> + and on the <a href="../../wiki.html">Wiki</a></p> +</div> +</div> </div> </div> @@ -647,7 +651,7 @@ aggregation.base.dir=/WEB-INF/templates/ </div> <div id="footer"> <div class="xright">© - 2004-2016 + 2004-2018 Apache Software Foundation Modified: portals/site-live/pluto/v101/userguide/testsuite.html URL: http://svn.apache.org/viewvc/portals/site-live/pluto/v101/userguide/testsuite.html?rev=1834161&r1=1834160&r2=1834161&view=diff ============================================================================== --- portals/site-live/pluto/v101/userguide/testsuite.html (original) +++ portals/site-live/pluto/v101/userguide/testsuite.html Fri Jun 22 19:35:14 2018 @@ -47,7 +47,7 @@ <div class="xleft"> - Last Published: 2016-12-02 + Last Published: 2018-06-22 | <a href="http://portals.apache.org/pluto"; class="externalLink">Home</a> </div> @@ -105,6 +105,10 @@ </li> <li class="none"> + <a href="../../security.html">Security</a> + </li> + + <li class="none"> <a href="../../status.html">Status</a> </li> @@ -136,27 +140,27 @@ <ul> <li class="none"> - <a href="../../v30/getting-started.html">Getting Started</a> + <a href="../../v301/getting-started.html">Getting Started</a> </li> <li class="none"> - <a href="../../v30/deploying.html">Deploying Portlets</a> + <a href="../../v301/deploying.html">Deploying Portlets</a> </li> <li class="none"> - <a href="../../v30/portlet-api.html">Portlet Concepts</a> + <a href="../../v301/portlet-api.html">Portlet Concepts</a> </li> <li class="none"> - <a href="../../v30/v3Features.html">Version 3 Features</a> + <a href="../../v301/v3Features.html">Version 3 Features</a> </li> <li class="none"> - <a href="../../v30/tck.html">Using the TCK</a> + <a href="../../v301/tck.html">Using the TCK</a> </li> <li class="none"> - <a href="../../v30/release-notes.html">Release Notes</a> + <a href="../../v301/release-notes.html">Release Notes</a> </li> </ul> <h5>Pluto 2.0</h5> @@ -250,9 +254,9 @@ </div> <div id="bodyColumn"> <div id="contentBox"> - <div class="section"><h2><a name="Testsuite_Overview"></a>Testsuite Overview</h2> -<p></p> -</div> + <div class="section"><h2><a name="Testsuite_Overview"></a>Testsuite Overview</h2> +<p></p> +</div> </div> </div> @@ -261,7 +265,7 @@ </div> <div id="footer"> <div class="xright">© - 2004-2016 + 2004-2018 Apache Software Foundation
