You are viewing a plain text version of this content. The canonical link for it is here.
Posted to wsrp4j-dev@portals.apache.org by jm...@apache.org on 2006/04/06 23:07:51 UTC
svn commit: r392075 - in
/portals/wsrp4j/trunk/site/src/documentation/content/xdocs/gettingstarted:
config.xml execution.xml installation.xml
Author: jmacna
Date: Thu Apr 6 14:07:47 2006
New Revision: 392075
URL: http://svn.apache.org/viewcvs?rev=392075&view=rev
Log:
Update installation notes to include how to use maven to build and install
Modified:
portals/wsrp4j/trunk/site/src/documentation/content/xdocs/gettingstarted/config.xml
portals/wsrp4j/trunk/site/src/documentation/content/xdocs/gettingstarted/execution.xml
portals/wsrp4j/trunk/site/src/documentation/content/xdocs/gettingstarted/installation.xml
Modified: portals/wsrp4j/trunk/site/src/documentation/content/xdocs/gettingstarted/config.xml
URL: http://svn.apache.org/viewcvs/portals/wsrp4j/trunk/site/src/documentation/content/xdocs/gettingstarted/config.xml?rev=392075&r1=392074&r2=392075&view=diff
==============================================================================
--- portals/wsrp4j/trunk/site/src/documentation/content/xdocs/gettingstarted/config.xml (original)
+++ portals/wsrp4j/trunk/site/src/documentation/content/xdocs/gettingstarted/config.xml Thu Apr 6 14:07:47 2006
@@ -22,29 +22,27 @@
<body>
<section>
<title>Producer Configuration</title>
- <ol>
- <li>
- Edit the portletentityregistry.xml file. (e.g.
- c:/Tomcat4.1/webapps/wsrp/WEB-INF/data/portletentityregistry.xml)
- <p>Add a new application element for your webapp.</p>
- <p>The definition ID has to match the webapp name, so for the sample,
- this is wsrptest.</p>
- <p>The portlet id will map to its handle, so make up a number.</p>
- <p>The definition id maps to its name in the portlet.xml file like
- so: <webapp-name>.<portlet-name></p>
- </li>
-
- <li>
- Create a portlet.xml file in your webapps/webapp-name/WEB-INF/
- directory.
- <p>Use webapps/wsrptest/WEB-INF/portlet.xml as a reference.</p>
- <p>The portlet name must match the second part of the definition id
- above.</p>
- </li>
- <!--<note>WRT to handles. It looks like the handle looked for by the Consumer is
- 0.1, but the portlet ID is 1. So if your new portlet has an ID of 3, then it's handle will be 0.3.
- </note>-->
- </ol>
+ <p>
+ The WSRP4J embeds Pluto as its portlet container. To add a
+ portlet to be hosted by the WSRP4J Producer, use Pluto's deploy
+ function to deploy the portlet's WAR file. The testportlet that
+ comes with WSRP4J uses the following maven goal to deploy itself
+ to Pluto. This code can be found in wsrp4j/testport/maven.xml.
+ </p>
+ <source>
+ <goal name="tomcat:deploy">
+ <java classname="org.apache.pluto.driver.deploy.CLI" fork="yes">
+ <classpath>
+ <path refid="maven.dependency.classpath"/>
+ <pathelement path="${maven.build.dest}"/>
+ </classpath>
+ <arg value="-verbose"/>
+ <arg value="-p"/><arg value="${maven.tomcat.home}/webapps/wsrp4j-producer"/>
+ <arg value="-d"/><arg value="${maven.tomcat.home}/webapps"/>
+ <arg value="${basedir}/target/${maven.war.final.name}"/>
+ </java>
+ </goal>
+ </source>
</section>
<section>
Modified: portals/wsrp4j/trunk/site/src/documentation/content/xdocs/gettingstarted/execution.xml
URL: http://svn.apache.org/viewcvs/portals/wsrp4j/trunk/site/src/documentation/content/xdocs/gettingstarted/execution.xml?rev=392075&r1=392074&r2=392075&view=diff
==============================================================================
--- portals/wsrp4j/trunk/site/src/documentation/content/xdocs/gettingstarted/execution.xml (original)
+++ portals/wsrp4j/trunk/site/src/documentation/content/xdocs/gettingstarted/execution.xml Thu Apr 6 14:07:47 2006
@@ -17,24 +17,38 @@
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.2//EN" "http://apache.org/forrest/dtd/document-v12.dtd">
<document>
<header>
- <title>Executing WSRP Components</title>
+ <title>Running the SwingConsumer</title>
</header>
<body>
- <ol>
- <li>Start Tomcat.</li>
- <li>Run the TCPMonitor program by
- executing the tunnel script in the tools directory. You may need
- to edit the tunnel script file to change the port mapping. By
- default, the SwingConsumer attempts to contact the Producer on
- port 8081. Tomcat is customarily configured to listen to port
- 8080. The tunnel script listens on port 8081 and writes to 8080
- by default. If Tomcat is listening on a port other than 8080,
- you will have to edit the tunnel.bat file. Note that you can
- also alter the relevant ports once the TCPMonitor is
- started.</li>
- <li>Run the SwingConsumer by executing the run
- script in the driver/SwingConsumer directory.</li>
- </ol>
+ <section><title>Running the SwingConsumer</title>
+
+ <p>Start the Producer by starting Tomcat, if it's not already running.</p>
+ <p>Run the TCPMonitor program by running the following maven command:</p>
+ <source>
+ maven tunnel
+ </source>
+ <p>
+ The tunnel defaults to listening on port 8081 and sending to
+ port 8080. The SwingConsumer sends to port 8081 by default.
+ Note that you can also alter the relevant ports once the
+ TCPMonitor is started.
+ </p>
+ <p>
+ Run the SwingConsumer by executing the following maven command:
+ </p>
+ <source>
+ maven run-swingconsumer
+ </source>
+ </section>
+ <section><title>Changing the SwingConsumer's Producer URL</title>
+ <p>
+ The SwingConsumer stores persistent files in the
+ wsrp4j/consumer-swingconsumer/target/persistence directory. In
+ the producers subdirectory, edit the file named:
+ org.apache.wsrp4j.commons.consumer.driver.ProducerImpl@WSRP4J.xml
+ and change all the URLs.
+ </p>
+ </section>
</body>
</document>
Modified: portals/wsrp4j/trunk/site/src/documentation/content/xdocs/gettingstarted/installation.xml
URL: http://svn.apache.org/viewcvs/portals/wsrp4j/trunk/site/src/documentation/content/xdocs/gettingstarted/installation.xml?rev=392075&r1=392074&r2=392075&view=diff
==============================================================================
--- portals/wsrp4j/trunk/site/src/documentation/content/xdocs/gettingstarted/installation.xml (original)
+++ portals/wsrp4j/trunk/site/src/documentation/content/xdocs/gettingstarted/installation.xml Thu Apr 6 14:07:47 2006
@@ -19,64 +19,56 @@
<header>
<title>Installation</title>
</header>
- <body>
+ <body>
+ <section><title>Prerequisites</title>
+ <ol>
+ <li>JDK 1.5.0 or higher</li>
+ <li>Subversion Client</li>
+ <li>Maven 1.0.2 </li>
+ <li>Tomcat 5.5, although other versions may work</li>
+ </ol>
+ </section>
+ <section><title>Downloading</title>
<p>
- The WSRP4J Project provides a producer component as well as a
- consumer component. Each of these components can be installed
- separately and has different prerequisites. The easiest way to
- install any of these components is to execute the appropriate
- batch file from the build directory. Alternatively you can start
- the build batch file with the appropriate argument. To get more
- information about available build targets, start build with no
- arguments.
+ Obtain WSRP4J from Subversion. The instructions are <link
+ href="site:cvs">here</link>.
+ </p>
+ </section>
+ <section><title>Project Components</title>
+ <p>
+ The WSRP4J Project is divided into the following components:
</p>
<ol>
- <li>Configure the location of your Tomcat installation.
- <p>
- Currently you have to do this in several locations. In each
- location you have to copy a file called <em>build.properties.example</em>
- to <em>build.properties</em> and correct the path to the
- Tomcat directory in the newly created file. The file locations are:
- </p>
- <ul>
- <li>In the wsrp4j/build directory,</li>
- <li>in the wsrp4j/portlets/proxyportlet directory and</li>
- <li>in the wsrp4j/portlets/wsrptest directory.</li>
- <li>in the wsrp4j/portlets/calc directory.</li>
- </ul>
- <p>
- Additionally, if you want to build any of the portlet components
- (ProxyPortlet or WSRPTest), you have to create the files
- proxyportlet.include and/or wsrptest.include and/or calc.include in the
- wsrp4j/portlets/build/ directory.
- </p>
- </li>
- <li>Change your working directory to the wsrp4j/build direcory.</li>
- <li>Run the install-swing-consumer script (either sh or bat).
- <p>
- This script rebuilds the WSRP4J core project and installs the
- WSRP4J Swing Consumer into the wsrp4j/driver directory.
- </p>
- <p>
- Prereq's: JDK 1.3.x
- </p>
- </li>
- <li>Run the install-provider-pluto script (either sh or bat).
- <p>
- The Pluto provider is installed as a webapp in the Tomcat webapps
- directory. A sample portlet is also installed.
- </p>
- <p>
- The Pluto provider is a WSRP Producer which is able to provide
- access to JSR168 compliant portlets via a web services
- interface.
- </p>
- <p>
- Prereq's: Tomcat 4.1.24 or higher, JDK 1.3.x
- </p>
- </li>
- <li>Next: <link href="execution.html">Run the Consumer. </link></li>
+ <li>producer</li>
+ <li>consumer</li>
+ <li>commons</li>
+ <li>commons-producer</li>
+ <li>commons-consumer</li>
+ <li>consumer-swingconsumer</li>
+ <li>testportlet</li>
</ol>
+ </section>
+
+ <section><title>Using Maven</title>
+ <p>
+ To build WSRP4J, execute the following maven command:
+ </p>
+ <source>
+ maven build
+ </source>
+ <p>
+ To build and install the WSRP4J Producer on Tomcat, execute the following maven command:
+ </p>
+ <source>
+ maven deploy-producer
+ </source>
+
+ <p>
+ Next: <link href="execution.html">Run the Consumer. </link>
+
+ </p>
+
+ </section>
</body>
</document>