Author: steveh
Date: Thu Apr 21 16:01:11 2005
New Revision: 164144
URL: http://svn.apache.org/viewcvs?rev=164144&view=rev
Log:
(1) Adding topic on getting started with web services
(2) Improving web services user's guide
(3) Adding topic on web service Employee sample
Added:
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/wsm/getting_started.xml
(with props)
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/wsm/sample_Employee.xml
(with props)
Modified:
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/jpetstore.xml
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/pageflow_databinding.xml
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/pageflow_datagrid.xml
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/site.xml
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/wsm/sample_AddressBook.xml
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/wsm/wsm_overview.xml
Modified:
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/jpetstore.xml
URL:
http://svn.apache.org/viewcvs/incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/jpetstore.xml?rev=164144&r1=164143&r2=164144&view=diff
==============================================================================
---
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/jpetstore.xml
(original)
+++
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/jpetstore.xml
Thu Apr 21 16:01:11 2005
@@ -167,22 +167,6 @@
context.path=petstoreWeb</source>
</section>
-
-<!-- <section id="copy_runtime">
- <title>To Copy the Runtime Resources</title>
- <p>The Petstore application is distributed
without the Beehive runtime JAR
- files it needs to run.
- To copy the runtime JARs into the
Petstore app,
- run the following Ant command. </p>
- <source>ant
- -f C:\beehive_projects\petstoreWeb\WEB-INF\src\build.xml
- deploy-beehive
-
-<strong>Copy and Paste version:</strong>
-ant -f C:\beehive_projects\petstoreWeb\WEB-INF\src\build.xml
deploy-beehive</source>
- <p>This will copy the Beehive webapp runtime
JARs into the following location.</p>
- <source>
C:/beehive_projects/petstoreWeb/WEB-INF/lib</source>
- </section>-->
<section id="compile">
<title>To Compile the Petstore
Application</title>
<p>To compile the Petstore app, enter the
following Ant
@@ -191,10 +175,11 @@
-f C:\beehive_projects\petstoreWeb\WEB-INF\src\build.xml
clean
build
+ war
<strong>Copy and Paste version:</strong>
-ant -f C:\beehive_projects\petstoreWeb\WEB-INF\src\build.xml clean
build</source>
-
+ant -f C:\beehive_projects\petstoreWeb\WEB-INF\src\build.xml clean build
war</source>
+<p>A WAR file named <code>petstoreWeb.war</code> will be saved at
<code>C:/beehive_projects/petstoreWeb.war</code>.</p>
</section>
<section id="start_tomcat">
<title>To Start Tomcat</title>
@@ -203,22 +188,13 @@
</section>
<section id="deploy">
<title>To Deploy to Tomcat</title>
- <p>To deploy the web application, 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>This method of application deployment assumes that you have added
the <code>manager</code>
- role to your Tomcat installation. For instructions on adding
the <code>manager</code> role,
- see <a class="fork" href="setup.html#optional">Beehive
Installation and Setup</a>.</p>
- <p class="quote">
- <a class="fork"
href="http://localhost:8080/manager/deploy?path=/petstoreWeb&war=file:C:/beehive_projects/petstoreWeb&update=true">http://localhost:8080/manager/deploy?path=/petstoreWeb&war=file:C:/pageflow_projects/petstoreWeb&update=true</a>
- </p>
- <p>If you are prompted for a username/password, enter:
<code>manager/manager</code></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>
+ <p>To deploy the web application, copy the WAR file to Tomcat's webapps
directory.</p>
+ <source>copy C:\beehive_projects\petstoreWeb.war
%CATALINA_HOME%\webapps</source>
+
</section>
<section id="test">
- <title>Running</title>
+ <title>Running Petstore</title>
+ <p>Visit the following URL:</p>
<p><a class="fork"
href="http://localhost:8080/petstoreWeb">http://localhost:8080/petstoreWeb</a></p>
</section>
</section>
Modified:
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/pageflow_databinding.xml
URL:
http://svn.apache.org/viewcvs/incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/pageflow_databinding.xml?rev=164144&r1=164143&r2=164144&view=diff
==============================================================================
---
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/pageflow_databinding.xml
(original)
+++
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/pageflow_databinding.xml
Thu Apr 21 16:01:11 2005
@@ -44,7 +44,8 @@
<code>applicationScope</code>
</td>
<td>an attribute map on the application
object (a JSP 2.0 implicit object)</td>
- <td></td>
+ <td>An implicit JSP object. Attributes
of this object are available across the web
+ app.</td>
</tr>
<tr>
<td>
@@ -103,21 +104,23 @@
<code>pageScope</code>
</td>
<td>an attribute map on the current JSP
page (a JSP 2.0 implicit object)</td>
- <td></td>
+ <td>An implicit JSP object. Attributes
of this object are available on the current JSP page.</td>
</tr>
<tr>
<td>
<code>requestScope</code>
</td>
<td>an attribute map on the request
object (a JSP 2.0 implicit object)</td>
- <td></td>
+ <td>An implicit JSP object. Attributes
of this object are available
+ for the life of the current
request.</td>
</tr>
<tr>
<td>
<code>sessionScope</code>
</td>
<td>an attribute map on the session
object (a JSP 2.0 implicit object)</td>
- <td></td>
+ <td>An implicit JSP object. Attributes
of this object are available
+ for the life of the user
session.</td>
</tr>
<tr>
<td>
Modified:
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/pageflow_datagrid.xml
URL:
http://svn.apache.org/viewcvs/incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/pageflow_datagrid.xml?rev=164144&r1=164143&r2=164144&view=diff
==============================================================================
---
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/pageflow_datagrid.xml
(original)
+++
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/pageflow_datagrid.xml
Thu Apr 21 16:01:11 2005
@@ -18,7 +18,7 @@
<p><img src="images/pageflow_database_app_1.png"
alt="pageflow_database"/></p>
<p><strong>The Database</strong></p>
<p>The role of the database is as a storehouse for the
data. The database persists
- the data from session to session and is the
common object which users view and
+ the data from session to session and is the
common object that users view and
operate upon.</p>
<p><strong>The Database Control</strong></p>
<p>The database control handles the data traffic with
the database. The database
@@ -38,7 +38,7 @@
the JSP pages, users can interact with the data
in the database, by
adding, deleting, and updating the data.</p>
<section
class="rendering_complex_data_sets"><title>Rendering Complex Data Sets as
HTML</title>
- <p>Beehive provides a specialized tag libarary
for viewing and managing
+ <p>Beehive provides a specialized tag library
for viewing and managing
the complex data sets associated with database
applications:
<a
href="../apidocs/taglib/taglib-overview-summary.html#netui-data"><code><netui-data:xxx></code></a>.
The central HTML-rendering tags are</p>
@@ -75,7 +75,7 @@
</ul>
</section>
<section id="how_objects_rendered"><title>How are Objects
Rendered?</title>
- <p>The data sets above are rendered as multiple rows in the an
HTML table; a single
+ <p>The data sets above are rendered as multiple rows in an HTML
table; a single
object in the set is rendered as a single row.</p>
<p>The properties of an object can be rendered as the cells of
a single row.</p>
<p>The HTML table has the following basic parts:</p>
@@ -207,7 +207,7 @@
<p>The data grid supports two modes for rendering CSS styles:
"default" and "empty".</p>
<p>Under the default mode, a CSS style prefix is prepended to a
standard set of CSS
style names (see table below). There are different CSS
style names for
- different parts of the rendered HTML. The CSS style
used is controled by writing
+ different parts of the rendered HTML. The CSS style
used is controlled by writing
different prepending prefixes into the HTML.</p>
<p>The prefix is controlled by setting the
<code>styleClassPrefix</code> attribute
of the <netui-data:dataGrid> tag.</p>
@@ -394,7 +394,7 @@
<section id="setup_netui-blank"><title>Setup the Page
Flow Web App Template</title>
<p>To set up a grid you first need a source of
some tabular data.
Below we use an in-memory ArrayList as the
source
- of tabluar data. In a real web application,
this data source would
+ of tabular data. In a real web application,
this data source would
come from a database, but the in-memory source
is sufficient for learning
how to render a data grid.</p>
<p>In these setup instructions, we assume that
you are using Tomcat as your web
Modified:
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/site.xml
URL:
http://svn.apache.org/viewcvs/incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/site.xml?rev=164144&r1=164143&r2=164144&view=diff
==============================================================================
---
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/site.xml
(original)
+++
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/site.xml
Thu Apr 21 16:01:11 2005
@@ -39,17 +39,22 @@
</controls>
<wsm label="Web Services">
<wsm_overview label="Web Services Overview"
href="wsm/wsm_overview.html"/>
- <wsm_overview label="Java Web Service Files"
href="wsm/wsm_JWSFiles.html"/>
+ <wsm_getting_started label="Getting Started"
href="wsm/getting_started.html"/>
+ <jws_files label="Java Web Service Files"
href="wsm/wsm_JWSFiles.html"/>
<supported_datatypes label="Supported Data Types"
href="wsm/datatypes.html"/>
<jsr181 label="Web Services (JSR 181)" href="webservices.html"/>
</wsm>
+ <!--<howdoi label="How Do I...?">
+ <useControl label="How Do I: Invoke a Control?"
href="how/howInvokeControl.html"/>
+ </howdoi>-->
<samples label="Samples">
<sam_index label="Samples" href="samples/index.html"/>
<jpetstore label="Petstore" href="jpetstore.html"/>
- <jpetstore label="Page Flow Samples"
href="pageflow/netui-samples.html"/>
+ <netui-samples label="Page Flow Samples"
href="pageflow/netui-samples.html"/>
<!--<dash label="Petstore Dashboard"
href="wsm/sample_Dashboard.html"/>-->
<db-sample label="Database Control"
href="controls/sample_controls-db.html"/>
<address label="AddressBook" href="wsm/sample_AddressBook.html"/>
+ <employee label="Employee"
href="wsm/sample_Employee.html"/>
<wsm-samples label="WSM Annotation Samples"
href="wsm/sample_wsmAnnoSamples.html"/>
<control-blank label="Page Flow Project"
href="pageflow/sample_netui-blank.html"/>
<control-blank label="Control Project"
href="controls/sample_controls-blank.html"/>
Added:
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/wsm/getting_started.xml
URL:
http://svn.apache.org/viewcvs/incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/wsm/getting_started.xml?rev=164144&view=auto
==============================================================================
---
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/wsm/getting_started.xml
(added)
+++
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/wsm/getting_started.xml
Thu Apr 21 16:01:11 2005
@@ -0,0 +1,28 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN"
"http://forrest.apache.org/dtd/document-v20.dtd">
+<document>
+ <header>
+ <title>Web Services: Getting Started</title>
+ </header>
+ <body>
+ <p>For an introduction to the <strong>basic
concepts</strong> of Web Service technology, see
+ the topic:</p>
+ <ul><li> <a href="#wsm_overview">Web Services
Overview</a></li></ul>
+ <p>The following <strong>tutorial</strong> demonstrates
the basic development cycle for Beehive web
+ services:</p>
+ <ul><li><a href="site:tutorial_wsm">Beehive Web Service
Tutorial</a></li></ul>
+ <p>The following <strong>sample</strong> demonstrates
the basic Beehive
+ web service features: </p>
+ <ul><li><a href="site:address">AddressBook
sample</a></li></ul>
+ <p>The following <strong>sample</strong> shows more
advanced web service features, such as web parameters
+ and "one way" methods.</p>
+ <ul><li><a href="site:address">AddressBook-Enhanced
sample</a></li></ul>
+ <p>The following <strong>sample</strong> shows how to
invoke a control from within a web service: </p>
+ <ul><li><a href="site:employee">Employee
sample</a></li></ul>
+ </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>
Propchange:
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/wsm/getting_started.xml
------------------------------------------------------------------------------
svn:eol-style = native
Modified:
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/wsm/sample_AddressBook.xml
URL:
http://svn.apache.org/viewcvs/incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/wsm/sample_AddressBook.xml?rev=164144&r1=164143&r2=164144&view=diff
==============================================================================
---
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/wsm/sample_AddressBook.xml
(original)
+++
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/wsm/sample_AddressBook.xml
Thu Apr 21 16:01:11 2005
@@ -88,21 +88,25 @@
</section>
<section id="setup_server">
<title>To Set up the Server</title>
- <!--<section id="copy_app">
+ <section id="copy_app">
<title>To Copy the Application to a
Project Folder</title>
<p>To keep your Beehive distribution
directory pristine,
- you should copy the
<code>AddressBookWS</code> and <code>EmployeeWS</code>
+ you should copy the application
folders to
another location before
proceeding. The following
- instructions assume that you
have copied these folders
- into the directory
+ instructions assume that you
have copied the folders</p>
+ <source>BEEHIVE_HOME/samples/wsm-addressbook
+BEEHIVE_HOME/samples/wsm-addressbook-enhanced</source>
+<p> into the directory
<code>C:/beehive_projects</code>, resulting in the
- following directory
structure.</p>
+ following directory
structures.</p>
<source>C:
beehive_projects
- wsm-addressbook
- EmployeeWS</source>
- </section>-->
+ wsm-addressbook</source>
+ <source>C:
+ beehive_projects
+ wsm-addressbook-enhanced</source>
+ </section>
<section id="start_tomcat">
<title>To Start Tomcat</title>
<p>To start Tomcat, run the following
command:</p>
@@ -123,8 +127,8 @@
<section id="edit_properties_file"><title>Edit the
<code>build.properties</code> Files</title>
<p>In this section you will edit the
<code>build.properties</code> files--the files
that set the build-related properties
for the web services.</p>
- <p>Open the files
<code>BEEHIVE_HOME/samples/wsm-addressbook/WEB-INF/src/build.properties</code>
- and
<code>BEEHIVE_HOME/samples/wsm-addressbook-enhanced/WEB-INF/src/build.properties</code>
+ <p>Open the files
<code>C:/beehive_projects/wsm-addressbook/WEB-INF/build.properties</code>
+ and
<code>C:/beehive_projects/wsm-addressbook-enhanced/WEB-INF/build.properties</code>
in a text editor.</p>
<p>Edit the files so that the
<code>beehive.home</code> property points to the
top-level folder of your beehive
installation. For example, if you beehive installation
@@ -136,7 +140,7 @@
<title>To Compile the Apps</title>
<p>To compile the AddressBookWS app, enter the following Ant
command.</p>
<source>ant
- -f %BEEHIVE_HOME%\samples\wsm-addressbook\WEB-INF\build.xml
+ -f C:\beehive_projects\wsm-addressbook\WEB-INF\build.xml
-Dto.dir=%CATALINA_HOME%\webapps
clean
build
@@ -144,11 +148,11 @@
<strong>Copy and paste version:</strong>
-ant -f %BEEHIVE_HOME%\samples\wsm-addressbook\WEB-INF\build.xml
-Dto.dir=%CATALINA_HOME%\webapps clean build deploy</source>
+ant -f C:\beehive_projects\wsm-addressbook\WEB-INF\build.xml
-Dto.dir=%CATALINA_HOME%\webapps clean build deploy</source>
<p>To compile the EnhancedAddressBookWS
app, enter the following Ant command.</p>
<source>ant
- -f %BEEHIVE_HOME%\samples\wsm-addressbook-enhanced\WEB-INF\build.xml
+ -f C:\beehive_projects\wsm-addressbook-enhanced\WEB-INF\build.xml
-Dto.dir=%CATALINA_HOME%\webapps
clean
build
@@ -156,7 +160,7 @@
<strong>Copy and paste version:</strong>
-ant -f %BEEHIVE_HOME%\samples\wsm-addressbook-enhanced\WEB-INF\build.xml
-Dto.dir=%CATALINA_HOME%\webapps clean build deploy</source>
+ant -f C:\beehive_projects\wsm-addressbook-enhanced\WEB-INF\build.xml
-Dto.dir=%CATALINA_HOME%\webapps clean build deploy</source>
<!-- <p>To compile the EmployeeWS app, enter the following Ant
command.</p>
<source>ant
-f %BEEHIVE_HOME%\ant\buildWebapp.xml
@@ -186,8 +190,8 @@
<title>To Run the Web Service Clients</title>
<p>To generate and run the client, run the
following build files.</p>
-<source>ant -f
%BEEHIVE_HOME%\samples\wsm-addressbook\WEB-INF\build-client.xml</source>
-<source>ant -f
%BEEHIVE_HOME%\samples\wsm-addressbook-enhanced\WEB-INF\build-client.xml</source>
+<source>ant -f
C:\beehive_projects\wsm-addressbook\WEB-INF\build-client.xml</source>
+<source>ant -f
C:\beehive_projects\wsm-addressbook-enhanced\WEB-INF\build-client.xml</source>
<!-- <p>and</p>
<source>ant -f
C:/beehive_projects/EmployeeWS/WEB-INF/build-client-dist.xml</source>-->
<p>Note that you do not need to run a
particular target within the build files
Added:
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/wsm/sample_Employee.xml
URL:
http://svn.apache.org/viewcvs/incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/wsm/sample_Employee.xml?rev=164144&view=auto
==============================================================================
---
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/wsm/sample_Employee.xml
(added)
+++
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/wsm/sample_Employee.xml
Thu Apr 21 16:01:11 2005
@@ -0,0 +1,177 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN"
+ "http://forrest.apache.org/dtd/document-v20.dtd">
+<document>
+ <header>
+ <title>Beehive EmployeeWS Sample</title>
+ </header>
+ <body>
+ <section id="intro">
+ <title>Introduction</title>
+ <p><strong>EmployeeWS</strong> provides a web service
interface for
+ an Employee database. Using SOAP messages, the
web service
+ queries the backend database: selecting,
updating and inserting
+ employee data. A Beehive database control
connects the web
+ service and the database. The web service class
is located at
+
<code>EmployeeWS/WEB-INF/src/web/Service.jws</code>. The
+ database control is located at
+
<code>EmployeeWS/WEB-INF/src/org/apache/beehive/sample/EmployeeDBControl.jcx</code>.
+ Note that EmployeeDBControl is a subclass of
DatabaseControl,
+ another Beehive sample. For more information
see <a
+
href="../controls/sample_controls-db.html">Database
+ Control</a>. </p>
+ <p>Apache Derby supplies the database implementation.
(Installing
+ Derby requires a simple JAR file download,
described below.)
+ Apache Axis provides the automatic
client-generation for the
+ web services. Custom unit tests are provided to
exercise the
+ webservice methods. The unit tests create the
database tables,
+ insert new records, query the database, and
finally drop
+ the tables. Use the junit tests as a template
for building
+ automatic tests for your own web services</p>
+ </section>
+ <section id="running">
+ <title>Running the Samples</title>
+ <section id="reqs">
+ <title>Requirements for Running the
Samples</title>
+ <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, details
below)</li>
+ <li>derby.jar </li>
+ </ul>
+ </section>
+ <section id="enviro">
+ <title>To Set up the Environment</title>
+ <p>Before proceeding, complete all of the
necessary and
+ optional steps in the following topic:
<a class="fork"
+ href="../setup.html">Beehive
Installation and Setup</a></p>
+ <p>Open a command shell and confirm that the
following
+ variables have been set:</p>
+ <ul>
+ <li>
+ <code>ANT_HOME</code>
+ </li>
+ <li>
+ <code>BEEHIVE_HOME</code>
+ </li>
+ <li>
+ <code>CATALINA_HOME</code>
+ </li>
+ <li>
+ <code>JAVA_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="setup_server">
+ <title>To Set up the Server</title>
+ <section id="copy_app">
+ <title>To Copy the Application to a
Project Folder</title>
+ <p>To keep your Beehive distribution
directory pristine,
+ you should copy the application
+ folders to
+ another location before
proceeding. The following
+ instructions assume that you
have copied the folder</p>
+ <source>BEEHIVE_HOME/samples/wsm-employee</source>
+<p> into the directory
+
<code>C:/beehive_projects</code>, resulting in the
+ following directory
structures.</p>
+<source>C:
+ beehive_projects
+ wsm-employee</source>
+ </section>
+ <section id="start_tomcat">
+ <title>To Start Tomcat</title>
+ <p>To start Tomcat, run the following
command:</p>
+ <source>%CATALINA_HOME%\bin\startup.bat</source>
+ </section>
+ <section id="external_jars">
+ <title>To Download Junit the JAR
File<!--and Derby JAR Files--></title>
+ <p>Download the junit ZIP archive 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>Unzip the archive, locate
<code>junit.jar</code>, and copy <code>junit.jar</code> to
+ <code>ANT_HOME/lib</code>.</p>
+ <p> Download the derby ZIP archive 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>Unzip the archive, locate
<code>derby.jar</code>, and copy <code>derby.jar</code> to
+
<code>C:/beehive_projects/EmployeeWS/WEB-INF/lib</code>.</p>
+ </section>
+ <section id="edit_properties_file"><title>Edit the
<code>build.properties</code> Files</title>
+ <p>In this section you will edit the
<code>build.properties</code> files--the files
+ that set the build-related properties
for the web services.</p>
+ <p>Open the files
<code>C:/beehive_projects/wsm-addressbook/WEB-INF/build.properties</code>
+ and
<code>C:/beehive_projects/wsm-addressbook-enhanced/WEB-INF/build.properties</code>
+ in a text editor.</p>
+ <p>Edit the files so that the
<code>beehive.home</code> property points to the
+ top-level folder of your beehive
installation. For example, if you beehive installation
+ resides at
<code>C:/apache/apache-beehive-1.0</code>, then your
<code>build.properties</code> files
+ would appear as follows.</p>
+
<source>beehive.home=<strong>C:/apache/apache-beehive-1.0</strong></source>
+ </section>
+ <section id="compile">
+ <title>To Compile the Apps</title>
+ <p>To compile the EmployeeWS app, enter the following Ant
command.</p>
+<source>ant
+ -f C:\beehive_projects\wsm-employee\WEB-INF\build.xml
+ -Dto.dir=%CATALINA_HOME%\webapps
+ clean
+ build
+ deploy
+
+<strong>Copy and paste version:</strong>
+
+ant -f C:\beehive_projects\wsm-employee\WEB-INF\build.xml
-Dto.dir=%CATALINA_HOME%\webapps clean build deploy</source>
+ </section>
+ <section id="verify_deploy"><title>To Verify the
Deployments</title>
+ <p>Verify that the web service is running by
pointing your
+ browser to:</p>
+ <p>
+ <a class="fork"
href="http://localhost:8080/EmployeeWS/">
+
http://localhost:8080/EmployeeWS/</a>
+ </p>
+ </section>
+ </section>
+ <section id="setup_clients">
+ <title>To Run the Web Service Clients</title>
+
+ <p>To generate and run the client, run the
following build files.</p>
+<source>ant -f
C:\beehive_projects\wsm-employee\WEB-INF\build-client.xml</source>
+ <p>Note that you do not need to run a
particular target within the build files
+ <code>client-build.xml</code>. Simply
run the Ant command
+ shown above and the clients 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 script makes
certain
+ assumptions about the Tomcat deployment
context path, namely,
+ that the app is deployed
+ on the context path
+ <code>EmployeeWS</code>.
+ If the context path differs from this
value, the URL in
+ the build-client.xml file must be
adjusted accordingly. </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>
\ No newline at end of file
Propchange:
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/wsm/sample_Employee.xml
------------------------------------------------------------------------------
svn:eol-style = native
Modified:
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/wsm/wsm_overview.xml
URL:
http://svn.apache.org/viewcvs/incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/wsm/wsm_overview.xml?rev=164144&r1=164143&r2=164144&view=diff
==============================================================================
---
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/wsm/wsm_overview.xml
(original)
+++
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/wsm/wsm_overview.xml
Thu Apr 21 16:01:11 2005
@@ -34,20 +34,56 @@
<!--<p><strong>Containers</strong></p>
<p>[todo]</p> -->
</section>
- <!--<section>
+ <section>
<title>Web Service Basics</title>
<p><strong>What Do Web Services Do?</strong></p>
- <p>At the most basic level, web services are servlets
that take requests (in the form
- of XML documents) and sends back responses (in
the form of XML documents). </p>
- <p><strong>SOAP</strong></p>
- <p></p>
- <p><strong>Design Considerations</strong></p>
- <p></p>
- <p><strong></strong></p>
- <p></p>
- <p><strong></strong></p>
- <p></p>
- </section>-->
+ <p>Web services are servlets that take requests (in the
form
+ of XML documents) and send back responses (in
the form of XML documents).</p>
+ <p>Because web services are based on standard
technologies (HTTP and XML),
+ they make communication possible even
+ if the parties are running on different
operating systems and are written in different
+ languages. For this reason they are an
excellent approach for building distributed
+ applications that must incorporate diverse
systems over a network.</p>
+ <p>Web services have the following features:</p>
+ <ul>
+ <li>The web service's functionality is publicly
described in a WSDL file.</li>
+ <li>Web services communicate with other
applications through XML messages, typically
+ in SOAP format.</li>
+ <li>Web services generally use a standard
network protocol, such as HTTP.</li>
+ </ul>
+ <section><title>WSDL Files</title>
+ <p>The Web Service Description Language (WSDL)
is a standard XML format for describing
+ web services. A WSDL file describes a
particular web service so that other
+ software applications can interface
with it.</p>
+ <p>WSDLs are generally publicly accessible and
provide enough
+ detail so that potential clients can
figure out how to
+ operate the service solely from reading
the WSDL file. If a
+ web service adds two integers and sends
back the result to
+ the client, the WSDL file will explain
how the integers
+ should be sent to the web service, and
how the resulting
+ sum will be returned to the requesting
client.</p>
+ </section>
+ <section><title>XML and SOAP</title>
+ <p>Extensible Markup Language (XML) messages
provide a common language by which
+ different applications can talk to one
another over a network. A client sends
+ an XML message containing a request to
+ the web service, and the web service
responds with an XML message containing
+ the results of the operation. In most
cases these XML messages are formatted
+ according to SOAP syntax.</p>
+ <p>Simple Object Access Protocol (SOAP) specifies a standard
format for applications
+ to call each other's methods and pass
data to one another. Note that web services
+ may communicate with XML messages that
are not SOAP-formatted. The types of
+ messages supported by a particular web
service are delineated in the serviceÃÂÂs
+ WSDL file.</p>
+ </section>
+ <section><title>Network Protocols</title>
+ <p>Web services receive requests and send
responses using widely used protocols such
+ as HyperText Transfer Protocol (HTTP)
and Java Message Service (JMS). A web
+ service may support more than one
protocol, and different methods on the web
+ service may support different
protocols. The protocols that a web service
+ supports are published in the WSDL
file.</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/>