You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@beehive.apache.org by st...@apache.org on 2004/10/15 19:14:48 UTC
svn commit: rev 54858 - in incubator/beehive/trunk/site: build/site src/documentation/content/xdocs
Author: steveh
Date: Fri Oct 15 10:14:47 2004
New Revision: 54858
Modified:
incubator/beehive/trunk/site/build/site/building.html
incubator/beehive/trunk/site/src/documentation/content/xdocs/building.xml
Log:
Adding docs on building beehive.
This doc is a 'forrestization' of /trunk/BUILDING.txt
Modified: incubator/beehive/trunk/site/build/site/building.html
==============================================================================
--- incubator/beehive/trunk/site/build/site/building.html (original)
+++ incubator/beehive/trunk/site/build/site/building.html Fri Oct 15 10:14:47 2004
@@ -2,7 +2,7 @@
<html>
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<title>Beehive Page Flow Tutorial</title>
+<title>Building Beehive</title>
<link type="text/css" href="skin/page.css" rel="stylesheet">
</head>
<body text="#000000" bgcolor="#FFFFFF">
@@ -223,754 +223,114 @@
<table class="title" summary="">
<tr>
<td valign="middle">
-<h1>Beehive Page Flow Tutorial</h1>
+<h1>Building Beehive</h1>
</td>
</tr>
</table>
<ul class="minitoc">
<li>
-<a href="#intro">Introduction To the Page Flow Tutorial</a>
-<ul class="minitoc">
-<li>
-<a href="#Tutorial+Goals">Tutorial Goals</a>
-</li>
-<li>
-<a href="#Note+on+the+Current+State+of+the+Page+Flow+Tutorial">Note on the Current State of the Page Flow Tutorial</a>
-</li>
-</ul>
-</li>
-<li>
-<a href="#step1">Step 1: Begin the Page Flow Tutorial</a>
-<ul class="minitoc">
-<li></li>
-<li>
-<a href="#Download+and+Install+JDK5">Download and Install JDK5</a>
-</li>
-<li>
-<a href="#Download+and+Install+SVN+%28Subversion+Source+Control%29">Download and Install SVN (Subversion Source Control)</a>
-</li>
-<li>
-<a href="#Download+and+Install+Beehive">Download and Install Beehive</a>
-</li>
-<li>
-<a href="#Install+ANT">Install ANT</a>
-</li>
-<li>
-<a href="#Run+the+">Run the bootstrap Target</a>
-</li>
-</ul>
-</li>
-<li>
-<a href="#step_2">Step 2: Create a New Page Flow Application</a>
-<ul class="minitoc">
-<li>
<a href="#Introduction">Introduction</a>
</li>
<li>
-<a href="#To+Create+a+Controller+File">To Create a Controller File</a>
-</li>
-<li>
-<a href="#To+Create+a+JSP+File">To Create a JSP File</a>
-</li>
-<li>
-<a href="#To+Create+the+WEB-INF+directory">To Create the WEB-INF directory</a>
-</li>
-<li>
-<a href="#Compile+the+Page+Flow">Compile the Page Flow</a>
-</li>
-<li>
-<a href="#To+Start+the+Tomcat+Server">To Start the Tomcat Server</a>
-</li>
-<li>
-<a href="#To+Test+the+Page+Flow+Web+Application">To Test the Page Flow Web Application</a>
-</li>
-</ul>
-</li>
-<li>
-<a href="#step_3">Step 3: Navigation</a>
-<ul class="minitoc">
-<li>
-<a href="#Create+a+Destination+JSP+Page">Create a Destination JSP Page</a>
-</li>
-<li>
-<a href="#Create+a+Link+to+the+Destination+Page">Create a Link to the Destination Page</a>
-</li>
-<li>
-<a href="#Add+an+Action+Method+to+Handle+the+Link">Add an Action Method to Handle the Link</a>
-</li>
-<li>
-<a href="#Compile+the+Page+Flow-N101D6">Compile the Page Flow</a>
-</li>
-<li>
-<a href="#To+Start+the+Tomcat+Server-N101FE">To Start the Tomcat Server</a>
-</li>
-<li>
-<a href="#To+Test+the+Page+Flow+Web+Application-N10214">To Test the Page Flow Web Application</a>
-</li>
-<li>
-<a href="#Shutdown+Tomcat+Server">Shutdown Tomcat Server</a>
-</li>
-</ul>
-</li>
-<li>
-<a href="#step_4">Step 4: Submitting Data</a>
-<ul class="minitoc">
-<li>
-<a href="#To+Create+a+Submission+Form">To Create a Submission Form</a>
-</li>
-<li>
-<a href="#To+Edit+the+Controller+File+to+Handle+the+Submitted+Data">To Edit the Controller File to Handle the Submitted Data</a>
+<a href="#setup">Setting Up Beehive on Your Machine</a>
</li>
<li>
-<a href="#Compile+the+Page+Flow-N10263">Compile the Page Flow</a>
+<a href="#Building+Beehive">Building Beehive</a>
</li>
<li>
-<a href="#To+Start+the+Tomcat+Server-N1028B">To Start the Tomcat Server</a>
-</li>
-<li>
-<a href="#To+Test+the+Page+Flow+Web+Application-N102A1">To Test the Page Flow Web Application</a>
-</li>
-<li>
-<a href="#Shutdown+Tomcat+Server-N102B7">Shutdown Tomcat Server</a>
+<a href="#Using+Proxies+With+a+Beehive+Build">Using Proxies With a Beehive Build</a>
</li>
</ul>
-</li>
-<li>
-<a href="#step_5">Step 5: Processing and Displaying Data</a>
-<ul class="minitoc">
-<li>
-<a href="#To+Process+the+Submitted+Data">To Process the Submitted Data</a>
-</li>
-<li>
-<a href="#To+Create+a+JSP+Page+to+Display+Submitted+Data">To Create a JSP Page to Display Submitted Data</a>
-</li>
-<li>
-<a href="#Compile+the+Page+Flow-N102E7">Compile the Page Flow</a>
-</li>
-<li>
-<a href="#To+Start+the+Tomcat+Server-N1030F">To Start the Tomcat Server</a>
-</li>
-<li>
-<a href="#To+Test+the+Page+Flow+Web+Application-N10325">To Test the Page Flow Web Application</a>
-</li>
-<li>
-<a href="#Shutdown+Tomcat+Server-N1033B">Shutdown Tomcat Server</a>
-</li>
-</ul>
-</li>
-<li>
-<a href="#summary">Summary: Page Flow Tutorial</a>
-</li>
-</ul>
-
-<a name="N1000C"></a><a name="intro"></a>
-<h3>Introduction To the Page Flow Tutorial</h3>
-<div style="margin-left: 0 ; border: 2px">
-<a name="N10012"></a><a name="Tutorial+Goals"></a>
-<h4>Tutorial Goals</h4>
-<div style="margin-left: 0 ; border: 2px">
-<p>In this tutorial, you will learn:</p>
-<ul>
-
-<li>How to create a basic Page Flow web application</li>
-
-<li>How to coordinate user navigation with Forward methods</li>
-
-<li>How to handle data submission and processing with data binding and Form Beans</li>
-
-<li>How to create a user interface with the <neuti> JSP tag library</li>
-
-<li>How Page Flows help to separate data processing and data presentation</li>
-
-</ul>
-</div>
-<a name="N1002E"></a><a name="Note+on+the+Current+State+of+the+Page+Flow+Tutorial"></a>
-<h4>Note on the Current State of the Page Flow Tutorial</h4>
-<div style="margin-left: 0 ; border: 2px">
-<p>This tutorial is currently a work in progress. Unfinished portions of the tutorial are marked [tbd], standing for "to be done". Also the tutorial assumes that you are using a Windows machine, however, with a little common sense it is very easy to run through the tutorial on a Linux machine. For example, where the tutorial tells you to run FOO.cmd, instead run FOO.sh.</p>
-<p>Please send any comments to Steve Hanson, at <span class="codefrag">steveh@bea.com</span>.</p>
-</div>
-</div>
-
-<a name="N1003F"></a><a name="step1"></a>
-<h3>Step 1: Begin the Page Flow Tutorial</h3>
-<div style="margin-left: 0 ; border: 2px">
-<a name="N10045"></a>
-<h4></h4>
-<div style="margin-left: 0 ; border: 2px"></div>
-<a name="N1004B"></a><a name="Download+and+Install+JDK5"></a>
-<h4>Download and Install JDK5</h4>
-<div style="margin-left: 0 ; border: 2px">
-<p>If you do not have JDK5 installed on your machine, visit <a target="_blank" href="http://java.sun.com/j2se/1.5.0/download.jsp">http://java.sun.com/j2se/1.5.0/download.jsp</a> and download the latest version of JDK5.</p>
-<p>Throughout this tutorial, it is assumed that you have JDK 5 installed at <span class="codefrag">C:\jdk1.5.0</span>
-</p>
-<p>[tbd: more detailed installation instructions]</p>
-</div>
-<a name="N10061"></a><a name="Download+and+Install+SVN+%28Subversion+Source+Control%29"></a>
-<h4>Download and Install SVN (Subversion Source Control)</h4>
+
+<a name="N1000C"></a><a name="Introduction"></a>
+<h3>Introduction</h3>
<div style="margin-left: 0 ; border: 2px">
-<p>Visit <a target="_blank" href="http://subversion.tigris.org">http://subversion.tigris.org</a> and install the SVN source control system.</p>
-<p>[tbd: more detailed installation instructions]</p>
+<p>This topic explains how to download and build the Beehive source code on your local machine.</p>
</div>
-<a name="N10072"></a><a name="Download+and+Install+Beehive"></a>
-<h4>Download and Install Beehive</h4>
+
+<a name="N10016"></a><a name="setup"></a>
+<h3>Setting Up Beehive on Your Machine</h3>
<div style="margin-left: 0 ; border: 2px">
+<p>To build Beehive, you need to have Java version 5 (or later) installed
+ with the JAVA_HOME environment variable defined to point to this JDK.
+ The JDK is available here:
+ </p>
+<pre class="code"> http://java.sun.com/j2se/1.5.0/download.jsp</pre>
<p>
- Create a directory called <span class="codefrag">beehive-src</span> on your C: drive. Confirm that the the following directory structure exists: <span class="codefrag">C:/beehive-src</span>. This directory will store the Beehive source and all of your Beehive projects. </p>
-<p>Open a command shell.</p>
-<p>At the command prompt, enter: <span class="codefrag">cd beehive-src</span>
-
-</p>
-<p>At the command prompt, enter: <span class="codefrag">svn checkout http://svn.apache.org/repos/asf/incubator/beehive/trunk/</span>
-
-</p>
-<p>Wait a few minutes while the Beehive source is downloaded to your local machine.</p>
-<p>At the command prompt, enter: <span class="codefrag">exit</span>
-
-</p>
-</div>
-<a name="N1009A"></a><a name="Install+ANT"></a>
-<h4>Install ANT</h4>
-<div style="margin-left: 0 ; border: 2px">
-<p>Create a directory named <span class="codefrag">installed</span>at <span class="codefrag">C:/beehive-src/trunk/installed</span>.</p>
-<p>Unzip the file <span class="codefrag">C:/beehive-src/trunk/external/ant/apache-ant-1.6.2-bin.zip</span> into <span class="codefrag">C:/beehive-src/Beehive/installed</span>.</p>
-<p>After the file has unzipped, confirm that the following directory structure exists: <span class="codefrag">C:/beehive-src/trunk/installed/apache-ant-1.6.2</span>.</p>
-</div>
-<a name="N100B9"></a><a name="Run+the+"></a>
-<h4>Run the bootstrap Target</h4>
-<div style="margin-left: 0 ; border: 2px">
-<p>At the command prompt, enter: <span class="codefrag">set JAVA_HOME=C:\jdk1.5.0</span>
-
-</p>
-<p>At the command prompt, enter: <span class="codefrag">set BEEHIVE_HOME=C:\beehive-src\trunk</span>
-
-</p>
-<p>At the command prompt, enter: <span class="codefrag">cd C:\beehive-src\trunk</span>
-
-</p>
-<p>At the command prompt, enter: <span class="codefrag">beehiveEnv.cmd</span>
-
-</p>
-<p>At the command prompt, enter: <span class="codefrag">ant bootstrap</span>
-
-</p>
-<p>At the command prompt, enter: <span class="codefrag">exit</span>
-
-</p>
-</div>
-</div>
-
-<a name="N100E8"></a><a name="step_2"></a>
-<h3>Step 2: Create a New Page Flow Application</h3>
-<div style="margin-left: 0 ; border: 2px">
-<a name="N100EE"></a><a name="Introduction"></a>
-<h4>Introduction</h4>
-<div style="margin-left: 0 ; border: 2px">
+ Set the BEEHIVE_HOME environment variable to point to the root of the branch in your
+ Beehive working copy that you want to work with. Typically you will be interested in
+ the trunk, where mainline work goes on. For example, if you ran
+ </p>
+<pre class="code">svn checkout https://svn.apache.org/repos/asf/incubator/beehive/trunk</pre>
<p>
- In this step you will create a Controller file and a JSP page. A Controller file is a Java class (with the JPF file extension) that controls how your web application functions and what it does. The methods in the Controller file determines all of the major features of a web application: how users navigate from page to page, how user requests are handled, and how the web application accesses back-end resources.
- </p>
-<p>
- Controller files control the features of a web application through the use of Action methods. An Action method may do something simple, such as forward a user from one JSP page to another; or it may do something complex, such as receive user input from a JSP page, calculate and/or retrieve other data based on the user input, and forward the user to a JSP page where the results are displayed.
- </p>
+ from within "C:\MyProjects\beehive", BEEHIVE_HOME will be "C:\MyProjects\beehive",
+ since you explicitly only checked out the trunk.
+ </p>
+<p>However, if you had run</p>
+<pre class="code">svn checkout https://svn.apache.org/repos/asf/incubator/beehive</pre>
+<p>from within "C:\MyProjects\beehive", BEEHIVE_HOME will be "C:\MyProjects\beehive\trunk".</p>
+<p>In addition, you'll need to install Ant in $BEEHIVE_HOME/installed/ from
+ the archive in $BEEHIVE_HOME/external/ant/apache-ant-1.6.2-bin.(zip|tar.gz).
+ The installed Ant distribution should end up here:</p>
+<pre class="code"> $BEEHIVE_HOME/installed/apache-ant-1.6.2/...</pre>
+</div>
+
+<a name="N10043"></a><a name="Building+Beehive"></a>
+<h3>Building Beehive</h3>
+<div style="margin-left: 0 ; border: 2px">
+<p>In the following examples, '$>' is your propmpt at $BEEHIVE_HOME, so if
+ you see '$>ant', type 'ant' (without the quotes) and press [enter].</p>
+<p>To initialize the Beehive build environment, run beehiveEnv for your platform:</p>
<p>
- The Controller file you create in this step contains one simple Action method. This simple navigational Action method forwards users to the index.jsp page. In the next step, you will create a more complex Action method.
- </p>
-</div>
-<a name="N100FE"></a><a name="To+Create+a+Controller+File"></a>
-<h4>To Create a Controller File</h4>
-<div style="margin-left: 0 ; border: 2px">
-<p>In this step you will create the Controller file in place in the Tomcat deployment directory.</p>
-<p>In the directory <span class="codefrag">C:/beehive-src/trunk/installed/jakarta-tomcat-5.0.25/webapps</span>, create a directory called <span class="codefrag">pageflow_tutorial</span>.</p>
-<p>In the directory <span class="codefrag">C:/beehive-src/trunk/installed/jakarta-tomcat-5.0.25/webapps/pageflow_tutorial</span>, create a file called <span class="codefrag">Controller.jpf</span>.</p>
-<p>In a text editor (or your IDE of choice), open the file Controller.jpf.</p>
-<p>Edit Controller.jpf so it appears as follows.</p>
-<pre class="code">
-import org.apache.beehive.netui.pageflow.Forward;
-import org.apache.beehive.netui.pageflow.PageFlowController;
-import org.apache.beehive.netui.pageflow.annotations.Jpf;
-
-@Jpf.Controller
-public class Controller extends PageFlowController
-{
- @Jpf.Action(
- forwards={
- @Jpf.Forward(name="success", path="index.jsp")
- }
- )
- protected Forward begin()
- {
- return new Forward("success");
- }
-}
- </pre>
+ Windows:
+ </p>
+<pre class="code"> C:\MyProjects\beehive>beehiveEnv.cmd</pre>
+<p>UNIX:</p>
+<pre class="code"> $>source beehiveEnv.sh</pre>
+<p>Because Beehive depends on a set of external software, these dependencies need
+ to be installed before a build can be successful. You will need a network
+ connection for this step because jsr173_api.jar needs to be downloaded from a
+ website; if you need to use a proxy for this downolad, see the "Using Proxies"
+ instructions below. Once this has been downloaded, the build and tests can
+ be run successfully without a network connection. To install the external
+ dependnecies, run:</p>
+<pre class="code"> $>ant bootstrap</pre>
+<p>which will unzip Log4J and Tomcat installers. </p>
+<p>To build Beehive, run:</p>
+<pre class="code"> $>ant clean deploy</pre>
+<p>To run Beehive tests, run:</p>
+<pre class="code"> $>ant drt</pre>
</div>
-<a name="N10125"></a><a name="To+Create+a+JSP+File"></a>
-<h4>To Create a JSP File</h4>
-<div style="margin-left: 0 ; border: 2px">
-<p>In the directory <span class="codefrag">C:/beehive-src/trunk/installed/jakarta-tomcat-5.0.25/webapps/pageflow_tutorial</span>, create a file named <span class="codefrag">index.jsp</span>.</p>
-<p>Edit index.jsp so it looks like the following.</p>
-<pre class="code">
-<%@ page language="java" contentType="text/html;charset=UTF-8"%>
-<%@ taglib uri="http://beehive.apache.org/netui/tags-databinding-1.0" prefix="netui-data"%>
-<%@ taglib uri="http://beehive.apache.org/netui/tags-html-1.0" prefix="netui"%>
-<%@ taglib uri="http://beehive.apache.org/netui/tags-template-1.0" prefix="netui-template"%>
-<netui:html>
- <head>
- <title>index.jsp</title>
- <netui:base/>
- </head>
- <netui:body>
- <p>
- index.jsp
- </p>
- </netui:body>
-</netui:html>
- </pre>
-</div>
-<a name="N1013D"></a><a name="To+Create+the+WEB-INF+directory"></a>
-<h4>To Create the WEB-INF directory</h4>
-<div style="margin-left: 0 ; border: 2px">
-<p> Open a command shell.</p>
-<p>At the command prompt, enter: <span class="codefrag">cd C:\beehive-src\trunk</span>
-
-</p>
-<p>At the command prompt, enter: <span class="codefrag">beehiveEnv.cmd</span>
-
-</p>
-<p>At the command prompt, enter: <span class="codefrag">cd C:\beehive-src\trunk\netui\ant</span>
-
-</p>
-<p>At the command prompt, enter: <span class="codefrag">ant -f webappTemplate.xml -Dwebapp.dist.dir=C:\beehive-src\trunk\installed\jakarta-tomcat-5.0.25\webapps\pageflow_tutorial</span>
-
-</p>
-</div>
-<a name="N1015F"></a><a name="Compile+the+Page+Flow"></a>
-<h4>Compile the Page Flow</h4>
-<div style="margin-left: 0 ; border: 2px">
-<p>At the command prompt, enter: <span class="codefrag">cd C:\beehive-src\trunk\test\ant</span>
-
-</p>
-<p>At the command prompt, enter: <span class="codefrag">ant -f buildWebapp.xml build.webapp -Dwebapp.dir=C:\beehive-src\trunk\installed\jakarta-tomcat-5.0.25\webapps\pageflow_tutorial</span>
-
-</p>
-</div>
-<a name="N10172"></a><a name="To+Start+the+Tomcat+Server"></a>
-<h4>To Start the Tomcat Server</h4>
-<div style="margin-left: 0 ; border: 2px">
-<p>At the command prompt, enter: <span class="codefrag">cd C:\beehive-src\trunk\installed\jakarta-tomcat-5.0.25\bin</span>
-
-</p>
-<p>At the command prompt, enter: <span class="codefrag">startup.bat</span>
-
-</p>
-<p>Leave this command shell open, so that you can stop and restart Tomcat when necessary.</p>
-</div>
-<a name="N10188"></a><a name="To+Test+the+Page+Flow+Web+Application"></a>
-<h4>To Test the Page Flow Web Application</h4>
-<div style="margin-left: 0 ; border: 2px">
-<p>Open a web browser and enter the following in the address bar: <span class="codefrag">http://localhost:8080/pageflow_tutorial</span>
-
-</p>
-<p>You will be directed to the index.jsp page.</p>
-</div>
-</div>
-
-<a name="N10199"></a><a name="step_3"></a>
-<h3>Step 3: Navigation</h3>
-<div style="margin-left: 0 ; border: 2px">
-<a name="N1019F"></a><a name="Create+a+Destination+JSP+Page"></a>
-<h4>Create a Destination JSP Page</h4>
-<div style="margin-left: 0 ; border: 2px">
-<p>In the directory <span class="codefrag">C:/beehive-src/trunk/installed/jakarta-tomcat-5.0.25/webapps/pageflow_tutorial</span>, create a file named <span class="codefrag">page2.jsp</span>.</p>
-<p>Edit page2.jsp so it looks like the following.</p>
-<pre class="code">
-<%@ page language="java" contentType="text/html;charset=UTF-8"%>
-<%@ taglib uri="http://beehive.apache.org/netui/tags-databinding-1.0" prefix="netui-data"%>
-<%@ taglib uri="http://beehive.apache.org/netui/tags-html-1.0" prefix="netui"%>
-<%@ taglib uri="http://beehive.apache.org/netui/tags-template-1.0" prefix="netui-template"%>
-<netui:html>
- <head>
- <title>page2.jsp</title>
- <netui:base/>
- </head>
- <netui:body>
- <p>
- Welcome to page2.jsp!
- </p>
- </netui:body>
-</netui:html>
- </pre>
-</div>
-<a name="N101B7"></a><a name="Create+a+Link+to+the+Destination+Page"></a>
-<h4>Create a Link to the Destination Page</h4>
-<div style="margin-left: 0 ; border: 2px">
-<p>Open the file C:/beehive-src/trunk/installed/jakarta-tomcat-5.0.25/webapps/pageflow_tutorial/index.jsp.</p>
-<p>Edit index.jsp so it appears as follows.</p>
-<pre class="code">
-<%@ page language="java" contentType="text/html;charset=UTF-8"%>
-<%@ taglib uri="http://beehive.apache.org/netui/tags-databinding-1.0" prefix="netui-data"%>
-<%@ taglib uri="http://beehive.apache.org/netui/tags-html-1.0" prefix="netui"%>
-<%@ taglib uri="http://beehive.apache.org/netui/tags-template-1.0" prefix="netui-template"%>
-<netui:html>
- <head>
- <title>index.jsp</title>
- <netui:base/>
- </head>
- <netui:body>
- <p>
- index.jsp
- </p>
- <p>
- <netui:anchor action="toPage2">Link to page2.jsp</netui:anchor>
- </p>
- </netui:body>
-</netui:html>
- </pre>
-</div>
-<a name="N101C9"></a><a name="Add+an+Action+Method+to+Handle+the+Link"></a>
-<h4>Add an Action Method to Handle the Link</h4>
-<div style="margin-left: 0 ; border: 2px">
-<p>Open the file C:/beehive-src/trunk/installed/jakarta-tomcat-5.0.25/webapps/pageflow_tutorial/Controller.jpf.</p>
-<p>Edit Controller.jpf so it appears as follows.</p>
-<pre class="code">
-import org.apache.beehive.netui.pageflow.Forward;
-import org.apache.beehive.netui.pageflow.PageFlowController;
-import org.apache.beehive.netui.pageflow.annotations.Jpf;
-
-public class Controller
- extends PageFlowController
-{
- @Jpf.Action(
- forwards={
- @Jpf.Forward(name="success", path="index.jsp")
- }
- )
- protected Forward begin()
- {
- return new Forward("success");
- }
-
- @Jpf.Action(
- forwards={
- @Jpf.Forward(name="success", path="page2.jsp")
- }
- )
- public Forward toPage2()
- {
- return new Forward("success");
- }
-}
- </pre>
-</div>
-<a name="N101DB"></a><a name="Compile+the+Page+Flow-N101D6"></a>
-<h4>Compile the Page Flow</h4>
-<div style="margin-left: 0 ; border: 2px">
-<p>Open a command shell.</p>
-<p>At the command prompt, enter: <span class="codefrag">set JAVA_HOME=C:\jdk1.5.0</span>
-
-</p>
-<p>At the command prompt, enter: <span class="codefrag">cd C:\beehive-src\trunk</span>
-
-</p>
-<p>At the command prompt, enter: <span class="codefrag">beehiveEnv.cmd</span>
-
-</p>
-<p>At the command prompt, enter: <span class="codefrag">cd C:\beehive-src\trunk\test\ant</span>
-
-</p>
-<p>At the command prompt, enter: <span class="codefrag">ant -f buildWebapp.xml build.webapp -Dwebapp.dir=C:\beehive-src\trunk\installed\jakarta-tomcat-5.0.25\webapps\pageflow_tutorial</span>
-
-</p>
-</div>
-<a name="N10203"></a><a name="To+Start+the+Tomcat+Server-N101FE"></a>
-<h4>To Start the Tomcat Server</h4>
-<div style="margin-left: 0 ; border: 2px">
-<p>At the command prompt, enter: <span class="codefrag">cd C:\beehive-src\trunk\installed\jakarta-tomcat-5.0.25\bin</span>
-
-</p>
-<p>At the command prompt, enter: <span class="codefrag">startup.bat</span>
-
-</p>
-<p>Leave this command shell open, so that you can stop and restart Tomcat when necessary.</p>
-</div>
-<a name="N10219"></a><a name="To+Test+the+Page+Flow+Web+Application-N10214"></a>
-<h4>To Test the Page Flow Web Application</h4>
-<div style="margin-left: 0 ; border: 2px">
-<p>Open a web browser and enter the following in the address bar: <span class="codefrag">http://localhost:8080/pageflow_tutorial</span>
-
-</p>
-<p>You will be directed to the index.jsp page.</p>
-<p>Click the link.</p>
-<p>You will be directed to page2.jsp.</p>
-</div>
-<a name="N1022F"></a><a name="Shutdown+Tomcat+Server"></a>
-<h4>Shutdown Tomcat Server</h4>
-<div style="margin-left: 0 ; border: 2px">
-<p>At the command prompt, enter: <span class="codefrag">shutdown.bat</span>
-
-</p>
-</div>
-</div>
-
-<a name="N1023D"></a><a name="step_4"></a>
-<h3>Step 4: Submitting Data</h3>
-<div style="margin-left: 0 ; border: 2px">
-<a name="N10243"></a><a name="To+Create+a+Submission+Form"></a>
-<h4>To Create a Submission Form</h4>
-<div style="margin-left: 0 ; border: 2px">
-<p>Edit the file <span class="codefrag">C:/beehive-src/trunk/installed/jakarta-tomcat-5.0.25/webapps/pageflow_tutorial/page2.jsp</span> so it appears as follows.</p>
-<pre class="code">
-<%@ page language="java" contentType="text/html;charset=UTF-8"%>
-<%@ taglib uri="http://beehive.apache.org/netui/tags-databinding-1.0" prefix="netui-data"%>
-<%@ taglib uri="http://beehive.apache.org/netui/tags-html-1.0" prefix="netui"%>
-<%@ taglib uri="http://beehive.apache.org/netui/tags-template-1.0" prefix="netui-template"%>
-<netui:html>
- <head>
- <title>page2.jsp</title>
- <netui:base/>
- </head>
- <netui:body>
- <p>
- Welcome to page2.jsp!
- </p>
- <p>
- <netui:form action="processData">
- <p>Name:<netui:textBox dataSource="actionForm.name"/>
- <p>Age:<netui:textBox dataSource="actionForm.age"/>
- <p><netui:button type="submit">Submit</netui:button>
- </netui:form>
- </p>
- </netui:body>
-</netui:html>
- </pre>
-</div>
-<a name="N10255"></a><a name="To+Edit+the+Controller+File+to+Handle+the+Submitted+Data"></a>
-<h4>To Edit the Controller File to Handle the Submitted Data</h4>
-<div style="margin-left: 0 ; border: 2px">
-<p>Open the file <span class="codefrag">C:/beehive-src/trunk/installed/jakarta-tomcat-5.0.25/webapps/pageflow_tutorial/Controller.jpf</span>
-
-</p>
-<p>Edit Controller.jpf so it appears as follows.</p>
-<pre class="code">
-import org.apache.beehive.netui.pageflow.Forward;
-import org.apache.beehive.netui.pageflow.PageFlowController;
-import org.apache.beehive.netui.pageflow.annotations.Jpf;
-import org.apache.beehive.netui.pageflow.FormData;
-
-@Jpf.Controller
-public class Controller extends PageFlowController
-{
- @Jpf.Action(
- forwards={
- @Jpf.Forward(name="success", path="index.jsp")
- }
- )
- public Forward begin()
- {
- return new Forward("success");
- }
-
- @Jpf.Action(
- forwards={
- @Jpf.Forward(name="success", path="page2.jsp")
- }
- )
- public Forward toPage2()
- {
- return new Forward("success");
- }
-
- @Jpf.Action(
- forwards = {
- @Jpf.Forward(name = "success", path = "showData.jsp")
- }
- )
- public Forward processData(ProcessDataForm form)
- {
- System.out.println("Name: " + form.name);
- System.out.println("Age: " + form.age);
- return new Forward("success");
- }
-
- public static class ProcessDataForm extends FormData
- {
- private int age;
- private String name;
-
- public void setName(String name)
- {
- this.name = name;
- }
-
- public String getName()
- {
- return this.name;
- }
-
- public void setAge(int age)
- {
- this.age = age;
- }
-
- public int getAge()
- {
- return this.age;
- }
- }
-}
- </pre>
-</div>
-<a name="N1026A"></a><a name="Compile+the+Page+Flow-N10263"></a>
-<h4>Compile the Page Flow</h4>
-<div style="margin-left: 0 ; border: 2px">
-<p>Open a command shell.</p>
-<p>At the command prompt, enter: <span class="codefrag">set JAVA_HOME=C:\jdk1.5.0</span>
-
-</p>
-<p>At the command prompt, enter: <span class="codefrag">cd C:\beehive-src\trunk</span>
-
-</p>
-<p>At the command prompt, enter: <span class="codefrag">beehiveEnv.cmd</span>
-
-</p>
-<p>At the command prompt, enter: <span class="codefrag">cd C:\beehive-src\trunk\test\ant</span>
-
-</p>
-<p>At the command prompt, enter: <span class="codefrag">ant -f buildWebapp.xml build.webapp -Dwebapp.dir=C:\beehive-src\trunk\installed\jakarta-tomcat-5.0.25\webapps\pageflow_tutorial</span>
-
-</p>
-</div>
-<a name="N10292"></a><a name="To+Start+the+Tomcat+Server-N1028B"></a>
-<h4>To Start the Tomcat Server</h4>
-<div style="margin-left: 0 ; border: 2px">
-<p>At the command prompt, enter: <span class="codefrag">cd C:\beehive-src\trunk\installed\jakarta-tomcat-5.0.25\bin</span>
-
-</p>
-<p>At the command prompt, enter: <span class="codefrag">startup.bat</span>
-
-</p>
-<p>Leave this command shell open, so that you can stop and restart Tomcat when necessary.</p>
-</div>
-<a name="N102A8"></a><a name="To+Test+the+Page+Flow+Web+Application-N102A1"></a>
-<h4>To Test the Page Flow Web Application</h4>
-<div style="margin-left: 0 ; border: 2px">
-<p>Open a web browser and enter the following in the address bar: <span class="codefrag">http://localhost:8080/pageflow_tutorial</span>
-
-</p>
-<p>You will be directed to the index.jsp page.</p>
-<p>Click the link.</p>
-<p>You will be directed to page2.jsp.</p>
-</div>
-<a name="N102BE"></a><a name="Shutdown+Tomcat+Server-N102B7"></a>
-<h4>Shutdown Tomcat Server</h4>
-<div style="margin-left: 0 ; border: 2px">
-<p>At the command prompt, enter: <span class="codefrag">shutdown.bat</span>
-
-</p>
-</div>
-</div>
-
-<a name="N102CC"></a><a name="step_5"></a>
-<h3>Step 5: Processing and Displaying Data</h3>
-<div style="margin-left: 0 ; border: 2px">
-<a name="N102D2"></a><a name="To+Process+the+Submitted+Data"></a>
-<h4>To Process the Submitted Data</h4>
-<div style="margin-left: 0 ; border: 2px">
-<p>Edit the processData method in the Controller.jpf file so it appears as follows. Code to add appears in red.</p>
-<pre class="code">
-@Jpf.Action(
- forwards = {
- @Jpf.Forward( name = "success", path = "showData.jsp" )
- }
-)
-public Forward processData( ProcessDataForm form )
-{
- System.out.println("Name: " + form.name);
- System.out.println("Age: " + form.age);
- getRequest().setAttribute("data", form);
- return new Forward("success");
-}
- </pre>
-</div>
-<a name="N102E1"></a><a name="To+Create+a+JSP+Page+to+Display+Submitted+Data"></a>
-<h4>To Create a JSP Page to Display Submitted Data</h4>
+
+<a name="N1007B"></a><a name="Using+Proxies+With+a+Beehive+Build"></a>
+<h3>Using Proxies With a Beehive Build</h3>
<div style="margin-left: 0 ; border: 2px">
-<p>Create a file named displayData.jsp in the directory [TOMCAT_HOME]/directory/pageflow_tutorial. Edit showData.jsp so it appears as follows.</p>
+<p>
+ If you need to use proxies you can setup additional environment variables
+ so that the Ant "bootstrap" target is successful in downloading the
+ JSR 173 API JAR file.
+ </p>
<pre class="code">
-<%@ page language="java" contentType="text/html;charset=UTF-8"%>
-<%@ taglib uri="http://beehive.apache.org/netui/tags-databinding-1.0" prefix="netui-data"%>
-<%@ taglib uri="http://beehive.apache.org/netui/tags-html-1.0" prefix="netui"%>
-<%@ taglib uri="http://beehive.apache.org/netui/tags-template-1.0" prefix="netui-template"%>
-<netui:html>
- <head>
- <title>showData.jsp</title>
- <netui:base/>
- </head>
- <netui:body>
- <p>Name:<netui:span value="${requestScope.data.name}"/>
- <p>Age:<netui:span value="${requestScope.data.age}"/>
- </netui:body>
-</netui:html>
- </pre>
-</div>
-<a name="N102F0"></a><a name="Compile+the+Page+Flow-N102E7"></a>
-<h4>Compile the Page Flow</h4>
-<div style="margin-left: 0 ; border: 2px">
-<p>Open a command shell.</p>
-<p>At the command prompt, enter: <span class="codefrag">set JAVA_HOME=C:\jdk1.5.0</span>
-
-</p>
-<p>At the command prompt, enter: <span class="codefrag">cd C:\beehive-src\trunk</span>
-
-</p>
-<p>At the command prompt, enter: <span class="codefrag">beehiveEnv.cmd</span>
-
-</p>
-<p>At the command prompt, enter: <span class="codefrag">cd C:\beehive-src\trunk\test\ant</span>
-
-</p>
-<p>At the command prompt, enter: <span class="codefrag">ant -f buildWebapp.xml build.webapp -Dwebapp.dir=C:\beehive-src\trunk\installed\jakarta-tomcat-5.0.25\webapps\pageflow_tutorial</span>
-
-</p>
+PROXYHOST=<name of proxy host>
+PROXYPORT=<port used for proxying>
+PROXYUSER=<username for proxy authentication>
+PROXYPASSWORD=<password for proxy authentication>
+NONPROXYHOSTS=<hosts that should not be proxied>
+SOCKSPROXYHOST=<socks proxy host name>
+SOCKSPROXYPORT=<socks proxy port>
+</pre>
+<p>At a minimum, you will need to set PROXYHOST and PROXYPORT if your
+ network environment requires a proxy connection. To set these
+ environment variables in your shell, run:</p>
+<pre class="code"> set PROXYHOST=<name of proxy host></pre>
+<p>in a Windows shell and </p>
+<pre class="code"> export PROXYHOST=<name of proxy host></pre>
+<p>in a UNIX shell.
+ For information on proxy support using the <span class="codefrag"><setproxy></span> task, please
+ visit http://ant.apache.org/manual/OptionalTasks/setproxy.html
+ </p>
</div>
-<a name="N10318"></a><a name="To+Start+the+Tomcat+Server-N1030F"></a>
-<h4>To Start the Tomcat Server</h4>
-<div style="margin-left: 0 ; border: 2px">
-<p>At the command prompt, enter: <span class="codefrag">cd C:\beehive-src\trunk\installed\jakarta-tomcat-5.0.25\bin</span>
-
-</p>
-<p>At the command prompt, enter: <span class="codefrag">startup.bat</span>
-
-</p>
-<p>Leave this command shell open, so that you can stop and restart Tomcat when necessary.</p>
-</div>
-<a name="N1032E"></a><a name="To+Test+the+Page+Flow+Web+Application-N10325"></a>
-<h4>To Test the Page Flow Web Application</h4>
-<div style="margin-left: 0 ; border: 2px">
-<p>Open a web browser and enter the following in the address bar: <span class="codefrag">http://localhost:8080/pageflow_tutorial</span>
-
-</p>
-<p>You will be directed to the index.jsp page.</p>
-<p>Click the link.</p>
-<p>You will be directed to page2.jsp.</p>
-</div>
-<a name="N10344"></a><a name="Shutdown+Tomcat+Server-N1033B"></a>
-<h4>Shutdown Tomcat Server</h4>
-<div style="margin-left: 0 ; border: 2px">
-<p>At the command prompt, enter: <span class="codefrag">shutdown.bat</span>
-
-</p>
-</div>
-</div>
-
-<a name="N10352"></a><a name="summary"></a>
-<h3>Summary: Page Flow Tutorial</h3>
-<div style="margin-left: 0 ; border: 2px">
-<p>This tutorial introduced you to the basics of building web applications with Beehive Page Flows.</p>
-<p>Concepts and Tasks Introduced in This Tutorial</p>
-<p>[tbd: more detailed summary]</p>
-</div>
-
+
<div class="attribution"></div>
</div>
</td><td width="10"><img width="10" height="1" alt="" src="skin/images/spacer.gif" class="spacer"></td>
Modified: incubator/beehive/trunk/site/src/documentation/content/xdocs/building.xml
==============================================================================
--- incubator/beehive/trunk/site/src/documentation/content/xdocs/building.xml (original)
+++ incubator/beehive/trunk/site/src/documentation/content/xdocs/building.xml Fri Oct 15 10:14:47 2004
@@ -1,522 +1,95 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.2//EN" "http://forrest.apache.org/dtd/document-v13.dtd">
<document>
- <header>
- <title>Beehive Page Flow Tutorial</title>
- </header>
- <body>
- <section id="intro">
- <title>Introduction To the Page Flow Tutorial</title>
- <section>
- <title>Tutorial Goals</title>
- <p>In this tutorial, you will learn:</p>
- <ul>
- <li>How to create a basic Page Flow web application</li>
- <li>How to coordinate user navigation with Forward methods</li>
- <li>How to handle data submission and processing with data binding and Form Beans</li>
- <li>How to create a user interface with the <neuti> JSP tag library</li>
- <li>How Page Flows help to separate data processing and data presentation</li>
- </ul>
- </section>
- <section>
- <title>Note on the Current State of the Page Flow Tutorial</title>
- <p>This tutorial is currently a work in progress. Unfinished portions of the tutorial are marked [tbd], standing for "to be done". Also the tutorial assumes that you are using a Windows machine, however, with a little common sense it is very easy to run through the tutorial on a Linux machine. For example, where the tutorial tells you to run FOO.cmd, instead run FOO.sh.</p>
- <p>Please send any comments to Steve Hanson, at <code>steveh@bea.com</code>.</p>
- </section>
- </section>
- <section id="step1">
- <title>Step 1: Begin the Page Flow Tutorial</title>
- <section>
- <title/>
- </section>
- <section>
- <title>Download and Install JDK5</title>
- <p>If you do not have JDK5 installed on your machine, visit <fork href="http://java.sun.com/j2se/1.5.0/download.jsp">http://java.sun.com/j2se/1.5.0/download.jsp</fork> and download the latest version of JDK5.</p>
- <p>Throughout this tutorial, it is assumed that you have JDK 5 installed at <code>C:\jdk1.5.0</code></p>
- <p>[tbd: more detailed installation instructions]</p>
- </section>
- <section>
- <title>Download and Install SVN (Subversion Source Control)</title>
- <p>Visit <fork href="http://subversion.tigris.org">http://subversion.tigris.org</fork> and install the SVN source control system.</p>
- <p>[tbd: more detailed installation instructions]</p>
- </section>
- <section>
- <title>Download and Install Beehive</title>
- <p>
- Create a directory called <code>beehive-src</code> on your C: drive. Confirm that the the following directory structure exists: <code>C:/beehive-src</code>. This directory will store the Beehive source and all of your Beehive projects. </p>
- <p>Open a command shell.</p>
- <p>At the command prompt, enter: <code>cd beehive-src</code>
- </p>
- <p>At the command prompt, enter: <code>svn checkout http://svn.apache.org/repos/asf/incubator/beehive/trunk/</code>
- </p>
- <p>Wait a few minutes while the Beehive source is downloaded to your local machine.</p>
- <p>At the command prompt, enter: <code>exit</code>
- </p>
- </section>
- <section>
- <title>Install ANT</title>
- <p>Create a directory named <code>installed</code>at <code>C:/beehive-src/trunk/installed</code>.</p>
- <p>Unzip the file <code>C:/beehive-src/trunk/external/ant/apache-ant-1.6.2-bin.zip</code> into <code>C:/beehive-src/Beehive/installed</code>.</p>
- <p>After the file has unzipped, confirm that the following directory structure exists: <code>C:/beehive-src/trunk/installed/apache-ant-1.6.2</code>.</p>
- </section>
- <section>
- <title>Run the <code>bootstrap</code> Target</title>
- <p>At the command prompt, enter: <code>set JAVA_HOME=C:\jdk1.5.0</code>
- </p>
- <p>At the command prompt, enter: <code>set BEEHIVE_HOME=C:\beehive-src\trunk</code>
- </p>
- <p>At the command prompt, enter: <code>cd C:\beehive-src\trunk</code>
- </p>
- <p>At the command prompt, enter: <code>beehiveEnv.cmd</code>
- </p>
- <p>At the command prompt, enter: <code>ant bootstrap</code>
- </p>
- <p>At the command prompt, enter: <code>exit</code>
- </p>
- </section>
- </section>
- <section id="step_2">
- <title>Step 2: Create a New Page Flow Application</title>
- <section>
- <title>Introduction</title>
- <p>
- In this step you will create a Controller file and a JSP page. A Controller file is a Java class (with the JPF file extension) that controls how your web application functions and what it does. The methods in the Controller file determines all of the major features of a web application: how users navigate from page to page, how user requests are handled, and how the web application accesses back-end resources.
- </p>
- <p>
- Controller files control the features of a web application through the use of Action methods. An Action method may do something simple, such as forward a user from one JSP page to another; or it may do something complex, such as receive user input from a JSP page, calculate and/or retrieve other data based on the user input, and forward the user to a JSP page where the results are displayed.
- </p>
- <p>
- The Controller file you create in this step contains one simple Action method. This simple navigational Action method forwards users to the index.jsp page. In the next step, you will create a more complex Action method.
- </p>
- </section>
- <section>
- <title>To Create a Controller File</title>
- <p>In this step you will create the Controller file in place in the Tomcat deployment directory.</p>
- <p>In the directory <code>C:/beehive-src/trunk/installed/jakarta-tomcat-5.0.25/webapps</code>, create a directory called <code>pageflow_tutorial</code>.</p>
- <p>In the directory <code>C:/beehive-src/trunk/installed/jakarta-tomcat-5.0.25/webapps/pageflow_tutorial</code>, create a file called <code>Controller.jpf</code>.</p>
- <p>In a text editor (or your IDE of choice), open the file Controller.jpf.</p>
- <p>Edit Controller.jpf so it appears as follows.</p>
- <source><![CDATA[
-import org.apache.beehive.netui.pageflow.Forward;
-import org.apache.beehive.netui.pageflow.PageFlowController;
-import org.apache.beehive.netui.pageflow.annotations.Jpf;
-
-@Jpf.Controller
-public class Controller extends PageFlowController
-{
- @Jpf.Action(
- forwards={
- @Jpf.Forward(name="success", path="index.jsp")
- }
- )
- protected Forward begin()
- {
- return new Forward("success");
- }
-}
- ]]></source>
- </section>
- <section>
- <title>To Create a JSP File</title>
- <p>In the directory <code>C:/beehive-src/trunk/installed/jakarta-tomcat-5.0.25/webapps/pageflow_tutorial</code>, create a file named <code>index.jsp</code>.</p>
- <p>Edit index.jsp so it looks like the following.</p>
- <source><![CDATA[
-<%@ page language="java" contentType="text/html;charset=UTF-8"%>
-<%@ taglib uri="http://beehive.apache.org/netui/tags-databinding-1.0" prefix="netui-data"%>
-<%@ taglib uri="http://beehive.apache.org/netui/tags-html-1.0" prefix="netui"%>
-<%@ taglib uri="http://beehive.apache.org/netui/tags-template-1.0" prefix="netui-template"%>
-<netui:html>
- <head>
- <title>index.jsp</title>
- <netui:base/>
- </head>
- <netui:body>
- <p>
- index.jsp
- </p>
- </netui:body>
-</netui:html>
- ]]></source>
- </section>
- <section>
- <title>To Create the WEB-INF directory</title>
- <p> Open a command shell.</p>
- <p>At the command prompt, enter: <code>cd C:\beehive-src\trunk</code>
- </p>
- <p>At the command prompt, enter: <code>beehiveEnv.cmd</code>
- </p>
- <p>At the command prompt, enter: <code>cd C:\beehive-src\trunk\netui\ant</code>
- </p>
- <p>At the command prompt, enter: <code>ant -f webappTemplate.xml -Dwebapp.dist.dir=C:\beehive-src\trunk\installed\jakarta-tomcat-5.0.25\webapps\pageflow_tutorial</code>
- </p>
- </section>
- <section>
- <title>Compile the Page Flow</title>
- <p>At the command prompt, enter: <code>cd C:\beehive-src\trunk\test\ant</code>
- </p>
- <p>At the command prompt, enter: <code>ant -f buildWebapp.xml build.webapp -Dwebapp.dir=C:\beehive-src\trunk\installed\jakarta-tomcat-5.0.25\webapps\pageflow_tutorial</code>
- </p>
- </section>
- <section>
- <title>To Start the Tomcat Server</title>
- <p>At the command prompt, enter: <code>cd C:\beehive-src\trunk\installed\jakarta-tomcat-5.0.25\bin</code>
- </p>
- <p>At the command prompt, enter: <code>startup.bat</code>
- </p>
- <p>Leave this command shell open, so that you can stop and restart Tomcat when necessary.</p>
- </section>
- <section>
- <title>To Test the Page Flow Web Application</title>
- <p>Open a web browser and enter the following in the address bar: <code>http://localhost:8080/pageflow_tutorial</code>
- </p>
- <p>You will be directed to the index.jsp page.</p>
- </section>
- </section>
- <section id="step_3">
- <title>Step 3: Navigation</title>
- <section>
- <title>Create a Destination JSP Page</title>
- <p>In the directory <code>C:/beehive-src/trunk/installed/jakarta-tomcat-5.0.25/webapps/pageflow_tutorial</code>, create a file named <code>page2.jsp</code>.</p>
- <p>Edit page2.jsp so it looks like the following.</p>
- <source><![CDATA[
-<%@ page language="java" contentType="text/html;charset=UTF-8"%>
-<%@ taglib uri="http://beehive.apache.org/netui/tags-databinding-1.0" prefix="netui-data"%>
-<%@ taglib uri="http://beehive.apache.org/netui/tags-html-1.0" prefix="netui"%>
-<%@ taglib uri="http://beehive.apache.org/netui/tags-template-1.0" prefix="netui-template"%>
-<netui:html>
- <head>
- <title>page2.jsp</title>
- <netui:base/>
- </head>
- <netui:body>
- <p>
- Welcome to page2.jsp!
- </p>
- </netui:body>
-</netui:html>
- ]]></source>
- </section>
- <section>
- <title>Create a Link to the Destination Page</title>
- <p>Open the file C:/beehive-src/trunk/installed/jakarta-tomcat-5.0.25/webapps/pageflow_tutorial/index.jsp.</p>
- <p>Edit index.jsp so it appears as follows.</p>
- <source><![CDATA[
-<%@ page language="java" contentType="text/html;charset=UTF-8"%>
-<%@ taglib uri="http://beehive.apache.org/netui/tags-databinding-1.0" prefix="netui-data"%>
-<%@ taglib uri="http://beehive.apache.org/netui/tags-html-1.0" prefix="netui"%>
-<%@ taglib uri="http://beehive.apache.org/netui/tags-template-1.0" prefix="netui-template"%>
-<netui:html>
- <head>
- <title>index.jsp</title>
- <netui:base/>
- </head>
- <netui:body>
- <p>
- index.jsp
- </p>
- <p>
- <netui:anchor action="toPage2">Link to page2.jsp</netui:anchor>
- </p>
- </netui:body>
-</netui:html>
- ]]></source>
- </section>
- <section>
- <title>Add an Action Method to Handle the Link</title>
- <p>Open the file C:/beehive-src/trunk/installed/jakarta-tomcat-5.0.25/webapps/pageflow_tutorial/Controller.jpf.</p>
- <p>Edit Controller.jpf so it appears as follows.</p>
- <source><![CDATA[
-import org.apache.beehive.netui.pageflow.Forward;
-import org.apache.beehive.netui.pageflow.PageFlowController;
-import org.apache.beehive.netui.pageflow.annotations.Jpf;
-
-public class Controller
- extends PageFlowController
-{
- @Jpf.Action(
- forwards={
- @Jpf.Forward(name="success", path="index.jsp")
- }
- )
- protected Forward begin()
- {
- return new Forward("success");
- }
-
- @Jpf.Action(
- forwards={
- @Jpf.Forward(name="success", path="page2.jsp")
- }
- )
- public Forward toPage2()
- {
- return new Forward("success");
- }
-}
- ]]></source>
- </section>
- <section>
- <title>Compile the Page Flow</title>
- <p>Open a command shell.</p>
- <p>At the command prompt, enter: <code>set JAVA_HOME=C:\jdk1.5.0</code>
- </p>
- <p>At the command prompt, enter: <code>cd C:\beehive-src\trunk</code>
- </p>
- <p>At the command prompt, enter: <code>beehiveEnv.cmd</code>
- </p>
- <p>At the command prompt, enter: <code>cd C:\beehive-src\trunk\test\ant</code>
- </p>
- <p>At the command prompt, enter: <code>ant -f buildWebapp.xml build.webapp -Dwebapp.dir=C:\beehive-src\trunk\installed\jakarta-tomcat-5.0.25\webapps\pageflow_tutorial</code>
- </p>
- </section>
- <section>
- <title>To Start the Tomcat Server</title>
- <p>At the command prompt, enter: <code>cd C:\beehive-src\trunk\installed\jakarta-tomcat-5.0.25\bin</code>
- </p>
- <p>At the command prompt, enter: <code>startup.bat</code>
- </p>
- <p>Leave this command shell open, so that you can stop and restart Tomcat when necessary.</p>
- </section>
- <section>
- <title>To Test the Page Flow Web Application</title>
- <p>Open a web browser and enter the following in the address bar: <code>http://localhost:8080/pageflow_tutorial</code>
- </p>
- <p>You will be directed to the index.jsp page.</p>
- <p>Click the link.</p>
- <p>You will be directed to page2.jsp.</p>
- </section>
- <section>
- <title>Shutdown Tomcat Server</title>
- <p>At the command prompt, enter: <code>shutdown.bat</code>
- </p>
- </section>
- </section>
- <section id="step_4">
- <title>Step 4: Submitting Data</title>
- <section>
- <title>To Create a Submission Form</title>
- <p>Edit the file <code>C:/beehive-src/trunk/installed/jakarta-tomcat-5.0.25/webapps/pageflow_tutorial/page2.jsp</code> so it appears as follows.</p>
- <source><![CDATA[
-<%@ page language="java" contentType="text/html;charset=UTF-8"%>
-<%@ taglib uri="http://beehive.apache.org/netui/tags-databinding-1.0" prefix="netui-data"%>
-<%@ taglib uri="http://beehive.apache.org/netui/tags-html-1.0" prefix="netui"%>
-<%@ taglib uri="http://beehive.apache.org/netui/tags-template-1.0" prefix="netui-template"%>
-<netui:html>
- <head>
- <title>page2.jsp</title>
- <netui:base/>
- </head>
- <netui:body>
- <p>
- Welcome to page2.jsp!
- </p>
- <p>
- <netui:form action="processData">
- <p>Name:<netui:textBox dataSource="actionForm.name"/>
- <p>Age:<netui:textBox dataSource="actionForm.age"/>
- <p><netui:button type="submit">Submit</netui:button>
- </netui:form>
- </p>
- </netui:body>
-</netui:html>
- ]]></source>
- </section>
- <section>
- <title>To Edit the Controller File to Handle the Submitted Data</title>
- <p>Open the file <code>C:/beehive-src/trunk/installed/jakarta-tomcat-5.0.25/webapps/pageflow_tutorial/Controller.jpf</code>
- </p>
- <p>Edit Controller.jpf so it appears as follows.</p>
- <source><![CDATA[
-import org.apache.beehive.netui.pageflow.Forward;
-import org.apache.beehive.netui.pageflow.PageFlowController;
-import org.apache.beehive.netui.pageflow.annotations.Jpf;
-import org.apache.beehive.netui.pageflow.FormData;
-
-@Jpf.Controller
-public class Controller extends PageFlowController
-{
- @Jpf.Action(
- forwards={
- @Jpf.Forward(name="success", path="index.jsp")
- }
- )
- public Forward begin()
- {
- return new Forward("success");
- }
-
- @Jpf.Action(
- forwards={
- @Jpf.Forward(name="success", path="page2.jsp")
- }
- )
- public Forward toPage2()
- {
- return new Forward("success");
- }
-
- @Jpf.Action(
- forwards = {
- @Jpf.Forward(name = "success", path = "showData.jsp")
- }
- )
- public Forward processData(ProcessDataForm form)
- {
- System.out.println("Name: " + form.name);
- System.out.println("Age: " + form.age);
- return new Forward("success");
- }
-
- public static class ProcessDataForm extends FormData
- {
- private int age;
- private String name;
-
- public void setName(String name)
- {
- this.name = name;
- }
-
- public String getName()
- {
- return this.name;
- }
-
- public void setAge(int age)
- {
- this.age = age;
- }
-
- public int getAge()
- {
- return this.age;
- }
- }
-}
- ]]></source>
- </section>
- <section>
- <title>Compile the Page Flow</title>
- <p>Open a command shell.</p>
- <p>At the command prompt, enter: <code>set JAVA_HOME=C:\jdk1.5.0</code>
- </p>
- <p>At the command prompt, enter: <code>cd C:\beehive-src\trunk</code>
- </p>
- <p>At the command prompt, enter: <code>beehiveEnv.cmd</code>
- </p>
- <p>At the command prompt, enter: <code>cd C:\beehive-src\trunk\test\ant</code>
- </p>
- <p>At the command prompt, enter: <code>ant -f buildWebapp.xml build.webapp -Dwebapp.dir=C:\beehive-src\trunk\installed\jakarta-tomcat-5.0.25\webapps\pageflow_tutorial</code>
- </p>
- </section>
- <section>
- <title>To Start the Tomcat Server</title>
- <p>At the command prompt, enter: <code>cd C:\beehive-src\trunk\installed\jakarta-tomcat-5.0.25\bin</code>
- </p>
- <p>At the command prompt, enter: <code>startup.bat</code>
- </p>
- <p>Leave this command shell open, so that you can stop and restart Tomcat when necessary.</p>
- </section>
- <section>
- <title>To Test the Page Flow Web Application</title>
- <p>Open a web browser and enter the following in the address bar: <code>http://localhost:8080/pageflow_tutorial</code>
- </p>
- <p>You will be directed to the index.jsp page.</p>
- <p>Click the link.</p>
- <p>You will be directed to page2.jsp.</p>
- </section>
- <section>
- <title>Shutdown Tomcat Server</title>
- <p>At the command prompt, enter: <code>shutdown.bat</code>
- </p>
- </section>
- </section>
- <section id="step_5">
- <title>Step 5: Processing and Displaying Data</title>
- <section>
- <title>To Process the Submitted Data</title>
- <p>Edit the processData method in the Controller.jpf file so it appears as follows. Code to add appears in red.</p>
- <source><![CDATA[
-@Jpf.Action(
- forwards = {
- @Jpf.Forward( name = "success", path = "showData.jsp" )
- }
-)
-public Forward processData( ProcessDataForm form )
-{
- System.out.println("Name: " + form.name);
- System.out.println("Age: " + form.age);
- getRequest().setAttribute("data", form);
- return new Forward("success");
-}
- ]]></source>
- </section>
- <section>
- <title>To Create a JSP Page to Display Submitted Data</title>
- <p>Create a file named displayData.jsp in the directory [TOMCAT_HOME]/directory/pageflow_tutorial. Edit showData.jsp so it appears as follows.</p>
- <source><![CDATA[
-<%@ page language="java" contentType="text/html;charset=UTF-8"%>
-<%@ taglib uri="http://beehive.apache.org/netui/tags-databinding-1.0" prefix="netui-data"%>
-<%@ taglib uri="http://beehive.apache.org/netui/tags-html-1.0" prefix="netui"%>
-<%@ taglib uri="http://beehive.apache.org/netui/tags-template-1.0" prefix="netui-template"%>
-<netui:html>
- <head>
- <title>showData.jsp</title>
- <netui:base/>
- </head>
- <netui:body>
- <p>Name:<netui:span value="${requestScope.data.name}"/>
- <p>Age:<netui:span value="${requestScope.data.age}"/>
- </netui:body>
-</netui:html>
- ]]></source>
- </section>
- <section>
- <title>Compile the Page Flow</title>
- <p>Open a command shell.</p>
- <p>At the command prompt, enter: <code>set JAVA_HOME=C:\jdk1.5.0</code>
- </p>
- <p>At the command prompt, enter: <code>cd C:\beehive-src\trunk</code>
- </p>
- <p>At the command prompt, enter: <code>beehiveEnv.cmd</code>
- </p>
- <p>At the command prompt, enter: <code>cd C:\beehive-src\trunk\test\ant</code>
- </p>
- <p>At the command prompt, enter: <code>ant -f buildWebapp.xml build.webapp -Dwebapp.dir=C:\beehive-src\trunk\installed\jakarta-tomcat-5.0.25\webapps\pageflow_tutorial</code>
- </p>
- </section>
- <section>
- <title>To Start the Tomcat Server</title>
- <p>At the command prompt, enter: <code>cd C:\beehive-src\trunk\installed\jakarta-tomcat-5.0.25\bin</code>
- </p>
- <p>At the command prompt, enter: <code>startup.bat</code>
- </p>
- <p>Leave this command shell open, so that you can stop and restart Tomcat when necessary.</p>
- </section>
- <section>
- <title>To Test the Page Flow Web Application</title>
- <p>Open a web browser and enter the following in the address bar: <code>http://localhost:8080/pageflow_tutorial</code>
- </p>
- <p>You will be directed to the index.jsp page.</p>
- <p>Click the link.</p>
- <p>You will be directed to page2.jsp.</p>
- </section>
- <section>
- <title>Shutdown Tomcat Server</title>
- <p>At the command prompt, enter: <code>shutdown.bat</code>
- </p>
- </section>
- </section>
- <section id="summary">
- <title>Summary: Page Flow Tutorial</title>
- <p>This tutorial introduced you to the basics of building web applications with Beehive Page Flows.</p>
- <p>Concepts and Tasks Introduced in This Tutorial</p>
- <p>[tbd: more detailed summary]</p>
- </section>
- </body>
- <footer>
- <legal>Java, J2EE, and JCP are trademarks or registered trademarks of Sun Microsystems, Inc. in the United States and other countries.<br/>
+ <header>
+ <title>Building Beehive</title>
+ </header>
+ <body>
+ <section>
+ <title>Introduction</title>
+ <p>This topic explains how to download and build the Beehive source code on your local machine.</p>
+ </section>
+ <section id="setup">
+ <title>Setting Up Beehive on Your Machine</title>
+ <p>To build Beehive, you need to have Java version 5 (or later) installed
+ with the JAVA_HOME environment variable defined to point to this JDK.
+ The JDK is available here:
+ </p>
+ <source> http://java.sun.com/j2se/1.5.0/download.jsp</source>
+ <p>
+ Set the BEEHIVE_HOME environment variable to point to the root of the branch in your
+ Beehive working copy that you want to work with. Typically you will be interested in
+ the trunk, where mainline work goes on. For example, if you ran
+ </p>
+ <source>svn checkout https://svn.apache.org/repos/asf/incubator/beehive/trunk</source>
+ <p>
+ from within "C:\MyProjects\beehive", BEEHIVE_HOME will be "C:\MyProjects\beehive",
+ since you explicitly only checked out the trunk.
+ </p>
+ <p>However, if you had run</p>
+ <source>svn checkout https://svn.apache.org/repos/asf/incubator/beehive</source>
+ <p>from within "C:\MyProjects\beehive", BEEHIVE_HOME will be "C:\MyProjects\beehive\trunk".</p>
+ <p>In addition, you'll need to install Ant in $BEEHIVE_HOME/installed/ from
+ the archive in $BEEHIVE_HOME/external/ant/apache-ant-1.6.2-bin.(zip|tar.gz).
+ The installed Ant distribution should end up here:</p>
+ <source> $BEEHIVE_HOME/installed/apache-ant-1.6.2/...</source>
+ </section>
+ <section>
+ <title>Building Beehive</title>
+ <p>In the following examples, '$>' is your propmpt at $BEEHIVE_HOME, so if
+ you see '$>ant', type 'ant' (without the quotes) and press [enter].</p>
+ <p>To initialize the Beehive build environment, run beehiveEnv for your platform:</p>
+ <p>
+ Windows:
+ </p>
+ <source> C:\MyProjects\beehive>beehiveEnv.cmd</source>
+ <p>UNIX:</p>
+ <source> $>source beehiveEnv.sh</source>
+ <p>Because Beehive depends on a set of external software, these dependencies need
+ to be installed before a build can be successful. You will need a network
+ connection for this step because jsr173_api.jar needs to be downloaded from a
+ website; if you need to use a proxy for this downolad, see the "Using Proxies"
+ instructions below. Once this has been downloaded, the build and tests can
+ be run successfully without a network connection. To install the external
+ dependnecies, run:</p>
+ <source> $>ant bootstrap</source>
+ <p>which will unzip Log4J and Tomcat installers. </p>
+ <p>To build Beehive, run:</p>
+ <source> $>ant clean deploy</source>
+ <p>To run Beehive tests, run:</p>
+ <source> $>ant drt</source>
+ </section>
+ <section>
+ <title>Using Proxies With a Beehive Build</title>
+ <p>
+ If you need to use proxies you can setup additional environment variables
+ so that the Ant "bootstrap" target is successful in downloading the
+ JSR 173 API JAR file.
+ </p>
+ <source><![CDATA[
+PROXYHOST=<name of proxy host>
+PROXYPORT=<port used for proxying>
+PROXYUSER=<username for proxy authentication>
+PROXYPASSWORD=<password for proxy authentication>
+NONPROXYHOSTS=<hosts that should not be proxied>
+SOCKSPROXYHOST=<socks proxy host name>
+SOCKSPROXYPORT=<socks proxy port>
+]]></source>
+ <p>At a minimum, you will need to set PROXYHOST and PROXYPORT if your
+ network environment requires a proxy connection. To set these
+ environment variables in your shell, run:</p>
+ <source><![CDATA[ set PROXYHOST=<name of proxy host>]]></source>
+ <p>in a Windows shell and </p>
+ <source><![CDATA[ export PROXYHOST=<name of proxy host>]]></source>
+ <p>in a UNIX shell.
+ For information on proxy support using the <code><setproxy></code> task, please
+ visit http://ant.apache.org/manual/OptionalTasks/setproxy.html
+ </p>
+ </section>
+ </body>
+ <footer>
+ <legal>Java, J2EE, and JCP are trademarks or registered trademarks of Sun Microsystems, Inc. in the United States and other countries.<br/>
© 2004, Apache Software Foundation
</legal>
- </footer>
+ </footer>
</document>