Author: steveh
Date: Wed Feb 16 13:52:56 2005
New Revision: 154085
URL: http://svn.apache.org/viewcvs?view=rev&rev=154085
Log:
(1) Updates to tutorials and sample docs
(2) Skin update
Modified:
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/controls/sample_controls-blank.xml
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/controls/tutorial_controls.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/wsm/sample_wsm-blank.xml
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/wsm/tutorial_wsm.xml
incubator/beehive/trunk/docs/forrest/src/documentation/skinconf.xml
incubator/beehive/trunk/docs/updating_livesite.txt
Modified:
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/controls/sample_controls-blank.xml
URL:
http://svn.apache.org/viewcvs/incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/controls/sample_controls-blank.xml?view=diff&r1=154084&r2=154085
==============================================================================
---
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/controls/sample_controls-blank.xml
(original)
+++
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/controls/sample_controls-blank.xml
Wed Feb 16 13:52:56 2005
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.2//EN"
"http://forrest.apache.org/dtd/document-v13.dtd";>
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN"
"http://forrest.apache.org/dtd/document-v20.dtd";>
<document>
<header>
<title>Control Project Template</title>
@@ -7,29 +7,36 @@
<body>
<section id="intro">
<title>Introduction</title>
-<p>Use the "blank" Control sample (located at
<code>BEEHIVE_HOME/samples/controls-blank</code>) as a template for building
your own Control projects.
+<p>Use the "blank" Control sample (located at
<code><BeehiveRoot>/samples/controls-blank</code>) as a
+ template for building your own Control projects.
</p>
-<p>The template contains a basic 'Hello World' control to get you started.
Control projects can be archived in a JAR file and then imported into multiple
applications. Simply import the JAR archive into the application's WEB-INF/lib
directory. </p>
+<p>The template contains a basic 'Hello World' control to get you started.
Control projects can be
+ archived in a JAR file and then imported into multiple applications.
Simply import the JAR archive
+ into the application's WEB-INF/lib directory. </p>
</section>
<section>
<title>Using the Control Project Template</title>
- <p>The following instruction assume that you have completed the basic
Beehive set up procedure at <fork href="../setup.html">Set Up the Dev
Environment</fork>.</p>
- <p>To use the template, copy the contents of
<code>BEEHIVE_HOME/samples/controls-blank</code> into your project folder
(refered to as <code><Project-Folder></code> below). An Ant build file is
included in the control application template, which will compile your control
project into a distributable JAR file.
-It is important to copy the <em>contents</em> of <code>controls-blank</code>
into your project folder, not the <code>controls-blank</code> folder itself.
After you have copied the contents of <code>controls-blank</code> into your
project folder, the following directory structure should exist:</p>
+ <p>The following instruction assume that you have completed the basic
Beehive set up procedure
+ at <a class="fork" href="../setup.html">Set Up the Dev
Environment</a>.</p>
+ <p>To use the template, copy the contents of
<code><BeehiveRoot>/samples/controls-blank</code> into your
+ project folder (refered to as <code><Project-Folder></code> below).
(Or copy <code>controls-blank</code>
+ to another location and rename it.)
+ An Ant build file is included
+ in the template, which will compile your control project into a
distributable JAR
+ file. After you have copied the contents of
+ <code>controls-blank</code> into your project folder, the following
directory structure should exist:</p>
<source><Project-Folder>
src
build.xml</source>
<p>The following Ant command will compile the control template. </p>
-<source> ant
- -f <Project-Folder>\build.xml build</source>
-
-
-
+<source>ant
+ -f <Project-Folder>\build.xml build</source>
<p>This will produce a distributable JAR file at:
<code><Project-Folder>/build/mycontrols.jar</code>.</p>
- <p>To use the JAR in your other projects (like a web app project or a web
service project), copy <code>mycontrols.jar</code> into the project's
<code>WEB-INF/lib</code> directory.</p>
+ <p>To use the JAR in your other projects (like a web app project or a web
service project), copy
+ <code>mycontrols.jar</code> into the project's
<code>WEB-INF/lib</code> directory.</p>
</section>
</body>
<footer>
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=154084&r2=154085
==============================================================================
---
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 Feb 16 13:52:56 2005
@@ -20,82 +20,130 @@
</ul>
</section>
</section>
- <section id="step1">
- <title>Step 1: Begin the Page Flow Tutorial</title>
- <section>
- <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>After completing the instructions, leave the command shell
open to use
- throughout this tutorial.</p>
- <p>Before proceding, confirm that you have the
following variables set in your shell:</p>
- <ul>
- <li><code>ANT_HOME</code></li>
- <li><code>JAVA_HOME</code></li>
-
<li><code>CATALINA_HOME</code></li>
- </ul>
- <p>Also ensure that the following
elements are on your <code>PATH</code>:</p>
- <ul>
-
<li><code>ANT_HOME/bin</code></li>
-
<li><code>JAVA_HOME/bin</code></li>
- </ul>
- </section>
- <section>
- <title>To Start the Tomcat Server</title>
- <p>At the command prompt, enter:</p>
- <source>%CATALINA_HOME%\bin\startup.bat</source>
- </section>
- </section>
- <section id="step_2">
- <title>Step 2: Create Control Implementation and Interface
Files</title>
- <section>
- <title>Introduction</title>
- <p>A Beehive Control consists of two files: an interface file
(with the JAVA file extension)
- and an implementation file (with the
JCS file extension). The interface file is the public face of your control.
It lists all of the methods which can be invoked by users. The implementation
file contains the implementation code for the methods listed in the interface
file.</p>
- </section>
- <section>
- <title>Make a Project Folder</title>
- <p>In this task you will make a web application
project folder. Control development
- will take place within this web
application. You
- might be asking yourself, <em>Why would
I need web application resources in a control
- tutorial?</em> The answer is that
developing your control within a web app
- makes it much easier to test your
control as you go. The web application will form
- the testing ground for your
control.</p>
- <p>On your C: drive, create a directory called
<code>beehive_projects</code>.</p>
- <p>Copy the folder
<code><BeehiveRoot>/samples/netui-blank</code> into
- <code>C:/beehive_projects</code>.
(<code><BeehiveRoot></code> refers to the
- top level folder of your Beehive
installation.)</p>
+ <section id="step1">
+ <title>Step 1: Begin the Control Tutorial</title>
+ <section id="setup">
+ <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>After completing the instructions, leave the
command shell
+ open to use throughout this
tutorial.</p>
+ <p>Before proceding, confirm that you have the
following
+ variables set in your shell:</p>
+ <ul>
+ <li>
+ <code>BEEHIVE_HOME</code>
+ </li>
+ <li>
+ <code>ANT_HOME</code>
+ </li>
+ <li>
+ <code>JAVA_HOME</code>
+ </li>
+ <li>
+ <code>CATALINA_HOME</code>
+ </li>
+ </ul>
+ <p>Also ensure that the following elements are
on your
+ <code>PATH</code>:</p>
+ <ul>
+ <li>
+ <code>ANT_HOME/bin</code>
+ </li>
+ <li>
+ <code>JAVA_HOME/bin</code>
+ </li>
+ </ul>
+ </section>
+ <section id="make_proj">
+ <title>To Make a Control Project Folder</title>
+ <p>In this task you will make a web application
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</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>
+ <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>control_tutorial</code></strong></p>
+
<code>C:/beehive_projects/</code><strong><code>controls_tutorial_test</code></strong></p>
<p>Before proceeding, confirm that the
following directory structure exists:</p>
- <source>C:
+ <source>C:
beehive_projects
- control_tutorial</source>
-
- </section>
-<section>
- <title>To Add Beehive Runtime JARs to Your Project Folder</title>
- <p>In this step you will assemble the runtime resources for your
Control.
- Most of these files are included in the WEB-INF directory.
- It includes JAR files with the JSP tag handler classes, the
Controls runtime JAR, etc.</p>
- <p>At the command prompt, enter the following ant command. In place of
<code><BeehiveRoot></code>
- substitute the path to the top-level directory of your Beehive
installation.</p>
- <source>ant
- -f <BeehiveRoot>\ant\webappRuntimeCore.xml
- -Dwebapp.dir=C:\beehive_projects\control_tutorial
- deploy.beehive.webapp.runtime</source>
-</section>
- <section>
+ controls_tutorial_test
+ resources
+ WEB-INF
+ Controller.jpf
+ error.jsp
+ index.jsp</source>
+ </section>
+ <section id="copy_JARs">
+ <title>To Copy Runtime JARs to the Web Application</title>
+ <p>In this step you will assemble the runtime resources for
your web application.
+ The runtime JARs include the Page Flow
runtime, the <netui> tag library, etc.
+ These resources are loaded into your
project's <code>WEB-INF/lib</code> folder
+ using the Ant command below.</p>
+ <p>At the command prompt, enter the following Ant command:</p>
+ <source>ant
+ -f %BEEHIVE_HOME%\ant\webappRuntimeCore.xml
+ -Dwebapp.dir=C:\beehive_projects\controls_tutorial_test
+ deploy.beehive.webapp.runtime
+
+<strong>Cut and paste version:</strong>
+ant -f %BEEHIVE_HOME%\ant\webappRuntimeCore.xml
-Dwebapp.dir=C:\beehive_projects\controls_tutorial_test
deploy.beehive.webapp.runtime</source>
+ <p>Before proceeding, confirm that the following directory
structure exists:</p>
+<source>C:
+ beehive_projects
+ controls_tutorial_test
+ WEB-INF
+ lib
+ [many JAR files]</source>
+ </section>
+
+ <section id="start_tomcat">
+ <title>To Start the Tomcat Server</title>
+ <p>At the command prompt, enter:</p>
+ <source>%CATALINA_HOME%\bin\startup.bat</source>
+ </section>
+ </section>
+ <section id="step_2">
+ <title>Step 2: Compile the Template 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)
+ and an implementation file (with the
JCS file extension). The interface file is the
+ public face of your control. It lists
all of the methods which can be invoked by
+ 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/control_tutorial/WEB-INF/src</code>, create a
directory called <code>hellocontrol</code>.</p>
- <p>In the directory
<code>C:/beehive_projects/webapps/control_tutorial/WEB-INF/src/hellocontrol</code>,
create a file called <code>HelloImpl.jcs</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
- control_tutorial
+ controls_tutorial
WEB-INF
src
hellocontrol
@@ -116,11 +164,12 @@
}]]></source>
<p>Save <code>HelloImpl.jcs</code>.</p>
</section>
- <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. <!--[tbd]-->
+ <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/control_tutorial/WEB-INF/src/hellocontrol</code>,
create a file named <code>Hello.java</code>.</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;
@@ -132,15 +181,44 @@
public String hello();
}]]></source>
<p>Save <code>Hello.java</code>.</p>
- </section>
- <section>
- <title>To Edit the <code>index.jsp</code> Page</title>
- <p>To test your Beehive Control, you need to call the control
from some other
+ </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>
+ <p>[todo: more here]</p>
+<source>package pkg;
+
+import org.apache.beehive.controls.api.bean.*;
+
[EMAIL PROTECTED]
+public class HelloImpl implements Hello
+{
+ public String hello()
+ {
+ return "hello!";
+ }
+}</source>
+<p>Open the file
<code>C:/beehive_projects/controls_tutorial/src/pkg/Hello.java</code>.</p>
+<p>[todo: more here]</p>
+<source>package pkg;
+
+import org.apache.beehive.controls.api.bean.*;
+
[EMAIL PROTECTED]
+public interface Hello
+{
+ 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
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.
</p>
- <p>Edit the file
<code>C:/beehive_projects/control_tutorial/index.jsp</code>
+ <p>Edit the file
<code>C:/beehive_projects/controls_tutorial_test/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"%>
@@ -153,7 +231,7 @@
<netui:base/>
</head>
<netui:body>
- <strong><jsp:useBean class="hellocontrol.HelloBean" id="helloBean"
scope="session"/>
+ <strong><jsp:useBean class="pkg.HelloBean" id="helloBean"
scope="session"/>
<h3>Control Tutorial Test Page</h3></strong>
<p>
<strong>Response from the hello() method on the Hello Control:
<strong> <%= helloBean.hello() %> </strong></strong>
@@ -163,50 +241,61 @@
</source>
<p>Save <code>index.jsp</code>.</p>
</section>
- <section>
+ <section id="compile_2">
<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. In
place of <code><BeehiveRoot></code>
- substitute the path to the top-level directory of your Beehive
installation.</p>
- <source>ant
- -f <BeehiveRoot>\ant\buildWebapp.xml
- -Dwebapp.dir=C:\beehive_projects\control_tutorial
- build</source>
- <p>To deploy the web application (with the control imbedded in it),
click the following link. We recommend that you open the
+ <p>At the command prompt, enter the following Ant command.</p>
+<source>ant
+ -f C:\beehive_projects\controls_tutorial\build.xml
+ build
+
+<strong>Cut 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>Cut and Paste version:</strong>
+copy C:\beehive_projects\controls_tutorial\build\mycontrols.jar
C:\beehive_projects\controls_tutorial_test\WEB-INF\lib
+</source>
+ <p>To deploy the web application (with the control imbedded in it),
click the following link. We
+ recommend that you open the
link in a new browser window. Each time you want to redeploy
the application,
simply refresh the browser.</p>
<p class="quote">
- <a class="fork"
href="http://localhost:8080/manager/deploy?path=/control_tutorial&war=file:C:/beehive_projects/control_tutorial&update=true";>http://localhost:8080/manager/deploy?path=/control_tutorial&war=file:C:/beehive_projects/control_tutorial&update=true</a>
+ <a class="fork"
href="http://localhost:8080/manager/deploy?path=/controls_tutorial_test&war=file:C:/beehive_projects/controls_tutorial_test&update=true";>http://localhost:8080/manager/deploy?path=/controls_tutorial_test&war=file:C:/beehive_projects/controls_tutorial_test&update=true</a>
</p>
<p>If you are prompted for a username/password, enter:
manager/manager</p>
<p>(For an explanation of this method of deploying an application to
Tomcat,
see the Tomcat 5 documentation:
<a class="fork"
href="http://jakarta.apache.org/tomcat/tomcat-5.0-doc/manager-howto.html#Deploy%20A%20New%20Application%20from%20a%20Local%20Path";>Deploy
A New Application from a Local Path</a>)</p>
</section>
- <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/control_tutorial/index.jsp";>http://localhost:8080/control_tutorial/index.jsp</a></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>You will be directed to the index.jsp page.</p>
- <p>Note the message on the page: "Hello, World!"</p>
+ <p>Note the message on the page: "hello!"</p>
<p>This message is provided by the Hello control.</p>
</section>
</section>
- <section>
+ <section id="add_param_method">
<title>Step 3: Add a Parameterized Method to the
Control</title>
- <section>
+ <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 bold.</p>
-<source>package hellocontrol;
+ <p>Edit <code>HelloImpl.jcs</code> so it appears as
follows. Code to add appears in
+ bold.</p>
+<source>package pkg;
import org.apache.beehive.controls.api.bean.*;
@ControlImplementation
public class HelloImpl implements Hello
-{
+{
public String hello()
{
- return "Hello, World!";
+ return "hello!";
}
<strong>public String helloParam( String name )
@@ -216,30 +305,33 @@
}</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>
-<source>package hellocontrol;
+<source>package pkg;
-import org.apache.beehive.controls.api.bean.ControlInterface;
+import org.apache.beehive.controls.api.bean.*;
@ControlInterface
public interface Hello
-{
- public String hello();
+{
+ String hello();
- <strong>public String helloParam( String name );</strong>
+ <strong>String helloParam( String name );</strong>
}</source>
</section>
-<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>
<source><%@ 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>Control Tutorial Test Page</title>
+ <netui:base/>
</head>
<netui:body>
- <jsp:useBean class="hellocontrol.HelloBean" id="helloBean"
scope="session"/>
+ <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>
@@ -251,25 +343,42 @@
</netui:html></source>
<p>Save and close <code>index.jsp</code></p>
</section>
-<section>
- <title>To Compile and Redeploy the Control</title>
-<p>Compile the control with the following Ant command:</p>
- <source>ant -f <BeehiveRoot>\ant\buildWebapp.xml
-Dwebapp.dir=C:\beehive_projects\control_tutorial build</source>
- <p>To redeploy the application, click the following link:</p>
- <source>
- <a
- class="fork"
-
href="http://localhost:8080/manager/deploy?path=/control_tutorial&war=file:C:/beehive_projects/control_tutorial&update=true";>http://localhost:8080/manager/deploy?path=/control_tutorial&war=file:C:/beehive_projects/control_tutorial&update=true</a>
- </source>
-</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>Cut 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
- <section>
+<strong>Cut and Paste version:</strong>
+copy C:\beehive_projects\controls_tutorial\build\mycontrols.jar
C:\beehive_projects\controls_tutorial_test\WEB-INF\lib
+</source>
+ <p>To deploy the web application (with the control imbedded in it),
click the following link. We
+ recommend that you open the
+ link in a new browser window. Each time you want to redeploy
the application,
+ simply refresh the browser.</p>
+ <p class="quote">
+ <a class="fork"
href="http://localhost:8080/manager/deploy?path=/controls_tutorial_test&war=file:C:/beehive_projects/controls_tutorial_test&update=true";>http://localhost:8080/manager/deploy?path=/controls_tutorial_test&war=file:C:/beehive_projects/controls_tutorial_test&update=true</a>
+ </p>
+ <p>If you are prompted for a username/password, enter:
manager/manager</p>
+ <p>(For an explanation of this method of deploying an application to
Tomcat,
+ see the Tomcat 5 documentation:
+ <a class="fork"
href="http://jakarta.apache.org/tomcat/tomcat-5.0-doc/manager-howto.html#Deploy%20A%20New%20Application%20from%20a%20Local%20Path";>Deploy
A New Application from a Local Path</a>)</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/control_tutorial/index.jsp";>http://localhost:8080/control_tutorial/index.jsp</a>
- </p>
+ <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>You will be directed to the index.jsp page.</p>
- <p>Note the messages on the page: "Hello, World!" and "Hello,
Moon!"</p>
+ <p>Note the messages on the page: "hello!" and "Hello,
Moon!"</p>
<p>These messages are provided by the Hello control.</p>
</section>
</section>
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=154084&r2=154085
==============================================================================
---
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 Feb 16 13:52:56 2005
@@ -21,13 +21,14 @@
</section>
<section id="step1_begin">
<title>Step 1: Begin the Page Flow Tutorial</title>
- <section>
+ <section id="setup">
<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>
<ul>
+
<li><code>BEEHIVE_HOME</code></li>
<li><code>ANT_HOME</code></li>
<li><code>JAVA_HOME</code></li>
<li><code>CATALINA_HOME</code></li>
@@ -38,7 +39,7 @@
<li><code>JAVA_HOME/bin</code></li>
</ul>
</section>
- <section>
+ <section id="start_tomcat">
<title>To Start the Tomcat Server</title>
<p>At the command prompt, enter:</p>
<source>%CATALINA_HOME%\bin\startup.bat</source>
@@ -46,7 +47,7 @@
</section>
<section id="step_2_create">
<title>Step 2: Create a New Page Flow Application</title>
- <section>
+ <section id="intro_2">
<title>Introduction</title>
<p>
In this step you will create a Controller file and a
JSP page. These are the basic files in
@@ -74,12 +75,11 @@
step, you will create a more complex Action
method.
</p>
</section>
- <section>
+ <section id="make_proj">
<title>Make a Project Folder</title>
<p>On your C: drive, create a directory named
<code>beehive_projects</code>.</p>
- <p>Copy the folder
<code><BeehiveRoot>/samples/netui-blank</code> into
- <code>C:/beehive_projects</code>.
(<code><BeehiveRoot></code> refers to the
- top level folder of your Beehive
installation.)</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>pageflow_tutorial</code></strong></p>
@@ -93,7 +93,7 @@
error.jsp
index.jsp</source>
</section>
- <section>
+ <section id="copy_JARs">
<title>To Copy Runtime JARs to the Project Folder</title>
<p>In this step you will assemble the runtime resources for
your Page Flow application.
The runtime JARs include the Page Flow
runtime, the <netui> tag library, etc.
@@ -101,7 +101,7 @@
using the Ant command below.</p>
<p>At the command prompt, enter the following Ant command:</p>
<source>ant
- -f <BeehiveRoot>\ant\webappRuntimeCore.xml
+ -f %BEEHIVE_HOME%\ant\webappRuntimeCore.xml
-Dwebapp.dir=C:\beehive_projects\pageflow_tutorial
deploy.beehive.webapp.runtime</source>
<p>Before proceeding, confirm that the following directory
structure exists:</p>
@@ -112,10 +112,12 @@
lib
[many JAR files]</source>
</section>
- <section>
+ <section id="examine">
<title>To Examine the <code>Controller.jpf</code> and
<code>index.jsp</code> Files</title>
<p>There are no edits to make in this step. The point of this
step is
to learn about the code you are about
to run.</p>
+ <p>Open the file
<code>C:/beehive_projects/pageflow_tutorial/Controller.jpf</code>.
+ [todo: explain]</p>
<p><strong><code>Controller.jpf</code></strong></p>
<source>import javax.servlet.http.HttpSession;
@@ -151,9 +153,10 @@
{
}
}</source>
-
+ <p>Open the file
<code>C:/beehive_projects/pageflow_tutorial/index.jsp</code>.
+ [todo: explain]</p>
<p><strong><code>index.jsp</code></strong></p>
- <source><%@ page language="java"
contentType="text/html;charset=UTF-8"%>
+<source><%@ 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"%>
@@ -172,12 +175,12 @@
<!--<p>[todo: what is this code doing?]</p>-->
</section>
- <section>
+ <section id="compile_2">
<title>To Compile and Deploy the Page Flow</title>
<p>You are now ready to compile the Page Flow and deploy it to
Tomcat.</p>
<p>At the command prompt, enter:</p>
<source>ant
- -f <BeehiveRoot>\ant\buildWebapp.xml
+ -f %BEEHIVE_HOME%\ant\buildWebapp.xml
-Dwebapp.dir=C:\beehive_projects\pageflow_tutorial
build</source>
<p>To deploy the web application, click the following link. We
recommend that you open the
@@ -191,7 +194,7 @@
see the Tomcat 5 documentation:
<a class="fork"
href="http://jakarta.apache.org/tomcat/tomcat-5.0-doc/manager-howto.html#Deploy%20A%20New%20Application%20from%20a%20Local%20Path";>Deploy
A New Application from a Local Path</a>)</p>
</section>
- <section>
+ <section id="test_2">
<title>To Test the Page Flow Web Application</title>
<p>Visit the following address:</p>
<p><a class="fork"
href="http://localhost:8080/pageflow_tutorial";>http://localhost:8080/pageflow_tutorial</a></p>
@@ -200,7 +203,7 @@
</section>
<section id="step_3_nav">
<title>Step 3: Navigation</title>
- <section>
+ <section id="create_dest_JSP">
<title>To Create a Destination JSP Page</title>
<p>In the directory
<code>C:/beehive_projects/pageflow_tutorial</code>, create a file named
<code>page2.jsp</code>.</p>
<p>Edit page2.jsp so it appears as follows.</p>
@@ -218,9 +221,9 @@
</p>
</netui:body>
</netui:html>]]></source>
- <p>Save and close <code>page2.jsp</code>.</p>
+ <p>Save <code>page2.jsp</code>.</p>
</section>
- <section>
+ <section id="create_link">
<title>To Create a Link to the Destination Page</title>
<p>Open the file
<code>C:/beehive_projects/pageflow_tutorial/index.jsp</code>.</p>
<p>Edit <code>index.jsp</code> so it appears as follows. Code
to add appears in bold type.</p>
@@ -244,8 +247,9 @@
</netui:body>
</netui:html>
</source>
+ <p>Save <code>index.jsp</code>.</p>
</section>
- <section>
+ <section id="add_simple_action">
<title>To Add a Simple Action to Handle the Link</title>
<p>Open the file
<code>C:/beehive_projects/pageflow_tutorial/Controller.jpf</code>.</p>
<p>Edit <code>Controller.jpf</code> so it appears as follows.
Don't forget
@@ -272,11 +276,12 @@
...
}</source>
</section>
- <section>
+ <p>Save <code>Controller.jpf</code>.</p>
+ <section id="compile_3">
<title>To Compile and Redeploy the Page Flow</title>
<p>At the command prompt, enter:</p>
<source>ant
- -f <BeehiveRoot>\ant\buildWebapp.xml
+ -f %BEEHIVE_HOME%\ant\buildWebapp.xml
-Dwebapp.dir=C:\beehive_projects\pageflow_tutorial
build</source>
<p>To deploy the web application, click the following link. (Or, if you
have the link below
@@ -284,7 +289,7 @@
<p class="quote">
<a class="fork"
href="http://localhost:8080/manager/deploy?path=/pageflow_tutorial&war=file:C:/beehive_projects/pageflow_tutorial&update=true";>http://localhost:8080/manager/deploy?path=/pageflow_tutorial&war=file:C:/pageflow_projects/control_tutorial&update=true</a>
</p></section>
- <section>
+ <section id="test_3">
<title>To Test the Page Flow Web Application</title>
<p>Visit the following link:
</p>
@@ -296,7 +301,7 @@
</section>
<section id="step_4_forms">
<title>Step 4: Submitting Data</title>
- <section>
+ <section id="create_form">
<title>To Create a Submission Form</title>
<p>Edit the file
<code>C:/beehive_projects/pageflow_tutorial/page2.jsp</code> so it appears as
follows.</p>
<p><strong><code>page2.jsp</code></strong></p>
@@ -320,14 +325,13 @@
</p></strong>
</netui:body>
</netui:html></source>
-<p>Save and close <code>page2.jsp</code>.</p>
+<p>Save <code>page2.jsp</code>.</p>
</section>
-
- <section>
- <title>To Create a Server Side Representation of the
Submission Form</title>
+ <section id="create_formbean">
+ <title>To Create a Server Side Representation of the
Submission Form (a.k.a. Create a Form Bean)</title>
<p>In this step you will create a Java class that represents
the submission form created in the previous task. When the form data is
submitted, the Java class will be instantiated, and the form data will be
loaded into the members of the Java class.</p>
- <p>In the directory
<code>C:/beehive_projects/pageflow_tutorial/WEB-INF/src</code> create a
directory named <code>forms</code>.</p>
- <p>In the directory
<code>C:/beehive_projects/pageflow_tutorial/WEB-INF/src/forms</code> create a
JAVA file named <code>ProfileForm.java</code>.</p>
+ <p>In the directory
<code>C:/beehive_projects/pageflow_tutorial/WEB-INF/src</code> create a
directory named <strong><code>forms</code></strong>.</p>
+ <p>In the directory
<code>C:/beehive_projects/pageflow_tutorial/WEB-INF/src/forms</code> create a
JAVA file named <strong><code>ProfileForm.java</code></strong>.</p>
<p>Edit
<code>C:/beehive_projects/pageflow_tutorial/WEB-INF/src/forms/ProfileForm.java</code>
so it appears as follows.</p>
<p><strong><code>ProfileForm.java</code></strong></p>
@@ -360,7 +364,7 @@
}</source>
<p>Save and close <code>ProfileForm.java</code>.</p>
</section>
- <section>
+ <section id="edit_4">
<title>To Edit the Controller File to Handle the Submitted
Data</title>
<p>Open the file
<code>C:/beehive_projects/pageflow_tutorial/Controller.jpf</code>
</p>
@@ -372,7 +376,7 @@
import org.apache.beehive.netui.pageflow.Forward;
import org.apache.beehive.netui.pageflow.PageFlowController;
import org.apache.beehive.netui.pageflow.annotations.Jpf;
-import forms.ProfileForm;
+<strong>import forms.ProfileForm;</strong>
@Jpf.Controller(
simpleActions={
@@ -416,13 +420,13 @@
}
}</source>
<!--<p>[TODO: what is this code doing?]</p>-->
- <p>Save and close <code>Controller.jpf</code>.</p>
+ <p>Save <code>Controller.jpf</code>.</p>
</section>
<section id="compile_redeploy">
<title>To Compile and Redeploy the Page Flow</title>
<p>At the command prompt, enter:</p>
<source>ant
- -f <BeehiveRoot>\ant\buildWebapp.xml
+ -f %BEEHIVE_HOME%\ant\buildWebapp.xml
-Dwebapp.dir=C:\beehive_projects\pageflow_tutorial
build</source>
<p>To deploy the web application, click the following link. (Or, if you
have the link below
@@ -447,7 +451,7 @@
<section id="create_jsp">
<title>To Create a JSP Page to Display Submitted Data</title>
<p>In the directory <code>C:/pageflow_tutorial</code> Create a
file named
- <code>displayData.jsp</code>. </p>
+
<strong><code>displayData.jsp</code></strong>. </p>
<p>Edit <code>displayData.jsp</code> so it
appears as follows.</p>
<p><strong><code>displayData.jsp</code></strong></p>
@@ -468,10 +472,12 @@
</p>
</netui:body>
</netui:html>]]></source>
+ <p>Save and close <code>displayData.jsp</code>.</p>
</section>
<section id="process_data">
<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 bold.</p>
+ <p>Edit the <code>processData</code> method in the
<code>Controller.jpf</code> file so it appears as
+ follows. Code to add appears in
bold.</p>
<p><strong><code>Controller.jpf</code></strong></p>
<source> ...
@@ -490,12 +496,13 @@
}
...</source>
+ <p>Save <code>Controller.jpf</code>.</p>
</section>
<section>
<title>To Compile and Redeploy the Page Flow</title>
<p>At the command prompt, enter:</p>
<source>ant
- -f <BeehiveRoot>\ant\buildWebapp.xml
+ -f %BEEHIVE_HOME%\ant\buildWebapp.xml
-Dwebapp.dir=C:\beehive_projects\pageflow_tutorial
build</source>
<p>To deploy the web application, click the following link. (Or, if you
have the link below
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=154084&r2=154085
==============================================================================
---
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/setup.xml
(original)
+++
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/setup.xml
Wed Feb 16 13:52:56 2005
@@ -19,15 +19,21 @@
<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>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>
<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>
<p>(2) Make sure that the following environmental variables are
set in your shell.</p>
<ul>
- <li><code>JAVA_HOME</code></li>
+ <li><code>BEEHIVE_HOME</code></li>
<li><code>ANT_HOME</code></li>
+ <li><code>JAVA_HOME</code></li>
</ul>
- <p> (Note: there is no
<code>BEEHIVE_HOME</code> environmental variable to set.)</p>
+ <p>Typical values for these variables would be as
follows.</p>
+ <source>BEEHIVE_HOME =
C:\apache\apache-beehive-incubating-svn-snapshot
+
+ANT_HOME = C:\apache\apache-ant-1.6.2
+
+JAVA_HOME = C:\jdk1.5.0</source>
<p>(3) Finally, ensure that <code>JAVA_HOME/bin</code>
and <code>ANT_HOME/bin</code> are on your <code>PATH</code>.</p>
<p>That's it! That's all you need to begin developing
Beehive
applications. The remaining steps are
only necessary if you
Modified:
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/wsm/sample_wsm-blank.xml
URL:
http://svn.apache.org/viewcvs/incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/wsm/sample_wsm-blank.xml?view=diff&r1=154084&r2=154085
==============================================================================
---
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/wsm/sample_wsm-blank.xml
(original)
+++
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/wsm/sample_wsm-blank.xml
Wed Feb 16 13:52:56 2005
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.2//EN"
"http://forrest.apache.org/dtd/document-v13.dtd";>
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN"
"http://forrest.apache.org/dtd/document-v20.dtd";>
<document>
<header>
<title>Web Service Project Sample Template</title>
@@ -7,48 +7,62 @@
<body>
<section id="intro">
<title>Introduction</title>
-<p>Use the "blank" web service sample (located at
<code>BEEHIVE_HOME/samples/wsm-blank</code>) as a template for building your
own web service applications.
+<p>Use the "blank" web service sample (located at
<code><BeehiveRoot>/samples/wsm-blank</code>)
+ as a template for building your own web service applications.
</p>
-<p>The sample contains everything needed in a basic web service application,
except for the runtime JAR files.
+<p>The template contains everything needed in a basic web service application,
except for the runtime JAR files.
</p>
</section>
- <section>
- <title>Using the Web Service Template</title>
- <p>The following instruction assume that you have completed the basic
Beehive set up procedure at <fork href="../setup.html">Set Up the Dev
Environment</fork>.</p>
- <p>To use the template, (1) copy the contents of
<code>BEEHIVE_HOME/samples/wsm-blank</code> into your project folder, and (2)
copy the runtime JARs to the project's WEB-INF/lib directory.
-It is important to copy the <em>contents</em> of <code>wsm-blank</code> into
your project folder, not the folder <code>wsm-blank</code> itself. After you
have copied the contents of <code>wsm-blank</code> into your project folder,
the following directory structure should exist:</p>
-<source><Project-Folder>
- WEB-INF
- happyaxis.jsp
- index.html</source>
-<p> The following Ant command will copy the necessary runtime JARs to
<code><Project-Folder>/WEB-INF/lib</code>, where
<code><Project-Folder></code> is the path to your web service project
folder: </p>
-<source> ant
- -f %BEEHIVE_HOME%\ant\buildWebapp.xml
- -Dwebapp.dir=<Project-Folder>
- deploy.wsm.webapp.runtime</source>
- <p>To build and run the template, run the following Ant command. (Before
running ensure that Tomcat is turned on:
<code>%CATALINA_HOME%\bin\startup.bat</code>. Or use the Ant command provided
in the distribution: <code>ant -f %BEEHIVE_HOME%\ant\buildWebapp.xml
start</code>. If you use the provided Ant command, you will have to press
<code>Ctrl+C</code> to continue issuing commands in that command window.)</p>
-<source> ant
- -f %BEEHIVE_HOME%\ant\buildWebapp.xml
- -Dwebapp.dir=<Project-Folder>
- -Dcontext.path=HelloWorldWS
- build.webapp
- deploy</source>
-<p>If the HelloWorldWS web service is already deployed, use the redeploy
target:</p>
-<source> ant
- -f %BEEHIVE_HOME%\ant\buildWebapp.xml
- -Dwebapp.dir=<Project-Folder>
- -Dcontext.path=HelloWorldWS
- build.webapp
- redeploy</source>
-<p>You can now try out the HelloWorldWS web service by pointing your browser
at the following links.</p>
- <ul>
- <li>Start Page: <fork
href="http://localhost:8080/HelloWorldWS/";>http://localhost:8080/HelloWorldWS/</fork></li>
- <li>WSDL: <fork
href="http://localhost:8080/HelloWorldWS/template/Blank.jws?wsdl";>http://localhost:8080/HelloWorldWS/template/Blank.jws?wsdl</fork></li>
- <li>Invoke the sayHelloWorld() method in Blank.java: <fork
href="http://localhost:8080/HelloWorldWS/template/Blank.jws?method=sayHelloWorld";>http://localhost:8080/HelloWorldWS/template/Blank.jws?method=sayHelloWorld</fork></li>
-</ul>
- <!--<source>
+ <section>
+ <title>Using the Web Service Template</title>
+ <p>The following instruction assume that you have completed the
basic
+ Beehive set up procedure at <a class="fork"
+ href="site:setup">Beehive Installation and
Setup</a>.</p>
+ <p>To use the template, (1) copy the contents of
+ <code>BEEHIVE_HOME/samples/wsm-blank</code> into your
project
+ folder, and (2) copy the runtime JARs to the project's
WEB-INF/lib
+ directory. It is important to copy the
<em>contents</em> of
+ <code>wsm-blank</code> into your project folder, not
the folder
+ <code>wsm-blank</code> itself. After you have copied
the contents
+ of <code>wsm-blank</code> into your project folder, the
following
+ directory structure should exist:</p>
+ <source><Project-Folder> WEB-INF happyaxis.jsp
index.html</source>
+ <p> The following Ant command will copy the necessary runtime
JARs to
+ <code><Project-Folder>/WEB-INF/lib</code>, where
+ <code><Project-Folder></code> is the path to your
web service
+ project folder: </p>
+ <source> ant -f %BEEHIVE_HOME%\ant\buildWebapp.xml
+ -Dwebapp.dir=<Project-Folder>
deploy.wsm.webapp.runtime</source>
+ <p>To build and run the template, run the following Ant
command.
+ (Before running ensure that Tomcat is turned on:
+ <code>%CATALINA_HOME%\bin\startup.bat</code>. Or use
the Ant
+ command provided in the distribution: <code>ant -f
+ %BEEHIVE_HOME%\ant\buildWebapp.xml start</code>. If you
use the
+ provided Ant command, you will have to press
<code>Ctrl+C</code> to
+ continue issuing commands in that command window.)</p>
+ <source> ant -f %BEEHIVE_HOME%\ant\buildWebapp.xml
+ -Dwebapp.dir=<Project-Folder>
-Dcontext.path=HelloWorldWS
+ build.webapp deploy</source>
+ <p>If the HelloWorldWS web service is already deployed, use the
+ redeploy target:</p>
+ <source> ant -f %BEEHIVE_HOME%\ant\buildWebapp.xml
+ -Dwebapp.dir=<Project-Folder>
-Dcontext.path=HelloWorldWS
+ build.webapp redeploy</source>
+ <p>You can now try out the HelloWorldWS web service by pointing
your
+ browser at the following links.</p>
+ <ul>
+ <li>Start Page: <a class="fork"
+
href="http://localhost:8080/HelloWorldWS/";>http://localhost:8080/HelloWorldWS/</a>
+ </li>
+ <li>WSDL: <a class="fork"
+
href="http://localhost:8080/HelloWorldWS/template/Blank.jws?wsdl";>http://localhost:8080/HelloWorldWS/template/Blank.jws?wsdl</a></li>
+ <li>Invoke the sayHelloWorld() method in Blank.java: <a
+ class="fork"
+
href="http://localhost:8080/HelloWorldWS/template/Blank.jws?method=sayHelloWorld";>http://localhost:8080/HelloWorldWS/template/Blank.jws?method=sayHelloWorld</a></li>
+ </ul>
+ <!--<source>
netui-blank
resources
beehive
@@ -66,7 +80,7 @@
netui-validator-rules.xml
web.xml
</source>-->
- </section>
+ </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/>
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=154084&r2=154085
==============================================================================
---
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 Feb 16 13:52:56 2005
@@ -19,7 +19,7 @@
</section>
<section id="step1">
<title>Step 1: Begin the Web Service Tutorial</title>
- <section>
+ <section id="set_up">
<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>
@@ -28,6 +28,7 @@
throughout this tutorial.</p>
<p>Before proceding, confirm that you have the
following variables set in your shell:</p>
<ul>
+
<li><code>BEEHIVE_HOME</code></li>
<li><code>ANT_HOME</code></li>
<li><code>JAVA_HOME</code></li>
<li><code>CATALINA_HOME</code></li>
@@ -38,7 +39,7 @@
<li><code>JAVA_HOME/bin</code></li>
</ul>
</section>
- <section>
+ <section id="start_tomcat">
<title>To Start the Tomcat Server</title>
<p>At the command prompt, enter:</p>
<source>%CATALINA_HOME%\bin\startup.bat</source>
@@ -50,12 +51,11 @@
<title>Introduction</title>
<p>[todo]</p>
</section>-->
- <section>
- <title>Make a Project Folder Using the Web Service Application
Template</title>
+ <section id="make_project">
+ <title>To Make a Project Folder Using the Web Service
Application Template</title>
<p>On your C: drive, create a directory called
<code>beehive_projects</code>.</p>
- <p>Copy the folder
<code><BeehiveRoot>/samples/</code><strong><code>wsm-blank</code></strong>
- into
<code>C:/</code><strong><code>beehive_projects</code></strong>.
(<code><BeehiveRoot></code> refers to the
- top level folder of your Beehive
installation.)</p>
+ <p>Copy the folder
<code>BEEHIVE_HOME/samples/</code><strong><code>wsm-blank</code></strong>
+ into
<code>C:/</code><strong><code>beehive_projects</code></strong>.</p>
<p>Rename the folder
<code>C:/beehive_projects/</code><strong><code>wsm-blank</code></strong>
as
<code>C:/beehive_projects/</code><strong><code>ws_tutorial</code></strong></p>
<p>Before proceeding, confirm that the following directory
structure exists:</p>
@@ -66,23 +66,24 @@
happyaxis.jsp
index.html</source>
</section>
- <section>
+ <section id="copy_JARs">
<title>To Copy Runtime JARs into the Project Folder</title>
- <p>At the command prompt, enter the following ant command. In place of
<code><BeehiveRoot>
- substitute the path to the top-level directory of your Beehive
installation</code>.</p>
+ <p>At the command prompt, enter the following ant command.</p>
<source>ant
- -f <BeehiveRoot>\ant\webappRuntimeCore.xml
+ -f %BEEHIVE_HOME%\ant\webappRuntimeCore.xml
-Dwebapp.dir=C:\beehive_projects\ws_tutorial
- deploy.beehive.webapp.runtime</source>
+ deploy.wsm.webapp.runtime</source>
</section>
- <section>
- <title>Examine the Blank.jws Web Service</title>
+ <section id="examine_JWS">
+ <title>To Examine the Blank.jws Web Service</title>
<p>You are now ready to compile and run the template web
service already included
- in the project folder.</p>
- <p>Before proceeding, lets examine the web service code. In a
text editor of your choice,
- open the file
<code>C:/beehive_projects/ws_tutorial/WEB-INF/src/template/Blank.jws</code>.
- The file extension 'JWS' stands for
Java Web Service. It is important to note that
- the file <code>Blank.jws</code> is a
plain old JAVA source file--nothing more, nothing less.
+ in the project folder--but before we
run the web service, let's first look at the code.</p>
+ <p>In a text editor of your choice,
+ open the file
<code>C:/beehive_projects/ws_tutorial/WEB-INF/src/web/Blank.jws</code>.
+ </p>
+ <p>The file extension
<strong><code>.jws</code></strong> stands for Java Web Service. It is
important to note that
+ the file <code>Blank.jws</code> is a
plain old JAVA source file--nothing more, nothing
+ less.
If your were to
rename
<code>Blank.</code><strong><em><code>jws</code></em></strong> to
<code>Blank.</code><strong><em><code>java</code></em></strong>,
@@ -91,24 +92,21 @@
extension purely as a mnemonic device
to help the developer remember what this file is:
a <strong>J</strong>ava
<strong>W</strong>eb <strong>S</strong>ervice file.</p>
<p>The code looks like this:</p>
- <source><![CDATA[package template;
+ <source>package web;
...
import javax.jws.WebMethod;
import javax.jws.WebParam;
import javax.jws.WebService;
-import javax.xml.rpc.holders.StringHolder;
-
[EMAIL PROTECTED]
+<strong>@WebService</strong>
public class Blank
{
- @WebMethod
- public String sayHelloWorld(@WebParam(name = "i", mode =
WebParam.Mode.OUT) StringHolder i)
+ <strong>@WebMethod</strong>
+ public String
sayHelloWorld(<strong>@WebParam</strong>(name="name",header=true) String s)
{
- i.value = "Beehive";
- return "Hello world!";
+ return "Hello world, " + s + "!";
}
-}]]></source>
+}</source>
<p>If you are familiar with Java code, everything probably looks familiar to
you,
although these two elements may be new:</p>
<source>
@@ -126,16 +124,14 @@
<p><code>@WebMethod</code> annotates the method
sayHelloWorld(): this tells the runtime that the
method can be invoked over the web.</p>
<p><code>@WebParam</code> tells the runtime that the
<code>sayHelloWorld()</code> method
- accepts a parameter. (Note that the parameter is only
an OUT parameter. We will
- add an IN parameter, and explain the difference between
OUT and IN parameters, in a future step.)</p>
+ accepts a parameter. (Note that the parameter is only an OUT
parameter. We will
+ add an IN parameter, and explain the difference between OUT and
IN parameters, in a future step.)</p>
</section>
- <section>
- <title>Compile and Deploy the Web Service</title>
+ <section id="compile_2">
+ <title>To Compile and Deploy the Web Service</title>
<p>In this step you will compile the web service and deploy it
to Tomcat.</p>
- <p>At the command prompt, enter the following Ant command.
In place of <code><BeehiveRoot></code>
- substitute the path to the top-level directory of your Beehive
installation.</p>
<source>ant
- -f <BeehiveRoot>\ant\buildWebapp.xml
+ -f %BEEHIVE_HOME%\ant\buildWebapp.xml
-Dwebapp.dir=C:\beehive_projects\ws_tutorial
build</source>
<p>To deploy the web service, click the following link.
@@ -152,7 +148,7 @@
see the Tomcat 5 documentation:
<a class="fork"
href="http://jakarta.apache.org/tomcat/tomcat-5.0-doc/manager-howto.html#Deploy%20A%20New%20Application%20from%20a%20Local%20Path";>Deploy
A New Application from a Local Path</a>)</p>
</section>
- <section>
+ <section id="run_2">
<title>To Run the Web Service</title>
<p>Visit the index.jsp page: <a class="fork"
href="http://localhost:8080/ws_tutorial/index.html";>http://localhost:8080/ws_tutorial/index.html</a>.</p>
<p>Click the "Validate" link for an evaluation of the
resources available to your web service. Note that you will need to download
additional resources to take full advantage of Beehive web services. For
example, for Axis to work properly with SOAP attachments, additional, external
jars (activation.jar and mailapi.jar) are required. You will download those
resources in later steps in the tutorial.</p>
@@ -164,26 +160,23 @@
<title>Step 3: Add a Parameterized Method to the Web
Service</title>
<p>In this step you will add a new method to the web
service: a method that
accepts in 'IN' parameter.</p>
- <section>
- <title>Edit the JWS File</title>
+ <section id="edit_3">
+ <title>To Edit the JWS File</title>
<p/>
- <p>Edit the file
<code>C:/beehive_projects/ws_tutorial/WEB-INF/src/template/Blank.jws</code> so
it appears as follows. Code to add appears in bold type.</p>
- <source>package template;
+ <p>Edit the file
<code>C:/beehive_projects/ws_tutorial/WEB-INF/src/web/Blank.jws</code> so it
appears as follows. Code to add appears in bold type.</p>
+<source>package web;
...
import javax.jws.WebMethod;
import javax.jws.WebParam;
import javax.jws.WebService;
-import javax.xml.rpc.holders.StringHolder;
-
@WebService
public class Blank
{
@WebMethod
- public String sayHelloWorld(@WebParam(name = "i", mode =
WebParam.Mode.OUT) StringHolder i)
+ public String sayHelloWorld(@WebParam(name="name",header=true) String s)
{
- i.value = "Beehive";
- return "Hello world!";
+ return "Hello world, " + s + "!";
}
<strong>@WebMethod
@@ -197,12 +190,11 @@
}</source>
<p>The <code>@WebParam</code> you just added lets you pass a String parameter
to the method over the web.</p>
</section>
- <section>
- <title>Compile and Redeploy the Web Service</title>
- <p>At the command prompt, enter the following Ant command.
In place of <code><BeehiveRoot></code>
- substitute the path to the top-level directory of your Beehive
installation.</p>
+ <section id="compile_3">
+ <title>To Compile and Redeploy the Web Service</title>
+ <p>At the command prompt, enter the following Ant command.</p>
<source>ant
- -f <BeehiveRoot>\ant\buildWebapp.xml
+ -f %BEEHIVE_HOME%\ant\buildWebapp.xml
-Dwebapp.dir=C:\beehive_projects\ws_tutorial
build</source>
<p>To redeploy the web service, click the following link.
@@ -212,10 +204,10 @@
<a class="fork"
href="http://localhost:8080/manager/deploy?path=/ws_tutorial&war=file:C:/beehive_projects/ws_tutorial&update=true";>http://localhost:8080/manager/deploy?path=/ws_tutorial&war=file:C:/beehive_projects/ws_tutorial&update=true</a>
</p>
</section>
- <section>
- <title>Test the Parameterized Method</title>
+ <section id="test_3">
+ <title>To Test the Parameterized Method</title>
<p>Enter the following URL in the address bar of your browser.
</p>
- <p><a class="fork"
href="http://localhost:8080/ws_tutorial/template/Blank.jws?method=sayHelloWorldInParam&greetee=Moon";>http://localhost:8080/ws_tutorial/template/Blank.jws?method=sayHelloWorldInParam&greetee=Moon</a></p>
+ <p><a class="fork"
href="http://localhost:8080/ws_tutorial/web/Blank.jws?method=sayHelloWorldInParam&greetee=Moon";>http://localhost:8080/ws_tutorial/web/Blank.jws?method=sayHelloWorldInParam&greetee=Moon</a></p>
<p>The following SOAP response appears in the browser:</p>
<source><![CDATA[<soapenv:Envelope>
<soapenv:Body>
@@ -229,25 +221,22 @@
</section>
<section id="step_4">
<title>Step 4: Add a Non-Web Invokable Method</title>
- <p>Edit the file
<code>C:/beehive_projects/ws_tutorial/WEB-INF/src/template/Blank.jws</code> so
it appears as follows. Code to add appears in bold type.</p>
- <source>package template;
+ <section id="edit_4"><title>To Edit the JWS File</title>
+ <p>Edit the file
<code>C:/beehive_projects/ws_tutorial/WEB-INF/src/web/Blank.jws</code> so it
appears as follows. Code to add appears in bold type.</p>
+<source>package web;
...
import javax.jws.WebMethod;
import javax.jws.WebParam;
import javax.jws.WebService;
-import javax.xml.rpc.holders.StringHolder;
-
@WebService
public class Blank
{
@WebMethod
- public String sayHelloWorld(@WebParam(name = "i", mode =
WebParam.Mode.OUT) StringHolder i)
+ public String sayHelloWorld(@WebParam(name="name",header=true) String s)
{
- i.value = "Beehive";
- return "Hello world!";
+ return "Hello world, " + s + "!";
}
-
@WebMethod
public String sayHelloWorldInParam( @WebParam String greetee )
@@ -256,20 +245,21 @@
{ greetee = "World"; }
return "Hello, " + greetee + "!";
- }
+ }
<strong>public String sayNothingOverTheWeb()
{
return "Not for for Web consumption!";
}</strong>
-}</source>
+}
+</source>
<p>Note that the method added, sayNothingOverTheWeb(), does not
have the annotation @WebMethod, indicating that it cannot be invoked by SOAP
messages over the web.</p>
- <section>
- <title>Compile and Redeploy the Web Service</title>
- <p>At the command prompt, enter the following Ant command.
In place of <code><BeehiveRoot></code>
- substitute the path to the top-level directory of your Beehive
installation.</p>
+</section>
+ <section id="compile_4">
+ <title>To Compile and Redeploy the Web Service</title>
+ <p>At the command prompt, enter the following Ant command.</p>
<source>ant
- -f <BeehiveRoot>\ant\buildWebapp.xml
+ -f %BEEHIVE_HOME%\ant\buildWebapp.xml
-Dwebapp.dir=C:\beehive_projects\ws_tutorial
build</source>
<p>To redeploy the web service, click the following link.
@@ -279,10 +269,10 @@
<a class="fork"
href="http://localhost:8080/manager/deploy?path=/ws_tutorial&war=file:C:/beehive_projects/ws_tutorial&update=true";>http://localhost:8080/manager/deploy?path=/ws_tutorial&war=file:C:/beehive_projects/ws_tutorial&update=true</a>
</p>
</section>
- <section>
+ <section id="test_4">
<title>To Test the Non-Web Invokable Method</title>
<p>Enter the following URL in the address bar of your browser.
</p>
- <p><a class="fork"
href="http://localhost:8080/ws_tutorial/template/Blank.jws?method=sayNothingOverTheWeb";>http://localhost:8080/ws_tutorial/template/Blank.jws?method=sayNothingOverTheWeb</a></p>
+ <p><a class="fork"
href="http://localhost:8080/ws_tutorial/web/Blank.jws?method=sayNothingOverTheWeb";>http://localhost:8080/ws_tutorial/web/Blank.jws?method=sayNothingOverTheWeb</a></p>
<p>The following SOAP response appears in the browser,
indicating that the method sayNothingOverTheWeb() cannot be invoked through the
web service (although it can be called by other methods within the web
service).</p>
<source><![CDATA[<soapenv:Envelope>
<soapenv:Body>
@@ -297,30 +287,27 @@
</soapenv:Envelope> ]]></source>
</section>
</section>
- <section>
+ <section id="step_5">
<title>Step 5: Change the SOAP Style</title>
+ <section id="edit_5"><title>To Edit the JWS File</title>
<p>The default SOAP style for JSR-181 web services is
DOC-literal. In this step you will change the style to RPC-encoded.</p>
- <p>Edit the file
<code>C:/beehive_projects/ws_tutorial/WEB-INF/src/template/Blank.jws</code> so
it appears as follows. Code to add appears in bold type.</p>
- <source>package template;
+ <p>Edit the file
<code>C:/beehive_projects/ws_tutorial/WEB-INF/src/web/Blank.jws</code> so it
appears as follows. Code to add appears in bold type.</p>
+<source>package web;
...
import javax.jws.WebMethod;
import javax.jws.WebParam;
import javax.jws.WebService;
<strong>import javax.jws.soap.SOAPBinding;</strong>
-import javax.xml.rpc.holders.StringHolder;
-
@WebService
<strong>@SOAPBinding(style = SOAPBinding.Style.RPC, use =
SOAPBinding.Use.ENCODED)</strong>
public class Blank
{
@WebMethod
- public String sayHelloWorld(@WebParam(name = "i", mode =
WebParam.Mode.OUT) StringHolder i)
+ public String sayHelloWorld(@WebParam(name="name",header=true) String s)
{
- i.value = "Beehive";
- return "Hello world!";
+ return "Hello world, " + s + "!";
}
-
@WebMethod
public String sayHelloWorldInParam( @WebParam String greetee )
@@ -334,15 +321,14 @@
public String sayNothingOverTheWeb()
{
return "Not for for Web consumption!";
- }
-}
-</source>
- <section>
- <title>Compile and Redeploy the Web Service</title>
- <p>At the command prompt, enter the following Ant command.
In place of <code><BeehiveRoot></code>
- substitute the path to the top-level directory of your Beehive
installation.</p>
+ }
+}</source>
+</section>
+ <section id="compile_5">
+ <title>To Compile and Redeploy the Web Service</title>
+ <p>At the command prompt, enter the following Ant command.</p>
<source>ant
- -f <BeehiveRoot>\ant\buildWebapp.xml
+ -f %BEEHIVE_HOME%\ant\buildWebapp.xml
-Dwebapp.dir=C:\beehive_projects\ws_tutorial
build</source>
<p>To redeploy the web service, click the following link.
@@ -352,10 +338,10 @@
<a class="fork"
href="http://localhost:8080/manager/deploy?path=/ws_tutorial&war=file:C:/beehive_projects/ws_tutorial&update=true";>http://localhost:8080/manager/deploy?path=/ws_tutorial&war=file:C:/beehive_projects/ws_tutorial&update=true</a>
</p>
</section>
- <section>
+ <section id="test_5">
<title>To Test the SOAP-encoded Style</title>
<p>Enter the following URL in the address bar of your browser.
</p>
- <p><a class="fork"
href="http://localhost:8080/ws_tutorial/template/Blank.jws?method=sayHelloWorldInParam&greetee=Moon";>http://localhost:8080/ws_tutorial/template/Blank.jws?method=sayHelloWorldInParam&greetee=Moon</a></p>
+ <p><a class="fork"
href="http://localhost:8080/ws_tutorial/web/Blank.jws?method=sayHelloWorldInParam&greetee=Moon";>http://localhost:8080/ws_tutorial/web/Blank.jws?method=sayHelloWorldInParam&greetee=Moon</a></p>
<p>The following SOAP response appears in the browser. Compare
the RPC style below with the DOC style above.</p>
<source><![CDATA[<soapenv:Envelope>
<soapenv:Body>
Modified: incubator/beehive/trunk/docs/forrest/src/documentation/skinconf.xml
URL:
http://svn.apache.org/viewcvs/incubator/beehive/trunk/docs/forrest/src/documentation/skinconf.xml?view=diff&r1=154084&r2=154085
==============================================================================
--- incubator/beehive/trunk/docs/forrest/src/documentation/skinconf.xml
(original)
+++ incubator/beehive/trunk/docs/forrest/src/documentation/skinconf.xml Wed Feb
16 13:52:56 2005
@@ -143,6 +143,10 @@
h3 {
font-size: 99%;
}
+ h4 {
+ font-weight: bold;
+ font-size: 99%;
+ }
</extra-css>
<colors>
<!-- These values are used for the generated CSS files. -->
Modified: incubator/beehive/trunk/docs/updating_livesite.txt
URL:
http://svn.apache.org/viewcvs/incubator/beehive/trunk/docs/updating_livesite.txt?view=diff&r1=154084&r2=154085
==============================================================================
--- incubator/beehive/trunk/docs/updating_livesite.txt (original)
+++ incubator/beehive/trunk/docs/updating_livesite.txt Wed Feb 16 13:52:56 2005
@@ -22,8 +22,8 @@
Posting of upcoming release docs is primarily for developer review of the
forthcoming docs.
-Process for Updating the Live Site
-----------------------------------
+Requirements for Updating the Live Site
+---------------------------------------
To update the live site, you must have the following three software
installations:
@@ -42,6 +42,10 @@
files. This insures that there are no permissions problems,
if someone else performs the next site update.
+
+Process for Updating the Live Site
+---------------------------------------
+
In brief, the process for updating the live site goes as follows:
(1) Make a ZIP file of the latest docs on your local machine.
@@ -51,7 +55,7 @@
(1) Make a ZIP file of the latest docs
--------------------------------------
-Run the following Ant command:
+Run the following Ant command (assuming that your shell is pointed at the
'beehive/trunk' directory):
ant -f distribution.xml build.dist.docs build.livesite
@@ -67,13 +71,12 @@
Because it is much easier to manage the URL for the live site, if the ZIP file
has no
URL-determining elements (such as a top-level directory) in it.
-
(2) Upload the ZIP file to the live, remove machine
---------------------------------------------------
cd to
- /beehive/trunk/build/jars/site.zip
+ /beehive/trunk/build/jars/
Run the following commmand:
@@ -90,10 +93,12 @@
Using the SSH client, make a connection to cvs.apache.org.
-cd to
-
- /www/incubator.apache.org/beehive/[target_dir]
+ cd to /www/incubator.apache.org/beehive/[target_dir]
+
+ unzip site.zip
-unzip site.zip
+If the directory already contains content, you will be asked to confirm the
overwrite.
+Note that the overwrite will not delete old content. If there is old content
to be
+deleted, you must manually delete the content before unzipping the new site.
The content is now live.
