You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@beehive.apache.org by st...@apache.org on 2004/11/04 05:21:54 UTC
svn commit: rev 56563 - in incubator/beehive/site: build/site build/site/controls build/site/pageflow build/site/wsm src/documentation/content/xdocs src/documentation/content/xdocs/wsm
Author: steveh
Date: Wed Nov 3 20:21:52 2004
New Revision: 56563
Added:
incubator/beehive/site/src/documentation/content/xdocs/wsm/sample_Dashboard.xml (contents, props changed)
Modified:
incubator/beehive/site/build/site/Controls.html
incubator/beehive/site/build/site/contributors.html
incubator/beehive/site/build/site/controls/tutorial_controls.html
incubator/beehive/site/build/site/downloads.html
incubator/beehive/site/build/site/faq.html
incubator/beehive/site/build/site/index.html
incubator/beehive/site/build/site/jpetstore.html
incubator/beehive/site/build/site/license.html
incubator/beehive/site/build/site/mailinglists.html
incubator/beehive/site/build/site/pageflow/guide.html
incubator/beehive/site/build/site/pageflow/tutorial_pageflow.html
incubator/beehive/site/build/site/reference.html
incubator/beehive/site/build/site/webservices.html
incubator/beehive/site/build/site/wsm/sample_AddressBook.html
incubator/beehive/site/build/site/wsm/tutorial_wsm.html
incubator/beehive/site/src/documentation/content/xdocs/site.xml
incubator/beehive/site/src/documentation/content/xdocs/wsm/sample_AddressBook.xml
Log:
Adding instructions for Dashboard, AddressBookWS.
Modified: incubator/beehive/site/build/site/Controls.html
==============================================================================
--- incubator/beehive/site/build/site/Controls.html (original)
+++ incubator/beehive/site/build/site/Controls.html Wed Nov 3 20:21:52 2004
@@ -172,11 +172,15 @@
<ul>
<li>
-<a href="jpetstore.html">Beehive Samples: JPetStore</a>
+<a href="jpetstore.html">Petstore</a>
</li>
<li>
-<a href="wsm/sample_AddressBook.html">WSM Sample: AddressBook</a>
+<a href="wsm/sample_Dashboard.html">Petstore Dashboard</a>
+</li>
+
+<li>
+<a href="wsm/sample_AddressBook.html">AddressBook</a>
</li>
</ul>
Modified: incubator/beehive/site/build/site/contributors.html
==============================================================================
--- incubator/beehive/site/build/site/contributors.html (original)
+++ incubator/beehive/site/build/site/contributors.html Wed Nov 3 20:21:52 2004
@@ -172,11 +172,15 @@
<ul>
<li>
-<a href="jpetstore.html">Beehive Samples: JPetStore</a>
+<a href="jpetstore.html">Petstore</a>
</li>
<li>
-<a href="wsm/sample_AddressBook.html">WSM Sample: AddressBook</a>
+<a href="wsm/sample_Dashboard.html">Petstore Dashboard</a>
+</li>
+
+<li>
+<a href="wsm/sample_AddressBook.html">AddressBook</a>
</li>
</ul>
Modified: incubator/beehive/site/build/site/controls/tutorial_controls.html
==============================================================================
--- incubator/beehive/site/build/site/controls/tutorial_controls.html (original)
+++ incubator/beehive/site/build/site/controls/tutorial_controls.html Wed Nov 3 20:21:52 2004
@@ -172,11 +172,15 @@
<ul>
<li>
-<a href="../jpetstore.html">Beehive Samples: JPetStore</a>
+<a href="../jpetstore.html">Petstore</a>
</li>
<li>
-<a href="../wsm/sample_AddressBook.html">WSM Sample: AddressBook</a>
+<a href="../wsm/sample_Dashboard.html">Petstore Dashboard</a>
+</li>
+
+<li>
+<a href="../wsm/sample_AddressBook.html">AddressBook</a>
</li>
</ul>
Modified: incubator/beehive/site/build/site/downloads.html
==============================================================================
--- incubator/beehive/site/build/site/downloads.html (original)
+++ incubator/beehive/site/build/site/downloads.html Wed Nov 3 20:21:52 2004
@@ -172,11 +172,15 @@
<ul>
<li>
-<a href="jpetstore.html">Beehive Samples: JPetStore</a>
+<a href="jpetstore.html">Petstore</a>
</li>
<li>
-<a href="wsm/sample_AddressBook.html">WSM Sample: AddressBook</a>
+<a href="wsm/sample_Dashboard.html">Petstore Dashboard</a>
+</li>
+
+<li>
+<a href="wsm/sample_AddressBook.html">AddressBook</a>
</li>
</ul>
Modified: incubator/beehive/site/build/site/faq.html
==============================================================================
--- incubator/beehive/site/build/site/faq.html (original)
+++ incubator/beehive/site/build/site/faq.html Wed Nov 3 20:21:52 2004
@@ -172,11 +172,15 @@
<ul>
<li>
-<a href="jpetstore.html">Beehive Samples: JPetStore</a>
+<a href="jpetstore.html">Petstore</a>
</li>
<li>
-<a href="wsm/sample_AddressBook.html">WSM Sample: AddressBook</a>
+<a href="wsm/sample_Dashboard.html">Petstore Dashboard</a>
+</li>
+
+<li>
+<a href="wsm/sample_AddressBook.html">AddressBook</a>
</li>
</ul>
Modified: incubator/beehive/site/build/site/index.html
==============================================================================
--- incubator/beehive/site/build/site/index.html (original)
+++ incubator/beehive/site/build/site/index.html Wed Nov 3 20:21:52 2004
@@ -172,11 +172,15 @@
<ul>
<li>
-<a href="jpetstore.html">Beehive Samples: JPetStore</a>
+<a href="jpetstore.html">Petstore</a>
</li>
<li>
-<a href="wsm/sample_AddressBook.html">WSM Sample: AddressBook</a>
+<a href="wsm/sample_Dashboard.html">Petstore Dashboard</a>
+</li>
+
+<li>
+<a href="wsm/sample_AddressBook.html">AddressBook</a>
</li>
</ul>
@@ -260,20 +264,20 @@
<a href="#Get+Involved">Get Involved</a>
</li>
</ul>
- <!--
- Beehive
- Welcome<should link to the HTML page created from Welcome.doc>
- License<should link to http://www.apache.org/licenses/LICENSE-2.0>
-
- Documentation
- FAQ<should link to the HTML page created from FAQ.doc>
- Controls Overview<should link to Kyle's control Overview>
- Controls Programming<should link to Kyle's Controls programming pdf>
- Web Services (JSR 181)<should link to http://jcp.org/en/jsr/detail?id=181>
-
- Contributing
- Mailing Lists<should link to HTML Page created from MailingLists.doc>
- Contributers<should link to HTML Page created from Contributers.doc>
+ <!--
+ Beehive
+ Welcome<should link to the HTML page created from Welcome.doc>
+ License<should link to http://www.apache.org/licenses/LICENSE-2.0>
+
+ Documentation
+ FAQ<should link to the HTML page created from FAQ.doc>
+ Controls Overview<should link to Kyle's control Overview>
+ Controls Programming<should link to Kyle's Controls programming pdf>
+ Web Services (JSR 181)<should link to http://jcp.org/en/jsr/detail?id=181>
+
+ Contributing
+ Mailing Lists<should link to HTML Page created from MailingLists.doc>
+ Contributers<should link to HTML Page created from Contributers.doc>
-->
Modified: incubator/beehive/site/build/site/jpetstore.html
==============================================================================
--- incubator/beehive/site/build/site/jpetstore.html (original)
+++ incubator/beehive/site/build/site/jpetstore.html Wed Nov 3 20:21:52 2004
@@ -172,11 +172,15 @@
<ul>
<li>
-<span class="sel"><font color="#ffcc00">Beehive Samples: JPetStore</font></span>
+<span class="sel"><font color="#ffcc00">Petstore</font></span>
</li>
<li>
-<a href="wsm/sample_AddressBook.html">WSM Sample: AddressBook</a>
+<a href="wsm/sample_Dashboard.html">Petstore Dashboard</a>
+</li>
+
+<li>
+<a href="wsm/sample_AddressBook.html">AddressBook</a>
</li>
</ul>
Modified: incubator/beehive/site/build/site/license.html
==============================================================================
--- incubator/beehive/site/build/site/license.html (original)
+++ incubator/beehive/site/build/site/license.html Wed Nov 3 20:21:52 2004
@@ -172,11 +172,15 @@
<ul>
<li>
-<a href="jpetstore.html">Beehive Samples: JPetStore</a>
+<a href="jpetstore.html">Petstore</a>
</li>
<li>
-<a href="wsm/sample_AddressBook.html">WSM Sample: AddressBook</a>
+<a href="wsm/sample_Dashboard.html">Petstore Dashboard</a>
+</li>
+
+<li>
+<a href="wsm/sample_AddressBook.html">AddressBook</a>
</li>
</ul>
Modified: incubator/beehive/site/build/site/mailinglists.html
==============================================================================
--- incubator/beehive/site/build/site/mailinglists.html (original)
+++ incubator/beehive/site/build/site/mailinglists.html Wed Nov 3 20:21:52 2004
@@ -172,11 +172,15 @@
<ul>
<li>
-<a href="jpetstore.html">Beehive Samples: JPetStore</a>
+<a href="jpetstore.html">Petstore</a>
</li>
<li>
-<a href="wsm/sample_AddressBook.html">WSM Sample: AddressBook</a>
+<a href="wsm/sample_Dashboard.html">Petstore Dashboard</a>
+</li>
+
+<li>
+<a href="wsm/sample_AddressBook.html">AddressBook</a>
</li>
</ul>
Modified: incubator/beehive/site/build/site/pageflow/guide.html
==============================================================================
--- incubator/beehive/site/build/site/pageflow/guide.html (original)
+++ incubator/beehive/site/build/site/pageflow/guide.html Wed Nov 3 20:21:52 2004
@@ -172,11 +172,15 @@
<ul>
<li>
-<a href="../jpetstore.html">Beehive Samples: JPetStore</a>
+<a href="../jpetstore.html">Petstore</a>
</li>
<li>
-<a href="../wsm/sample_AddressBook.html">WSM Sample: AddressBook</a>
+<a href="../wsm/sample_Dashboard.html">Petstore Dashboard</a>
+</li>
+
+<li>
+<a href="../wsm/sample_AddressBook.html">AddressBook</a>
</li>
</ul>
Modified: incubator/beehive/site/build/site/pageflow/tutorial_pageflow.html
==============================================================================
--- incubator/beehive/site/build/site/pageflow/tutorial_pageflow.html (original)
+++ incubator/beehive/site/build/site/pageflow/tutorial_pageflow.html Wed Nov 3 20:21:52 2004
@@ -172,11 +172,15 @@
<ul>
<li>
-<a href="../jpetstore.html">Beehive Samples: JPetStore</a>
+<a href="../jpetstore.html">Petstore</a>
</li>
<li>
-<a href="../wsm/sample_AddressBook.html">WSM Sample: AddressBook</a>
+<a href="../wsm/sample_Dashboard.html">Petstore Dashboard</a>
+</li>
+
+<li>
+<a href="../wsm/sample_AddressBook.html">AddressBook</a>
</li>
</ul>
Modified: incubator/beehive/site/build/site/reference.html
==============================================================================
--- incubator/beehive/site/build/site/reference.html (original)
+++ incubator/beehive/site/build/site/reference.html Wed Nov 3 20:21:52 2004
@@ -172,11 +172,15 @@
<ul>
<li>
-<a href="jpetstore.html">Beehive Samples: JPetStore</a>
+<a href="jpetstore.html">Petstore</a>
</li>
<li>
-<a href="wsm/sample_AddressBook.html">WSM Sample: AddressBook</a>
+<a href="wsm/sample_Dashboard.html">Petstore Dashboard</a>
+</li>
+
+<li>
+<a href="wsm/sample_AddressBook.html">AddressBook</a>
</li>
</ul>
Modified: incubator/beehive/site/build/site/webservices.html
==============================================================================
--- incubator/beehive/site/build/site/webservices.html (original)
+++ incubator/beehive/site/build/site/webservices.html Wed Nov 3 20:21:52 2004
@@ -172,11 +172,15 @@
<ul>
<li>
-<a href="jpetstore.html">Beehive Samples: JPetStore</a>
+<a href="jpetstore.html">Petstore</a>
</li>
<li>
-<a href="wsm/sample_AddressBook.html">WSM Sample: AddressBook</a>
+<a href="wsm/sample_Dashboard.html">Petstore Dashboard</a>
+</li>
+
+<li>
+<a href="wsm/sample_AddressBook.html">AddressBook</a>
</li>
</ul>
Modified: incubator/beehive/site/build/site/wsm/sample_AddressBook.html
==============================================================================
--- incubator/beehive/site/build/site/wsm/sample_AddressBook.html (original)
+++ incubator/beehive/site/build/site/wsm/sample_AddressBook.html Wed Nov 3 20:21:52 2004
@@ -2,7 +2,7 @@
<html>
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<title>Beehive Web Service Samples</title>
+<title>Beehive AddressBookWS and EmployeeWS Samples</title>
<link type="text/css" href="../skin/page.css" rel="stylesheet">
</head>
<body text="#000000" bgcolor="#FFFFFF">
@@ -172,11 +172,15 @@
<ul>
<li>
-<a href="../jpetstore.html">Beehive Samples: JPetStore</a>
+<a href="../jpetstore.html">Petstore</a>
</li>
<li>
-<span class="sel"><font color="#ffcc00">WSM Sample: AddressBook</font></span>
+<a href="../wsm/sample_Dashboard.html">Petstore Dashboard</a>
+</li>
+
+<li>
+<span class="sel"><font color="#ffcc00">AddressBook</font></span>
</li>
</ul>
@@ -242,146 +246,136 @@
<table class="title" summary="">
<tr>
<td valign="middle">
-<h1>Beehive Web Service Samples</h1>
+<h1>Beehive AddressBookWS and EmployeeWS Samples</h1>
</td>
</tr>
</table>
<ul class="minitoc">
<li>
-<a href="#The+AddressBook+Sample">The AddressBook Sample</a>
+<a href="#The+AddressBookWS+and+EmployeeWS+Samples">The AddressBookWS and EmployeeWS Samples</a>
+</li>
+<li>
+<a href="#Running+the+Samples">Running the Samples</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+Environment">Setting up the Environment</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>
+<a href="#Setting+up+the+Clients">Setting up the Clients</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>
+<a name="N1000C"></a><a name="The+AddressBookWS+and+EmployeeWS+Samples"></a>
+<h3>The AddressBookWS and EmployeeWS Samples</h3>
<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>
+<p>The AddressBookWS sample is an annotation-aware web service based on the Apache Axis sample of the same name. AddressBookWS 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>EmployeeWS [todo]</p>
</div>
-<a name="N10037"></a><a name="Setting+up+the+Server"></a>
-<h4>Setting up the Server</h4>
+
+<a name="N10019"></a><a name="Running+the+Samples"></a>
+<h3>Running the Samples</h3>
<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 Backend Java Types of the AddressBook Sample</li>
-
+<a name="N1001F"></a><a name="Requirements+for+Running+the+Sample"></a>
+<h4>Requirements for Running the Sample</h4>
+<div style="margin-left: 0 ; border: 2px">
+<p>To run the Samples, you need:</p>
<ul>
-
-<li>Note: this step is necessary to build the Java types in /AddressBook/server/src/org/beehive/demo. The web service file itself (AddressBook.jws), does not need to be pre-compiled, because of the Axis drop-in deployment model.</li>
-
-<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>Beehive</li>
-<li>Deploy the AddressBook sample to the server.</li>
+<li>Tomcat 5</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>
+<li>J2SE 5</li>
-</ul>
+<li>Ant 1.6.2</li>
-<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>junit.jar (v3.8.1 or later)</li>
-</li>
+<li>derby.jar (for EmployeeWS only)</li>
-</ol>
+</ul>
</div>
-<a name="N100A9"></a><a name="Setting+up+the+Client"></a>
-<h4>Setting up the Client</h4>
+<a name="N1003E"></a><a name="Setting+up+the+Environment"></a>
+<h4>Setting up the Environment</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>
+<p>Download a Beehive distribution archive, and explode it on your local machine. In the instructions below, the top level directory of the exploded Beehive archive is called '<span class="codefrag"><dist-dir></span>'. For example if you explode the archive into </p>
+<pre class="code">C:/beehive</pre>
+<p>then</p>
+<pre class="code"><dist-dir> = C:/beehive/apache-beehive-incubating-alpha-xxx [todo: get exact path]</pre>
+<p>Edit <span class="codefrag"><dist-dir>/beehiveUser.cmd|sh</span> to match your local environment. The following four paths must resolve to paths on your machine.</p>
+<pre class="code">
+ BEEHIVE_HOME
+ JAVA_HOME
+ CATALINA_HOME
+ ANT_HOME
+</pre>
+<p>
-<li>cd to <span class="codefrag">BEEHIVE_HOME/wsm/samples/dropInDeployment/AddressBook/client</span>
+<span class="codefrag">BEEHIVE_HOME</span> should refer to <dist-dir>:</p>
+<pre class="code">
+REM the root of Beehive distribution
+set BEEHIVE_HOME=C:\beehive\apache-beehive-incubating-alpha-xxx
+</pre>
+<p>After editing the file, open a command shell and run <span class="codefrag">beehiveUser.cmd|sh</span>.</p>
+</div>
+<p>Download junit.jar from <a href="http://prdownloads.sourceforge.net/junit/junit3.8.1.zip?download">http://prdownloads.sourceforge.net/junit/junit3.8.1.zip?download</a>
+</p>
+<p> Copy <span class="codefrag">junit.jar</span> to <span class="codefrag">ANT_HOME/lib</span>.</p>
+<p> Download derby.jar from <a href="http://incubator.apache.org/derby/binaries/derby_snapshot_svnversion_46005.ZIP">http://incubator.apache.org/derby/binaries/derby_snapshot_svnversion_46005.ZIP</a>.</p>
+<p> Copy <span class="codefrag">derby.jar</span> to <span class="codefrag">BEEHIVE_HOME/samples/EmployeeWS/WEB-INF/lib</span>.</p>
+<a name="N10094"></a><a name="Setting+up+the+Server"></a>
+<h4>Setting up the Server</h4>
+<div style="margin-left: 0 ; border: 2px">
+<p>
-</li>
+<span class="codefrag">cd</span> to <dist-dir>. </p>
+<p>Run the following Ant command:</p>
+<pre class="code"> ant -f ant\buildWebapp.xml start</pre>
+<p>This will start the Tomcat server located at <span class="codefrag">CATALINA_HOME</span>.</p>
+<p>To build and deploy the web services, run the following Ant commands:</p>
+<pre class="code"> ant -Dwebapp.dir=%BEEHIVE_HOME%\samples\AddressBookWS -Dcontext.path=AddressBookWS -f ant\buildWebapp.xml deploy.wsm.webapp.runtime build.webapp deploy</pre>
+<pre class="code"> ant -Dwebapp.dir=%BEEHIVE_HOME%\samples\EmployeeWS -Dcontext.path=EmployeeWS -f ant\buildWebapp.xml deploy.wsm.webapp.runtime build.webapp deploy</pre>
+<p>Verify that the web services are running by pointing your browser to:</p>
+<p>
-<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>
+<a target="_blank" href="http://localhost:8080/AddressBookWS/">http://localhost:8080/AddressBookWS/</a>
+
+</p>
+<p>and</p>
+<p>
-<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>
+<a target="_blank" href="http://localhost:8080/EmployeeWS/">http://localhost:8080/EmployeeWS/</a>
-</ol>
+</p>
+<p>Follow the validation links (<a target="_blank" href="http://localhost:8080/AddressBookWS/happyaxis.jsp">http://localhost:8080/AddressBookWS/happyaxis.jsp</a> and <a target="_blank" href="http://localhost:8080/EmployeeWS/happyaxis.jsp">http://localhost:8080/EmployeeWS/happyaxis.jsp</a>) to see the verification pages.</p>
+<p>For the WSDLs visit</p>
+<p>
+<a href="http://localhost:8080/AddressBookWS/web/Service.jws?wsdl"> http://localhost:8080/AddressBookWS/web/Service.jws?wsdl</a>
+</p>
+<p>
+<a href="http://localhost:8080/EmployeeWS/web/Service.jws?wsdl"> http://localhost:8080/EmployeeWS/web/Service.jws?wsdl</a>
+</p>
+</div>
+<a name="N100E8"></a><a name="Setting+up+the+Clients"></a>
+<h4>Setting up the Clients</h4>
+<div style="margin-left: 0 ; border: 2px">
+<p>To generate the clients run the following build files.</p>
+<pre class="code"> ant -f %BEEHIVE_HOME%/samples/AddressBookWS/WEB-INF/client-build.xml</pre>
+<p>and</p>
+<pre class="code"> ant -f %BEEHIVE_HOME%/samples/EmployeeWS/WEB-INF/client-build.xml</pre>
+<p>Note that you do not need to run a particular target within <span class="codefrag">client-build.xml</span>. Simply run the following ant commands shown above, and the client will be generated in <span class="codefrag">WEB-INF/build/generated</span>.</p>
+<p>The clients consist of JUnit test cases that exercise the contract published in the WSDL. The final result shows the number of successfully passed JUnit tests.</p>
+<p>The code generated in <span class="codefrag">/WEB-INF/build/generated/</span> can be used as a template to write your own client side applications.</p>
+<p>Note that the client-build.xml scripts make certain assumptions about the context.path provided when the WS server is deployed. If the context.path differs from the name of the directory for a sample, the URLs in client-build.xml have to be adjusted accordingly.
+</p>
</div>
</div>
Modified: incubator/beehive/site/build/site/wsm/tutorial_wsm.html
==============================================================================
--- incubator/beehive/site/build/site/wsm/tutorial_wsm.html (original)
+++ incubator/beehive/site/build/site/wsm/tutorial_wsm.html Wed Nov 3 20:21:52 2004
@@ -172,11 +172,15 @@
<ul>
<li>
-<a href="../jpetstore.html">Beehive Samples: JPetStore</a>
+<a href="../jpetstore.html">Petstore</a>
</li>
<li>
-<a href="../wsm/sample_AddressBook.html">WSM Sample: AddressBook</a>
+<a href="../wsm/sample_Dashboard.html">Petstore Dashboard</a>
+</li>
+
+<li>
+<a href="../wsm/sample_AddressBook.html">AddressBook</a>
</li>
</ul>
Modified: incubator/beehive/site/src/documentation/content/xdocs/site.xml
==============================================================================
--- incubator/beehive/site/src/documentation/content/xdocs/site.xml (original)
+++ incubator/beehive/site/src/documentation/content/xdocs/site.xml Wed Nov 3 20:21:52 2004
@@ -23,8 +23,9 @@
<jsr181 label="Web Services (JSR 181)" href="webservices.html"/>
</wsm>
<samples label="Samples">
- <jpetstore label="Beehive Samples: JPetStore" href="jpetstore.html"/>
- <jsr181 label="WSM Sample: AddressBook" href="wsm/sample_AddressBook.html"/>
+ <jpetstore label="Petstore" href="jpetstore.html"/>
+ <jsr181 label="Petstore Dashboard" href="wsm/sample_Dashboard.html"/>
+ <jsr181 label="AddressBook" href="wsm/sample_AddressBook.html"/>
</samples>
<ref label="Reference Docs" href="reference.html"/>
<!--<gloss label="Glossary" href="glossary.html"/>-->
Modified: incubator/beehive/site/src/documentation/content/xdocs/wsm/sample_AddressBook.xml
==============================================================================
--- incubator/beehive/site/src/documentation/content/xdocs/wsm/sample_AddressBook.xml (original)
+++ incubator/beehive/site/src/documentation/content/xdocs/wsm/sample_AddressBook.xml Wed Nov 3 20:21:52 2004
@@ -2,88 +2,87 @@
<!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>
+ <title>Beehive AddressBookWS and EmployeeWS 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>
+ <title>The AddressBookWS and EmployeeWS Samples</title>
+ <p>The AddressBookWS sample is an annotation-aware web service based on the Apache Axis sample of the same name. AddressBookWS 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>EmployeeWS [todo]</p>
+ </section>
+ <section>
+ <title>Running the Samples</title>
<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>
+ <p>To run the Samples, you need:</p>
+ <ul>
+ <li>Beehive</li>
+ <li>Tomcat 5</li>
+ <li>J2SE 5</li>
+ <li>Ant 1.6.2</li>
+ <li>junit.jar (v3.8.1 or later)</li>
+ <li>derby.jar (for EmployeeWS only)</li>
+ </ul>
+ </section>
+ <section>
+ <title>Setting up the Environment</title>
+ <p>Download a Beehive distribution archive, and explode it on your local machine. In the instructions below, the top level directory of the exploded Beehive archive is called '<code><dist-dir></code>'. For example if you explode the archive into </p>
+ <source>C:/beehive</source>
+ <p>then</p>
+ <source><dist-dir> = C:/beehive/apache-beehive-incubating-alpha-xxx [todo: get exact path]</source>
+ <p>Edit <code><dist-dir>/beehiveUser.cmd|sh</code> to match your local environment. The following four paths must resolve to paths on your machine.</p>
+ <source>
+ BEEHIVE_HOME
+ JAVA_HOME
+ CATALINA_HOME
+ ANT_HOME
+</source>
+ <p>
+ <code>BEEHIVE_HOME</code> should refer to <dist-dir>:</p>
+ <source>
+REM the root of Beehive distribution
+set BEEHIVE_HOME=C:\beehive\apache-beehive-incubating-alpha-xxx
+</source>
+ <p>After editing the file, open a command shell and run <code>beehiveUser.cmd|sh</code>.</p>
</section>
+ <p>Download junit.jar from <link href="http://prdownloads.sourceforge.net/junit/junit3.8.1.zip?download">http://prdownloads.sourceforge.net/junit/junit3.8.1.zip?download</link> </p>
+ <p> Copy <code>junit.jar</code> to <code>ANT_HOME/lib</code>.</p>
+ <p> Download derby.jar from <link href="http://incubator.apache.org/derby/binaries/derby_snapshot_svnversion_46005.ZIP">http://incubator.apache.org/derby/binaries/derby_snapshot_svnversion_46005.ZIP</link>.</p>
+ <p> Copy <code>derby.jar</code> to <code>BEEHIVE_HOME/samples/EmployeeWS/WEB-INF/lib</code>.</p>
<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 Backend Java Types of the AddressBook Sample</li>
- <ul>
- <li>Note: this step is necessary to build the Java types in /AddressBook/server/src/org/beehive/demo. The web service file itself (AddressBook.jws), does not need to be pre-compiled, because of the Axis drop-in deployment model.</li>
- <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>
+ <p>
+ <code>cd</code> to <dist-dir>. </p>
+ <p>Run the following Ant command:</p>
+ <source> ant -f ant\buildWebapp.xml start</source>
+ <p>This will start the Tomcat server located at <code>CATALINA_HOME</code>.</p>
+ <p>To build and deploy the web services, run the following Ant commands:</p>
+ <source> ant -Dwebapp.dir=%BEEHIVE_HOME%\samples\AddressBookWS -Dcontext.path=AddressBookWS -f ant\buildWebapp.xml deploy.wsm.webapp.runtime build.webapp deploy</source>
+ <source> ant -Dwebapp.dir=%BEEHIVE_HOME%\samples\EmployeeWS -Dcontext.path=EmployeeWS -f ant\buildWebapp.xml deploy.wsm.webapp.runtime build.webapp deploy</source>
+ <p>Verify that the web services are running by pointing your browser to:</p>
+ <p>
+ <fork href="http://localhost:8080/AddressBookWS/">http://localhost:8080/AddressBookWS/</fork>
+ </p>
+ <p>and</p>
+ <p>
+ <fork href="http://localhost:8080/EmployeeWS/">http://localhost:8080/EmployeeWS/</fork>
+ </p>
+ <p>Follow the validation links (<fork href="http://localhost:8080/AddressBookWS/happyaxis.jsp">http://localhost:8080/AddressBookWS/happyaxis.jsp</fork> and <fork href="http://localhost:8080/EmployeeWS/happyaxis.jsp">http://localhost:8080/EmployeeWS/happyaxis.jsp</fork>) to see the verification pages.</p>
+ <p>For the WSDLs visit</p>
+ <p><link href="http://localhost:8080/AddressBookWS/web/Service.jws?wsdl"> http://localhost:8080/AddressBookWS/web/Service.jws?wsdl</link></p>
+ <p><link href="http://localhost:8080/EmployeeWS/web/Service.jws?wsdl"> http://localhost:8080/EmployeeWS/web/Service.jws?wsdl</link></p>
</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>
+ <title>Setting up the Clients</title>
+ <p>To generate the clients run the following build files.</p>
+ <source> ant -f %BEEHIVE_HOME%/samples/AddressBookWS/WEB-INF/client-build.xml</source>
+ <p>and</p>
+ <source> ant -f %BEEHIVE_HOME%/samples/EmployeeWS/WEB-INF/client-build.xml</source>
+ <p>Note that you do not need to run a particular target within <code>client-build.xml</code>. Simply run the following ant commands shown above, and the client will be generated in <code>WEB-INF/build/generated</code>.</p>
+ <p>The clients consist of JUnit test cases that exercise the contract published in the WSDL. The final result shows the number of successfully passed JUnit tests.</p>
+ <p>The code generated in <code>/WEB-INF/build/generated/</code> can be used as a template to write your own client side applications.</p>
+ <p>Note that the client-build.xml scripts make certain assumptions about the context.path provided when the WS server is deployed. If the context.path differs from the name of the directory for a sample, the URLs in client-build.xml have to be adjusted accordingly.
+</p>
</section>
</section>
</body>
Added: incubator/beehive/site/src/documentation/content/xdocs/wsm/sample_Dashboard.xml
==============================================================================
--- (empty file)
+++ incubator/beehive/site/src/documentation/content/xdocs/wsm/sample_Dashboard.xml Wed Nov 3 20:21:52 2004
@@ -0,0 +1,113 @@
+<?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: Petstore Dashboard</title>
+ </header>
+ <body>
+ <section>
+ <title>The Petstore Dashboard Sample</title>
+ <p>Petstore has both a web site and a web service interface. The web site is designed for customer access; the web service is for employee access. Through the web service, employees update the prices and inventory seen on the customer web site. The Petstore Dashboard is a Swing client application for this web service. Updates made on the Dashboard are passed to the web service and ultimately the updates appear on the Petstore web site.
+</p>
+<!--
+ <p>The Dashboard sample source code is located at <code>BEEHIVE_HOME/samples/PetStoreDashboard</code>. [todo: more about the code breakdown]</p>
+ <source><![CDATA[
+ PetStoreDashboard
+ | - images
+ | - lib
+ | - src ]]></source>
+ -->
+ </section>
+
+<section>
+ <title>Running the Dashboard Sample</title>
+ <section>
+ <title>Requirements for Running the Sample</title>
+ <p>To run the Sample, you need:</p>
+ <ul>
+ <li>Beehive</li>
+ <li>Tomcat 5</li>
+ <li>J2SE 5</li>
+ <li>Ant 1.6.2</li>
+ <li>activation.jar (details below)</li>
+ <li>mailapi.jar (details below)</li>
+ </ul>
+ </section>
+ <section>
+ <title>Setting up the Environment</title>
+ <p>Download a Beehive distribution archive, and explode it on your local machine. In the instructions below, the top level directory of the exploded Beehive archive is called '<code><dist-dir></code>'. For example if you explode the archive into </p>
+ <source>C:/beehive</source>
+ <p>then</p>
+ <source><dist-dir> = C:/beehive/apache-beehive-incubating-alpha-xxx x`</source>
+ <p>Edit <code><dist-dir>/beehiveUser.cmd|sh</code> to match your local environment. The following four paths must resolve to paths on your machine.</p>
+ <source>
+ BEEHIVE_HOME
+ JAVA_HOME
+ CATALINA_HOME
+ ANT_HOME
+</source>
+ <p>
+ <code>BEEHIVE_HOME</code> should refer to <dist-dir>:</p>
+ <source>
+REM the root of Beehive distribution
+set BEEHIVE_HOME=C:\beehive\apache-beehive-incubating-alpha-xxx
+</source>
+ <p>After editing the file, open a command shell and run <code>beehiveUser.cmd|sh</code>.</p>
+ </section>
+ <section>
+ <title>Undeploy Petstore</title>
+ <p>If you have previously deployed Petstore, you must undeploy it now. (This allows you to recompile the Petstore source, which occurs in the next step.)</p>
+ <source> ant -Dwebapp.dir=BEEHIVE_HOME/samples/petstoreWeb -Dcontext.path=petstoreWeb -f ant/buildWebapp.xml undeploy</source>
+ </section>
+ <section>
+ <title>Download Required JAR Files</title>
+<p> Before you can build Petstore Dashboard you must download 1) activation.jar and 2) mailapi.jar.</p>
+
+<p> 1) download activation.jar (<link href="http://java.sun.com/products/javabeans/glasgow/jaf.html">http://java.sun.com/products/javabeans/glasgow/jaf.html</link>) </p>
+
+ <p>Note that activation.jar is archived in the JAF 1.0.2 distribution ZIP file. Download the JAF 1.0.2 ZIP, extract activation.jar, and copy activation.jar into both </p>
+
+<source> BEEHIVE_HOME/samples/PetstoreDashboard/lib/ </source>
+
+<p>and</p>
+
+<source> BEEHIVE_HOME/samples/petstoreWeb/WEB-INF/lib</source>
+
+<p>2) mailapi.jar (<link href="http://java.sun.com/products/javamail/downloads/index.html">http://java.sun.com/products/javamail/downloads/index.html</link>)</p>
+
+<p> mailapi.jar is archived in the JavaMail 1.3.2 distribution ZIP file. Download the JavaMail 1.3.2 ZIP, extract mailapi.jar, and copy mailapi.jar into both </p>
+
+<source> BEEHIVE_HOME/samples/PetstoreDashboard/lib/ </source>
+
+<p>and</p>
+
+<source> BEEHIVE_HOME/samples/petstoreWeb/WEB-INF/lib</source>
+
+ </section>
+<section>
+ <title>Initialize, Build and Deploy Petstore</title>
+<p>To build and deploy Petstore, enter the following Ant command:</p>
+<source>ant
+ -Dwebapp.dir=%BEEHIVE_HOME%/samples/petstoreWeb
+ -Dcontext.path=petstoreWeb
+ -f ant/buildWebapp.xml
+ deploy.beehive.webapp.runtime build.webapp deploy
+ </source>
+ <p>To launch the Dashboard:</p>
+ <p>cd to: <code>BEEHIVE_HOME/samples/PetstoreDashboard</code></p>
+ <p>At the command line, enter <code>ant</code></p>
+ <p></p>
+<p>The Swing application comes up in its own window. Click on the different categories and modify price and quantity. The changes show up on the Petstore site (when the browser is refreshed).
+</p>
+<p> Note: If the petstoreWeb sample is deployed to Tomcat with a context.path different from "petstoreWeb", or if it is deployed to a different server than localhost:8080, then BEEHIVE_HOME/samples/PetstoreDashboard/build.xml needs to be modified accordingly. The client generator relies on these default values.</p>
+
+</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>