Modified: portals/site-live/pluto/v101/userguide/portal.html URL: http://svn.apache.org/viewvc/portals/site-live/pluto/v101/userguide/portal.html?rev=1772018&r1=1772017&r2=1772018&view=diff ============================================================================== --- portals/site-live/pluto/v101/userguide/portal.html (original) +++ portals/site-live/pluto/v101/userguide/portal.html Wed Nov 30 12:21:20 2016 @@ -1,274 +1,264 @@ -<!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 - User Guide: Pluto Portal Driver</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: 2011-09-26 - | - <a href="http://portals.apache.org/pluto" class="externalLink">Home</a> - </div> - <div class="xright"> <a href="../../jetspeed-2/">Jetspeed-2</a> - | - <a href="../../bridges/">Bridges</a> - | - <a href="../../pluto/">Pluto</a> - | - <a href="../../applications/">Applications</a> - | - <a href="../../jetspeed-1/">Jetspeed-1</a> - | - <a href="http://jcp.org/en/jsr/detail?id=168" class="externalLink">JSR 168 (Portlet 1.0)</a> - | - <a href="http://portals.apache.org/pluto/portlet-1.0-apidocs" class="externalLink">Portlet 1.0 API (Javadoc)</a> - | - <a href="http://jcp.org/en/jsr/detail?id=286" class="externalLink">JSR 286 (Portlet 2.0)</a> - | - <a href="http://portals.apache.org/pluto/portlet-2.0-apidocs" class="externalLink">Portlet 2.0 API (Javadoc)</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="../../status.html">Status</a> - </li> - - <li class="none"> - <a href="../../app-servers.html">App Servers</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="../../powered.html">Powered By Pluto</a> - </li> - - <li class="none"> - <a href="../../helping.html">Get Involved</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> - </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> - - <li class="none"> - <a href="../../subprojects/container-api.html">Pluto Container API</a> - </li> - - <li class="none"> - <a href="../../subprojects/portlet-container.html">Pluto Portlet Container</a> - </li> - - <li class="none"> - <a href="../../subprojects/tag-library.html">Pluto Portlet Tag Library</a> - </li> - - <li class="none"> - <a href="../../subprojects/driver.html">Pluto Portal Driver</a> - </li> - - <li class="none"> - <a href="../../subprojects/portal.html">Pluto Portal</a> - </li> - - <li class="none"> - <a href="../../subprojects/utilities.html">Pluto Utilities</a> - </li> - - <li class="none"> - <a href="../../subprojects/installer.html">Pluto Installer</a> - </li> - - <li class="none"> - <a href="../../subprojects/testsuite.html">Pluto Testsuite</a> - </li> - - <li class="none"> - <a href="../../subprojects/anttasks.html">Pluto Ant Tasks</a> - </li> - - <li class="none"> - <a href="../../subprojects/skin.html">Pluto Website Skin</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"> +<!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 - User Guide: Pluto Portal Driver</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: 2016-11-30 + | + <a href="http://portals.apache.org/pluto" class="externalLink">Home</a> + </div> + <div class="xright"> <a href="http://jcp.org/en/jsr/detail?id=168" class="externalLink">JSR 168 (Portlet 1.0)</a> + | + <a href="http://portals.apache.org/pluto/portlet-1.0-apidocs" class="externalLink">Portlet 1.0 API (Javadoc)</a> + | + <a href="http://jcp.org/en/jsr/detail?id=286" class="externalLink">JSR 286 (Portlet 2.0)</a> + | + <a href="http://portals.apache.org/pluto/portlet-2.0-apidocs" class="externalLink">Portlet 2.0 API (Javadoc)</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="../../status.html">Status</a> + </li> + + <li class="none"> + <a href="../../app-servers.html">App Servers</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="../../powered.html">Powered By Pluto</a> + </li> + + <li class="none"> + <a href="../../helping.html">Get Involved</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> + </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> + + <li class="none"> + <a href="../../subprojects/container-api.html">Pluto Container API</a> + </li> + + <li class="none"> + <a href="../../subprojects/portlet-container.html">Pluto Portlet Container</a> + </li> + + <li class="none"> + <a href="../../subprojects/tag-library.html">Pluto Portlet Tag Library</a> + </li> + + <li class="none"> + <a href="../../subprojects/driver.html">Pluto Portal Driver</a> + </li> + + <li class="none"> + <a href="../../subprojects/portal.html">Pluto Portal</a> + </li> + + <li class="none"> + <a href="../../subprojects/utilities.html">Pluto Utilities</a> + </li> + + <li class="none"> + <a href="../../subprojects/installer.html">Pluto Installer</a> + </li> + + <li class="none"> + <a href="../../subprojects/testsuite.html">Pluto Testsuite</a> + </li> + + <li class="none"> + <a href="../../subprojects/anttasks.html">Pluto Ant Tasks</a> + </li> + + <li class="none"> + <a href="../../subprojects/skin.html">Pluto Website Skin</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="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> @@ -381,7 +371,7 @@ <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 href="http://jakarta.apache.org/tomcat/tomcat-5.5-doc/config/context.html" class="externalLink">Tomcat 5.5</a>. + <a class="externalLink" href="http://jakarta.apache.org/tomcat/tomcat-5.5-doc/config/context.html">Tomcat 5.5</a>. </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 @@ -658,29 +648,29 @@ aggregation.base.dir=/WEB-INF/templates/ and on the <a href="../../wiki.html">Wiki</a></p> </div> </div> - - </div> - </div> - <div class="clear"> - <hr/> - </div> - <div id="footer"> - <div class="xright">© - 2004-2011 - - Apache Software Foundation - - - - - - - - - </div> - <div class="clear"> - <hr/> - </div> - </div> - </body> -</html> + + </div> + </div> + <div class="clear"> + <hr/> + </div> + <div id="footer"> + <div class="xright">© + 2004-2016 + + Apache Software Foundation + + + + + + + + + </div> + <div class="clear"> + <hr/> + </div> + </div> + </body> +</html>
Modified: portals/site-live/pluto/v101/userguide/testsuite.html URL: http://svn.apache.org/viewvc/portals/site-live/pluto/v101/userguide/testsuite.html?rev=1772018&r1=1772017&r2=1772018&view=diff ============================================================================== --- portals/site-live/pluto/v101/userguide/testsuite.html (original) +++ portals/site-live/pluto/v101/userguide/testsuite.html Wed Nov 30 12:21:20 2016 @@ -47,21 +47,11 @@ <div class="xleft"> - Last Published: 2011-09-26 + Last Published: 2016-11-30 | <a href="http://portals.apache.org/pluto" class="externalLink">Home</a> </div> - <div class="xright"> <a href="../../jetspeed-2/">Jetspeed-2</a> - | - <a href="../../bridges/">Bridges</a> - | - <a href="../../pluto/">Pluto</a> - | - <a href="../../applications/">Applications</a> - | - <a href="../../jetspeed-1/">Jetspeed-1</a> - | - <a href="http://jcp.org/en/jsr/detail?id=168" class="externalLink">JSR 168 (Portlet 1.0)</a> + <div class="xright"> <a href="http://jcp.org/en/jsr/detail?id=168" class="externalLink">JSR 168 (Portlet 1.0)</a> | <a href="http://portals.apache.org/pluto/portlet-1.0-apidocs" class="externalLink">Portlet 1.0 API (Javadoc)</a> | @@ -269,9 +259,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> @@ -280,7 +270,7 @@ </div> <div id="footer"> <div class="xright">© - 2004-2011 + 2004-2016 Apache Software Foundation Modified: portals/site-live/pluto/v11/deploying.html URL: http://svn.apache.org/viewvc/portals/site-live/pluto/v11/deploying.html?rev=1772018&r1=1772017&r2=1772018&view=diff ============================================================================== --- portals/site-live/pluto/v11/deploying.html (original) +++ portals/site-live/pluto/v11/deploying.html Wed Nov 30 12:21:20 2016 @@ -47,21 +47,11 @@ <div class="xleft"> - Last Published: 2011-09-26 + Last Published: 2016-11-30 | <a href="http://portals.apache.org/pluto" class="externalLink">Home</a> </div> - <div class="xright"> <a href="../jetspeed-2/">Jetspeed-2</a> - | - <a href="../bridges/">Bridges</a> - | - <a href="../pluto/">Pluto</a> - | - <a href="../applications/">Applications</a> - | - <a href="../jetspeed-1/">Jetspeed-1</a> - | - <a href="http://jcp.org/en/jsr/detail?id=168" class="externalLink">JSR 168 (Portlet 1.0)</a> + <div class="xright"> <a href="http://jcp.org/en/jsr/detail?id=168" class="externalLink">JSR 168 (Portlet 1.0)</a> | <a href="http://portals.apache.org/pluto/portlet-1.0-apidocs" class="externalLink">Portlet 1.0 API (Javadoc)</a> | @@ -269,249 +259,249 @@ </div> <div id="bodyColumn"> <div id="contentBox"> - <div class="section"><h2><a name="Deploying_Portlet_to_Pluto_Portal"></a>Deploying Portlet to Pluto Portal</h2> -<p> - There are 2 steps involved in deploying a portlet application in Pluto 1.1: - <ul><li><b>Assembly</b>: All portlet applications must be run through the - pluto assembler before being deployed. The assembly process injects - pluto specific information for deployment. Specifically, a servlet - and servlet mapping are added to the deployment descriptor (web.xml). - This servlet (<code>org.apache.pluto.core.PortletServlet</code> - will be used to dispatch portlet requests to the portlet application. - </li> -<li><b>Deployment</b>: After portlet applications are assembled properly - they must be deployed to the servlet engine within which the portal - application is running. The current bundled distribution uses - Tomcat 5.5 as the servlet engine. - </li> -</ul> -</p> -<div class="section"><h3><a name="Portlet_Assembly"></a>Portlet Assembly</h3> -<p> - The maven-pluto-plugin can be used to assemble a portlet application war. - It will place the proper <code>PortletServlet</code> configuration in web.xml. - </p> -<p> - The custom Maven 2 build shown below requires - a Tomcat context deployment descriptor that has the same name as your - artifactId with an xml extension (e.g. HelloWorldPortlet.xml). - </p> -<p> - To properly assemble your portlet using the Maven 2 plugin, - your project's directory structure and artifact placement must conform to Maven's standard: - </p> -<p><div class="source"><pre> - HelloWorldPortlet (top level directory) - |- pom.xml (the pom file) - |- src (Subdir containing main subdirectory) - |- main (Subdir containing java, resources and webapp subdirs) - |- java (java source code goes under here) - | `- com - | `- mycompany - | `- portlet - | `- HelloWorldPortlet.java (portlet source) - |- webapp (webapp resources (jsp, css, images) go under here) - `- jsp - `- HelloWorldPortletView.jsp (for view mode) - `- HelloWorldPortletEdit.jsp (for edit mode) - `- META-INF - `- HelloWorldPortlet.xml (Tomcat context deployment descriptor) - `- WEB-INF - `- portlet.xml (JSR-168 deployment descriptor) - `- web.xml (This will be modified by maven-pluto-plugin) - </pre> -</div> -</p> -<p> - This is an example of what the Tomcat context deployment descriptor will contain: - <div class="source"><pre> - <Context path="/HelloWorldPortlet" - docBase="HelloWorldPortlet" - crossContext="true"/> - </pre> -</div> -</p> -<p> - To configure the maven-pluto-plugin, you must configure it in your pom. - For easy of setup, use this as you pom file, changing the groupId, artifactId and version - to values appropriate to your custom portlet. - <div class="source"><pre> -<project xmlns="http://maven.apache.org/POM/4.0.0" - xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" - xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd"> - - <!-- Change this to something akin to your java package structure --> - <groupId>com.mycompany.portlet</groupId> - <modelVersion>4.0.0</modelVersion> - <!-- Version of this app --> - <version>0.1-alpha1</version> - <!-- Base name of the war file without .war ext --> - <artifactId>HelloWorldPortlet</artifactId> - <packaging>war</packaging> - <name>${pom.artifactId}</name> - <!-- Dependency Version Properties ======================================= --> - <properties> - <pluto.version>1.1.4</pluto.version> - <portlet-api.version>1.0</portlet-api.version> - <servlet-api.version>2.4</servlet-api.version> - <jsp-api.version>2.0</jsp-api.version> - <junit.version>3.8.1</junit.version> - </properties> - <dependencies> - <dependency> - <groupId>javax.portlet</groupId> - <artifactId>portlet-api</artifactId> - <version>${portlet-api.version}</version> - <scope>provided</scope><!-- Prevents addition to war file --> - </dependency> - <dependency> - <groupId>javax.servlet</groupId> - <artifactId>servlet-api</artifactId> - <version>${servlet-api.version}</version> - <scope>provided</scope> - </dependency> - <dependency> - <groupId>junit</groupId> - <artifactId>junit</artifactId> - <version>${junit.version}</version> - <scope>test</scope> - </dependency> - <dependency> - <groupId>org.apache.pluto</groupId> - <artifactId>pluto-util</artifactId> - <version>${pluto.version}</version> - <scope>provided</scope> - </dependency> - <!-- Any other build or deployment dependancies go here --> - </dependencies> - <build> - <finalName>${pom.name}</finalName> - <plugins> - <!-- configure to use Java 6 to compile (change to your JDK) --> - <plugin> - <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-compiler-plugin</artifactId> - <configuration> - <source>1.6</source> - <target>1.6</target> - </configuration> - </plugin> - <!-- configure maven-war-plugin to use updated web.xml --> - <plugin> - <artifactId>maven-war-plugin</artifactId> - <configuration> - <webXml>${project.build.directory}/pluto-resources/web.xml</webXml> - </configuration> - </plugin> - <!-- bind 'pluto:assemble' goal to 'generate-resources' lifecycle --> - <plugin> - <groupId>org.apache.pluto</groupId> - <artifactId>maven-pluto-plugin</artifactId> - <version>${pluto.version}</version> - <executions> - <execution> - <phase>generate-resources</phase> - <goals> - <goal>assemble</goal> - </goals> - </execution> - </executions> - </plugin> - </plugins> - </build> - -</project> - </pre> -</div> -</p> -<p> - Once configured, the war generated by an 'mvn package' (or install) command will contain - the appropriate pluto configuration. - </p> -</div> -<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 - maven plugins and ant tasks that can assist with this, or you can use - an administrative web console. This console is the Tomcat manager webapp in the - 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> - <plugin> - <artifactId>maven-antrun-plugin</artifactId> - <executions> - <execution> - <phase>integration-test</phase> - <configuration> - <tasks> - <property environment="env"/> - <!-- This assumes that you have set a CATALINA_HOME environmental variable --> - <property name="pluto.home" value="${env.CATALINA_HOME}"/> - <copy file="target/${pom.name}.war" todir="${pluto.home}/webapps"/> - </tasks> - </configuration> - <goals> - <goal>run</goal> - </goals> - </execution> - </executions> - </plugin> - </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 - the environmental variable CATALINA_HOME to the Pluto home directory. If that has not been - 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> -<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> - element, like this: - <div class="source"><pre> -<render-config default="Test Page"> - ... ... - <page name="Your Portal Page Name" uri="/WEB-INF/fragments/portlet.jsp"> - <portlet context="/your_portlet_app_context_path" - name="your_portlet_1"/> - <portlet context="/your_portlet_app_context_path" - name="your_portlet_2"/> - </page> -</render-config> - </pre> -</div> -</p> -<p> - The <code>uri</code> attribute defines the theme of your portal page. - If you use <code>/WEB-INF/fragments/portlet.jsp</code> (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. - </p> -</div> -</div> + <div class="section"><h2><a name="Deploying_Portlet_to_Pluto_Portal"></a>Deploying Portlet to Pluto Portal</h2> +<p> + There are 2 steps involved in deploying a portlet application in Pluto 1.1: + <ul><li><b>Assembly</b>: All portlet applications must be run through the + pluto assembler before being deployed. The assembly process injects + pluto specific information for deployment. Specifically, a servlet + and servlet mapping are added to the deployment descriptor (web.xml). + This servlet (<code>org.apache.pluto.core.PortletServlet</code> + will be used to dispatch portlet requests to the portlet application. + </li> +<li><b>Deployment</b>: After portlet applications are assembled properly + they must be deployed to the servlet engine within which the portal + application is running. The current bundled distribution uses + Tomcat 5.5 as the servlet engine. + </li> +</ul> +</p> +<div class="section"><h3><a name="Portlet_Assembly"></a>Portlet Assembly</h3> +<p> + The maven-pluto-plugin can be used to assemble a portlet application war. + It will place the proper <code>PortletServlet</code> configuration in web.xml. + </p> +<p> + The custom Maven 2 build shown below requires + a Tomcat context deployment descriptor that has the same name as your + artifactId with an xml extension (e.g. HelloWorldPortlet.xml). + </p> +<p> + To properly assemble your portlet using the Maven 2 plugin, + your project's directory structure and artifact placement must conform to Maven's standard: + </p> +<p><div class="source"><pre> + HelloWorldPortlet (top level directory) + |- pom.xml (the pom file) + |- src (Subdir containing main subdirectory) + |- main (Subdir containing java, resources and webapp subdirs) + |- java (java source code goes under here) + | `- com + | `- mycompany + | `- portlet + | `- HelloWorldPortlet.java (portlet source) + |- webapp (webapp resources (jsp, css, images) go under here) + `- jsp + `- HelloWorldPortletView.jsp (for view mode) + `- HelloWorldPortletEdit.jsp (for edit mode) + `- META-INF + `- HelloWorldPortlet.xml (Tomcat context deployment descriptor) + `- WEB-INF + `- portlet.xml (JSR-168 deployment descriptor) + `- web.xml (This will be modified by maven-pluto-plugin) + </pre> +</div> +</p> +<p> + This is an example of what the Tomcat context deployment descriptor will contain: + <div class="source"><pre> + <Context path="/HelloWorldPortlet" + docBase="HelloWorldPortlet" + crossContext="true"/> + </pre> +</div> +</p> +<p> + To configure the maven-pluto-plugin, you must configure it in your pom. + For easy of setup, use this as you pom file, changing the groupId, artifactId and version + to values appropriate to your custom portlet. + <div class="source"><pre> +<project xmlns="http://maven.apache.org/POM/4.0.0" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd"> + + <!-- Change this to something akin to your java package structure --> + <groupId>com.mycompany.portlet</groupId> + <modelVersion>4.0.0</modelVersion> + <!-- Version of this app --> + <version>0.1-alpha1</version> + <!-- Base name of the war file without .war ext --> + <artifactId>HelloWorldPortlet</artifactId> + <packaging>war</packaging> + <name>${pom.artifactId}</name> + <!-- Dependency Version Properties ======================================= --> + <properties> + <pluto.version>1.1.4</pluto.version> + <portlet-api.version>1.0</portlet-api.version> + <servlet-api.version>2.4</servlet-api.version> + <jsp-api.version>2.0</jsp-api.version> + <junit.version>3.8.1</junit.version> + </properties> + <dependencies> + <dependency> + <groupId>javax.portlet</groupId> + <artifactId>portlet-api</artifactId> + <version>${portlet-api.version}</version> + <scope>provided</scope><!-- Prevents addition to war file --> + </dependency> + <dependency> + <groupId>javax.servlet</groupId> + <artifactId>servlet-api</artifactId> + <version>${servlet-api.version}</version> + <scope>provided</scope> + </dependency> + <dependency> + <groupId>junit</groupId> + <artifactId>junit</artifactId> + <version>${junit.version}</version> + <scope>test</scope> + </dependency> + <dependency> + <groupId>org.apache.pluto</groupId> + <artifactId>pluto-util</artifactId> + <version>${pluto.version}</version> + <scope>provided</scope> + </dependency> + <!-- Any other build or deployment dependancies go here --> + </dependencies> + <build> + <finalName>${pom.name}</finalName> + <plugins> + <!-- configure to use Java 6 to compile (change to your JDK) --> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-compiler-plugin</artifactId> + <configuration> + <source>1.6</source> + <target>1.6</target> + </configuration> + </plugin> + <!-- configure maven-war-plugin to use updated web.xml --> + <plugin> + <artifactId>maven-war-plugin</artifactId> + <configuration> + <webXml>${project.build.directory}/pluto-resources/web.xml</webXml> + </configuration> + </plugin> + <!-- bind 'pluto:assemble' goal to 'generate-resources' lifecycle --> + <plugin> + <groupId>org.apache.pluto</groupId> + <artifactId>maven-pluto-plugin</artifactId> + <version>${pluto.version}</version> + <executions> + <execution> + <phase>generate-resources</phase> + <goals> + <goal>assemble</goal> + </goals> + </execution> + </executions> + </plugin> + </plugins> + </build> + +</project> + </pre> +</div> +</p> +<p> + Once configured, the war generated by an 'mvn package' (or install) command will contain + the appropriate pluto configuration. + </p> +</div> +<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 + maven plugins and ant tasks that can assist with this, or you can use + an administrative web console. This console is the Tomcat manager webapp in the + 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> + <plugin> + <artifactId>maven-antrun-plugin</artifactId> + <executions> + <execution> + <phase>integration-test</phase> + <configuration> + <tasks> + <property environment="env"/> + <!-- This assumes that you have set a CATALINA_HOME environmental variable --> + <property name="pluto.home" value="${env.CATALINA_HOME}"/> + <copy file="target/${pom.name}.war" todir="${pluto.home}/webapps"/> + </tasks> + </configuration> + <goals> + <goal>run</goal> + </goals> + </execution> + </executions> + </plugin> + </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 + the environmental variable CATALINA_HOME to the Pluto home directory. If that has not been + 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> +<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> + element, like this: + <div class="source"><pre> +<render-config default="Test Page"> + ... ... + <page name="Your Portal Page Name" uri="/WEB-INF/fragments/portlet.jsp"> + <portlet context="/your_portlet_app_context_path" + name="your_portlet_1"/> + <portlet context="/your_portlet_app_context_path" + name="your_portlet_2"/> + </page> +</render-config> + </pre> +</div> +</p> +<p> + The <code>uri</code> attribute defines the theme of your portal page. + If you use <code>/WEB-INF/fragments/portlet.jsp</code> (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. + </p> +</div> +</div> </div> </div> @@ -520,7 +510,7 @@ </div> <div id="footer"> <div class="xright">© - 2004-2011 + 2004-2016 Apache Software Foundation Modified: portals/site-live/pluto/v11/getting-started.html URL: http://svn.apache.org/viewvc/portals/site-live/pluto/v11/getting-started.html?rev=1772018&r1=1772017&r2=1772018&view=diff ============================================================================== --- portals/site-live/pluto/v11/getting-started.html (original) +++ portals/site-live/pluto/v11/getting-started.html Wed Nov 30 12:21:20 2016 @@ -47,21 +47,11 @@ <div class="xleft"> - Last Published: 2011-09-26 + Last Published: 2016-11-30 | <a href="http://portals.apache.org/pluto" class="externalLink">Home</a> </div> - <div class="xright"> <a href="../jetspeed-2/">Jetspeed-2</a> - | - <a href="../bridges/">Bridges</a> - | - <a href="../pluto/">Pluto</a> - | - <a href="../applications/">Applications</a> - | - <a href="../jetspeed-1/">Jetspeed-1</a> - | - <a href="http://jcp.org/en/jsr/detail?id=168" class="externalLink">JSR 168 (Portlet 1.0)</a> + <div class="xright"> <a href="http://jcp.org/en/jsr/detail?id=168" class="externalLink">JSR 168 (Portlet 1.0)</a> | <a href="http://portals.apache.org/pluto/portlet-1.0-apidocs" class="externalLink">Portlet 1.0 API (Javadoc)</a> | @@ -269,202 +259,202 @@ </div> <div id="bodyColumn"> <div id="contentBox"> - <div class="section"><h2><a name="Installing_the_Pluto_1.1_Binary_Build"></a>Installing the Pluto 1.1 Binary Build</h2> -<div class="highlightBox"><h4>About Pluto Distributions</h4> -<p> - There are a number of distributions to choose from depending - on your needs. - <ul><li><strong>pluto-current-bundle</strong> - Provides Pluto and Tomcat bundled together. - If you are getting started with Pluto, this is the distribution you - want.</li> -<li><strong>pluto-current-bin</strong> - Provides the Pluto libraries, portal and - testsuite web applications. Includes ant tasks.</li> -<li><strong>pluto-current-container-bin</strong> - Provides the Pluto container - libraries only.</li> -<li><strong>pluto-current-src</strong> - Provides the Pluto source code; requires - that you build and deploy Pluto on your own.</li> -</ul> -</p> -</div><ol type="1"><li>Download the Pluto 1.1 binary distribution named <strong>pluto-current-bundle</strong> from - a <a href="http://www.apache.org/dyn/closer.cgi/portals/pluto/" class="externalLink">distribution site</a>.</li> -<li>Unzip the binary distribution into a directory.</li> -<ol type="1"><li><PLUTO-1.1-HOME> will be the top level directory.</li> -</ol> -<li>Execute startup.bat (Windows) or startup.sh (Unix) -in <PLUTO-1.1-HOME>/bin.</li> -<ol type="1"><li>Use shutdown.bat/shutdown.sh to stop the portal</li> -</ol> -<li>Browse to <a href="http://localhost:8080/pluto/portal" class="externalLink">http://localhost:8080/pluto/portal</a></li> -<li>Login as user pluto (password=pluto) or tomcat (password=tomcat).</li> -</ol> -</div> -<div class="section"><h2><a name="Building_Pluto_1.1_from_Source"></a>Building Pluto 1.1 from Source</h2> -<p> - Maven 2 is utilized as the project management and build system for - Pluto 1.1. Pluto currently provides Maven plugins which can be used to - install the Pluto Portal, assemble portlet applications, deploy - applications, and publish portlet applications to the Pluto Portal. - </p> -<div class="section"><h3><a name="Obtaining_Pluto_1.1_Source_Code"></a>Obtaining Pluto 1.1 Source Code</h3> -<p>The Pluto project uses the - <a href="http://subversion.tigris.org/" class="externalLink">Subversion</a> version control - system. If you're new to Subversion, you can check out the - <a href="http://svnbook.red-bean.com/" class="externalLink">online book</a> about Subversion. - Note that we are currently using Subversion 1.3.x (there are separate - versions of the book covering the different versions of Subversion). - </p> -<p><b>Web Access to Subversion</b></p> -<p> - To browse the Pluto source code, you can use the - <a href="http://svn.apache.org/viewcvs.cgi/portals/pluto/trunk?root=Apache-SVN" class="externalLink">ViewCVS - web interface</a> to Subversion. This is current at all times. - </p> -<p><b>Normal Subversion Access</b></p> -<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> -<h3>Check out from Subversion</h3><p>To check out Pluto 1.1.<code>x</code> source to the 'pluto' directory use this command (substituting '<code>x</code>' for the - current release number, e.g. 1.1.<code>5</code>): - <pre>svn checkout https://svn.apache.org/repos/asf/portals/pluto/tags/pluto-1.1.x pluto</pre></p> -<p> - Zipped up Pluto 1.1 source distributions can also be downloaded from - a <a href="http://www.apache.org/dyn/closer.cgi/portals/pluto/" class="externalLink">distribution mirror</a>. - </p> -</div> -<div class="section"><h3><a name="Building_Pluto_with_Maven_2"></a>Building Pluto with Maven 2</h3> -<p> - If this is your first time building Pluto with Maven 2, edit <code>~/.m2/settings.xml</code> - and add the <pluginGroups> element: - <p><div class="source"><pre> -<settings> - ... - <pluginGroups> - <pluginGroup>org.apache.pluto</pluginGroup> - </pluginGroups> - ... -</settings> - </pre> -</div> -</p> - - If you don't have <code>org.apache.pluto</code> specified as a <code><pluginGroup></code>, - then the <code>pluto:install</code> will fail. - </p> -<p><code><PLUTO_SRCHOME></code> is the local directory where the - Pluto 1.1 source distribution has been checked out or unzipped into. - </p> -<p><div class="source"><pre> -$> cd <PLUTO_SRCHOME> -$> mvn install -$> mvn pluto:install -DinstallDir=path/to/appserver - </pre> -</div> -</p> -<p> - The <code>install</code> goal is a built in Maven 2 lifecycle - which builds the project artifacts and installs them into the Maven - repository. - </p> -<p> - The <code>pluto:install</code> goal will take the resulting artifacts - and properly deploy them within the configured Tomcat installation. - Currently, the Pluto install has been tested on Tomcat 5.5.9, 5.5.17 and 5.5.20, 5.5.23, and 6.0.13. - The Tomcat 5 archive can be found <a href="http://archive.apache.org/dist/tomcat/tomcat-5/archive" class="externalLink">here</a>. - </p> -<p> - If installing to a directory that contains spaces, <code>installDir</code> - needs to be enclosed within quotes: - </p> -<p><div class="source"><pre> -C:\pluto> mvn pluto:install -DinstallDir="C:\Program Files\Apache Software Foundation\Tomcat 5.5" - </pre> -</div> -</p> -</div> -<div class="section"><h3><a name="Installing_Pluto_Manually"></a>Installing Pluto Manually</h3> -<p> - This section documents the manual installation of Pluto 1.1 into Tomcat. It replaces - the pluto:install goal, but requires that the built-in Maven 2 install goal - (<code>mvn install</code>) be run from <code><PLUTO_SRCHOME></code>. - </p> -<p><b>Step 1:</b><div class="source"><pre> -$> cd <PLUTO_SRCHOME> -$> mvn install - </pre> -</div> -</p> -<p><b>Step 2:</b> Copy the following to - <code><TOMCAT_HOME>/shared/lib</code>: - <ul><li>castor-1.1.1.jar (Pluto 1.1.x only)</li> -<li>portlet-api-1.0.jar</li> -<li>pluto-container-x.x.x.jar (x.x.x is the version of Pluto you built)</li> -<li>pluto-taglib-x.x.x.jar (x.x.x is the version of Pluto you built)</li> -</ul> -</p> -<p><b>Step 3:</b> For platforms running on Java 1.4 and Pluto 1.1, copy the following to - <code><TOMCAT_HOME>/common/endorsed</code> (if you are running Java 1.5+, it is recommended to skip this step): - <ul><li>xercesImpl-2.6.2.jar</li> -<li>xmlParserAPIs-2.6.2.jar</li> -</ul> -</p> -<p><b>Step 4:</b> Copy the following to - <code><TOMCAT_HOME>/conf/Catalina/localhost</code>: - <ul><li><PLUTO_SRCHOME>/pluto-portal/src/main/resources/pluto.xml</li> -<li><PLUTO_SRCHOME>/pluto-testsuite/src/main/resources/testsuite.xml</li> -</ul> -</p> -<p><b>Step 5:</b> Copy the following to - <code><TOMCAT_HOME>/webapps</code>: - <ul><li><PLUTO_SRCHOME>/pluto-portal/target/pluto-portal.war</li> -<li><PLUTO_SRCHOME>/pluto-testsuite/target/pluto-testsuite.war</li> -</ul> -</p> -</div> -<div class="section"><h3><a name="Configuring_Source-Built_Pluto_for_Application_Scope_PortletSession_Attributes"></a>Configuring Source-Built Pluto for Application Scope PortletSession Attributes</h3> -<p>To be able to use application-scoped <code>PortletSession</code> attributes in Pluto, modify - the Connector element for port 8080 in <code><TOMCAT_HOME>/conf/server.xml</code> by - adding the following attribute and value: emptySessionPath="true". - </p> -</div> -<div class="section"><h3><a name="Configuring_User_and_Role_in_the_Pluto_Source_Build"></a>Configuring User and Role in the Pluto Source Build</h3> -<p> - The Pluto Testsuite portlet application needs the role '<code>pluto</code>' - to run the Security Mapping Test. So before starting tomcat, you should - edit <code><TOMCAT_HOME>/conf/tomcat-users.xml</code>, add the - role '<code>pluto</code>', and add a user in that role. The simplest way - to do this is to edit add the '<code>pluto</code>' role to the - '<code>tomcat</code>' user's record. Here is a sample - <code>tomcat-users.xml</code> file: - <div class="source"><pre> -<?xml version="1.0" encoding="utf-8"?> -<tomcat-users> - <role rolename="manager"/> - <role rolename="pluto"/> - <role rolename="tomcat"/> - <role rolename="role1"/> - <user username="tomcat" password="tomcat" roles="tomcat,pluto,manager"/> - <user username="role1" password="tomcat" roles="role1"/> - <user username="both" password="tomcat" roles="tomcat,role1"/> - <user username="pluto" password="pluto" roles="pluto,manager"/> -</tomcat-users> - </pre> -</div> -</p> -</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 - the user and password you just created in <code>tomcat-users.xml</code>. - If you added the 'pluto' role to the 'tomcat' user's record, you can - login as 'tomcat/tomcat'. - </p> -</div> -</div> + <div class="section"><h2><a name="Installing_the_Pluto_1.1_Binary_Build"></a>Installing the Pluto 1.1 Binary Build</h2> +<div class="highlightBox"><h4>About Pluto Distributions</h4> +<p> + There are a number of distributions to choose from depending + on your needs. + <ul><li><strong>pluto-current-bundle</strong> - Provides Pluto and Tomcat bundled together. + If you are getting started with Pluto, this is the distribution you + want.</li> +<li><strong>pluto-current-bin</strong> - Provides the Pluto libraries, portal and + testsuite web applications. Includes ant tasks.</li> +<li><strong>pluto-current-container-bin</strong> - Provides the Pluto container + libraries only.</li> +<li><strong>pluto-current-src</strong> - Provides the Pluto source code; requires + that you build and deploy Pluto on your own.</li> +</ul> +</p> +</div><ol type="1"><li>Download the Pluto 1.1 binary distribution named <strong>pluto-current-bundle</strong> 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-1.1-HOME> will be the top level directory.</li> +</ol> +<li>Execute startup.bat (Windows) or startup.sh (Unix) +in <PLUTO-1.1-HOME>/bin.</li> +<ol type="1"><li>Use shutdown.bat/shutdown.sh to stop the portal</li> +</ol> +<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=tomcat).</li> +</ol> +</div> +<div class="section"><h2><a name="Building_Pluto_1.1_from_Source"></a>Building Pluto 1.1 from Source</h2> +<p> + Maven 2 is utilized as the project management and build system for + Pluto 1.1. Pluto currently provides Maven plugins which can be used to + install the Pluto Portal, assemble portlet applications, deploy + applications, and publish portlet applications to the Pluto Portal. + </p> +<div class="section"><h3><a name="Obtaining_Pluto_1.1_Source_Code"></a>Obtaining Pluto 1.1 Source Code</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.3.x (there are separate + versions of the book covering the different versions of Subversion). + </p> +<p><b>Web Access to Subversion</b></p> +<p> + To browse the Pluto source code, you can use the + <a class="externalLink" href="http://svn.apache.org/viewcvs.cgi/portals/pluto/trunk?root=Apache-SVN">ViewCVS + web interface</a> to Subversion. This is current at all times. + </p> +<p><b>Normal Subversion Access</b></p> +<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> +<h3>Check out from Subversion</h3><p>To check out Pluto 1.1.<code>x</code> source to the 'pluto' directory use this command (substituting '<code>x</code>' for the + current release number, e.g. 1.1.<code>5</code>): + <pre>svn checkout https://svn.apache.org/repos/asf/portals/pluto/tags/pluto-1.1.x pluto</pre></p> +<p> + Zipped up Pluto 1.1 source distributions can also be downloaded from + a <a class="externalLink" href="http://www.apache.org/dyn/closer.cgi/portals/pluto/">distribution mirror</a>. + </p> +</div> +<div class="section"><h3><a name="Building_Pluto_with_Maven_2"></a>Building Pluto with Maven 2</h3> +<p> + If this is your first time building Pluto with Maven 2, edit <code>~/.m2/settings.xml</code> + and add the <pluginGroups> element: + <p><div class="source"><pre> +<settings> + ... + <pluginGroups> + <pluginGroup>org.apache.pluto</pluginGroup> + </pluginGroups> + ... +</settings> + </pre> +</div> +</p> + + If you don't have <code>org.apache.pluto</code> specified as a <code><pluginGroup></code>, + then the <code>pluto:install</code> will fail. + </p> +<p><code><PLUTO_SRCHOME></code> is the local directory where the + Pluto 1.1 source distribution has been checked out or unzipped into. + </p> +<p><div class="source"><pre> +$> cd <PLUTO_SRCHOME> +$> mvn install +$> mvn pluto:install -DinstallDir=path/to/appserver + </pre> +</div> +</p> +<p> + The <code>install</code> goal is a built in Maven 2 lifecycle + which builds the project artifacts and installs them into the Maven + repository. + </p> +<p> + The <code>pluto:install</code> goal will take the resulting artifacts + and properly deploy them within the configured Tomcat installation. + Currently, the Pluto install has been tested on Tomcat 5.5.9, 5.5.17 and 5.5.20, 5.5.23, and 6.0.13. + The Tomcat 5 archive can be found <a class="externalLink" href="http://archive.apache.org/dist/tomcat/tomcat-5/archive">here</a>. + </p> +<p> + If installing to a directory that contains spaces, <code>installDir</code> + needs to be enclosed within quotes: + </p> +<p><div class="source"><pre> +C:\pluto> mvn pluto:install -DinstallDir="C:\Program Files\Apache Software Foundation\Tomcat 5.5" + </pre> +</div> +</p> +</div> +<div class="section"><h3><a name="Installing_Pluto_Manually"></a>Installing Pluto Manually</h3> +<p> + This section documents the manual installation of Pluto 1.1 into Tomcat. It replaces + the pluto:install goal, but requires that the built-in Maven 2 install goal + (<code>mvn install</code>) be run from <code><PLUTO_SRCHOME></code>. + </p> +<p><b>Step 1:</b><div class="source"><pre> +$> cd <PLUTO_SRCHOME> +$> mvn install + </pre> +</div> +</p> +<p><b>Step 2:</b> Copy the following to + <code><TOMCAT_HOME>/shared/lib</code>: + <ul><li>castor-1.1.1.jar (Pluto 1.1.x only)</li> +<li>portlet-api-1.0.jar</li> +<li>pluto-container-x.x.x.jar (x.x.x is the version of Pluto you built)</li> +<li>pluto-taglib-x.x.x.jar (x.x.x is the version of Pluto you built)</li> +</ul> +</p> +<p><b>Step 3:</b> For platforms running on Java 1.4 and Pluto 1.1, copy the following to + <code><TOMCAT_HOME>/common/endorsed</code> (if you are running Java 1.5+, it is recommended to skip this step): + <ul><li>xercesImpl-2.6.2.jar</li> +<li>xmlParserAPIs-2.6.2.jar</li> +</ul> +</p> +<p><b>Step 4:</b> Copy the following to + <code><TOMCAT_HOME>/conf/Catalina/localhost</code>: + <ul><li><PLUTO_SRCHOME>/pluto-portal/src/main/resources/pluto.xml</li> +<li><PLUTO_SRCHOME>/pluto-testsuite/src/main/resources/testsuite.xml</li> +</ul> +</p> +<p><b>Step 5:</b> Copy the following to + <code><TOMCAT_HOME>/webapps</code>: + <ul><li><PLUTO_SRCHOME>/pluto-portal/target/pluto-portal.war</li> +<li><PLUTO_SRCHOME>/pluto-testsuite/target/pluto-testsuite.war</li> +</ul> +</p> +</div> +<div class="section"><h3><a name="Configuring_Source-Built_Pluto_for_Application_Scope_PortletSession_Attributes"></a>Configuring Source-Built Pluto for Application Scope PortletSession Attributes</h3> +<p>To be able to use application-scoped <code>PortletSession</code> attributes in Pluto, modify + the Connector element for port 8080 in <code><TOMCAT_HOME>/conf/server.xml</code> by + adding the following attribute and value: emptySessionPath="true". + </p> +</div> +<div class="section"><h3><a name="Configuring_User_and_Role_in_the_Pluto_Source_Build"></a>Configuring User and Role in the Pluto Source Build</h3> +<p> + The Pluto Testsuite portlet application needs the role '<code>pluto</code>' + to run the Security Mapping Test. So before starting tomcat, you should + edit <code><TOMCAT_HOME>/conf/tomcat-users.xml</code>, add the + role '<code>pluto</code>', and add a user in that role. The simplest way + to do this is to edit add the '<code>pluto</code>' role to the + '<code>tomcat</code>' user's record. Here is a sample + <code>tomcat-users.xml</code> file: + <div class="source"><pre> +<?xml version="1.0" encoding="utf-8"?> +<tomcat-users> + <role rolename="manager"/> + <role rolename="pluto"/> + <role rolename="tomcat"/> + <role rolename="role1"/> + <user username="tomcat" password="tomcat" roles="tomcat,pluto,manager"/> + <user username="role1" password="tomcat" roles="role1"/> + <user username="both" password="tomcat" roles="tomcat,role1"/> + <user username="pluto" password="pluto" roles="pluto,manager"/> +</tomcat-users> + </pre> +</div> +</p> +</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 + the user and password you just created in <code>tomcat-users.xml</code>. + If you added the 'pluto' role to the 'tomcat' user's record, you can + login as 'tomcat/tomcat'. + </p> +</div> +</div> </div> </div> @@ -473,7 +463,7 @@ $> mvn install </div> <div id="footer"> <div class="xright">© - 2004-2011 + 2004-2016 Apache Software Foundation