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 2005/04/14 00:11:14 UTC
svn commit: r161224 - in
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs:
controls/tutorial_controls.xml docs/index.xml glossary.xml jpetstore.xml
pageflow/tutorial_pageflow.xml setup.xml site.xml wsm/tutorial_wsm.xml
Author: steveh
Date: Wed Apr 13 15:11:12 2005
New Revision: 161224
URL: http://svn.apache.org/viewcvs?view=rev&rev=161224
Log:
(1) General grammar edits provided by Liza Ketchum.
(2) Fix for BEEHIVE-523: Control tutorial: control should be called from Controller file, not JSP
Modified:
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/controls/tutorial_controls.xml
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/docs/index.xml
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/glossary.xml
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/jpetstore.xml
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/tutorial_pageflow.xml
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/setup.xml
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/site.xml
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/wsm/tutorial_wsm.xml
Modified: incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/controls/tutorial_controls.xml
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/controls/tutorial_controls.xml?view=diff&r1=161223&r2=161224
==============================================================================
--- incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/controls/tutorial_controls.xml (original)
+++ incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/controls/tutorial_controls.xml Wed Apr 13 15:11:12 2005
@@ -11,12 +11,12 @@
<title>Tutorial Goals</title>
<p>In this tutorial, you will learn:</p>
<ul>
- <li>What Beehive Controls are for and what they do</li>
- <li>How to create a Beehive Control interface and implementation</li>
- <li>How to compile a Beehive Control</li>
- <li>How to use a Beehive Control as a component in a larger application</li>
- <li>How to use metadata annotations in Beehive Controls</li>
- <li>How to create custom metadata annotations</li>
+ <li>what Beehive Controls are for and what they do.</li>
+ <li>how to create a Beehive Control interface and implementation.</li>
+ <li>how to compile a Beehive Control.</li>
+ <li>how to use a Beehive Control as a component in a larger application.</li>
+ <li>how to use metadata annotations in Beehive Controls.</li>
+ <li>how to create custom metadata annotations.</li>
</ul>
</section>
</section>
@@ -56,64 +56,61 @@
</li>
</ul>
</section>
- <section id="make_proj">
- <title>To Make a Control Project Folder</title>
- <p>In this task you will make a control project folder.
- </p>
- <p>On your C: drive, create a directory called
- <strong><code>beehive_projects</code></strong>.</p>
- <p>Copy the folder
- <code>BEEHIVE_HOME/samples/controls-blank</code> into
- <code>C:/beehive_projects</code>.</p>
- <p>Rename the folder
- <code>C:/beehive_projects/</code><strong><code>controls-blank</code></strong>
- to the name
- <code>C:/beehive_projects/</code><strong><code>controls_tutorial</code></strong></p>
- <p>Before proceeding, confirm that the following directory
- structure exists:</p>
- <source>C:
- beehive_projects
- controls_tutorial
- src
- build.xml</source>
- </section>
<section id="make_test_enviro">
- <title>To Create a Web Application Test Environment</title>
- <p>In this step you create a web application that serves as the testing ground for
- your control. To test the control, you will import the control into the web application
- and invoke the control methods from the web application.</p>
+ <title>To Create a Development and Test Application</title>
+ <p>In this step you create a web application that serves as the
+ development and testing ground
+ for your control. To test the control, you will
+ invoke the control methods from the web application.</p>
<p>Copy the folder <code>BEEHIVE_HOME/samples/netui-blank</code> into
<code>C:/beehive_projects</code>.</p>
<p>Rename the folder
<code>C:/beehive_projects/</code><strong><code>netui-blank</code></strong> to the name
- <code>C:/beehive_projects/</code><strong><code>controls_tutorial_test</code></strong></p>
+ <code>C:/beehive_projects/</code><strong><code>control_tutorial</code></strong></p>
<p>Before proceeding, confirm that the following directory structure exists:</p>
<source>C:
beehive_projects
- controls_tutorial_test
+ control_tutorial
resources
WEB-INF
Controller.jpf
error.jsp
index.jsp</source>
- <p>In this section you will edit the <code>build.properties</code> file--the file
+ </section>
+ <section><title>Edit the <code>build.properties</code> File</title>
+ <p>Next you will edit the <code>build.properties</code> file--the file
that sets the build-related properties for your test environment.</p>
- <p>Open the file <code>C:/beehive_projects/controls_tutorial_test/WEB-INF/src/build.properties</code>
+ <p>Open the file <code>C:/beehive_projects/control_tutorial/WEB-INF/src/build.properties</code>
in a text editor.</p>
- <p>Edit the <code>beehive.home</code> property points to the
+ <p>Edit the <code>beehive.home</code> property so it points to the
top-level folder of your beehive installation.</p>
- <p>Add the line <strong><code>contextPath=controls_tutorial_test</code></strong> (as shown below).</p>
+ <p>Edit the <code>contextPath</code> property so it has the value
+ <strong><code>control_tutorial</code></strong> (as shown below).</p>
<p>For example, if your beehive installation
resides at <code>C:/apache/apache-beehive-1.0</code>, then your <code>build.properties</code> file
would appear as follows.</p>
<source>beehive.home=<strong>C:/apache/apache-beehive-1.0</strong>
-<strong>contextPath=controls_tutorial_test</strong>
servlet-api.jar=${os.CATALINA_HOME}/common/lib/servlet-api.jar
jsp-api.jar=${os.CATALINA_HOME}/common/lib/jsp-api.jar
+
+<strong>context.path=control_tutorial</strong>
</source>
-
- </section>
+ </section>
+ <section id="add_control_files">
+ <title>Add the Control Interface and Implementation Files</title>
+ <p>Copy the folder <strong><code>BEEHIVE_HOME/samples/controls-blank/src/pkg</code></strong>
+ into the folder <strong><code>C:/beehive_projects/control_tutorial/WEB-INF/src</code></strong>.</p>
+ <p>Before proceeding, confirm that the following directory structure exists:</p>
+ <source>C:
+ beehive_projects
+ control_tutorial
+ WEB-INF
+ src
+ pkg
+ Hello.java
+ HelloImpl.jcs</source>
+ </section>
<section id="start_tomcat">
<title>To Start the Tomcat Server</title>
<p>At the command prompt, enter:</p>
@@ -121,7 +118,7 @@
</section>
</section>
<section id="step_2">
- <title>Step 2: Compile the Template Control Implementation and Interface Files</title>
+ <title>Step 2: Compile the Control Implementation and Interface Files</title>
<section id="intro_2">
<title>Introduction</title>
<p>A Beehive Control consists of two files: an interface file (with the JAVA file extension)
@@ -130,57 +127,8 @@
users. The implementation file contains the implementation code for the methods
listed in the interface file.</p>
</section>
-<!--
- <section id="create_impl">
- <title>To Create the Control's Implementation File</title>
- <p>In this step you will create the implementation file for your Beehive Control. This is a Java class (although it has the JCS file extension) that contains the bulk of your Control's working code.</p>
- <p>In the directory <code>C:/beehive_projects/webapps/controls_tutorial/WEB-INF/src</code>, create a directory called <strong><code>hellocontrol</code></strong>.</p>
- <p>In the directory <code>C:/beehive_projects/webapps/controls_tutorial/WEB-INF/src/hellocontrol</code>, create a file called <strong><code>HelloImpl.jcs</code></strong>.</p>
- <p>Before proceeding, confirm that the following directory structure exists:</p>
- <source>C:
- beehive_projects
- controls_tutorial
- WEB-INF
- src
- hellocontrol
- HelloImpl.jcs</source>
- <p>In a text editor (or your IDE of choice), open the file HelloImpl.jcs.</p>
- <p>Edit HelloImpl.jcs so it appears as follows.</p>
- <source><![CDATA[package hellocontrol;
-
-import org.apache.beehive.controls.api.bean.*;
-
-@ControlImplementation
-public class HelloImpl implements Hello
-{
- public String hello()
- {
- return "Hello, World!";
- }
-}]]></source>
- <p>Save <code>HelloImpl.jcs</code>.</p>
- </section>
- <section id="create_inter">
- <title>To Create the Control's Interface File</title>
- <p>The interface file is a JAVA file that defines the public face of your control.
- [todo: more info here]
- </p>
- <p>In the directory <code>C:/beehive_projects/controls_tutorial/WEB-INF/src/hellocontrol</code>, create a file named <code>Hello.java</code>.</p>
- <p>Edit Hello.java so it looks like the following.</p>
- <source><![CDATA[package hellocontrol;
-
-import org.apache.beehive.controls.api.bean.ControlInterface;
-
-@ControlInterface
-public interface Hello
-{
- public String hello();
-}]]></source>
- <p>Save <code>Hello.java</code>.</p>
- </section>
- -->
- <section id="examine"><title>To Examine the Template Control Files</title>
- <p>Open the file <code>C:/beehive_projects/controls_tutorial/src/pkg/HelloImpl.jcs</code>.</p>
+ <section id="examine"><title>To Examine the Control Files</title>
+ <p>Open the file <code>C:/beehive_projects/control_tutorial/WEB-INF/src/pkg/HelloImpl.jcs</code>.</p>
<p>The implementation file appears as follows. (There is no need to edit the file at
this point in the tutorial.)</p>
<source>package pkg;
@@ -195,7 +143,7 @@
return "hello!";
}
}</source>
-<p>Open the file <code>C:/beehive_projects/controls_tutorial/src/pkg/Hello.java</code>.</p>
+<p>Open the file <code>C:/beehive_projects/control_tutorial/WEB-INF/src/pkg/Hello.java</code>.</p>
<p>The interface file appears as follows. (There is no need to edit the file at
this point in the tutorial.)</p>
<source>package pkg;
@@ -208,15 +156,82 @@
String hello();
}</source>
</section>
-
- <section id="edit_index.jsp">
- <title>To Edit the <code>index.jsp</code>Test Page</title>
- <p>To test the Hello control, you need to call the control from some other
+ <section id="edit_controller.jpf">
+ <title>Edit the Controller.jpf File</title>
+ <p>To test the Hello control, you need to call the control from some other
resource, such as a JAVA application, JSP page, or Page Flow web application.
- In this step you will call the
- control from a JSP page.
+ In the following two steps you will call the
+ control from the Contoller.jpf file and display the results
+ on a JSP page.
</p>
- <p>Edit the file <code>C:/beehive_projects/controls_tutorial_test/index.jsp</code>
+ <p>Open the file <code>C:/beehive_projects/control_tutorial/Controller.jpf</code> in a text editor.</p>
+ <p>Edit <code>Controller.jpf</code> so it appears as follows:</p>
+ <source>import javax.servlet.http.HttpSession;
+
+import org.apache.beehive.netui.pageflow.Forward;
+import org.apache.beehive.netui.pageflow.PageFlowController;
+import org.apache.beehive.netui.pageflow.annotations.Jpf;
+
+<strong>import org.apache.beehive.controls.api.bean.Control;
+import pkg.Hello;</strong>
+
+@Jpf.Controller(
+ simpleActions={
+ @Jpf.SimpleAction(name="<strong>old_</strong>begin", path="index.jsp")
+ },
+ sharedFlowRefs={
+ @Jpf.SharedFlowRef(name="shared", type=shared.SharedFlow.class)
+ }
+)
+public class Controller
+ extends PageFlowController
+{
+ @Jpf.SharedFlowField(name="shared")
+ private shared.SharedFlow sharedFlow;
+
+ <strong>@Control
+ private Hello _helloControl;
+
+ @Jpf.Action(
+ forwards={
+ @Jpf.Forward( name="success", path="index.jsp" )
+ }
+ )
+ protected Forward begin() throws Exception
+ {
+ Forward f = new Forward("success");
+ f.addActionOutput("helloMessage", _helloControl.hello());
+ return f;
+ }</strong>
+
+ /**
+ * Callback that is invoked when this controller instance is created.
+ */
+ protected void onCreate()
+ {
+ }
+
+ /**
+ * Callback that is invoked when this controller instance is destroyed.
+ */
+ protected void onDestroy(HttpSession session)
+ {
+ }
+}</source>
+ <p>The two import statements import the @Control annotation and the Hello
+ control, respectively.</p>
+ <p>The <code>@Jpf.SimpleAction</code> named "<code>begin</code>" is
+ renamed to "<code>old_begin</code>"
+ because the Beehive runtime automatically
+ looks for and runs any action named "<code>begin</code>" when
+ a Page Flow is
+ first instantiated. The renaming makes the runtime run the action
+ method <code>begin()</code>, which allows us to call the Hello control
+ inside of the method body.</p>
+ </section>
+ <section id="edit_index.jsp">
+ <title>To Edit the <code>index.jsp</code>Test Page</title>
+ <p>Edit the file <code>C:/beehive_projects/control_tutorial/index.jsp</code>
so it appears as follows. Code to edit appears in bold.</p>
<source>
<%@ page language="java" contentType="text/html;charset=UTF-8"%>
@@ -229,51 +244,37 @@
<netui:base/>
</head>
<netui:body>
- <strong><jsp:useBean class="pkg.HelloBean" id="helloBean" scope="session"/>
- <h3>Control Tutorial Test Page</h3></strong>
+ <strong><h3>Control Tutorial Test Page</h3></strong>
<p>
- <strong>Response from the hello() method on the Hello Control: <strong> <%= helloBean.hello() %> </strong></strong>
+ <strong>Response from the hello() method on the Hello Control:
+ <netui:label style="color:#FF0000" value="${pageInput.helloMessage}"/></strong>
</p>
</netui:body>
</netui:html>
</source>
- <p>Save <code>index.jsp</code>.</p>
</section>
<section id="compile_2">
<title>To Compile and Deploy the Control</title>
- <p>You are now ready to compile the control.</p>
+ <p>You are now ready to compile the test webapp
+ and the imbedded the control.</p>
<p>At the command prompt, enter the following Ant command.</p>
-<source>ant
- -f C:\beehive_projects\controls_tutorial\build.xml
- build
-
-<strong>Copy and Paste version:</strong>
-ant -f C:\beehive_projects\controls_tutorial\build.xml build</source>
-<p>Now copy the JAR file into the test web application.</p>
-<source>copy
- C:\beehive_projects\controls_tutorial\build\mycontrols.jar
- C:\beehive_projects\controls_tutorial_test\WEB-INF\lib
-
-<strong>Copy and Paste version:</strong>
-copy C:\beehive_projects\controls_tutorial\build\mycontrols.jar C:\beehive_projects\controls_tutorial_test\WEB-INF\lib
-</source>
- <p>You are now ready to compile the test environment and deploy it to Tomcat.</p>
<p>At the command prompt, enter:</p>
<source>ant
- -f C:\beehive_projects\controls_tutorial_test\WEB-INF\src\build.xml
+ -f C:\beehive_projects\control_tutorial\WEB-INF\src\build.xml
clean
build
war
<strong>Copy and Paste version:</strong>
-ant -f C:\beehive_projects\controls_tutorial_test\WEB-INF\src\build.xml clean build war</source>
-<p>To deploy the application, copy the WAR file into Tomcat's <code>webapps</code> directory.</p>
-<source>copy C:\beehive_projects\controls_tutorial_test.war %CATALINA_HOME%\webapps</source>
+
+ant -f C:\beehive_projects\control_tutorial\WEB-INF\src\build.xml clean build war</source>
+<p>To deploy the web app, copy the WAR file into Tomcat's <code>webapps</code> directory.</p>
+<source>copy C:\beehive_projects\control_tutorial.war %CATALINA_HOME%\webapps /Y</source>
</section>
<section id="test_2">
<title>To Test the Control</title>
<p>Open a web browser and enter the following in the address bar:</p>
- <p class="quote"><a class="fork" href="http://localhost:8080/controls_tutorial_test/index.jsp">http://localhost:8080/controls_tutorial_test/index.jsp</a></p>
+ <p class="quote"><a class="fork" href="http://localhost:8080/control_tutorial/Controller.jpf">http://localhost:8080/control_tutorial/Controller.jpf</a></p>
<p>You will be directed to the index.jsp page.</p>
<p>Note the message on the page: "hello!"</p>
<p>This message is provided by the Hello control.</p>
@@ -283,7 +284,8 @@
<title>Step 3: Add a Parameterized Method to the Control</title>
<section id="edit_3">
<title>To edit the Interface and Implementation Files</title>
- <p>Edit <code>HelloImpl.jcs</code> so it appears as follows. Code to add appears in
+ <p>Edit <code>C:/beehive_projects/control_tutorial/WEB-INF/src/pkg/HelloImpl.jcs</code>
+ so it appears as follows. Code to add appears in
bold.</p>
<source>package pkg;
@@ -302,8 +304,7 @@
return "Hello, " + name + "!";
}</strong>
}</source>
-<p>Save and close <code>HelloImpl.jcs</code></p>
-<p>Edit <code>Hello.java</code> so it appears as follows. Code to add appears in bold.</p>
+<p>Edit <code>C:/beehive_projects/control_tutorial/WEB-INF/src/pkg/Hello.java</code> so it appears as follows. Code to add appears in bold.</p>
<source>package pkg;
import org.apache.beehive.controls.api.bean.*;
@@ -316,7 +317,34 @@
<strong>String helloParam( String name );</strong>
}</source>
</section>
+<section id="edit_jpf_3"><title>Edit the Controller.jpf File</title>
+ <p>Edit the <code>begin()</code> method in
+ <code>Controller.jpf</code> so it appears as follows. Code to add appears in bold.</p>
+ <source>...
+
+public class Controller
+ extends PageFlowController
+{
+ ...
+
+ @Jpf.Action(
+ forwards={
+ @Jpf.Forward( name="success", path="index.jsp" )
+ }
+ )
+ protected Forward begin() throws Exception
+ {
+ Forward f = new Forward("success");
+ f.addActionOutput("helloMessage", _helloControl.hello());
+ <strong>f.addActionOutput("helloParamMessage", _helloControl.helloParam("World"));</strong>
+ return f;
+ }
+
+ ...
+
+}</source>
+ </section>
<section id="edit_jsp_3">
<title>To Edit the Test JSP Page</title>
<p>Edit <code>index.jsp</code> so it appears as follows. Code to add appears in bold.</p>
@@ -333,52 +361,27 @@
<jsp:useBean class="pkg.HelloBean" id="helloBean" scope="session"/>
<h3>Control Tutorial Test Page</h3>
<p>
- Response from the hello() method on the Hello Control: <strong> <%= helloBean.hello() %> </strong>
+ Response from the hello() method on the Hello Control:
+ <netui:label style="color:#FF0000" value="${pageInput.helloMessage}"/>
</p>
<strong><p>
- Response from the helloParam() method on the Hello Control: <strong> <%= helloBean.helloParam("Moon") %> </strong>
+ Response from the helloParam() method on the Hello Control:
+ <netui:label style="color:#FF0000" value="${pageInput.helloParamMessage}"/>
</p></strong>
</netui:body>
</netui:html></source>
- <p>Save and close <code>index.jsp</code></p>
</section>
<section id="compile_3">
- <title>To Compile and Deploy the Control</title>
- <p>You are now ready to compile the control.</p>
- <p>At the command prompt, enter the following Ant command.</p>
-<source>ant
- -f C:\beehive_projects\controls_tutorial\build.xml
- build
-
-<strong>Copy and Paste version:</strong>
-ant -f C:\beehive_projects\controls_tutorial\build.xml build</source>
-<p>Now copy the JAR file into the test web application.</p>
-<source>copy
- C:\beehive_projects\controls_tutorial\build\mycontrols.jar
- C:\beehive_projects\controls_tutorial_test\WEB-INF\lib
-
-<strong>Copy and Paste version:</strong>
-copy C:\beehive_projects\controls_tutorial\build\mycontrols.jar C:\beehive_projects\controls_tutorial_test\WEB-INF\lib
-</source>
- <p>You are now ready to compile the test environment and deploy it to Tomcat.</p>
- <p>At the command prompt, enter:</p>
-<source>ant
- -f C:\beehive_projects\controls_tutorial_test\WEB-INF\src\build.xml
- clean
- build
- war
-
-<strong>Copy and Paste version:</strong>
-ant -f C:\beehive_projects\controls_tutorial_test\WEB-INF\src\build.xml clean build war</source>
-<p>To deploy the application, copy the WAR file into Tomcat's <code>webapps</code> directory.</p>
-<source>copy C:\beehive_projects\controls_tutorial_test.war %CATALINA_HOME%\webapps</source>
+ <title>To Compile and Redeploy the Control</title>
+ <p>Compile and deploy the web application using the same command line statements used in the
+ the previous step.</p>
</section>
<section id="test_3">
<title>To Test the Control</title>
<p>Open a web browser and enter the following in the address bar:</p>
- <p class="quote"><a class="fork" href="http://localhost:8080/controls_tutorial_test/index.jsp">http://localhost:8080/controls_tutorial_test/index.jsp</a></p>
+ <p class="quote"><a class="fork" href="http://localhost:8080/control_tutorial/Controller.jpf">http://localhost:8080/control_tutorial/Controller.jpf</a></p>
<p>You will be directed to the index.jsp page.</p>
- <p>Note the messages on the page: "hello!" and "Hello, Moon!"</p>
+ <p>Note the messages on the page: "hello!" and "Hello, World!"</p>
<p>These messages are provided by the Hello control.</p>
</section>
</section>
Modified: incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/docs/index.xml
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/docs/index.xml?view=diff&r1=161223&r2=161224
==============================================================================
--- incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/docs/index.xml (original)
+++ incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/docs/index.xml Wed Apr 13 15:11:12 2005
@@ -5,7 +5,7 @@
<title>Beehive 1.0 Beta Documentation</title>
</header>
<body>
- <p>Beehive documetation contains documentation for all three Beehive sub-projects: Controls,
+ <p>Beehive documentation contains documentation for all three Beehive sub-projects: Controls,
Page Flows, and Web Services.</p>
<p>If your are new to Beehive, begin by following the
<a href="../setup.html">Installation and Startup</a> instructions.</p>
Modified: incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/glossary.xml
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/glossary.xml?view=diff&r1=161223&r2=161224
==============================================================================
--- incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/glossary.xml (original)
+++ incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/glossary.xml Wed Apr 13 15:11:12 2005
@@ -7,14 +7,35 @@
<body>
<section>
<title>Terms</title>
- <p id="bee_control">Beehive Control -- Beehive Controls are designed to make it easier to integrate complex resources into your Java application. For example, the A Beehive Control consists of two JAVA files: a Control implementation file, and a Control interface file. </p>
- <p>Contoller file</p>
- <p>Contoller implementation</p>
- <p>Contoller interface</p>
- <p>Contoller file</p>
- <p>Data Binding</p>
- <p>Form Bean -- Typically, a Form Bean is a server-side representation of a HTML <netui:form> tag. Form Beans follow ordinary Java Bean syntax: each Form Bean is a class consisting of any number of members, each member having a setter and a getter method
- associated with it. Form Beans must extend the class org.apache.beehive.netui.pageflow.FormData. The Sample Form Bean below has two members, each member has a getter and setter method associated with it.</p>
+ <dl id="control">
+ <dt><strong>Control</strong></dt>
+ <dd>Controls are designed to make it easier to integrate complex resources
+ into your Java application. Controls consist
+ of two JAVA files: a Control implementation file, and a Control interface
+ file.</dd>
+ </dl>
+ <dl id="controller_file">
+ <dt><strong>Controller class / Controller file</strong></dt>
+ <dd>The Controller class is a JAVA class that handles the data processing
+ tasks in a <a href="#page_flow">Page Flow</a>.</dd>
+ </dl>
+ <dl id="databinding">
+ <dt><strong>Data Binding</strong></dt>
+ <dd>The process of databinding connects JSP pages to data objects. The data objects
+ can be located in various places throughout the web application:
+ in the <a href="#controller_file">Controller file</a>, in the
+ standard JSP objects, etc. A list of </dd>
+ </dl>
+ <dl id="formbean">
+ <dt><strong>Form Bean</strong></dt>
+ <dd><p>Typically, a Form Bean is a server-side representation of a HTML
+ <netui:form> tag. Form Beans follow ordinary Java Bean syntax: each
+ Form Bean is a class consisting of any number of members, each member
+ having a setter and a getter method
+ associated with it. Form Beans must extend the class
+ org.apache.beehive.netui.pageflow.FormData. The Sample Form Bean below
+ has two members, each member has a getter and setter method associated
+ with it.</p>
<source><![CDATA[
public static class ProfileFormBean extends FormData
{
@@ -43,12 +64,32 @@
}
}
]]></source>
- <p>Form Beans are most often used to pick up data that is submitted from a <netui:form> tag, or incoming data from a back-end resource. Once the data has been picked up by a Form Bean instance, it is then passed to an Action method.</p>
- <p>JWS</p>
- <p>JPF</p>
- <p>JCS</p>
- <p><netui> tag library</p>
- <p>Page Flow</p>
+ <p>Form Beans are most often used to pick up data that is submitted from a
+ <netui:form> tag, or incoming data from a back-end resource.
+ Once the data has been picked up by a Form Bean instance, it is
+ then passed to an Action method.</p>
+ </dd>
+ </dl>
+ <dl id="jws">
+ <dt><strong>JWS</strong></dt>
+ <dd>[todo]</dd>
+ </dl>
+ <dl id="jpf">
+ <dt><strong>JPF</strong></dt>
+ <dd>[todo]</dd>
+ </dl>
+ <dl id="jcs">
+ <dt><strong>JCS</strong></dt>
+ <dd>[todo]</dd>
+ </dl>
+ <dl id="netui_tag_lib">
+ <dt><strong><netui> tag library</strong></dt>
+ <dd>[todo]</dd>
+ </dl>
+ <dl id="page_flow">
+ <dt><strong>Page Flow</strong></dt>
+ <dd></dd>
+ </dl>
</section>
</body>
<footer>
Modified: incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/jpetstore.xml
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/jpetstore.xml?view=diff&r1=161223&r2=161224
==============================================================================
--- incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/jpetstore.xml (original)
+++ incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/jpetstore.xml Wed Apr 13 15:11:12 2005
@@ -48,32 +48,32 @@
<tr>
<td> account</td>
<td>Page Flow (=Controller.jpf + JSP files) user interface
- for managing user accounts.</td>
+ for managing user accounts</td>
</tr>
<tr>
<td> auth</td>
<td>Page Flow user interface for managing login and
- logout.</td>
+ logout</td>
</tr>
<tr>
<td> checkout</td>
<td>Page Flow user interface for managing the shopping
- cart.</td>
+ cart</td>
</tr>
<tr>
<td> search</td>
<td>Page Flow user interface for searching the
- Petstore.</td>
+ Petstore</td>
</tr>
<tr>
<td> shop</td>
<td>Page Flow user interface for browsing the catalogue of
- pets.</td>
+ pets</td>
</tr>
<tr>
<td> site</td>
<td>Contains the Petstore "skin", including the CSS file,
- HTML frameset, and template file.</td>
+ HTML frameset, and template file</td>
</tr>
<tr>
<td> webappRoot</td>
@@ -84,7 +84,7 @@
<tr>
<td> WEB-INF</td>
<td>Contains configuration files for deployment,
- validation, and security (web.xml).</td>
+ validation, and security (web.xml)</td>
</tr>
<tr>
<td> lib</td>
@@ -100,19 +100,19 @@
src/.../controls</td>
<td>Beehive Controls encapsulating different
functionalities, including handling user account data,
- catalogue data, and order processing.</td>
+ catalogue data, and order processing</td>
</tr>
<tr>
<td>
src/.../forms</td>
<td>Form Beans: each form bean is a server-side
representation of an HTML form appearing in the user
- interface.</td>
+ interface</td>
</tr>
<tr>
<td>
src/.../model</td>
- <td>Java object classes used by the Controls.</td>
+ <td>Java object classes used by the Controls</td>
</tr>
</table>
</section>
@@ -125,8 +125,7 @@
<p>Before proceeding, complete all of the necessary and optional steps in the
following topic:
<a class="fork" href="setup.html">Beehive Installation and Setup</a></p>
- <p>Open a command shell and confirm that you have the following variables
- have been set:</p>
+ <p>Open a command shell and confirm that you have set following variables:</p>
<ul>
<li><code>ANT_HOME</code></li>
<li><code>JAVA_HOME</code></li>
@@ -158,7 +157,7 @@
<p>Open the file <code>C:/beehive_projects/petstoreWeb/WEB-INF/src/build.properties</code>
in a text editor.</p>
<p>Edit the file so that the <code>beehive.home</code> property points to the
- top-level folder of your beehive installation. For example, if you beehive installation
+ top-level folder of your beehive installation. For example, if your beehive installation
resides at <code>C:/apache/apache-beehive-1.0</code>, then your <code>build.properties</code> file
would appear as follows.</p>
<source>beehive.home=<strong>C:/apache/apache-beehive-1.0</strong>
Modified: incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/tutorial_pageflow.xml
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/tutorial_pageflow.xml?view=diff&r1=161223&r2=161224
==============================================================================
--- incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/tutorial_pageflow.xml (original)
+++ incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/tutorial_pageflow.xml Wed Apr 13 15:11:12 2005
@@ -11,11 +11,11 @@
<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>
+ <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>
@@ -25,8 +25,7 @@
<title>To Set up the Development Environment</title>
<p>Complete all of the necessary and optional steps in the following topic:
<a class="fork" href="../setup.html">Beehive Installation and Setup</a></p>
- <p>Open a command shell and confirm that you have the following variables
- have been set:</p>
+ <p>Open a command shell and confirm that you have set the following variables:</p>
<ul>
<li><code>ANT_HOME</code></li>
<li><code>JAVA_HOME</code></li>
@@ -91,8 +90,9 @@
In this step you will create a Controller file and a JSP page. These are the basic files in
a Beehive Page Flow web application. Each Page Flow contains one Controller file and any
number of JSP pages. 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
+ controls how your web application functions and what it does. The methods in the
+ Controller
+ file determine 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. The JSP pages determine what a visitor to the web sees in the browser.
(In terms of the Model-View-Controller paradigm for web applications: the Controller.jpf
Modified: incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/setup.xml
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/setup.xml?view=diff&r1=161223&r2=161224
==============================================================================
--- incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/setup.xml (original)
+++ incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/setup.xml Wed Apr 13 15:11:12 2005
@@ -18,7 +18,7 @@
<title>Basic Installation</title>
<p>(1) The following software is required for developing Beehive applications:</p>
<ul>
- <li>Beehive Binary Distribution (download: <a class="fork" href="http://cvs.apache.org/dist/incubator/beehive/v1.0-alpha/bin/">http://cvs.apache.org/dist/incubator/beehive/v1.0-alpha/bin/</a>)</li>
+ <li>Beehive Binary Distribution (download: <a class="fork" href="http://cvs.apache.org/dist/incubator/beehive/v1.0-beta/bin/">http://cvs.apache.org/dist/incubator/beehive/v1.0-beta/bin/</a>)</li>
<li>Ant 1.6.2 (download: <a class="fork" href="http://ant.apache.org/bindownload.cgi">http://ant.apache.org/bindownload.cgi</a>)</li>
<li>J2SE5 (download: <a class="fork" href="http://java.sun.com/j2se/1.5.0/download.jsp">http://java.sun.com/j2se/1.5.0/download.jsp</a>)</li>
</ul>
Modified: incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/site.xml
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/site.xml?view=diff&r1=161223&r2=161224
==============================================================================
--- incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/site.xml (original)
+++ incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/site.xml Wed Apr 13 15:11:12 2005
@@ -13,10 +13,12 @@
<docs label="Beehive Docs" href="docs/index.html"/>
<setup label="Installation and Setup" href="setup.html" />
<tutorials label="Tutorials">
+ <tutorial_pageflow label="Page Flows" href="pageflow/tutorial_pageflow.html"/>
+ <tutorial_control label="Controls" href="controls/tutorial_controls.html"/>
+ <tutorial_wsm label="Web Services" href="wsm/tutorial_wsm.html"/>
<tut_dbwebapp label="DB-Driven Web App" href="tutorial/tut_dbdrivenwebapp.html" />
</tutorials>
<pageflow label="Page Flows">
- <tutorial_pageflow label="Tutorial" href="pageflow/tutorial_pageflow.html"/>
<pageflow_overview label="Overview" href="pageflow/pageflow_overview.html"/>
<pageflow_controllers label="Controller Files" href="pageflow/pageflow_controllers.html"/>
<pageflow_jsp label="JSP Files" href="pageflow/pageflow_jsp.html"/>
@@ -31,13 +33,11 @@
<!--<pageflow_programming label="Page Flow Programming" href="pageflow/guide.html"/>-->
</pageflow>
<controls label="Controls">
- <tutorial_control label="Tutorial" href="controls/tutorial_controls.html"/>
<control_overview label="Controls Overview" href="controls/controlsOverview.html"/>
<control_prog label="Control Programming" href="controls/controlsProgramming.html"/>
<control_contain label="Controls Containment" href="controls/controlsContainment.html"/>
</controls>
<wsm label="Web Services">
- <tutorial_wsm label="Tutorial" href="wsm/tutorial_wsm.html"/>
<wsm_overview label="Web Services Overview" href="wsm/wsm_overview.html"/>
<wsm_overview label="Java Web Service Files" href="wsm/wsm_JWSFiles.html"/>
<supported_datatypes label="Supported Data Types" href="wsm/datatypes.html"/>
Modified: incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/wsm/tutorial_wsm.xml
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/wsm/tutorial_wsm.xml?view=diff&r1=161223&r2=161224
==============================================================================
--- incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/wsm/tutorial_wsm.xml (original)
+++ incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/wsm/tutorial_wsm.xml Wed Apr 13 15:11:12 2005
@@ -12,9 +12,9 @@
<p><strong>Tutorial Goals</strong></p>
<p>In this tutorial, you will learn:</p>
<ul>
- <li>How to create a basic Beehive web service application.</li>
- <li>How to use (JSR 175 and 181) metadata annotations.</li>
- <li>How to deploy and test a web service to Tomcat</li>
+ <li>how to create a basic Beehive web service application.</li>
+ <li>how to use (JSR 175 and 181) metadata annotations.</li>
+ <li>how to deploy and test a web service on Tomcat.</li>
</ul>
</section>
<section id="step1">
@@ -190,7 +190,7 @@
</section>
<section id="compile_3">
<title>To Compile and Redeploy the Web Service</title>
- <p>To compile the web service and deploy it to Tomcat.</p>
+
<p>At the command prompt, enter:</p>
<source>ant
-f C:\beehive_projects\ws_tutorial\WEB-INF\build.xml
@@ -254,7 +254,6 @@
</section>
<section id="compile_4">
<title>To Compile and Redeploy the Web Service</title>
- <p>To compile the web service and deploy it to Tomcat.</p>
<p>At the command prompt, enter:</p>
<source>ant
-f C:\beehive_projects\ws_tutorial\WEB-INF\build.xml
@@ -323,7 +322,6 @@
</section>
<section id="compile_5">
<title>To Compile and Redeploy the Web Service</title>
- <p>To compile the web service and deploy it to Tomcat.</p>
<p>At the command prompt, enter:</p>
<source>ant
-f C:\beehive_projects\ws_tutorial\WEB-INF\build.xml