Modified: portals/site-live/pluto/v301/deploying.html URL: http://svn.apache.org/viewvc/portals/site-live/pluto/v301/deploying.html?rev=1858149&r1=1858148&r2=1858149&view=diff ============================================================================== --- portals/site-live/pluto/v301/deploying.html (original) +++ portals/site-live/pluto/v301/deploying.html Thu Apr 25 17:29:43 2019 @@ -1,266 +1,133 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> - - - - - - - - - - - -<html xmlns="http://www.w3.org/1999/xhtml";> - <head> - <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> - <title>Pluto - Deploying a Portlet to Pluto Portal Version 3.0.1</title> - <style type="text/css" media="all"> - @import url("../css/maven-base.css"); - @import url("../css/maven-theme.css"); - @import url("../css/site.css"); - </style> - <link rel="stylesheet" href="../css/print.css" type="text/css" media="print" /> - </head> - <body class="composite"> - <div id="banner"> - <a href="http://portals.apache.org/pluto/"; id="bannerLeft"> - - <img src="http://portals.apache.org/pluto/images/apache-portals.gif"; alt="" /> - - </a> - <span id="bannerRight"> - - <img src="http://portals.apache.org/pluto/images/banner.png"; alt="" /> - - </span> - <div class="clear"> - <hr/> - </div> - </div> - <div id="breadcrumbs"> - - - - - - - - - <div class="xleft"> - Last Published: 2018-06-22 - | - <a href="http://portals.apache.org/pluto"; class="externalLink">Home</a> - </div> - <div class="xright"> <a href="../portlet-3.0-apidocs/index.html">Portlet 3.0 API</a> - | - <a href="../portlet-2.0-apidocs/index.html">Portlet 2.0 API</a> - | - <a href="../portlet-1.0-apidocs/index.html">Portlet 1.0 API</a> - | - <a href="http://jcp.org/en/jsr/detail?id=362"; class="externalLink">JSR 362 JCP Page</a> - | - <a href="http://jcp.org/en/jsr/detail?id=286"; class="externalLink">JSR 286 JCP Page</a> - | - <a href="http://jcp.org/en/jsr/detail?id=168"; class="externalLink">JSR 168 JCP Page</a> - - - - - - - - - </div> - <div class="clear"> - <hr/> - </div> - </div> - <div id="leftColumn"> - <div id="navcolumn"> - - - - - - - - - <h5>The Pluto Project</h5> - <ul> - - <li class="none"> - <a href="../index.html">About Pluto</a> - </li> - - <li class="none"> - <a href="../mission.html">Mission</a> - </li> - - <li class="none"> - <a href="../download.html">Download</a> - </li> - - <li class="none"> - <a href="../news.html">News</a> - </li> - - <li class="none"> - <a href="../security.html">Security</a> - </li> - - <li class="none"> - <a href="../status.html">Status</a> - </li> - - <li class="none"> - <a href="../architecture.html">Architecture</a> - </li> - - <li class="none"> - <a href="../resources.html">Resources</a> - </li> - - <li class="none"> - <a href="../faq.html">FAQ</a> - </li> - - <li class="none"> - <a href="http://wiki.apache.org/portals/Pluto"; class="externalLink">Wiki</a> - </li> - - <li class="none"> - <a href="https://issues.apache.org/jira/browse/PLUTO"; class="externalLink">Issue Tracker (JIRA)</a> - </li> - - <li class="none"> - <a href="../helping.html">Get Involved</a> - </li> - </ul> - <h5>Pluto 3.0</h5> - <ul> - - <li class="none"> - <a href="../v301/getting-started.html">Getting Started</a> - </li> - - <li class="none"> - <strong>Deploying Portlets</strong> - </li> - - <li class="none"> - <a href="../v301/portlet-api.html">Portlet Concepts</a> - </li> - - <li class="none"> - <a href="../v301/v3Features.html">Version 3 Features</a> - </li> - - <li class="none"> - <a href="../v301/tck.html">Using the TCK</a> - </li> - - <li class="none"> - <a href="../v301/release-notes.html">Release Notes</a> - </li> - </ul> - <h5>Pluto 2.0</h5> - <ul> - - <li class="none"> - <a href="../v20/getting-started.html">Getting Started</a> - </li> - - <li class="none"> - <a href="../v20/deploying.html">Deploying</a> - </li> - - <li class="none"> - <a href="../v20/embedding.html">Embedding</a> - </li> - - <li class="none"> - <a href="../v20/release-notes.html">Release Notes</a> - </li> - - <li class="none"> - <a href="../v20/app-servers.html">App Servers</a> - </li> - - <li class="none"> - <a href="../v20/powered.html">Powered By Pluto</a> - </li> - </ul> - <h5>Pluto 1.1</h5> - <ul> - - <li class="none"> - <a href="../v11/getting-started.html">Getting Started</a> - </li> - - <li class="none"> - <a href="../v11/deploying.html">Deploying</a> - </li> - - <li class="none"> - <a href="../v11/release-notes.html">Release Notes</a> - </li> - </ul> - <h5>Subprojects</h5> - <ul> - - <li class="none"> - <a href="../subprojects/subprojects.html">Overview</a> - </li> - </ul> - <h5>Project Info</h5> - <ul> - - <li class="none"> - <a href="../project-summary.html">Project Summary</a> - </li> - - <li class="none"> - <a href="../team-list.html">Project Team</a> - </li> - - <li class="none"> - <a href="../license.html">Project License</a> - </li> - - <li class="none"> - <a href="../mail-lists.html">Mailing Lists</a> - </li> - - <li class="none"> - <a href="../source-repository.html">Source Repository</a> - </li> - - <li class="none"> - <a href="../issue-tracking.html">Issue Tracking</a> - </li> - </ul> - <a href="http://maven.apache.org/"; title="Built by Maven" class="poweredBy"> - <img alt="Built by Maven" src="../images/logos/maven-feather.png"></img> - </a> - - - - - - - - - </div> - </div> - <div id="bodyColumn"> - <div id="contentBox"> - <div class="section"><h2><a name="Deploying_a_Portlet_to_Pluto_Portal_Version_3.0.1"></a>Deploying a Portlet to Pluto Portal Version 3.0.1</h2> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> +<!-- Generated by Apache Maven Doxia Site Renderer 1.8.1 from src/site/xdoc/v301/deploying.xml at 2019-04-25 --> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> + <title>Pluto – Deploying a Portlet to Pluto Portal Version 3.0.1</title> + <style type="text/css" media="all"> + @import url("../css/maven-base.css"); + @import url("../css/maven-theme.css"); + @import url("../css/site.css"); + </style> + <link rel="stylesheet" href="../css/print.css" type="text/css" media="print" /> + <meta http-equiv="Content-Language" content="en" /> + + </head> + <body class="composite"> + <div id="banner"> +<a href="http://portals.apache.org/pluto/"; id="bannerLeft"><img src="http://portals.apache.org/pluto/images/apache-portals.gif"; alt="Pluto"/></a> +<div id="bannerRight"> +<img src="http://portals.apache.org/pluto/images/banner.png"; alt=""/></div> + <div class="clear"> + <hr/> + </div> + </div> + <div id="breadcrumbs"> + <div class="xleft"> + <span id="publishDate">Last Published: 2019-04-25</span> + | <a href="http://portals.apache.org/pluto"; class="externalLink" title="Home">Home</a> > +Deploying a Portlet to Pluto Portal Version 3.0.1 + </div> + <div class="xright"><a href="../portlet-3.0-apidocs/index.html" title="Portlet 3.0 API">Portlet 3.0 API</a> | +<a href="../portlet-2.0-apidocs/index.html" title="Portlet 2.0 API">Portlet 2.0 API</a> | +<a href="../portlet-1.0-apidocs/index.html" title="Portlet 1.0 API">Portlet 1.0 API</a> | +<a href="http://jcp.org/en/jsr/detail?id=362"; class="externalLink" title="JSR 362 JCP Page">JSR 362 JCP Page</a> | +<a href="http://jcp.org/en/jsr/detail?id=286"; class="externalLink" title="JSR 286 JCP Page">JSR 286 JCP Page</a> | +<a href="http://jcp.org/en/jsr/detail?id=168"; class="externalLink" title="JSR 168 JCP Page">JSR 168 JCP Page</a> </div> + <div class="clear"> + <hr/> + </div> + </div> + <div id="leftColumn"> + <div id="navcolumn"> + <h5>The Pluto Project</h5> + <ul> + <li class="none"><a href="../index.html" title="About Pluto">About Pluto</a></li> + <li class="none"><a href="../mission.html" title="Mission">Mission</a></li> + <li class="none"><a href="../download.html" title="Download">Download</a></li> + <li class="none"><a href="../news.html" title="News">News</a></li> + <li class="none"><a href="../security.html" title="Security">Security</a></li> + <li class="none"><a href="../status.html" title="Status">Status</a></li> + <li class="none"><a href="../architecture.html" title="Architecture">Architecture</a></li> + <li class="none"><a href="../resources.html" title="Resources">Resources</a></li> + <li class="none"><a href="../faq.html" title="FAQ">FAQ</a></li> + <li class="none"><a href="http://wiki.apache.org/portals/Pluto"; class="externalLink" title="Wiki">Wiki</a></li> + <li class="none"><a href="https://issues.apache.org/jira/browse/PLUTO"; class="externalLink" title="Issue Tracker (JIRA)">Issue Tracker (JIRA)</a></li> + <li class="none"><a href="../helping.html" title="Get Involved">Get Involved</a></li> + </ul> + <h5>Pluto 3.1</h5> + <ul> + <li class="none"><a href="../v310/mvcbean-portlets.html" title="MVCBean Portlets">MVCBean Portlets</a></li> + <li class="none"><a href="../v310/getting-started.html" title="Getting Started">Getting Started</a></li> + <li class="none"><a href="../v310/maven-archetypes.html" title="Maven Archetypes">Maven Archetypes</a></li> + <li class="none"><a href="../v310/deploying.html" title="Deploying Portlets">Deploying Portlets</a></li> + <li class="none"><a href="../v310/portlet-api.html" title="Portlet Concepts">Portlet Concepts</a></li> + <li class="none"><a href="../v310/v3Features.html" title="Version 3 Features">Version 3 Features</a></li> + <li class="none"><a href="../v310/tck.html" title="Using the TCK">Using the TCK</a></li> + <li class="none"><a href="../v310/release-notes.html" title="Release Notes">Release Notes</a></li> + </ul> + <h5>Pluto 3.0</h5> + <ul> + <li class="none"><a href="../v301/getting-started.html" title="Getting Started">Getting Started</a></li> + <li class="none"><strong>Deploying Portlets</strong></li> + <li class="none"><a href="../v301/portlet-api.html" title="Portlet Concepts">Portlet Concepts</a></li> + <li class="none"><a href="../v301/v3Features.html" title="Version 3 Features">Version 3 Features</a></li> + <li class="none"><a href="../v301/tck.html" title="Using the TCK">Using the TCK</a></li> + <li class="none"><a href="../v301/release-notes.html" title="Release Notes">Release Notes</a></li> + </ul> + <h5>Pluto 2.0</h5> + <ul> + <li class="none"><a href="../v20/getting-started.html" title="Getting Started">Getting Started</a></li> + <li class="none"><a href="../v20/deploying.html" title="Deploying">Deploying</a></li> + <li class="none"><a href="../v20/embedding.html" title="Embedding">Embedding</a></li> + <li class="none"><a href="../v20/release-notes.html" title="Release Notes">Release Notes</a></li> + <li class="none"><a href="../v20/app-servers.html" title="App Servers">App Servers</a></li> + <li class="none"><a href="../v20/powered.html" title="Powered By Pluto">Powered By Pluto</a></li> + </ul> + <h5>Pluto 1.1</h5> + <ul> + <li class="none"><a href="../v11/getting-started.html" title="Getting Started">Getting Started</a></li> + <li class="none"><a href="../v11/deploying.html" title="Deploying">Deploying</a></li> + <li class="none"><a href="../v11/release-notes.html" title="Release Notes">Release Notes</a></li> + </ul> + <h5>Subprojects</h5> + <ul> + <li class="none"><a href="../subprojects/subprojects.html" title="Overview">Overview</a></li> + </ul> + <h5>Project Info</h5> + <ul> + <li class="none"><a href="../project-summary.html" title="Project Summary">Project Summary</a></li> + <li class="none"><a href="../team-list.html" title="Project Team">Project Team</a></li> + <li class="none"><a href="../license.html" title="Project License">Project License</a></li> + <li class="none"><a href="../mail-lists.html" title="Mailing Lists">Mailing Lists</a></li> + <li class="none"><a href="../source-repository.html" title="Source Repository">Source Repository</a></li> + <li class="none"><a href="../issue-tracking.html" title="Issue Tracking">Issue Tracking</a></li> + </ul> + <a href="http://maven.apache.org/"; title="Built by Maven" class="poweredBy"> + <img class="poweredBy" alt="Built by Maven" src="../images/logos/maven-feather.png" /> + </a> + </div> + </div> + <div id="bodyColumn"> + <div id="contentBox"> + + + + + <div class="section"> +<h2><a name="Deploying_a_Portlet_to_Pluto_Portal_Version_3.0.1"></a>Deploying a Portlet to Pluto Portal Version 3.0.1</h2> + + <p> The portlet war file is built just like any other web application war file. No special processing steps are necessary. Note in particular that the assembly processing step required by Pluto version 2.0 is no longer needed. </p> -<div class="section"><h3><a name="Portlet_Deployment"></a>Portlet Deployment</h3> + + +<div class="section"> +<h3><a name="Portlet_Deployment"></a>Portlet Deployment</h3> + <p> To deploy a portlet application, simply deploy the application war using any standard mechanism for your application server. There are many @@ -269,12 +136,15 @@ Pluto bundled distribution and is accessed via the 'Upload and deploy portlet war' link on the page administration portlet. See the Help link on that portlet for more details. </p> + <p> In the bundled distribution that uses Tomcat, deployment of an assembled war can simply be done by dropping the war into the webapps directory. You can automatically achive this by adding the following code within the plugins section of your maven pom.xml: </p> -<div class="source"><pre> + +<div class="source"> +<pre> <plugin> <artifactId>maven-antrun-plugin</artifactId> <executions> @@ -294,8 +164,8 @@ </execution> </executions> </plugin> - </pre> -</div> + </pre></div> + <p> Once the pom.xml file has been updated with this plugin, you can run the full build and deployment using the command: mvn integration-test. The code assumes that you have set @@ -303,25 +173,36 @@ done, just set pluto.home from the command line with the -D flag. The command line would then be: mvn -Dpluto.home=C:/pluto integration-test. </p> -</div> -<div class="section"><h3><a name="Portlet_Publishing"></a>Portlet Publishing</h3> + + </div> + + +<div class="section"> +<h3><a name="Portlet_Publishing"></a>Portlet Publishing</h3> + <p> As soon as the portlet application (war) is deployed to the servlet container the portlet application will be available to the portal and can be added to pages using the page administration portlet. See the help mode in this portlet for details on its use. </p> + + <p><b>Portal Page Configuration</b></p> + <p> If you'd like for your page configuration to be consistent throughout restarts of the application server (currently placements made through the page administration portlet is not persistent), you should then configure the page layout in the portal-driver configuration file (pluto-portal-driver-config.xml). </p> + <p> - The page can then be configured by adding a <code>page</code> child element of the <code>render-config</code> + The page can then be configured by adding a <tt>page</tt> child element of the <tt>render-config</tt> element, like this: - <div class="source"><pre> + </p> +<div class="source"> +<pre> <render-config default="Test Page"> ... ... <page name="Your Portal Page Name" uri="/WEB-INF/themes/pluto-default-theme.jsp"> @@ -329,41 +210,35 @@ <portlet context="/your_portlet_app_context_path" name="your_portlet_2"/> </page> </render-config> - </pre> -</div> -</p> + </pre></div> + + <p> - The <code>uri</code> attribute defines the theme of your portal page. - If you use <code>/WEB-INF/themes/pluto-default-theme.jsp</code> (which is the + The <tt>uri</tt> attribute defines the theme of your portal page. + If you use <tt>/WEB-INF/themes/pluto-default-theme.jsp</tt> (which is the default theme of Pluto Testsuite portlet app), your portlets will be displayed in two columns. You can clone this file to customize your layout. - If you do so, make sure the <code>uri</code> attribute points to the new file. + If you do so, make sure the <tt>uri</tt> attribute points to the new file. </p> -</div> -</div> - - </div> - </div> - <div class="clear"> - <hr/> - </div> - <div id="footer"> - <div class="xright">© - 2004-2018 - - Apache Software Foundation - - - - - - - - - </div> - <div class="clear"> - <hr/> - </div> - </div> - </body> -</html> + </div> + + </div> + + + + + </div> + </div> + <div class="clear"> + <hr/> + </div> + <div id="footer"> + <div class="xright"> + Copyright © 2004–2019 <a href="http://www.apache.org/";>Apache Software Foundation</a>. +All rights reserved. </div> + <div class="clear"> + <hr/> + </div> + </div> + </body> +</html>
Modified: portals/site-live/pluto/v301/getting-started.html URL: http://svn.apache.org/viewvc/portals/site-live/pluto/v301/getting-started.html?rev=1858149&r1=1858148&r2=1858149&view=diff ============================================================================== --- portals/site-live/pluto/v301/getting-started.html (original) +++ portals/site-live/pluto/v301/getting-started.html Thu Apr 25 17:29:43 2019 @@ -1,464 +1,421 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> - - - - - - - - - - - -<html xmlns="http://www.w3.org/1999/xhtml";> - <head> - <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> - <title>Pluto - Getting Started With Pluto 3.0.1</title> - <style type="text/css" media="all"> - @import url("../css/maven-base.css"); - @import url("../css/maven-theme.css"); - @import url("../css/site.css"); - </style> - <link rel="stylesheet" href="../css/print.css" type="text/css" media="print" /> - </head> - <body class="composite"> - <div id="banner"> - <a href="http://portals.apache.org/pluto/"; id="bannerLeft"> - - <img src="http://portals.apache.org/pluto/images/apache-portals.gif"; alt="" /> - - </a> - <span id="bannerRight"> - - <img src="http://portals.apache.org/pluto/images/banner.png"; alt="" /> - - </span> - <div class="clear"> - <hr/> - </div> - </div> - <div id="breadcrumbs"> - - - - - - - - - <div class="xleft"> - Last Published: 2018-06-22 - | - <a href="http://portals.apache.org/pluto"; class="externalLink">Home</a> - </div> - <div class="xright"> <a href="../portlet-3.0-apidocs/index.html">Portlet 3.0 API</a> - | - <a href="../portlet-2.0-apidocs/index.html">Portlet 2.0 API</a> - | - <a href="../portlet-1.0-apidocs/index.html">Portlet 1.0 API</a> - | - <a href="http://jcp.org/en/jsr/detail?id=362"; class="externalLink">JSR 362 JCP Page</a> - | - <a href="http://jcp.org/en/jsr/detail?id=286"; class="externalLink">JSR 286 JCP Page</a> - | - <a href="http://jcp.org/en/jsr/detail?id=168"; class="externalLink">JSR 168 JCP Page</a> - - - - - - - - - </div> - <div class="clear"> - <hr/> - </div> - </div> - <div id="leftColumn"> - <div id="navcolumn"> - - - - - - - - - <h5>The Pluto Project</h5> - <ul> - - <li class="none"> - <a href="../index.html">About Pluto</a> - </li> - - <li class="none"> - <a href="../mission.html">Mission</a> - </li> - - <li class="none"> - <a href="../download.html">Download</a> - </li> - - <li class="none"> - <a href="../news.html">News</a> - </li> - - <li class="none"> - <a href="../security.html">Security</a> - </li> - - <li class="none"> - <a href="../status.html">Status</a> - </li> - - <li class="none"> - <a href="../architecture.html">Architecture</a> - </li> - - <li class="none"> - <a href="../resources.html">Resources</a> - </li> - - <li class="none"> - <a href="../faq.html">FAQ</a> - </li> - - <li class="none"> - <a href="http://wiki.apache.org/portals/Pluto"; class="externalLink">Wiki</a> - </li> - - <li class="none"> - <a href="https://issues.apache.org/jira/browse/PLUTO"; class="externalLink">Issue Tracker (JIRA)</a> - </li> - - <li class="none"> - <a href="../helping.html">Get Involved</a> - </li> - </ul> - <h5>Pluto 3.0</h5> - <ul> - - <li class="none"> - <strong>Getting Started</strong> - </li> - - <li class="none"> - <a href="../v301/deploying.html">Deploying Portlets</a> - </li> - - <li class="none"> - <a href="../v301/portlet-api.html">Portlet Concepts</a> - </li> - - <li class="none"> - <a href="../v301/v3Features.html">Version 3 Features</a> - </li> - - <li class="none"> - <a href="../v301/tck.html">Using the TCK</a> - </li> - - <li class="none"> - <a href="../v301/release-notes.html">Release Notes</a> - </li> - </ul> - <h5>Pluto 2.0</h5> - <ul> - - <li class="none"> - <a href="../v20/getting-started.html">Getting Started</a> - </li> - - <li class="none"> - <a href="../v20/deploying.html">Deploying</a> - </li> - - <li class="none"> - <a href="../v20/embedding.html">Embedding</a> - </li> - - <li class="none"> - <a href="../v20/release-notes.html">Release Notes</a> - </li> - - <li class="none"> - <a href="../v20/app-servers.html">App Servers</a> - </li> - - <li class="none"> - <a href="../v20/powered.html">Powered By Pluto</a> - </li> - </ul> - <h5>Pluto 1.1</h5> - <ul> - - <li class="none"> - <a href="../v11/getting-started.html">Getting Started</a> - </li> - - <li class="none"> - <a href="../v11/deploying.html">Deploying</a> - </li> - - <li class="none"> - <a href="../v11/release-notes.html">Release Notes</a> - </li> - </ul> - <h5>Subprojects</h5> - <ul> - - <li class="none"> - <a href="../subprojects/subprojects.html">Overview</a> - </li> - </ul> - <h5>Project Info</h5> - <ul> - - <li class="none"> - <a href="../project-summary.html">Project Summary</a> - </li> - - <li class="none"> - <a href="../team-list.html">Project Team</a> - </li> - - <li class="none"> - <a href="../license.html">Project License</a> - </li> - - <li class="none"> - <a href="../mail-lists.html">Mailing Lists</a> - </li> - - <li class="none"> - <a href="../source-repository.html">Source Repository</a> - </li> - - <li class="none"> - <a href="../issue-tracking.html">Issue Tracking</a> - </li> - </ul> - <a href="http://maven.apache.org/"; title="Built by Maven" class="poweredBy"> - <img alt="Built by Maven" src="../images/logos/maven-feather.png"></img> - </a> - - - - - - - - - </div> - </div> - <div id="bodyColumn"> - <div id="contentBox"> - <div class="section"><h2><a name="Installing_the_Pluto_3.0.1_Binary_Build"></a>Installing the Pluto 3.0.1 Binary Build</h2> -<div class="highlightBox"><h4>About Pluto Distributions</h4> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> +<!-- Generated by Apache Maven Doxia Site Renderer 1.8.1 from src/site/xdoc/v301/getting-started.xml at 2019-04-25 --> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> + <title>Pluto – Getting Started With Pluto 3.0.1</title> + <style type="text/css" media="all"> + @import url("../css/maven-base.css"); + @import url("../css/maven-theme.css"); + @import url("../css/site.css"); + </style> + <link rel="stylesheet" href="../css/print.css" type="text/css" media="print" /> + <meta http-equiv="Content-Language" content="en" /> + + </head> + <body class="composite"> + <div id="banner"> +<a href="http://portals.apache.org/pluto/"; id="bannerLeft"><img src="http://portals.apache.org/pluto/images/apache-portals.gif"; alt="Pluto"/></a> +<div id="bannerRight"> +<img src="http://portals.apache.org/pluto/images/banner.png"; alt=""/></div> + <div class="clear"> + <hr/> + </div> + </div> + <div id="breadcrumbs"> + <div class="xleft"> + <span id="publishDate">Last Published: 2019-04-25</span> + | <a href="http://portals.apache.org/pluto"; class="externalLink" title="Home">Home</a> > +Getting Started With Pluto 3.0.1 + </div> + <div class="xright"><a href="../portlet-3.0-apidocs/index.html" title="Portlet 3.0 API">Portlet 3.0 API</a> | +<a href="../portlet-2.0-apidocs/index.html" title="Portlet 2.0 API">Portlet 2.0 API</a> | +<a href="../portlet-1.0-apidocs/index.html" title="Portlet 1.0 API">Portlet 1.0 API</a> | +<a href="http://jcp.org/en/jsr/detail?id=362"; class="externalLink" title="JSR 362 JCP Page">JSR 362 JCP Page</a> | +<a href="http://jcp.org/en/jsr/detail?id=286"; class="externalLink" title="JSR 286 JCP Page">JSR 286 JCP Page</a> | +<a href="http://jcp.org/en/jsr/detail?id=168"; class="externalLink" title="JSR 168 JCP Page">JSR 168 JCP Page</a> </div> + <div class="clear"> + <hr/> + </div> + </div> + <div id="leftColumn"> + <div id="navcolumn"> + <h5>The Pluto Project</h5> + <ul> + <li class="none"><a href="../index.html" title="About Pluto">About Pluto</a></li> + <li class="none"><a href="../mission.html" title="Mission">Mission</a></li> + <li class="none"><a href="../download.html" title="Download">Download</a></li> + <li class="none"><a href="../news.html" title="News">News</a></li> + <li class="none"><a href="../security.html" title="Security">Security</a></li> + <li class="none"><a href="../status.html" title="Status">Status</a></li> + <li class="none"><a href="../architecture.html" title="Architecture">Architecture</a></li> + <li class="none"><a href="../resources.html" title="Resources">Resources</a></li> + <li class="none"><a href="../faq.html" title="FAQ">FAQ</a></li> + <li class="none"><a href="http://wiki.apache.org/portals/Pluto"; class="externalLink" title="Wiki">Wiki</a></li> + <li class="none"><a href="https://issues.apache.org/jira/browse/PLUTO"; class="externalLink" title="Issue Tracker (JIRA)">Issue Tracker (JIRA)</a></li> + <li class="none"><a href="../helping.html" title="Get Involved">Get Involved</a></li> + </ul> + <h5>Pluto 3.1</h5> + <ul> + <li class="none"><a href="../v310/mvcbean-portlets.html" title="MVCBean Portlets">MVCBean Portlets</a></li> + <li class="none"><a href="../v310/getting-started.html" title="Getting Started">Getting Started</a></li> + <li class="none"><a href="../v310/maven-archetypes.html" title="Maven Archetypes">Maven Archetypes</a></li> + <li class="none"><a href="../v310/deploying.html" title="Deploying Portlets">Deploying Portlets</a></li> + <li class="none"><a href="../v310/portlet-api.html" title="Portlet Concepts">Portlet Concepts</a></li> + <li class="none"><a href="../v310/v3Features.html" title="Version 3 Features">Version 3 Features</a></li> + <li class="none"><a href="../v310/tck.html" title="Using the TCK">Using the TCK</a></li> + <li class="none"><a href="../v310/release-notes.html" title="Release Notes">Release Notes</a></li> + </ul> + <h5>Pluto 3.0</h5> + <ul> + <li class="none"><strong>Getting Started</strong></li> + <li class="none"><a href="../v301/deploying.html" title="Deploying Portlets">Deploying Portlets</a></li> + <li class="none"><a href="../v301/portlet-api.html" title="Portlet Concepts">Portlet Concepts</a></li> + <li class="none"><a href="../v301/v3Features.html" title="Version 3 Features">Version 3 Features</a></li> + <li class="none"><a href="../v301/tck.html" title="Using the TCK">Using the TCK</a></li> + <li class="none"><a href="../v301/release-notes.html" title="Release Notes">Release Notes</a></li> + </ul> + <h5>Pluto 2.0</h5> + <ul> + <li class="none"><a href="../v20/getting-started.html" title="Getting Started">Getting Started</a></li> + <li class="none"><a href="../v20/deploying.html" title="Deploying">Deploying</a></li> + <li class="none"><a href="../v20/embedding.html" title="Embedding">Embedding</a></li> + <li class="none"><a href="../v20/release-notes.html" title="Release Notes">Release Notes</a></li> + <li class="none"><a href="../v20/app-servers.html" title="App Servers">App Servers</a></li> + <li class="none"><a href="../v20/powered.html" title="Powered By Pluto">Powered By Pluto</a></li> + </ul> + <h5>Pluto 1.1</h5> + <ul> + <li class="none"><a href="../v11/getting-started.html" title="Getting Started">Getting Started</a></li> + <li class="none"><a href="../v11/deploying.html" title="Deploying">Deploying</a></li> + <li class="none"><a href="../v11/release-notes.html" title="Release Notes">Release Notes</a></li> + </ul> + <h5>Subprojects</h5> + <ul> + <li class="none"><a href="../subprojects/subprojects.html" title="Overview">Overview</a></li> + </ul> + <h5>Project Info</h5> + <ul> + <li class="none"><a href="../project-summary.html" title="Project Summary">Project Summary</a></li> + <li class="none"><a href="../team-list.html" title="Project Team">Project Team</a></li> + <li class="none"><a href="../license.html" title="Project License">Project License</a></li> + <li class="none"><a href="../mail-lists.html" title="Mailing Lists">Mailing Lists</a></li> + <li class="none"><a href="../source-repository.html" title="Source Repository">Source Repository</a></li> + <li class="none"><a href="../issue-tracking.html" title="Issue Tracking">Issue Tracking</a></li> + </ul> + <a href="http://maven.apache.org/"; title="Built by Maven" class="poweredBy"> + <img class="poweredBy" alt="Built by Maven" src="../images/logos/maven-feather.png" /> + </a> + </div> + </div> + <div id="bodyColumn"> + <div id="contentBox"> + + + + + <div class="section"> +<h2><a name="Installing_the_Pluto_3.0.1_Binary_Build"></a>Installing the Pluto 3.0.1 Binary Build</h2> + + +<div class="highlightBox"> + +<div class="section"> +<div class="section"> +<h4><a name="About_Pluto_Distributions"></a>About Pluto Distributions</h4> + <p> You can download a pre-built Pluto bundle, or you can build Pluto from the source code. - <ul><li><strong>pluto-bundle</strong> - Provides Pluto and Tomcat bundled together. + </p> +<ul> + +<li> + <b>pluto-bundle</b> - Provides Pluto and Tomcat bundled together. </li> -<li><strong>pluto-source-release</strong> - Provides the Pluto source code; requires + +<li><b>pluto-source-release</b> - Provides the Pluto source code; requires that you build and deploy Pluto on your own.</li> -</ul> -</p> -</div><ol type="1"><li> + </ul> + + </div> + + +<ol style="list-style-type: decimal"> + +<li> - Download the Pluto 3.0.1 binary distribution named <strong>pluto-bundle-3.0.1.zip</strong> from + Download the Pluto 3.0.1 binary distribution named <b>pluto-bundle-3.0.1.zip</b> from a <a class="externalLink" href="http://www.apache.org/dyn/closer.cgi/portals/pluto/";>distribution site</a>.</li> + <li>Unzip the binary distribution into a directory.</li> -<ol type="1"><li>pluto-<version> (pluto-3.0.1) will be the top level directory.</li> -</ol> + +<ol style="list-style-type: decimal"> + +<li>pluto-<version> (pluto-3.0.1) will be the top level directory.</li> + </ol> + <li> Execute startup.bat (Windows) or startup.sh (Unix) in pluto-<version>/bin.</li> + <li> Use shutdown.bat/shutdown.sh to stop the portal </li> + <li> - Browse to <a class="externalLink" href="http://localhost:8080/pluto/portal";>http://localhost:8080/pluto/portal</a></li> + Browse to <a class="externalLink" href="http://localhost:8080/pluto/portal";>http://localhost:8080/pluto/portal</a> + </li> + <li> Login as user pluto (password=pluto) or tomcat (password=pluto). </li> -</ol> -</div> -<div class="section"><h2><a name="Building_Pluto_3.0.1_from_Source"></a>Building Pluto 3.0.1 from Source</h2> + </ol> + + </div></div></div> + + +<div class="section"> +<h2><a name="Building_Pluto_3.0.1_from_Source"></a>Building Pluto 3.0.1 from Source</h2> + + <p> Pluto uses Maven 3 as its project management and build system. Pluto currently provides Maven plugins and ant scripts which can be used to install the Pluto Portal. </p> + + <p> The Pluto project uses the <a class="externalLink" href="https://git-scm.com/";>Git</a> version control system. If you're new to Git, you can find many books and online resources to help you. </p> -<h4>Software Prerequisites</h4> + + +<div class="section"> +<div class="section"> +<h4><a name="Software_Prerequisites"></a>Software Prerequisites</h4> + + <p> In order to build Pluto, you will need to have the following software packages installed on your system. For help in obtaining and installing the packages, please access the appropriate web resources. - <ul><li> + </p> +<ul> + +<li> A Java runtime environment, version 1.7.0 or later. See - <a class="externalLink" href="https://java.com/en/download/";>the Java download site</a></li> + <a class="externalLink" href="https://java.com/en/download/";>the Java download site</a> + </li> + <li> Apache Ant, version 1.9.3 or later. See - <a class="externalLink" href="https://ant.apache.org/bindownload.cgi";>the Apache Ant download site</a></li> + <a class="externalLink" href="https://ant.apache.org/bindownload.cgi";>the Apache Ant download site</a> + </li> + <li> Apache Maven, version 3.3.1 or later. See - <a class="externalLink" href="https://maven.apache.org/download.cgi";>the Apache Maven download site</a></li> + <a class="externalLink" href="https://maven.apache.org/download.cgi";>the Apache Maven download site</a> + </li> + <li> Git version control software, version 2.0.0 or later. See - <a class="externalLink" href="https://git-scm.com/downloads";>the Git download site</a></li> -</ul> - + <a class="externalLink" href="https://git-scm.com/downloads";>the Git download site</a> + </li> + </ul> Note that your computer will also require access to the Internet during the build process in order to access maven repositories and other information. - </p> -<h4>Obtaining Pluto 3.0.1 Source Code</h4> + + + </div> +<div class="section"> +<h4><a name="Obtaining_Pluto_3.0.1_Source_Code"></a>Obtaining Pluto 3.0.1 Source Code</h4> + + <p> To browse the Pluto source code online, access <a class="externalLink" href="https://github.com/apache/portals-pluto";>the Apache Pluto Github mirror.</a> This is current at all times. </p> -<h4>Cloning the Pluto Repository</h4> + + </div> +<div class="section"> +<h4><a name="Cloning_the_Pluto_Repository"></a>Cloning the Pluto Repository</h4> + <p> Anyone can clone the Pluto repository from the Github mirror. However, in order to update the repository, you will need to be an Apache pluto committer. To clone the repository, switch to the directory in which you would like the code to reside, and execute the following command: </p> -<p><code>git clone https://github.com/apache/portals-pluto.git pluto</code></p> + <p> - You now have the complete Pluto source code in the <code>./pluto</code> subdirectory. + <tt>git clone https://github.com/apache/portals-pluto.git pluto</tt> </p> + +<p> + You now have the complete Pluto source code in the <tt>./pluto</tt> subdirectory. + </p> + <p> The source code versions are tagged in the respository. If you want to build version 3.0.1 rather than the current development version, checkout the 'pluto-3.0.1' tag: </p> -<p><code>git checkout pluto-3.0.1</code></p> -<h4>Building Pluto using Apache Ant</h4> + +<p> + <tt>git checkout pluto-3.0.1</tt> + </p> + + </div> +<div class="section"> +<h4><a name="Building_Pluto_using_Apache_Ant"></a>Building Pluto using Apache Ant</h4> + <p> This is the easiest way to build Pluto. The Ant build script will use first build the binaries from source, then download and unpack the appropriate Apache Tomcat web container for the code version being built. It will then install pluto on Tomcat, adjusting the Tomcat configuration as necessary. </p> + <p> - The <code>dist-build.xml</code> build script allows a number + The <tt>dist-build.xml</tt> build script allows a number of options for building and packaging the code. View the file for details. The options used in the following command causes the demo portlets to be deployed and retains the tomcat directory created during the build process rather than deleting it. Execute the following command: </p> -<p><code>ant -f dist-build.xml -DincludeDemos=true -DnoClean=true</code></p> + <p> - You now have Pluto built and deployed in the <code>./pluto/target/dist</code> subdirectory. - You can now switch to the <code>./pluto/target/dist/<tomcat>/bin</code> + <tt>ant -f dist-build.xml -DincludeDemos=true -DnoClean=true</tt> + </p> + +<p> + You now have Pluto built and deployed in the <tt>./pluto/target/dist</tt> subdirectory. + You can now switch to the <tt>./pluto/target/dist/<tomcat>/bin</tt> subdirectory and start Tomcat and Pluto as described in the next section. </p> -<div class="section"><h3><a name="Starting_the_Portal"></a>Starting the Portal</h3> + + </div></div> +<div class="section"> +<h3><a name="Starting_the_Portal"></a>Starting the Portal</h3> + <p> Now you are ready to use the Pluto Portal built from source. Start up tomcat by running - <code>startup.bat</code> (for windows) or <code>startup.sh</code> (for - *nix) in <code><TOMCAT_HOME>/bin</code>, and browse to - <code>http://localhost:8080/pluto/portal</code>. Login to Pluto using + <tt>startup.bat</tt> (for windows) or <tt>startup.sh</tt> (for + *nix) in <tt><TOMCAT_HOME>/bin</tt>, and browse to + <tt>http://localhost:8080/pluto/portal</tt>. Login to Pluto using the user ID 'pluto' and password 'pluto'. </p> -</div> -</div> -<div class="section"><h2><a name="Using_the_Demo_Portlets"></a>Using the Demo Portlets</h2> + </div> + </div> + + +<div class="section"> +<h2><a name="Using_the_Demo_Portlets"></a>Using the Demo Portlets</h2> + <p> The Pluto distribution contains four version 3.0.1 portlet applications that illustrate the use of all aspects of JSR 362 portlet programming. </p> -<ul><li> + +<ul> + +<li> PortletHubDemo - Contains portlets that show how you can use the Portlet Hub JavaScript API to create portal-based single-page applications. </li> + <li> PortletV3AnnotatedDemo - Contains portlets that illustrate the use of the version 3.0.1 Extended Method Annotations feature. </li> + <li> PortletV3Demo - Contains portlets that illustrate miscellaneous aspects of the API. </li> + <li> chatRoomDemo - Contains portlets that implement a simple chat room demo based on the Portlet Hub JavaScript API and the portlet asynchronous processing feature. </li> -</ul> + </ul> + <p> The best way to view the source code would be to import the modules mentioned above into your favorite IDE. </p> -</div> -<div class="section"><h2><a name="Using_the_Pluto_Maven_Archetypes"></a>Using the Pluto Maven Archetypes</h2> + </div> + + +<div class="section"> +<h2><a name="Using_the_Pluto_Maven_Archetypes"></a>Using the Pluto Maven Archetypes</h2> + <p> There are two Maven archetypes available to quickly get you started developing a portlet application. - <ul><li>generic-portlet-archetype + </p> +<ul> + +<li>generic-portlet-archetype </li> + <li> bean-portlet-archetype </li> -</ul> -</p> + </ul> + + <p> The generic-portlet-archetype can be used to create an old-fashioned portlet project which has a class that extends GenericPortlet. - <div class="source"><pre> + </p> +<div class="source"> +<pre> mvn archetype:generate \ -DarchetypeGroupId=org.apache.portals.pluto.archetype \ -DarchetypeArtifactId=generic-portlet-archetype \ -DarchetypeVersion=3.0.1 \ -DgroupId=com.mycompany \ -DartifactId=com.mycompany.my.generic.portlet - </pre> -</div> -</p> + </pre></div> + + <p> The bean-portlet-archetype can be used to create a modern "bean portlet" that utilizes the Portlet 3.0.1 CDI features. - <div class="source"><pre> + </p> +<div class="source"> +<pre> mvn archetype:generate \ -DarchetypeGroupId=org.apache.portals.pluto.archetype \ -DarchetypeArtifactId=bean-portlet-archetype \ -DarchetypeVersion=3.0.1 \ -DgroupId=com.mycompany \ -DartifactId=com.mycompany.my.bean.portlet - </pre> -</div> -</p> -<p> - Archetypes are available in Maven Central <a class="externalLink" href="http://search.maven.org/#search%7Cga%7C1%7Cpluto%20archetype";>here.</a></p> -</div> - - </div> - </div> - <div class="clear"> - <hr/> - </div> - <div id="footer"> - <div class="xright">© - 2004-2018 - - Apache Software Foundation - - - - - - - - - </div> - <div class="clear"> - <hr/> - </div> - </div> - </body> -</html> + </pre></div> + + +<p> + Archetypes are available in Maven Central <a class="externalLink" href="http://search.maven.org/#search%7Cga%7C1%7Cpluto%20archetype";>here.</a> + </p> + </div> + + + + </div> + </div> + <div class="clear"> + <hr/> + </div> + <div id="footer"> + <div class="xright"> + Copyright © 2004–2019 <a href="http://www.apache.org/";>Apache Software Foundation</a>. +All rights reserved. </div> + <div class="clear"> + <hr/> + </div> + </div> + </body> +</html> Modified: portals/site-live/pluto/v301/portlet-api.html URL: http://svn.apache.org/viewvc/portals/site-live/pluto/v301/portlet-api.html?rev=1858149&r1=1858148&r2=1858149&view=diff ============================================================================== --- portals/site-live/pluto/v301/portlet-api.html (original) +++ portals/site-live/pluto/v301/portlet-api.html Thu Apr 25 17:29:43 2019 @@ -1,286 +1,162 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> - - - - - - - - - - - -<html xmlns="http://www.w3.org/1999/xhtml";> - <head> - <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> - <title>Pluto - Portlet Concepts</title> - <style type="text/css" media="all"> - @import url("../css/maven-base.css"); - @import url("../css/maven-theme.css"); - @import url("../css/site.css"); - </style> - <link rel="stylesheet" href="../css/print.css" type="text/css" media="print" /> - </head> - <body class="composite"> - <div id="banner"> - <a href="http://portals.apache.org/pluto/"; id="bannerLeft"> - - <img src="http://portals.apache.org/pluto/images/apache-portals.gif"; alt="" /> - - </a> - <span id="bannerRight"> - - <img src="http://portals.apache.org/pluto/images/banner.png"; alt="" /> - - </span> - <div class="clear"> - <hr/> - </div> - </div> - <div id="breadcrumbs"> - - - - - - - - - <div class="xleft"> - Last Published: 2018-06-22 - | - <a href="http://portals.apache.org/pluto"; class="externalLink">Home</a> - </div> - <div class="xright"> <a href="../portlet-3.0-apidocs/index.html">Portlet 3.0 API</a> - | - <a href="../portlet-2.0-apidocs/index.html">Portlet 2.0 API</a> - | - <a href="../portlet-1.0-apidocs/index.html">Portlet 1.0 API</a> - | - <a href="http://jcp.org/en/jsr/detail?id=362"; class="externalLink">JSR 362 JCP Page</a> - | - <a href="http://jcp.org/en/jsr/detail?id=286"; class="externalLink">JSR 286 JCP Page</a> - | - <a href="http://jcp.org/en/jsr/detail?id=168"; class="externalLink">JSR 168 JCP Page</a> - - - - - - - - - </div> - <div class="clear"> - <hr/> - </div> - </div> - <div id="leftColumn"> - <div id="navcolumn"> - - - - - - - - - <h5>The Pluto Project</h5> - <ul> - - <li class="none"> - <a href="../index.html">About Pluto</a> - </li> - - <li class="none"> - <a href="../mission.html">Mission</a> - </li> - - <li class="none"> - <a href="../download.html">Download</a> - </li> - - <li class="none"> - <a href="../news.html">News</a> - </li> - - <li class="none"> - <a href="../security.html">Security</a> - </li> - - <li class="none"> - <a href="../status.html">Status</a> - </li> - - <li class="none"> - <a href="../architecture.html">Architecture</a> - </li> - - <li class="none"> - <a href="../resources.html">Resources</a> - </li> - - <li class="none"> - <a href="../faq.html">FAQ</a> - </li> - - <li class="none"> - <a href="http://wiki.apache.org/portals/Pluto"; class="externalLink">Wiki</a> - </li> - - <li class="none"> - <a href="https://issues.apache.org/jira/browse/PLUTO"; class="externalLink">Issue Tracker (JIRA)</a> - </li> - - <li class="none"> - <a href="../helping.html">Get Involved</a> - </li> - </ul> - <h5>Pluto 3.0</h5> - <ul> - - <li class="none"> - <a href="../v301/getting-started.html">Getting Started</a> - </li> - - <li class="none"> - <a href="../v301/deploying.html">Deploying Portlets</a> - </li> - - <li class="none"> - <strong>Portlet Concepts</strong> - </li> - - <li class="none"> - <a href="../v301/v3Features.html">Version 3 Features</a> - </li> - - <li class="none"> - <a href="../v301/tck.html">Using the TCK</a> - </li> - - <li class="none"> - <a href="../v301/release-notes.html">Release Notes</a> - </li> - </ul> - <h5>Pluto 2.0</h5> - <ul> - - <li class="none"> - <a href="../v20/getting-started.html">Getting Started</a> - </li> - - <li class="none"> - <a href="../v20/deploying.html">Deploying</a> - </li> - - <li class="none"> - <a href="../v20/embedding.html">Embedding</a> - </li> - - <li class="none"> - <a href="../v20/release-notes.html">Release Notes</a> - </li> - - <li class="none"> - <a href="../v20/app-servers.html">App Servers</a> - </li> - - <li class="none"> - <a href="../v20/powered.html">Powered By Pluto</a> - </li> - </ul> - <h5>Pluto 1.1</h5> - <ul> - - <li class="none"> - <a href="../v11/getting-started.html">Getting Started</a> - </li> - - <li class="none"> - <a href="../v11/deploying.html">Deploying</a> - </li> - - <li class="none"> - <a href="../v11/release-notes.html">Release Notes</a> - </li> - </ul> - <h5>Subprojects</h5> - <ul> - - <li class="none"> - <a href="../subprojects/subprojects.html">Overview</a> - </li> - </ul> - <h5>Project Info</h5> - <ul> - - <li class="none"> - <a href="../project-summary.html">Project Summary</a> - </li> - - <li class="none"> - <a href="../team-list.html">Project Team</a> - </li> - - <li class="none"> - <a href="../license.html">Project License</a> - </li> - - <li class="none"> - <a href="../mail-lists.html">Mailing Lists</a> - </li> - - <li class="none"> - <a href="../source-repository.html">Source Repository</a> - </li> - - <li class="none"> - <a href="../issue-tracking.html">Issue Tracking</a> - </li> - </ul> - <a href="http://maven.apache.org/"; title="Built by Maven" class="poweredBy"> - <img alt="Built by Maven" src="../images/logos/maven-feather.png"></img> - </a> - - - - - - - - - </div> - </div> - <div id="bodyColumn"> - <div id="contentBox"> - <div class="section"><h2><a name="Portlet_Concepts"></a>Portlet Concepts</h2> -<div class="section"><h3><a name="The_Portlet_Phase_Model"></a>The Portlet Phase Model</h3> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> +<!-- Generated by Apache Maven Doxia Site Renderer 1.8.1 from src/site/xdoc/v301/portlet-api.xml at 2019-04-25 --> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> + <title>Pluto – Portlet Concepts</title> + <style type="text/css" media="all"> + @import url("../css/maven-base.css"); + @import url("../css/maven-theme.css"); + @import url("../css/site.css"); + </style> + <link rel="stylesheet" href="../css/print.css" type="text/css" media="print" /> + <meta http-equiv="Content-Language" content="en" /> + + </head> + <body class="composite"> + <div id="banner"> +<a href="http://portals.apache.org/pluto/"; id="bannerLeft"><img src="http://portals.apache.org/pluto/images/apache-portals.gif"; alt="Pluto"/></a> +<div id="bannerRight"> +<img src="http://portals.apache.org/pluto/images/banner.png"; alt=""/></div> + <div class="clear"> + <hr/> + </div> + </div> + <div id="breadcrumbs"> + <div class="xleft"> + <span id="publishDate">Last Published: 2019-04-25</span> + | <a href="http://portals.apache.org/pluto"; class="externalLink" title="Home">Home</a> > +Portlet Concepts + </div> + <div class="xright"><a href="../portlet-3.0-apidocs/index.html" title="Portlet 3.0 API">Portlet 3.0 API</a> | +<a href="../portlet-2.0-apidocs/index.html" title="Portlet 2.0 API">Portlet 2.0 API</a> | +<a href="../portlet-1.0-apidocs/index.html" title="Portlet 1.0 API">Portlet 1.0 API</a> | +<a href="http://jcp.org/en/jsr/detail?id=362"; class="externalLink" title="JSR 362 JCP Page">JSR 362 JCP Page</a> | +<a href="http://jcp.org/en/jsr/detail?id=286"; class="externalLink" title="JSR 286 JCP Page">JSR 286 JCP Page</a> | +<a href="http://jcp.org/en/jsr/detail?id=168"; class="externalLink" title="JSR 168 JCP Page">JSR 168 JCP Page</a> </div> + <div class="clear"> + <hr/> + </div> + </div> + <div id="leftColumn"> + <div id="navcolumn"> + <h5>The Pluto Project</h5> + <ul> + <li class="none"><a href="../index.html" title="About Pluto">About Pluto</a></li> + <li class="none"><a href="../mission.html" title="Mission">Mission</a></li> + <li class="none"><a href="../download.html" title="Download">Download</a></li> + <li class="none"><a href="../news.html" title="News">News</a></li> + <li class="none"><a href="../security.html" title="Security">Security</a></li> + <li class="none"><a href="../status.html" title="Status">Status</a></li> + <li class="none"><a href="../architecture.html" title="Architecture">Architecture</a></li> + <li class="none"><a href="../resources.html" title="Resources">Resources</a></li> + <li class="none"><a href="../faq.html" title="FAQ">FAQ</a></li> + <li class="none"><a href="http://wiki.apache.org/portals/Pluto"; class="externalLink" title="Wiki">Wiki</a></li> + <li class="none"><a href="https://issues.apache.org/jira/browse/PLUTO"; class="externalLink" title="Issue Tracker (JIRA)">Issue Tracker (JIRA)</a></li> + <li class="none"><a href="../helping.html" title="Get Involved">Get Involved</a></li> + </ul> + <h5>Pluto 3.1</h5> + <ul> + <li class="none"><a href="../v310/mvcbean-portlets.html" title="MVCBean Portlets">MVCBean Portlets</a></li> + <li class="none"><a href="../v310/getting-started.html" title="Getting Started">Getting Started</a></li> + <li class="none"><a href="../v310/maven-archetypes.html" title="Maven Archetypes">Maven Archetypes</a></li> + <li class="none"><a href="../v310/deploying.html" title="Deploying Portlets">Deploying Portlets</a></li> + <li class="none"><a href="../v310/portlet-api.html" title="Portlet Concepts">Portlet Concepts</a></li> + <li class="none"><a href="../v310/v3Features.html" title="Version 3 Features">Version 3 Features</a></li> + <li class="none"><a href="../v310/tck.html" title="Using the TCK">Using the TCK</a></li> + <li class="none"><a href="../v310/release-notes.html" title="Release Notes">Release Notes</a></li> + </ul> + <h5>Pluto 3.0</h5> + <ul> + <li class="none"><a href="../v301/getting-started.html" title="Getting Started">Getting Started</a></li> + <li class="none"><a href="../v301/deploying.html" title="Deploying Portlets">Deploying Portlets</a></li> + <li class="none"><strong>Portlet Concepts</strong></li> + <li class="none"><a href="../v301/v3Features.html" title="Version 3 Features">Version 3 Features</a></li> + <li class="none"><a href="../v301/tck.html" title="Using the TCK">Using the TCK</a></li> + <li class="none"><a href="../v301/release-notes.html" title="Release Notes">Release Notes</a></li> + </ul> + <h5>Pluto 2.0</h5> + <ul> + <li class="none"><a href="../v20/getting-started.html" title="Getting Started">Getting Started</a></li> + <li class="none"><a href="../v20/deploying.html" title="Deploying">Deploying</a></li> + <li class="none"><a href="../v20/embedding.html" title="Embedding">Embedding</a></li> + <li class="none"><a href="../v20/release-notes.html" title="Release Notes">Release Notes</a></li> + <li class="none"><a href="../v20/app-servers.html" title="App Servers">App Servers</a></li> + <li class="none"><a href="../v20/powered.html" title="Powered By Pluto">Powered By Pluto</a></li> + </ul> + <h5>Pluto 1.1</h5> + <ul> + <li class="none"><a href="../v11/getting-started.html" title="Getting Started">Getting Started</a></li> + <li class="none"><a href="../v11/deploying.html" title="Deploying">Deploying</a></li> + <li class="none"><a href="../v11/release-notes.html" title="Release Notes">Release Notes</a></li> + </ul> + <h5>Subprojects</h5> + <ul> + <li class="none"><a href="../subprojects/subprojects.html" title="Overview">Overview</a></li> + </ul> + <h5>Project Info</h5> + <ul> + <li class="none"><a href="../project-summary.html" title="Project Summary">Project Summary</a></li> + <li class="none"><a href="../team-list.html" title="Project Team">Project Team</a></li> + <li class="none"><a href="../license.html" title="Project License">Project License</a></li> + <li class="none"><a href="../mail-lists.html" title="Mailing Lists">Mailing Lists</a></li> + <li class="none"><a href="../source-repository.html" title="Source Repository">Source Repository</a></li> + <li class="none"><a href="../issue-tracking.html" title="Issue Tracking">Issue Tracking</a></li> + </ul> + <a href="http://maven.apache.org/"; title="Built by Maven" class="poweredBy"> + <img class="poweredBy" alt="Built by Maven" src="../images/logos/maven-feather.png" /> + </a> + </div> + </div> + <div id="bodyColumn"> + <div id="contentBox"> + + + + + <div class="section"> +<h2><a name="Portlet_Concepts"></a>Portlet Concepts</h2> + +<div class="section"> +<h3><a name="The_Portlet_Phase_Model"></a>The Portlet Phase Model</h3> + <p> When a request arrives at a portal targeted to a portlet, the portlet container executes portlet code according to a phase model. </p> -<img src="../images/phaseModel.png" /><p> + <img src="../images/phaseModel.png" alt="" /> + +<p> There are three processing stages containing five processing phases, defined as follows: </p> + <p> The portlet API allows creation of URLs that can be included into portlet markup in order to activate the portlet processing stages. </p> -<ul><li> + +<ul> + +<li> The Action URL, or Partial Action URL triggers preparation stage processing. </li> + <li> The Render URL triggers aggregation stage processing. </li> + <li> The Resource URL triggers resourec stage processing. </li> -</ul> + </ul> + <p> When a stage is triggered, the processing phases within that stage are executed. </p> -<dl><dt> + +<dl> + +<dt> Action Phase </dt> <dd> @@ -322,25 +198,32 @@ the response returned to the client. It may produce markup, JSON data, or binary data, for example. </dd> -</dl> + </dl> + <p> The portlet container drives portlet phase execution by setting up the execution environment for each portlet and phase and calling the corresponding portlet lifecycle methods. </p> + <p> The portlet participates in the phase model by implementing the corresponding lifecycle methods and by using the portlet API to carry out the appropriate tasks. </p> -</div> -<div class="section"><h3><a name="The_Portlet_Lifecyce_Methods"></a>The Portlet Lifecyce Methods</h3> -<img src="../images/lifecycleMethods.png" /><p> + </div> + + +<div class="section"> +<h3><a name="The_Portlet_Lifecyce_Methods"></a>The Portlet Lifecyce Methods</h3> + <img src="../images/lifecycleMethods.png" alt="" /> + +<p> Each portlet phase has a corresponding lifecycle method. The portlet container executes the prrocessing phase by calling the portlet lifecycle method. Each phase is provided with specific request and response objects. Methods can implemented using the interfaces - <code>Portlet, ResourceServingPortlet, EventPortlet</code> and <code>HeaderPortlet</code>. + <tt>Portlet, ResourceServingPortlet, EventPortlet</tt> and <tt>HeaderPortlet</tt>. Portlets can be configured through annotation or using the portlet deployment descriptor. </p> <p> @@ -355,7 +238,10 @@ data beyond that provided in the annotation is required. Additional configuration is possible through annotation or portlet deployment descriptor. </p> -<ul><li> + +<ul> + +<li> Set up / tear down: @InitMethod, @DestroyMethod </li> <li> @@ -367,32 +253,26 @@ <li> Resource stage: @ServeResourceMethod </li> -</ul> -</div> -</div> - - </div> - </div> - <div class="clear"> - <hr/> - </div> - <div id="footer"> - <div class="xright">© - 2004-2018 - - Apache Software Foundation - - - - - - - - - </div> - <div class="clear"> - <hr/> - </div> - </div> - </body> -</html> + </ul> + </div> + + </div> + + + + + </div> + </div> + <div class="clear"> + <hr/> + </div> + <div id="footer"> + <div class="xright"> + Copyright © 2004–2019 <a href="http://www.apache.org/";>Apache Software Foundation</a>. +All rights reserved. </div> + <div class="clear"> + <hr/> + </div> + </div> + </body> +</html>
![http://portals.apache.org/pluto/images/apache-portals.gif"](http://portals.apache.org/pluto/images/apache-portals.gif"){kind=link}
![http://portals.apache.org/pluto/images/banner.png"](http://portals.apache.org/pluto/images/banner.png"){kind=link}