Author: steveh
Date: Tue Oct 19 11:45:22 2004
New Revision: 55083
Added:
incubator/beehive/trunk/site/build/site/wsm/sample_AddressBook.html
(contents, props changed)
incubator/beehive/trunk/site/src/documentation/content/xdocs/wsm/sample_AddressBook.xml
(contents, props changed)
Modified:
incubator/beehive/trunk/site/build/site/Controls.html
incubator/beehive/trunk/site/build/site/building.html
incubator/beehive/trunk/site/build/site/contributors.html
incubator/beehive/trunk/site/build/site/controls/tutorial_controls.html
incubator/beehive/trunk/site/build/site/downloads.html
incubator/beehive/trunk/site/build/site/faq.html
incubator/beehive/trunk/site/build/site/index.html
incubator/beehive/trunk/site/build/site/license.html
incubator/beehive/trunk/site/build/site/mailinglists.html
incubator/beehive/trunk/site/build/site/pageflow/tutorial_pageflow.html
incubator/beehive/trunk/site/build/site/reference.html
incubator/beehive/trunk/site/build/site/webservices.html
incubator/beehive/trunk/site/src/documentation/content/xdocs/site.xml
incubator/beehive/trunk/site/src/documentation/content/xdocs/wsm/tutorial_wsm.xml
Log:
Adding instructions for running the wsm sample: AddressBook
Modified: incubator/beehive/trunk/site/build/site/Controls.html
==============================================================================
--- incubator/beehive/trunk/site/build/site/Controls.html (original)
+++ incubator/beehive/trunk/site/build/site/Controls.html Tue Oct 19
11:45:22 2004
@@ -160,6 +160,10 @@
<li>
<a href="webservices.html">Web Services (JSR 181)</a>
</li>
+
+<li>
+<a href="wsm/sample_AddressBook.html">AddressBook Sample</a>
+</li>
</ul>
</li>
Modified: incubator/beehive/trunk/site/build/site/building.html
==============================================================================
--- incubator/beehive/trunk/site/build/site/building.html (original)
+++ incubator/beehive/trunk/site/build/site/building.html Tue Oct 19
11:45:22 2004
@@ -160,6 +160,10 @@
<li>
<a href="webservices.html">Web Services (JSR 181)</a>
</li>
+
+<li>
+<a href="wsm/sample_AddressBook.html">AddressBook Sample</a>
+</li>
</ul>
</li>
Modified: incubator/beehive/trunk/site/build/site/contributors.html
==============================================================================
--- incubator/beehive/trunk/site/build/site/contributors.html (original)
+++ incubator/beehive/trunk/site/build/site/contributors.html Tue Oct 19
11:45:22 2004
@@ -160,6 +160,10 @@
<li>
<a href="webservices.html">Web Services (JSR 181)</a>
</li>
+
+<li>
+<a href="wsm/sample_AddressBook.html">AddressBook Sample</a>
+</li>
</ul>
</li>
Modified:
incubator/beehive/trunk/site/build/site/controls/tutorial_controls.html
==============================================================================
--- incubator/beehive/trunk/site/build/site/controls/tutorial_controls.html
(original)
+++ incubator/beehive/trunk/site/build/site/controls/tutorial_controls.html
Tue Oct 19 11:45:22 2004
@@ -160,6 +160,10 @@
<li>
<a href="../webservices.html">Web Services (JSR 181)</a>
</li>
+
+<li>
+<a href="../wsm/sample_AddressBook.html">AddressBook Sample</a>
+</li>
</ul>
</li>
Modified: incubator/beehive/trunk/site/build/site/downloads.html
==============================================================================
--- incubator/beehive/trunk/site/build/site/downloads.html (original)
+++ incubator/beehive/trunk/site/build/site/downloads.html Tue Oct 19
11:45:22 2004
@@ -160,6 +160,10 @@
<li>
<a href="webservices.html">Web Services (JSR 181)</a>
</li>
+
+<li>
+<a href="wsm/sample_AddressBook.html">AddressBook Sample</a>
+</li>
</ul>
</li>
Modified: incubator/beehive/trunk/site/build/site/faq.html
==============================================================================
--- incubator/beehive/trunk/site/build/site/faq.html (original)
+++ incubator/beehive/trunk/site/build/site/faq.html Tue Oct 19 11:45:22 2004
@@ -160,6 +160,10 @@
<li>
<a href="webservices.html">Web Services (JSR 181)</a>
</li>
+
+<li>
+<a href="wsm/sample_AddressBook.html">AddressBook Sample</a>
+</li>
</ul>
</li>
Modified: incubator/beehive/trunk/site/build/site/index.html
==============================================================================
--- incubator/beehive/trunk/site/build/site/index.html (original)
+++ incubator/beehive/trunk/site/build/site/index.html Tue Oct 19 11:45:22 2004
@@ -160,6 +160,10 @@
<li>
<a href="webservices.html">Web Services (JSR 181)</a>
</li>
+
+<li>
+<a href="wsm/sample_AddressBook.html">AddressBook Sample</a>
+</li>
</ul>
</li>
Modified: incubator/beehive/trunk/site/build/site/license.html
==============================================================================
--- incubator/beehive/trunk/site/build/site/license.html (original)
+++ incubator/beehive/trunk/site/build/site/license.html Tue Oct 19
11:45:22 2004
@@ -160,6 +160,10 @@
<li>
<a href="webservices.html">Web Services (JSR 181)</a>
</li>
+
+<li>
+<a href="wsm/sample_AddressBook.html">AddressBook Sample</a>
+</li>
</ul>
</li>
Modified: incubator/beehive/trunk/site/build/site/mailinglists.html
==============================================================================
--- incubator/beehive/trunk/site/build/site/mailinglists.html (original)
+++ incubator/beehive/trunk/site/build/site/mailinglists.html Tue Oct 19
11:45:22 2004
@@ -160,6 +160,10 @@
<li>
<a href="webservices.html">Web Services (JSR 181)</a>
</li>
+
+<li>
+<a href="wsm/sample_AddressBook.html">AddressBook Sample</a>
+</li>
</ul>
</li>
Modified:
incubator/beehive/trunk/site/build/site/pageflow/tutorial_pageflow.html
==============================================================================
--- incubator/beehive/trunk/site/build/site/pageflow/tutorial_pageflow.html
(original)
+++ incubator/beehive/trunk/site/build/site/pageflow/tutorial_pageflow.html
Tue Oct 19 11:45:22 2004
@@ -160,6 +160,10 @@
<li>
<a href="../webservices.html">Web Services (JSR 181)</a>
</li>
+
+<li>
+<a href="../wsm/sample_AddressBook.html">AddressBook Sample</a>
+</li>
</ul>
</li>
Modified: incubator/beehive/trunk/site/build/site/reference.html
==============================================================================
--- incubator/beehive/trunk/site/build/site/reference.html (original)
+++ incubator/beehive/trunk/site/build/site/reference.html Tue Oct 19
11:45:22 2004
@@ -160,6 +160,10 @@
<li>
<a href="webservices.html">Web Services (JSR 181)</a>
</li>
+
+<li>
+<a href="wsm/sample_AddressBook.html">AddressBook Sample</a>
+</li>
</ul>
</li>
Modified: incubator/beehive/trunk/site/build/site/webservices.html
==============================================================================
--- incubator/beehive/trunk/site/build/site/webservices.html (original)
+++ incubator/beehive/trunk/site/build/site/webservices.html Tue Oct 19
11:45:22 2004
@@ -160,6 +160,10 @@
<li>
<span class="sel"><font color="#ffcc00">Web Services (JSR 181)</font></span>
</li>
+
+<li>
+<a href="wsm/sample_AddressBook.html">AddressBook Sample</a>
+</li>
</ul>
</li>
Added: incubator/beehive/trunk/site/build/site/wsm/sample_AddressBook.html
==============================================================================
--- (empty file)
+++ incubator/beehive/trunk/site/build/site/wsm/sample_AddressBook.html Tue Oct
19 11:45:22 2004
@@ -0,0 +1,398 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html>
+<head>
+<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>Beehive Web Service Samples</title>
+<link type="text/css" href="../skin/page.css" rel="stylesheet">
+</head>
+<body text="#000000" bgcolor="#FFFFFF">
+<!--================= start Navigation Path ==================-->
+<table summary="navigation path" width="100%" border="0" cellpadding="0"
cellspacing="0">
+<tr>
+<td nowrap="nowrap" valign="middle" bgcolor="#CFDCED" height="20"><img
height="1" width="5" alt="" src="../skin/images/spacer.gif"
class="spacer"><!--===== breadcrumb trail (javascript-generated) ====--><font
size="2" face="Arial, Helvetica, Sans-serif"><script
src="../skin/breadcrumbs.js" language="JavaScript"
type="text/javascript"></script></font></td>
+</tr>
+<tr>
+<td bgcolor="#4C6C8F" height="2"><img height="2" width="2" alt=""
src="../skin/images/spacer.gif" class="spacer"></td>
+</tr>
+</table>
+<!--================= end Navigation Path ==================-->
+<!--================= start Banner ==================-->
+<table summary="header with logos" width="100%" border="0" cellpadding="0"
cellspacing="0">
+<tr>
+<!--================= start Group Logo ==================-->
+<td bgcolor="#294563"><a href="http://incubator.apache.org/";><img border="0"
class="logoImage" alt="Apache Incubator"
src="../images/_incubator-logo.gif"></a></td>
+<!--================= end Group Logo ==================-->
+<!--================= start Project Logo ==================--><td width="100%"
align="center" bgcolor="#294563"><a
href="http://incubator.apache.org/beehive";><img border="0" class="logoImage"
alt="Apache Beehive" src="../images/_beehive_logo_wide.gif"></a></td>
+<!--================= end Project Logo ==================-->
+<!--================= start Search ==================--><td valign="top"
rowspan="2" bgcolor="#294563">
+<form target="_blank" action="http://www.google.com/search"; method="get">
+<table summary="search" border="0" cellspacing="0" cellpadding="0"
bgcolor="#4C6C8F">
+<tr>
+<td colspan="3"><img height="10" width="1" alt=""
src="../skin/images/spacer.gif" class="spacer"></td>
+</tr>
+<tr>
+<td><img height="1" width="1" alt="" src="../skin/images/spacer.gif"
class="spacer"></td><td nowrap="nowrap"><input value="incubator.apache.org"
name="sitesearch" type="hidden"><input size="15" name="q" id="query"
type="text"><img height="1" width="5" alt="" src="../skin/images/spacer.gif"
class="spacer"><input name="Search" value="Search" type="submit">
+<br>
+<font face="Arial, Helvetica, Sans-serif" size="2" color="white">
+ the Apache Beehive site
+
+
+ </font></td><td><img height="1" width="1" alt=""
src="../skin/images/spacer.gif" class="spacer"></td>
+</tr>
+<tr>
+<td><img alt="" border="0" height="10" width="9"
src="../skin/images/search-left.gif"></td><td><img height="1" width="1" alt=""
src="../skin/images/spacer.gif" class="spacer"></td><td><img alt="" border="0"
height="10" width="9" src="../skin/images/search-right.gif"></td>
+</tr>
+</table>
+</form>
+</td>
+<!--================= start Search ==================--><td
bgcolor="#294563"><img height="10" width="10" alt=""
src="../skin/images/spacer.gif" class="spacer"></td>
+</tr>
+<tr>
+<td valign="bottom" bgcolor="#294563" colspan="2">
+<!--================= start Tabs ==================-->
+<div class="tab">
+<table summary="tab bar" border="0" cellpadding="0" cellspacing="0">
+<tr>
+<td width="6"><img alt="" height="8" width="6"
src="../skin/images/spacer.gif"></td><td valign="bottom">
+<table summary="selected tab" style="height: 1.8em" border="0" cellpadding="0"
cellspacing="0">
+<tr>
+<td valign="top" width="5" bgcolor="#4C6C8F"><img height="5" width="5" alt=""
src="../skin/images/tabSel-left.gif"></td><td valign="middle"
bgcolor="#4C6C8F"><font color="#ffffff" size="2" face="Arial, Helvetica,
Sans-serif"><b><a class="base-selected"
href="../index.html">Home</a></b></font></td><td valign="top" width="5"
bgcolor="#4C6C8F"><img height="5" width="5" alt=""
src="../skin/images/tabSel-right.gif"></td>
+</tr>
+</table>
+</td>
+</tr>
+</table>
+</div>
+<!--================= end Tabs ==================-->
+</td><td bgcolor="#294563"><img alt="" width="1" height="1"
src="../skin/images/spacer.gif" class="spacer"></td>
+</tr>
+<tr>
+<td bgcolor="#4C6C8F" colspan="4"><img width="1" height="10" alt=""
src="../skin/images/spacer.gif" class="spacer"></td>
+</tr>
+</table>
+<!--================= end Banner ==================-->
+<!--================= start Menu, NavBar, Content ==================-->
+<table summary="page content" bgcolor="#ffffff" width="100%" border="0"
cellpadding="0" cellspacing="0">
+<tr>
+<td valign="top">
+<table summary="menu" border="0" cellspacing="0" cellpadding="0">
+<tr>
+<!--================= start left top NavBar ==================-->
+<td rowspan="3" valign="top">
+<table summary="blue line" border="0" cellpadding="0" cellspacing="0">
+<tr>
+<td bgcolor="#294563"><img width="10" height="1" alt=""
src="../skin/images/spacer.gif" class="spacer"></td>
+</tr>
+<tr>
+<td bgcolor="#CFDCED"><font color="#4C6C8F" size="4" face="Arial, Helvetica,
Sans-serif"> </font></td>
+</tr>
+<tr>
+<td bgcolor="#294563"><img width="10" height="1" alt=""
src="../skin/images/spacer.gif" class="spacer"></td>
+</tr>
+</table>
+</td>
+<!--================= end left top NavBar ==================--><td
bgcolor="#294563"><img width="1" height="1" alt=""
src="../skin/images/spacer.gif" class="spacer"></td><td valign="bottom"
bgcolor="#4C6C8F"><img width="10" height="10" alt=""
src="../skin/images/spacer.gif" class="spacer"></td><td nowrap="nowrap"
valign="top" bgcolor="#4C6C8F">
+<!--================= start Menu items ==================-->
+<div class="menu">
+<ul>
+<li>
+<font color="#CFDCED">Beehive</font>
+<ul>
+
+<li>
+<a href="../index.html">Welcome</a>
+</li>
+
+<li>
+<a href="../license.html">License</a>
+</li>
+
+<li>
+<a href="../downloads.html">Downloads</a>
+</li>
+
+<li>
+<a href="../faq.html">FAQ</a>
+</li>
+
+</ul>
+</li>
+<li>
+<font color="#CFDCED">Documentation</font>
+<ul>
+
+<li>
+<a href="../building.html">Building Beehive</a>
+</li>
+
+<li>
+<font color="#CFDCED">Page Flows</font>
+<ul>
+
+<li>
+<a href="../pageflow/tutorial_pageflow.html">Page Flow Tutorial</a>
+</li>
+
+
+</ul>
+</li>
+
+<li>
+<font color="#CFDCED">Controls</font>
+<ul>
+
+<li>
+<a href="../controls/tutorial_controls.html">Control Tutorial</a>
+</li>
+
+<li>
+<a href="../Controls.html">Control Programming</a>
+</li>
+
+</ul>
+</li>
+
+<li>
+<font color="#CFDCED">Web Services</font>
+<ul>
+
+
+<li>
+<a href="../webservices.html">Web Services (JSR 181)</a>
+</li>
+
+<li>
+<span class="sel"><font color="#ffcc00">AddressBook Sample</font></span>
+</li>
+
+</ul>
+</li>
+
+
+<li>
+<a href="../reference.html">Reference Docs</a>
+</li>
+
+</ul>
+</li>
+<li>
+<font color="#CFDCED">Community</font>
+<ul>
+
+<li>
+<a href="../mailinglists.html">Mailing Lists</a>
+</li>
+
+<li>
+<a href="../contributors.html">Contributors</a>
+</li>
+
+</ul>
+</li>
+</ul>
+</div>
+<!--================= end Menu items ==================-->
+</td><td valign="bottom" bgcolor="#4C6C8F"><img width="10" height="10" alt=""
src="../skin/images/spacer.gif" class="spacer"></td><td bgcolor="#294563"><img
width="1" height="1" alt="" src="../skin/images/spacer.gif" class="spacer"></td>
+</tr>
+<tr>
+<td valign="bottom" align="left" colspan="2" rowspan="2"
bgcolor="#4C6C8F"><img height="10" width="10" border="0" alt=""
src="../skin/images/menu-left.gif"></td><td bgcolor="#4C6C8F"><img height="10"
width="10" alt="" src="../skin/images/spacer.gif" class="spacer"></td><td
valign="bottom" align="right" colspan="2" rowspan="2" bgcolor="#4C6C8F"><img
height="10" width="10" border="0" alt=""
src="../skin/images/menu-right.gif"></td>
+</tr>
+<tr>
+<td height="1" bgcolor="#294563"><img width="1" height="1" alt=""
src="../skin/images/spacer.gif" class="spacer"></td>
+</tr>
+</table>
+</td><td valign="top" width="100%">
+<table summary="content" width="100%" border="0" cellpadding="0"
cellspacing="0">
+<!--================= start middle NavBar ==================-->
+<tr>
+<td colspan="4" bgcolor="#294563"><img width="10" height="1" alt=""
src="../skin/images/spacer.gif" class="spacer"></td>
+</tr>
+<tr>
+<td align="left" width="10" bgcolor="#CFDCED"><img width="10" height="1"
alt="" src="../skin/images/spacer.gif" class="spacer"></td><td align="left"
width="50%" bgcolor="#CFDCED"><font color="#4C6C8F" size="3" face="Arial,
Helvetica, Sans-serif">
+
+
+ </font><img width="10" height="8" alt=""
src="../skin/images/spacer.gif" class="spacer"></td><td align="right"
width="50%" bgcolor="#CFDCED"><font color="#4C6C8F" size="3" face="Arial,
Helvetica, Sans-serif">
+
+
+ </font><img width="10" height="8" alt=""
src="../skin/images/spacer.gif" class="spacer"></td><td width="10"
bgcolor="#CFDCED"><img width="10" height="1" alt=""
src="../skin/images/spacer.gif" class="spacer"></td>
+</tr>
+<tr>
+<td colspan="4" bgcolor="#294563"><img width="10" height="1" alt=""
src="../skin/images/spacer.gif" class="spacer"></td>
+</tr>
+<!--================= end middle NavBar ==================-->
+<!--================= start Content==================-->
+<tr>
+<td align="left" width="10"><img width="10" height="1" alt=""
src="../skin/images/spacer.gif" class="spacer"></td><td colspan="2"
align="left" width="100%">
+<div class="content">
+<table class="title" summary="">
+<tr>
+<td valign="middle">
+<h1>Beehive Web Service Samples</h1>
+</td>
+</tr>
+</table>
+<ul class="minitoc">
+<li>
+<a href="#The+AddressBook+Sample">The AddressBook Sample</a>
+<ul class="minitoc">
+<li>
+<a href="#Requirements+for+Running+the+Sample">Requirements for Running the
Sample</a>
+</li>
+<li>
+<a href="#Setting+up+the+Server">Setting up the Server</a>
+</li>
+<li>
+<a href="#Setting+up+the+Client">Setting up the Client</a>
+</li>
+</ul>
+</li>
+</ul>
+
+<a name="N1000C"></a><a name="The+AddressBook+Sample"></a>
+<h3>The AddressBook Sample</h3>
+<div style="margin-left: 0 ; border: 2px">
+<p>The AddressBook sample is an annotation-aware web service based on the
Apache Axis sample of the same name. AddressBook is organized as an application
with POJO (Plain Old Java Objects) models, service interface, service
implementation, and unit tests for the service. The directory structure and ant
build file can be used as a template for building new standalone web
services.</p>
+<p> AddressBook uses Axis's "drop-in" or "instant" deployment model. For more
information on the drop-in deployment model see <a target="_blank"
href="http://ws.apache.org/axis/java/user-
guide.html">http://ws.apache.org/axis/java/user-guide.html</a>
+
+</p>
+<p>The AddressBook sample source code is located at <span
class="codefrag">BEEHIVE_HOME/wsm/samples/dropInDeployment/AddressBook</span>.
The source code is divided into two parts: code that runs on the server (in the
<span class="codefrag">server</span> folder) and code that runs on the client
(in the <span class="codefrag">client</span> folder). The following list
describes the directory structure for the AddressBook sample.</p>
+<pre class="code">
+ AddressBook
+ | -- client
+ | | -- build - Output directory for the build process
+ | | -- lib - JAR resources for the client
+ | | -- src - The client implementation code
+ | -- server
+ | | -- build - Output directory of the build process
+ | | -- src - The web service implementation. Web
Serivce is implemented using JSR 181,
+ with Plain Old Java Objects
(POJO) as the model.
+ | | -- tests - Contains tests for the web service
+ | | -- web - Location of the .jws file that exposes
the web service </pre>
+<a name="N1002D"></a><a name="Requirements+for+Running+the+Sample"></a>
+<h4>Requirements for Running the Sample</h4>
+<div style="margin-left: 0 ; border: 2px">
+<p>You need to have a servlet container, like a Tomcat distribution (the
Tomcat distribution that ships with Beehive is fine), or use an alternative
servlet container.</p>
+</div>
+<a name="N10037"></a><a name="Setting+up+the+Server"></a>
+<h4>Setting up the Server</h4>
+<div style="margin-left: 0 ; border: 2px">
+<ol>
+
+<li>Install AnnotatedAxis</li>
+
+<ul>
+
+<li>Build the Beehive Web
+ Services project: cd to <span
class="codefrag">BEEHIVE_HOME/wsm</span> and run <span class="codefrag">ant
deploy</span>
+
+</li>
+
+<li>Copy the folder <span
class="codefrag">BEEHIVE_HOME/wsm/build/dist/webapps/AnnotatedAxis</span>
+
+ to your server. (For example,
copy the <span class="codefrag">AnnotatedAxis</span> folder to <span
class="codefrag">BEEHIVE_HOME/installed/jakarta-tomcat-5.0.25/webapps</span>.)</li>
+
+<li>Start your server. (For
+ example, <span
class="codefrag">BEEHIVE_HOME/installed/jakarta-tomcat-5.0.25/bin/startup.bat</span>.)</li>
+
+<li>Verify that AnnotatedAxis is
+ installed by visiting: <a
target="_blank"
href="http://localhost:8080/AnnotatedAxis/index.html";>http://localhost:8080/AnnotatedAxis/index.html</a>
+
+</li>
+
+</ul>
+
+<li>Set CATALINA_HOME to be the installed directory of the server. (For
example, <span class="codefrag">set
CATALINA_HOME=C:\beehive-src\trunk\installed\jakarta-tomcat-5.0.25</span>)</li>
+
+<li>Build the AddressBook Sample</li>
+
+<ul>
+
+<li>cd to <span
class="codefrag">BEEHIVE_HOME/wsm/samples/dropInDeployment/AddressBook/server</span>
+
+</li>
+
+<li>run <span class="codefrag">ant build</span>
+
+</li>
+
+</ul>
+
+<li>Deploy the AddressBook sample to the server.</li>
+
+<ul>
+
+<li>To deploy the application run <span class="codefrag">ant deploy</span>.
+ </li>
+
+<li>The <span class="codefrag">deploy</span> target will copy (1) the
application jar AddressBookWS.jar
+and (2) the web service file AddressBookWebService.jws to the AnnotatedAxis
+directory (<span
class="codefrag">CATALINA_HOME/webapps/AnnotatedAxis</span>).</li>
+
+</ul>
+
+<li>Confirm that AddressBook has been deployed to the server.
+ <ul>
+
+<li>Restart your server (if it was running during the deployment).</li>
+
+<li>If deployment was successful, you should be able to see
+ the web service's WSDL at: <a
target="_blank"
href="http://localhost:8080/AnnotatedAxis/AddressBookWebService.jws?wsdl";>http://localhost:8080/AnnotatedAxis/AddressBookWebService.jws?wsdl</a>
+
+</li>
+
+</ul>
+
+</li>
+
+</ol>
+</div>
+<a name="N100A6"></a><a name="Setting+up+the+Client"></a>
+<h4>Setting up the Client</h4>
+<div style="margin-left: 0 ; border: 2px">
+<p>Once the server is up and running, run the client to verify the server
+code is operating properly. The client side uses the Axis WSDL2Java
application to
+generate the client side code and unit test.</p>
+<ol>
+
+<li>cd to <span
class="codefrag">BEEHIVE_HOME/wsm/samples/dropInDeployment/AddressBook/client</span>
+
+</li>
+
+<li>Run <span class="codefrag">ant</span>. You do not need to run any
particular ant target: the default target will be run if you enter "ant" at the
command prompt.</li>
+
+<li>This generates the client code, and runs the Junit test
+that Axis generates for the client. The JUnit test calls to every
+method of the web service. The test can be enhanced to perform
validation.</li>
+
+</ol>
+</div>
+</div>
+
+<div class="attribution"></div>
+</div>
+</td><td width="10"><img width="10" height="1" alt=""
src="../skin/images/spacer.gif" class="spacer"></td>
+</tr>
+<!--================= end Content==================-->
+</table>
+</td>
+</tr>
+</table>
+<!--================= end Menu, NavBar, Content ==================-->
+<!--================= start Footer ==================-->
+<table summary="footer" cellspacing="0" cellpadding="0" width="100%"
border="0">
+<tr>
+<td colspan="2" height="1" bgcolor="#4C6C8F"><img height="1" width="1" alt=""
src="../skin/images/spacer.gif" class="spacer"><a
href="../skin/images/label.gif"></a><a href="../skin/images/page.gif"></a><a
href="../skin/images/chapter.gif"></a><a
href="../skin/images/chapter_open.gif"></a><a
href="../skin/images/current.gif"></a><a href="/favicon.ico"></a></td>
+</tr>
+<tr>
+<td colspan="2" bgcolor="#CFDCED" class="copyright" align="center"><font
size="2" face="Arial, Helvetica, Sans-Serif">Copyright ©
+ 2004 The Apache Software Foundation. All rights
reserved.<script type="text/javascript" language="JavaScript"><!--
+ document.write(" - "+"Last Published: " + document.lastModified);
+ // --></script></font></td>
+</tr>
+<tr>
+<td colspan="2" align="left" bgcolor="#CFDCED" class="logos"></td>
+</tr>
+</table>
+<!--================= end Footer ==================-->
+</body>
+</html>
Modified: incubator/beehive/trunk/site/src/documentation/content/xdocs/site.xml
==============================================================================
--- incubator/beehive/trunk/site/src/documentation/content/xdocs/site.xml
(original)
+++ incubator/beehive/trunk/site/src/documentation/content/xdocs/site.xml
Tue Oct 19 11:45:22 2004
@@ -19,6 +19,7 @@
<wsm label="Web Services">
<!--<tutorial_wsm label="Web Services Tutorial"
href="wsm/tutorial_wsm.html"/>-->
<jsr181 label="Web Services (JSR 181)" href="webservices.html"/>
+ <jsr181 label="AddressBook Sample"
href="wsm/sample_AddressBook.html"/>
</wsm>
<!--<samples label="Samples">
<jpetstore label="JPetStore Samples" href="jpetstore.html"/>
Added:
incubator/beehive/trunk/site/src/documentation/content/xdocs/wsm/sample_AddressBook.xml
==============================================================================
--- (empty file)
+++
incubator/beehive/trunk/site/src/documentation/content/xdocs/wsm/sample_AddressBook.xml
Tue Oct 19 11:45:22 2004
@@ -0,0 +1,94 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.2//EN"
"http://forrest.apache.org/dtd/document-v13.dtd";>
+<document>
+ <header>
+ <title>Beehive Web Service Samples</title>
+ </header>
+ <body>
+ <section>
+ <title>The AddressBook Sample</title>
+ <p>The AddressBook sample is an annotation-aware web service based
on the Apache Axis sample of the same name. AddressBook is organized as an
application with POJO (Plain Old Java Objects) models, service interface,
service implementation, and unit tests for the service. The directory structure
and ant build file can be used as a template for building new standalone web
services.</p>
+ <p> AddressBook uses Axis's "drop-in" or "instant" deployment
model. For more information on the drop-in deployment model see <fork
href="http://ws.apache.org/axis/java/user-
guide.html">http://ws.apache.org/axis/java/user-guide.html</fork>
+ </p>
+ <p>The AddressBook sample source code is located at
<code>BEEHIVE_HOME/wsm/samples/dropInDeployment/AddressBook</code>. The source
code is divided into two parts: code that runs on the server (in the
<code>server</code> folder) and code that runs on the client (in the
<code>client</code> folder). The following list describes the directory
structure for the AddressBook sample.</p>
+ <source><![CDATA[
+ AddressBook
+ | -- client
+ | | -- build - Output directory for the build process
+ | | -- lib - JAR resources for the client
+ | | -- src - The client implementation code
+ | -- server
+ | | -- build - Output directory of the build process
+ | | -- src - The web service implementation. Web
Serivce is implemented using JSR 181,
+ with Plain Old Java Objects
(POJO) as the model.
+ | | -- tests - Contains tests for the web service
+ | | -- web - Location of the .jws file that exposes
the web service ]]></source>
+ <section>
+ <title>Requirements for Running the Sample</title>
+ <p>You need to have a servlet container, like a Tomcat
distribution (the Tomcat distribution that ships with Beehive is fine), or use
an alternative servlet container.</p>
+ </section>
+ <section>
+ <title>Setting up the Server</title>
+ <ol>
+ <li>Install AnnotatedAxis</li>
+ <ul>
+ <li>Build the Beehive Web
+ Services project: cd to
<code>BEEHIVE_HOME/wsm</code> and run <code>ant deploy</code>
+ </li>
+ <li>Copy the folder
<code>BEEHIVE_HOME/wsm/build/dist/webapps/AnnotatedAxis</code>
+
+ to your server. (For example,
copy the <code>AnnotatedAxis</code> folder to
<code>BEEHIVE_HOME/installed/jakarta-tomcat-5.0.25/webapps</code>.)</li>
+ <li>Start your server. (For
+ example,
<code>BEEHIVE_HOME/installed/jakarta-tomcat-5.0.25/bin/startup.bat</code>.)</li>
+ <li>Verify that AnnotatedAxis is
+ installed by visiting: <fork
href="http://localhost:8080/AnnotatedAxis/index.html";>http://localhost:8080/AnnotatedAxis/index.html</fork>
+ </li>
+ </ul>
+ <li>Set CATALINA_HOME to be the installed directory of the
server. (For example, <code>set
CATALINA_HOME=C:\beehive-src\trunk\installed\jakarta-tomcat-5.0.25</code>)</li>
+ <li>Build the AddressBook Sample</li>
+ <ul>
+ <li>cd to
<code>BEEHIVE_HOME/wsm/samples/dropInDeployment/AddressBook/server</code>
+ </li>
+ <li>run <code>ant build</code>
+ </li>
+ </ul>
+ <li>Deploy the AddressBook sample to the server.</li>
+ <ul>
+ <li>To deploy the application run <code>ant
deploy</code>.
+ </li>
+ <li>The <code>deploy</code> target will copy (1) the
application jar AddressBookWS.jar
+and (2) the web service file AddressBookWebService.jws to the AnnotatedAxis
+directory (<code>CATALINA_HOME/webapps/AnnotatedAxis</code>).</li>
+ </ul>
+ <li>Confirm that AddressBook has been deployed to the
server.
+ <ul>
+ <li>Restart your server (if it was running during
the deployment).</li>
+ <li>If deployment was successful, you should be
able to see
+ the web service's WSDL at: <fork
href="http://localhost:8080/AnnotatedAxis/AddressBookWebService.jws?wsdl";>http://localhost:8080/AnnotatedAxis/AddressBookWebService.jws?wsdl</fork>
+ </li>
+ </ul>
+ </li>
+ </ol>
+ </section>
+ <section>
+ <title>Setting up the Client</title>
+ <p>Once the server is up and running, run the client to verify
the server
+code is operating properly. The client side uses the Axis WSDL2Java
application to
+generate the client side code and unit test.</p>
+ <ol>
+ <li>cd to
<code>BEEHIVE_HOME/wsm/samples/dropInDeployment/AddressBook/client</code>
+ </li>
+ <li>Run <code>ant</code>. You do not need to run any
particular ant target: the default target will be run if you enter "ant" at the
command prompt.</li>
+ <li>This generates the client code, and runs the Junit test
+that Axis generates for the client. The JUnit test calls to every
+method of the web service. The test can be enhanced to perform
validation.</li>
+ </ol>
+ </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/>
+ © 2004, Apache Software Foundation
+ </legal>
+ </footer>
+</document>
Modified:
incubator/beehive/trunk/site/src/documentation/content/xdocs/wsm/tutorial_wsm.xml
==============================================================================
---
incubator/beehive/trunk/site/src/documentation/content/xdocs/wsm/tutorial_wsm.xml
(original)
+++
incubator/beehive/trunk/site/src/documentation/content/xdocs/wsm/tutorial_wsm.xml
Tue Oct 19 11:45:22 2004
@@ -2,56 +2,51 @@
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.2//EN"
"http://forrest.apache.org/dtd/document-v13.dtd";>
<document>
<header>
- <title>Beehive Page Flow Tutorial</title>
+ <title>Beehive Web Service Tutorial</title>
</header>
<body>
<section id="intro">
- <title>Introduction To the Page Flow Tutorial</title>
+ <title>Introduction to the Web Service Tutorial</title>
<section>
<title>Tutorial Goals</title>
<p>In this tutorial, you will learn:</p>
<ul>
- <li>How to create a basic Page Flow web
application</li>
- <li>How to coordinate user navigation
with Forward methods</li>
- <li>How to handle data submission and
processing with data binding and Form Beans</li>
- <li>How to create a user interface with
the <neuti> JSP tag library</li>
- <li>How Page Flows help to separate
data processing and data presentation</li>
+ <li>How to create a basic Beehive web
service application.</li>
+ <li>How to use metadata
annotations.</li>
+ <li></li>
+ <li></li>
+ <li></li>
</ul>
</section>
<section>
- <title>Note on the Current State of the Page
Flow Tutorial</title>
- <p>This tutorial is currently a work in
progress. Unfinished portions of the tutorial are marked [tbd], standing for
"to be done". Also the tutorial assumes that you are using a Windows machine,
however, with a little common sense it is very easy to run through the tutorial
on a Linux machine. For example, where the tutorial tells you to run FOO.cmd,
instead run FOO.sh.</p>
- <p>Please send any comments to Steve Hanson,
at <code>[EMAIL PROTECTED]</code>.</p>
+ <title>Note on the Current State of the Web
Service Tutorial</title>
+ <p>This tutorial is currently a work in
progress, and will by changed and amended in the coming weeks. The tutorial
assumes that you are using a Windows machine, however, with a little common
sense it is very easy to run through the tutorial on a Linux machine. For
example, where the tutorial tells you to run FOO.cmd, instead run FOO.sh.</p>
+ <p>Please send any comments to Steve Hanson,
at <code>steveh at bea.com</code>.</p>
</section>
</section>
<section id="step1">
- <title>Step 1: Begin the Page Flow Tutorial</title>
- <section>
- <title/>
- </section>
+ <title>Step 1: Begin the Web Service Tutorial</title>
<section>
<title>Download and Install JDK5</title>
- <p>If you do not have JDK5 installed on your
machine, visit <fork
href="http://java.sun.com/j2se/1.5.0/download.jsp";>http://java.sun.com/j2se/1.5.0/download.jsp</fork>
and download the latest version of JDK5.</p>
- <p>Throughout this tutorial, it is assumed that
you have JDK 5 installed at <code>C:\jdk1.5.0</code></p>
- <p>[tbd: more detailed installation
instructions]</p>
+ <p>If you do not have JDK5 installed on your
machine, visit <fork
href="http://java.sun.com/j2se/1.5.0/download.jsp";>http://java.sun.com/j2se/1.5.0/download.jsp</fork>
and download the latest version.</p>
+ <p>Throughout this tutorial, it is assumed that
you have JDK 5 installed at <code>C:\jdk1.5.0</code>.</p>
+ <p></p>
</section>
<section>
<title>Download and Install SVN (Subversion
Source Control)</title>
<p>Visit <fork
href="http://subversion.tigris.org";>http://subversion.tigris.org</fork> and
install the SVN source control system.</p>
- <p>[tbd: more detailed installation
instructions]</p>
+ <p></p>
</section>
<section>
<title>Download and Install Beehive</title>
<p>
- Create a directory called
<code>beehive-src</code> on your C: drive. Confirm that the the following
directory structure exists: <code>C:/beehive-src</code>. This directory will
store the Beehive source and all of your Beehive projects.
</p>
+ Create a directory called
<code>beehive-src</code> on your C: drive. Confirm that the the following
directory structure exists: <code>C:/beehive-src</code>. This directory will
store the Beehive source and all of your Beehive projects. </p>
<p>Open a command shell.</p>
<p>At the command prompt, enter: <code>cd
beehive-src</code>
</p>
<p>At the command prompt, enter: <code>svn
checkout http://svn.apache.org/repos/asf/incubator/beehive/trunk/</code>
</p>
<p>Wait a few minutes while the Beehive source
is downloaded to your local machine.</p>
- <p>At the command prompt, enter:
<code>exit</code>
- </p>
</section>
<section>
<title>Install ANT</title>
@@ -60,7 +55,7 @@
<p>After the file has unzipped, confirm that
the following directory structure exists:
<code>C:/beehive-src/trunk/installed/apache-ant-1.6.2</code>.</p>
</section>
<section>
- <title>Run the <code>bootstrap</code>
Target</title>
+ <title>Run the <code>bootstrap</code> Target
and Compile the Beehive Source</title>
<p>At the command prompt, enter: <code>set
JAVA_HOME=C:\jdk1.5.0</code>
</p>
<p>At the command prompt, enter: <code>set
BEEHIVE_HOME=C:\beehive-src\trunk</code>
@@ -71,29 +66,30 @@
</p>
<p>At the command prompt, enter: <code>ant
bootstrap</code>
</p>
- <p>At the command prompt, enter:
<code>exit</code>
+ <p>Wait a few minutes while the
<code>bootstrap</code> target completes.
+ </p>
+ <p>At the command prompt, enter: <code>ant
deploy</code>.
+ </p>
+ <p>Wait a few minutes while the
<code>deploy</code> target completes.
+ </p>
+ <p>You are now ready to create a Beehive web
service.
</p>
</section>
</section>
<section id="step_2">
- <title>Step 2: Create a New Page Flow
Application</title>
+ <title>Step 2: Create a New Web Service</title>
<section>
<title>Introduction</title>
- <p>
- In this step you will create a Controller file
and a JSP page. A Controller file is a Java class (with the JPF file extension)
that controls how your web application functions and what it does. The methods
in the Controller file determines all of the major
features of a web application: how users navigate from page to page, how
user requests are handled, and how the web application accesses back-end
resources.
- </p>
- <p>
- Controller files control the features of a web
application through the use of Action methods. An Action method may do
something simple, such as forward a user from one JSP page to another; or it
may do something complex, such as receive
user input from a JSP page, calculate and/or retrieve other data based on the
user input, and forward the user to a JSP page where the results are displayed.
- </p>
- <p>
- The Controller file you create in this step
contains one simple Action method. This simple navigational Action method
forwards users to the index.jsp page. In the next step, you will create a more
complex Action method.
- </p>
+ <p></p>
+ <p> </p>
+ <p> </p>
</section>
<section>
- <title>To Create a Controller File</title>
- <p>In this step you will create the Controller
file in place in the Tomcat deployment directory.</p>
- <p>In the directory
<code>C:/beehive-src/trunk/installed/jakarta-tomcat-5.0.25/webapps</code>,
create a directory called <code>pageflow_tutorial</code>.</p>
- <p>In the directory
<code>C:/beehive-src/trunk/installed/jakarta-tomcat-5.0.25/webapps/pageflow_tutorial</code>,
create a file called <code>Controller.jpf</code>.</p>
+ <title>Set Up Drop In Deployment</title>
+ <p>Copy the folder
C:/beehive-src/trunk/wsm/test/webapps/AnnotatedAxis into the directory
C:/beehive-src/trunk/installed/jakarta-tomcat-5.0.25/webapps.</p>
+ <p>Confirm that the following directory
structure exists:
C:\beehive-src\trunk\installed\jakarta-tomcat-5.0.25\webapps\AnnotatedAxis</p>
+ <p>At the command prompt, enter:
<code>C:\beehive-src\trunk\installed\jakarta-tomcat-5.0.25\bin\startup.bat</code></p>
+ <p>At the command prompt, enter: <code>cd
C:\beehive-src\trunk\wsm\samples\dropInDeployment\AddressBook\server</code></p>
<p>In a text editor (or your IDE of choice),
open the file Controller.jpf.</p>
<p>Edit Controller.jpf so it appears as
follows.</p>
<source><