Author: steveh Date: Mon Nov 8 14:54:09 2004 New Revision: 56978 Modified: incubator/beehive/site/build/site/index.html incubator/beehive/site/build/site/jpetstore.html incubator/beehive/site/build/site/wsm/tutorial_wsm.html incubator/beehive/site/src/documentation/content/xdocs/jpetstore.xml incubator/beehive/site/src/documentation/content/xdocs/wsm/tutorial_wsm.xml Log: Fix for JIRA #42: WSM Needs Updating
Modified: incubator/beehive/site/build/site/index.html ============================================================================== --- incubator/beehive/site/build/site/index.html (original) +++ incubator/beehive/site/build/site/index.html Mon Nov 8 14:54:09 2004 @@ -276,20 +276,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 Mon Nov 8 14:54:09 2004 @@ -279,10 +279,16 @@ <a href="#Setup">Setup</a> </li> <li> -<a href="#Building%0A">Building</a> +<a href="#%28Optional%29+Copy+the+Petstore+Application+to+a+Project+Folder">(Optional) Copy the Petstore Application to a Project Folder</a> </li> <li> -<a href="#Deploying+and+Running%0A">Deploying and Running</a> +<a href="#Copy+the+Runtime+Resources+and+Compile%0A">Copy the Runtime Resources and Compile</a> +</li> +<li> +<a href="#Start+Tomcat">Start Tomcat</a> +</li> +<li> +<a href="#Deploying+to+Tomcat+and+Running%0A">Deploying to Tomcat and Running</a> </li> </ul> </li> @@ -302,104 +308,119 @@ <div style="margin-left: 0 ; border: 2px"> <p>The table below describes the functions of the most important files in the Petstore web application.</p> <table class="ForrestTable" cellspacing="1" cellpadding="4"> - + <tr> - -<th colspan="1" rowspan="1">Directory</th><th colspan="1" rowspan="1">Description</th> - + +<th colspan="1" rowspan="1">Directory</th> + <th colspan="1" rowspan="1">Description</th> + </tr> - + <tr> - -<td colspan="1" rowspan="1">petstoreWeb</td><td colspan="1" rowspan="1"></td> - + +<td colspan="1" rowspan="1">petstoreWeb</td> + <td colspan="1" rowspan="1"></td> + </tr> - + <tr> - -<td colspan="1" rowspan="1"> account</td><td colspan="1" rowspan="1">Page Flow (=Controller.jpf + JSP files) user interface for managing user accounts.</td> - + +<td colspan="1" rowspan="1"> account</td> + <td colspan="1" rowspan="1">Page Flow (=Controller.jpf + JSP files) user interface for managing user accounts.</td> + </tr> - + <tr> - -<td colspan="1" rowspan="1"> auth</td><td colspan="1" rowspan="1">Page Flow user interface for managing login and logout.</td> - + +<td colspan="1" rowspan="1"> auth</td> + <td colspan="1" rowspan="1">Page Flow user interface for managing login and logout.</td> + </tr> - + <tr> - -<td colspan="1" rowspan="1"> checkout</td><td colspan="1" rowspan="1">Page Flow user interface for managing the shopping cart.</td> - + +<td colspan="1" rowspan="1"> checkout</td> + <td colspan="1" rowspan="1">Page Flow user interface for managing the shopping cart.</td> + </tr> - + <tr> - -<td colspan="1" rowspan="1"> search</td><td colspan="1" rowspan="1">Page Flow user interface for searching the Petstore.</td> - + +<td colspan="1" rowspan="1"> search</td> + <td colspan="1" rowspan="1">Page Flow user interface for searching the Petstore.</td> + </tr> - + <tr> - -<td colspan="1" rowspan="1"> shop</td><td colspan="1" rowspan="1">Page Flow user interface for browsing the catalogue of pets.</td> - + +<td colspan="1" rowspan="1"> shop</td> + <td colspan="1" rowspan="1">Page Flow user interface for browsing the catalogue of pets.</td> + </tr> - + <tr> - -<td colspan="1" rowspan="1"> site</td><td colspan="1" rowspan="1">Contains the Petstore "skin", including the CSS file, HTML frameset, and template file.</td> - + +<td colspan="1" rowspan="1"> site</td> + <td colspan="1" rowspan="1">Contains the Petstore "skin", including the CSS file, HTML frameset, and template file.</td> + </tr> - + <tr> - -<td colspan="1" rowspan="1"> webappRoot</td><td colspan="1" rowspan="1">[todo]</td> - + +<td colspan="1" rowspan="1"> webappRoot</td> + <td colspan="1" rowspan="1">[todo]</td> + </tr> - + <tr> - -<td colspan="1" rowspan="1"> WEB-INF</td><td colspan="1" rowspan="1">Contains configuration files for deployment, validation, and security (web.xml).</td> - + +<td colspan="1" rowspan="1"> WEB-INF</td> + <td colspan="1" rowspan="1">Contains configuration files for deployment, validation, and security (web.xml).</td> + </tr> - + <tr> - -<td colspan="1" rowspan="1"> lib</td><td colspan="1" rowspan="1">JAR resources</td> - + +<td colspan="1" rowspan="1"> lib</td> + <td colspan="1" rowspan="1">JAR resources</td> + </tr> - + <tr> - -<td colspan="1" rowspan="1"> lib/PetstoreInventoryManager.jws</td><td colspan="1" rowspan="1">Web service for employee access to the store</td> - + +<td colspan="1" rowspan="1"> lib/PetstoreInventoryManager.jws</td> + <td colspan="1" rowspan="1">Web service for employee access to the store</td> + </tr> - + <tr> - -<td colspan="1" rowspan="1"> src/.../controls</td><td colspan="1" rowspan="1">Beehive Controls encapsulating different functionalities, including handling user account data, catalogue data, and order processing.</td> - + +<td colspan="1" rowspan="1"> src/.../controls</td> + <td colspan="1" rowspan="1">Beehive Controls encapsulating different functionalities, including handling user account data, catalogue data, and order processing.</td> + </tr> - + <tr> - -<td colspan="1" rowspan="1"> src/.../forms</td><td colspan="1" rowspan="1">Form Beans: each form bean is a server-side representation of an HTML form appearing in the user interface.</td> - + +<td colspan="1" rowspan="1"> src/.../forms</td> + <td colspan="1" rowspan="1">Form Beans: each form bean is a server-side representation of an HTML form appearing in the user interface.</td> + </tr> - + <tr> - -<td colspan="1" rowspan="1"> src/.../model</td><td colspan="1" rowspan="1">Java object classes used by the Controls.</td> - + +<td colspan="1" rowspan="1"> src/.../model</td> + <td colspan="1" rowspan="1">Java object classes used by the Controls.</td> + </tr> - + </table> </div> -<a name="N100EC"></a><a name="Running+the+PetStore+Sample+on+Tomcat+5"></a> +<a name="N100FB"></a><a name="Running+the+PetStore+Sample+on+Tomcat+5"></a> <h3>Running the PetStore Sample on Tomcat 5</h3> <div style="margin-left: 0 ; border: 2px"> -<a name="N100F2"></a><a name="Requirements"></a> +<a name="N10101"></a><a name="Requirements"></a> <h4>Requirements</h4> <div style="margin-left: 0 ; border: 2px"> <p>Beehive requires the following software to build and deploy @@ -415,7 +436,7 @@ </ul> </div> -<a name="N10108"></a><a name="Setup"></a> +<a name="N10117"></a><a name="Setup"></a> <h4>Setup</h4> <div style="margin-left: 0 ; border: 2px"> <p>In the descriptions below, <span class="codefrag">BEEHIVE_HOME</span> refers to the root of the @@ -434,23 +455,27 @@ <ul> <li> + <span class="codefrag">BEEHIVE_HOME</span> - + </li> <li> + <span class="codefrag">JAVA_HOME</span> - + </li> <li> + <span class="codefrag">ANT_HOME</span> - + </li> <li> + <span class="codefrag">CATALINA_HOME</span> - + </li> </ul> @@ -460,28 +485,33 @@ </p> </div> -<a name="N10148"></a><a name="Building%0A"></a> -<h4>Building +<a name="N1015B"></a><a name="%28Optional%29+Copy+the+Petstore+Application+to+a+Project+Folder"></a> +<h4>(Optional) Copy the Petstore Application to a Project Folder</h4> +<div style="margin-left: 0 ; border: 2px"> +<p>If you want to keep your Beehive distribution directory pristine, you might consider copying the <span class="codefrag">petstoreWeb</span> folder to another location before proceeding. The following instructions assume that you have copied the <span class="codefrag">petstoreWeb</span> folder into the directory <span class="codefrag">C:/beehive_projects</span>.</p> +</div> +<a name="N1016E"></a><a name="Copy+the+Runtime+Resources+and+Compile%0A"></a> +<h4>Copy the Runtime Resources and Compile </h4> <div style="margin-left: 0 ; border: 2px"> -<p>Note, if you are running on Unix, you will need to replace -<span class="codefrag">%BEEHIVE_HOME%</span> with <span class="codefrag">$BEEHIVE_HOME</span> below. -</p> -<p>To build the Petstore web application, run the following target: +<p>To copy the runtime JARs into the application source and compile, run the following target: </p> <pre class="code">ant -f %BEEHIVE_HOME%\ant\buildWebapp.xml - deploy.beehive.webapp.runtime build.webapp - -Dwebapp.dir=%BEEHIVE_HOME%\samples\petstoreWeb -</pre> -<p>This will copy the Beehive webapp runtime into -</p> -<pre class="code"> BEEHIVE_HOME/samples/petstoreWeb/WEB-INF/lib</pre> -<p>and run the Beehive webapp build process on the petstoreWeb application. - -</p> + -Dwebapp.dir=C:/beehive_projects/petstoreWeb + deploy.beehive.webapp.runtime + build.webapp</pre> +<p>This will copy the Beehive webapp runtime JARs into </p> +<pre class="code"> C:/beehive_projects/petstoreWeb/WEB-INF/lib</pre> +<p>and run the Beehive webapp build process on the petstoreWeb application.</p> </div> -<a name="N1016B"></a><a name="Deploying+and+Running%0A"></a> -<h4>Deploying and Running +<a name="N10188"></a><a name="Start+Tomcat"></a> +<h4>Start Tomcat</h4> +<div style="margin-left: 0 ; border: 2px"> +<p>To start Tomcat, run the following Ant command:</p> +<pre class="code">%CATALINA_HOME%\bin\startup.bat</pre> +</div> +<a name="N10197"></a><a name="Deploying+to+Tomcat+and+Running%0A"></a> +<h4>Deploying to Tomcat and Running </h4> <div style="margin-left: 0 ; border: 2px"> <p>Petstore can be deployed to a running version of Tomcat in one @@ -501,11 +531,19 @@ </p> <pre class="code">ant -f %BEEHIVE_HOME%\ant\buildWebapp.xml deploy - -Dwebapp.dir=%BEEHIVE_HOME%\samples\petstoreWeb + -Dwebapp.dir=C:\beehive_projects\petstoreWeb -Dcontext.path=petstoreWeb</pre> -<p>To hit the running application, use the URL: +<p>If petstoreWeb is already deployed on the server, run the undeploy target first.</p> +<pre class="code">ant + -f %BEEHIVE_HOME%\ant\buildWebapp.xml + undeploy + -Dwebapp.dir=C:\beehive_projects\petstoreWeb + -Dcontext.path=petstoreWeb</pre> +<p>To see the running application, visit the URL: +</p> +<p> +<a href=" http://localhost:8080/petstoreWeb/Controller.jpf";>http://localhost:8080/petstoreWeb/Controller.jpf</a> </p> -<pre class="code"> http://localhost:8080/petstoreWeb/Controller.jpf</pre> </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 Mon Nov 8 14:54:09 2004 @@ -310,10 +310,13 @@ <a href="#To+Copy+the+Web+Services+Application+Template">To Copy the Web Services Application Template</a> </li> <li> +<a href="#Copy+the+Runtime+JARs+into+the+Project+Folder">Copy the Runtime JARs into the Project Folder</a> +</li> +<li> <a href="#Examine+the+Blank.jws+Web+Service">Examine the Blank.jws Web Service</a> </li> <li> -<a href="#Copy+Runtime+JARs%2C+Compile%2C+and+Deploy+the+Web+Service">Copy Runtime JARs, Compile, and Deploy the Web Service</a> +<a href="#Compile+and+Deploy+the+Web+Service">Compile and Deploy the Web Service</a> </li> <li> <a href="#To+Run+the+Web+Service+Provided+in+the+Template">To Run the Web Service Provided in the Template</a> @@ -338,7 +341,7 @@ <a href="#Step+4%3A+Add+a+Non-Web+Invokable+Method">Step 4: Add a Non-Web Invokable Method</a> <ul class="minitoc"> <li> -<a href="#Compile+and+Redeploy+the+Web+Service-N101DF">Compile and Redeploy the Web Service</a> +<a href="#Compile+and+Redeploy+the+Web+Service-N101F6">Compile and Redeploy the Web Service</a> </li> <li> <a href="#To+Test+the+Non-Web+Invokable+Method">To Test the Non-Web Invokable Method</a> @@ -462,30 +465,41 @@ <p>In the <span class="codefrag">beehive_projects</span> directory, create a directory called ws_tutorial.</p> <p>Before proceeding, confirm that the following directory structure exists:</p> <pre class="code">C: - beehive_projects - ws_tutorial</pre> + beehive_projects + ws_tutorial</pre> </div> <a name="N100FF"></a><a name="To+Copy+the+Web+Services+Application+Template"></a> <h4>To Copy the Web Services Application Template</h4> <div style="margin-left: 0 ; border: 2px"> -<p>[todo: what is the wsm template? What is in there?]</p> -<p>Copy the <em>contents</em> of the folder</p> +<p>In this step you will copy the Web Services project template into your project folder. The project template contains a simple web service and a test JSP page.</p> +<p>Copy the contents of the folder</p> <pre class="code">BEEHIVE_HOME/samples/wsm-blank</pre> -<p>into</p> +<p>into your project folder</p> <pre class="code">C:/beehive_projects/ws_tutorial</pre> -<p>It important that you copy the <em>contents</em> of <span class="codefrag">wsm-blank</span>; do not copy the folder <span class="codefrag">wsm-blank</span> itself.</p> +<p>It is important that you copy the <em>contents</em> of <span class="codefrag">wsm-blank</span>; do not copy the folder <span class="codefrag">wsm-blank</span> itself.</p> <p>Before proceeding, confirm that the following directory structure exists:</p> <pre class="code">C: - beehive_projects - ws_tutorial - WEB-INF - happyaxis.jsp - index.html</pre> + beehive_projects + ws_tutorial + WEB-INF + happyaxis.jsp + index.html</pre> +</div> +<a name="N1012D"></a><a name="Copy+the+Runtime+JARs+into+the+Project+Folder"></a> +<h4>Copy the Runtime JARs into the Project Folder</h4> +<div style="margin-left: 0 ; border: 2px"> +<p>To copy the runtime JARs into your project, run the following Ant command:</p> +<pre class="code">ant + -Dwebapp.dir=C:\beehive_projects\ws_tutorial + -f ant\buildWebapp.xml + deploy.wsm.webapp.runtime</pre> +<p>This will copy the JAR files from <span class="codefrag">BEEHIVE_HOME/lib/wsm</span> into <span class="codefrag">C:/beehive_projects/ws_tutorial/WEB-INF/lib</span>.</p> </div> -<a name="N10130"></a><a name="Examine+the+Blank.jws+Web+Service"></a> +<a name="N10145"></a><a name="Examine+the+Blank.jws+Web+Service"></a> <h4>Examine the Blank.jws Web Service</h4> <div style="margin-left: 0 ; border: 2px"> -<p>Lets examine some web service code. In a text editor of your choice, open the file <span class="codefrag">C:/beehive_projects/ws_tutorial/WEB-INF/src/template/Blank.jws</span>. The file extension 'JWS' stands for Java Web Service. Beehive web services do not require the JWS extension, but it is recommended that you use JWS, especially when working in conjunction Beehive Controls and Page Flows.</p> +<p>You are now ready to compile and run your web service.</p> +<p>Before proceeding, lets examine the web service code. In a text editor of your choice, open the file <span class="codefrag">C:/beehive_projects/ws_tutorial/WEB-INF/src/template/Blank.jws</span>. The file extension 'JWS' stands for Java Web Service. Beehive web services do not require the JWS extension, but it is recommended that you use JWS, especially when working in conjunction Beehive Controls and Page Flows.</p> <pre class="code">package template; ... import javax.jws.WebMethod; @@ -508,14 +522,14 @@ <p> <span class="codefrag">@WebService</span> and <span class="codefrag">@WebMethod</span> are "metadata annotations", a.k.a. "annotations". Annotations allow you to set properties on Java classes and methods. They can be used to generate compile-time artifacts such as configuration files or Java classes (this is how many Beehive Control annotations work) or to determine some runtime behavior (this is how Beehive Web Service annotations work). <span class="codefrag">@WebService</span> annotates (or "decorates") the class Blank: this tells the runtime that Blank is a web service that listens for SOAP messages and responds in kind. <span class="codefrag">@WebMethod</span> annotates the method sayHelloWorld(): this tells the runtime that the method can be invoked over the web.</p> </div> -<a name="N10158"></a><a name="Copy+Runtime+JARs%2C+Compile%2C+and+Deploy+the+Web+Service"></a> -<h4>Copy Runtime JARs, Compile, and Deploy the Web Service</h4> +<a name="N10170"></a><a name="Compile+and+Deploy+the+Web+Service"></a> +<h4>Compile and Deploy the Web Service</h4> <div style="margin-left: 0 ; border: 2px"> -<p>In this step you will copy the runtime jars to your web service, copile the web service, and deploy it to Tomcat, all in one step.</p> +<p>In this step you will compile the web service and deploy it to Tomcat, all in one step.</p> <p>Run the following Ant command:</p> -<pre class="code">ant -f %BEEHIVE_HOME%\ant\buildWebapp.xml -Dwebapp.dir=C:\beehive_projects\ws_tutorial -Dcontext.path=ws_tutorial deploy.wsm.webapp.runtime build.webapp deploy</pre> +<pre class="code">ant -f %BEEHIVE_HOME%\ant\buildWebapp.xml -Dwebapp.dir=C:\beehive_projects\ws_tutorial -Dcontext.path=ws_tutorial build.webapp deploy</pre> </div> -<a name="N1016A"></a><a name="To+Run+the+Web+Service+Provided+in+the+Template"></a> +<a name="N10182"></a><a name="To+Run+the+Web+Service+Provided+in+the+Template"></a> <h4>To Run the Web Service Provided in the Template</h4> <div style="margin-left: 0 ; border: 2px"> <p>Visit the index.jsp page: <a target="_blank" href="http://localhost:8080/ws_tutorial/index.jsp";>http://localhost:8080/ws_tutorial/index.jsp</a>.</p> @@ -525,10 +539,10 @@ </div> </div> -<a name="N10182"></a><a name="step_3"></a> +<a name="N1019A"></a><a name="step_3"></a> <h3>Step 3: Add a Parameterized Method to the Web Service</h3> <div style="margin-left: 0 ; border: 2px"> -<a name="N10188"></a><a name="Edit+the+JWS+File"></a> +<a name="N101A0"></a><a name="Edit+the+JWS+File"></a> <h4>Edit the JWS File</h4> <div style="margin-left: 0 ; border: 2px"> <p></p> @@ -561,14 +575,14 @@ }</pre> <p>The <span class="codefrag">@WebParam</span> you just added lets you pass a String parameter to the method over the web. The <span class="codefrag">name="greetee"</span> attribute is optional. If you do not explicitly specify a <span class="codefrag">name</span> attribute, the parameter will take the default name <span class="codefrag">str0</span> [<--- todo: verify].</p> </div> -<a name="N101AB"></a><a name="Compile+and+Redeploy+the+Web+Service"></a> +<a name="N101C3"></a><a name="Compile+and+Redeploy+the+Web+Service"></a> <h4>Compile and Redeploy the Web Service</h4> <div style="margin-left: 0 ; border: 2px"> <p>At the command prompt, enter the following Ant command:</p> <pre class="code">ant -f %BEEHIVE_HOME%\ant\buildWebapp.xml -Dwebapp.dir=C:\beehive_projects\ws_tutorial -Dcontext.path=ws_tutorial build.webapp redeploy</pre> <p>This Ant command compiles the app, undeploys it, and then deploys it. Calling <span class="codefrag">ant ... redeploy</span> is equivalent to calling <span class="codefrag">ant ... undeploy deploy</span>.</p> </div> -<a name="N101C3"></a><a name="Test+the+Parameterized+Method"></a> +<a name="N101DB"></a><a name="Test+the+Parameterized+Method"></a> <h4>Test the Parameterized Method</h4> <div style="margin-left: 0 ; border: 2px"> <p>Enter the following URL in the address bar of your browser. </p> @@ -585,7 +599,7 @@ </div> </div> -<a name="N101D9"></a><a name="Step+4%3A+Add+a+Non-Web+Invokable+Method"></a> +<a name="N101F1"></a><a name="Step+4%3A+Add+a+Non-Web+Invokable+Method"></a> <h3>Step 4: Add a Non-Web Invokable Method</h3> <div style="margin-left: 0 ; border: 2px"> <p>Edit the file <span class="codefrag">C:/beehive_projects/ws_tutorial/WEB-INF/src/template/Blank.jws</span> so it appears as follows.</p> @@ -622,14 +636,14 @@ } </pre> <p>Note that the method added, sayNothingOverTheWeb(), does not have the annotation @WebMethod, indicating that it cannot be invoked by SOAP messages over the web.</p> -<a name="N101ED"></a><a name="Compile+and+Redeploy+the+Web+Service-N101DF"></a> +<a name="N10205"></a><a name="Compile+and+Redeploy+the+Web+Service-N101F6"></a> <h4>Compile and Redeploy the Web Service</h4> <div style="margin-left: 0 ; border: 2px"> <p>At the command prompt, enter the following Ant command:</p> <pre class="code">ant -f %BEEHIVE_HOME%\ant\buildWebapp.xml -Dwebapp.dir=C:\beehive_projects\ws_tutorial -Dcontext.path=ws_tutorial build.webapp redeploy</pre> <p>This Ant command compiles the app, undeploys it, and then deploys it. Calling <span class="codefrag">ant ... redeploy</span> is equivalent to calling <span class="codefrag">ant ... undeploy deploy</span>.</p> </div> -<a name="N10205"></a><a name="To+Test+the+Non-Web+Invokable+Method"></a> +<a name="N1021D"></a><a name="To+Test+the+Non-Web+Invokable+Method"></a> <h4>To Test the Non-Web Invokable Method</h4> <div style="margin-left: 0 ; border: 2px"> <p>Enter the following URL in the address bar of your browser. </p> @@ -647,7 +661,7 @@ </soapenv:Body> </soapenv:Envelope> </pre> </div> -<a name="N1021A"></a><a name="Step+5%3A+Change+the+SOAP+Style"></a> +<a name="N10232"></a><a name="Step+5%3A+Change+the+SOAP+Style"></a> <h4>Step 5: Change the SOAP Style</h4> <div style="margin-left: 0 ; border: 2px"> <p>The default SOAP style for JSR-181 web services is DOC-literal. In this step you will change the style to RPC-encoded.</p> @@ -685,13 +699,13 @@ return "Not for for Web consumption!"; } }</pre> -<a name="N1022E"></a><a name="Compile+and+Redeploy+the+Web+Service-N1021D"></a> +<a name="N10246"></a><a name="Compile+and+Redeploy+the+Web+Service-N10234"></a> <h5>Compile and Redeploy the Web Service</h5> <div style="margin-left: 0 ; border: 2px"> <p>At the command prompt, enter the following Ant command:</p> <pre class="code">ant -f %BEEHIVE_HOME%\ant\buildWebapp.xml -Dwebapp.dir=C:\beehive_projects\ws_tutorial -Dcontext.path=ws_tutorial build.webapp redeploy</pre> </div> -<a name="N1023D"></a><a name="To+Test+the+Non-Web+Invokable+Method-N1022B"></a> +<a name="N10255"></a><a name="To+Test+the+Non-Web+Invokable+Method-N10242"></a> <h5>To Test the Non-Web Invokable Method</h5> <div style="margin-left: 0 ; border: 2px"> <p>Enter the following URL in the address bar of your browser. </p> Modified: incubator/beehive/site/src/documentation/content/xdocs/jpetstore.xml ============================================================================== --- incubator/beehive/site/src/documentation/content/xdocs/jpetstore.xml (original) +++ incubator/beehive/site/src/documentation/content/xdocs/jpetstore.xml Mon Nov 8 14:54:09 2004 @@ -9,59 +9,74 @@ <title>Introduction</title> <p>The Petstore sample demonstrates how to integrate all three Beehive technologies (Page Flows, Controls and Web Services) in one application.</p> <p>The Page Flows provide customers with web access to the Petstore. There are separate Page Flows for different customer activities: the 'shop' Page Flow (located at: <code>petstoreWeb/shop/</code>) lets users browse the catalog of pets, the 'checkout' Page Flow (petstoreWeb/checkout) lets users purchase selected items from a shopping cart, etc.</p> - <p>The Web Service provides employee access to the Petstore. Through the web service (located at <code>petstoreWeb/WEB-INF/src/PetstoreInventoryManager.jws</code>) employees can update the current inventory and prices displayed to customers through the web site. A Swing client for the web service is provided in the sample <link href="http://incubator.apache.org/beehive/wsm/sample_Dashboard.html";>Petstore Dashboard</link>. </p> - <p>Most of the Page Flows have associated Control files (located at: <code>petstoreWeb/WEB-INF/src/org/apache/beehive/samples/petstore/controls/</code>). The Controls handle the backend data traffic and encupsulate the operations of the web application, such as retrieving data from a database and handling user orders.</p> + <p>The Web Service provides employee access to the Petstore. Through the web service (located at <code>petstoreWeb/WEB-INF/src/PetstoreInventoryManager.jws</code>) employees can update the current inventory and prices displayed to customers through the web site. A Swing client for the web service is provided in the sample <link href="http://incubator.apache.org/beehive/wsm/sample_Dashboard.html";>Petstore Dashboard</link>. </p> + <p>Most of the Page Flows have associated Control files (located at: <code>petstoreWeb/WEB-INF/src/org/apache/beehive/samples/petstore/controls/</code>). The Controls handle the backend data traffic and encupsulate the operations of the web application, such as retrieving data from a database and handling user orders.</p> </section> <section> <title>Petstore Directory Structure</title> - <p>The table below describes the functions of the most important files in the Petstore web application.</p> - <table> - <tr> - <th>Directory</th><th>Description</th> - </tr> - <tr> - <td>petstoreWeb</td><td></td> - </tr> - <tr> - <td> account</td><td>Page Flow (=Controller.jpf + JSP files) user interface for managing user accounts.</td> - </tr> - <tr> - <td> auth</td><td>Page Flow user interface for managing login and logout.</td> - </tr> - <tr> - <td> checkout</td><td>Page Flow user interface for managing the shopping cart.</td> - </tr> - <tr> - <td> search</td><td>Page Flow user interface for searching the Petstore.</td> - </tr> - <tr> - <td> shop</td><td>Page Flow user interface for browsing the catalogue of pets.</td> - </tr> - <tr> - <td> site</td><td>Contains the Petstore "skin", including the CSS file, HTML frameset, and template file.</td> - </tr> - <tr> - <td> webappRoot</td><td>[todo]</td> - </tr> - <tr> - <td> WEB-INF</td><td>Contains configuration files for deployment, validation, and security (web.xml).</td> - </tr> - <tr> - <td> lib</td><td>JAR resources</td> - </tr> - <tr> - <td> lib/PetstoreInventoryManager.jws</td><td>Web service for employee access to the store</td> - </tr> - <tr> - <td> src/.../controls</td><td>Beehive Controls encapsulating different functionalities, including handling user account data, catalogue data, and order processing.</td> - </tr> - <tr> - <td> src/.../forms</td><td>Form Beans: each form bean is a server-side representation of an HTML form appearing in the user interface.</td> - </tr> - <tr> - <td> src/.../model</td><td>Java object classes used by the Controls.</td> - </tr> -</table> + <p>The table below describes the functions of the most important files in the Petstore web application.</p> + <table> + <tr> + <th>Directory</th> + <th>Description</th> + </tr> + <tr> + <td>petstoreWeb</td> + <td/> + </tr> + <tr> + <td> account</td> + <td>Page Flow (=Controller.jpf + JSP files) user interface for managing user accounts.</td> + </tr> + <tr> + <td> auth</td> + <td>Page Flow user interface for managing login and logout.</td> + </tr> + <tr> + <td> checkout</td> + <td>Page Flow user interface for managing the shopping cart.</td> + </tr> + <tr> + <td> search</td> + <td>Page Flow user interface for searching the Petstore.</td> + </tr> + <tr> + <td> shop</td> + <td>Page Flow user interface for browsing the catalogue of pets.</td> + </tr> + <tr> + <td> site</td> + <td>Contains the Petstore "skin", including the CSS file, HTML frameset, and template file.</td> + </tr> + <tr> + <td> webappRoot</td> + <td>[todo]</td> + </tr> + <tr> + <td> WEB-INF</td> + <td>Contains configuration files for deployment, validation, and security (web.xml).</td> + </tr> + <tr> + <td> lib</td> + <td>JAR resources</td> + </tr> + <tr> + <td> lib/PetstoreInventoryManager.jws</td> + <td>Web service for employee access to the store</td> + </tr> + <tr> + <td> src/.../controls</td> + <td>Beehive Controls encapsulating different functionalities, including handling user account data, catalogue data, and order processing.</td> + </tr> + <tr> + <td> src/.../forms</td> + <td>Form Beans: each form bean is a server-side representation of an HTML form appearing in the user interface.</td> + </tr> + <tr> + <td> src/.../model</td> + <td>Java object classes used by the Controls.</td> + </tr> + </table> </section> <section> <title>Running the PetStore Sample on Tomcat 5</title> @@ -92,14 +107,18 @@ shell with some required environment variables including: </p> <ul> - <li><code>BEEHIVE_HOME</code> -</li> - <li><code>JAVA_HOME</code> -</li> - <li><code>ANT_HOME</code> -</li> - <li><code>CATALINA_HOME</code> -</li> + <li> + <code>BEEHIVE_HOME</code> + </li> + <li> + <code>JAVA_HOME</code> + </li> + <li> + <code>ANT_HOME</code> + </li> + <li> + <code>CATALINA_HOME</code> + </li> </ul> <p>Running <code>beehiveUser.cmd</code> will also add Java and Ant to your PATH. </p> @@ -107,26 +126,29 @@ </p> </section> <section> - <title>Building + <title>(Optional) Copy the Petstore Application to a Project Folder</title> + <p>If you want to keep your Beehive distribution directory pristine, you might consider copying the <code>petstoreWeb</code> folder to another location before proceeding. The following instructions assume that you have copied the <code>petstoreWeb</code> folder into the directory <code>C:/beehive_projects</code>.</p> + </section> + <section> + <title>Copy the Runtime Resources and Compile </title> - <p>Note, if you are running on Unix, you will need to replace -<code>%BEEHIVE_HOME%</code> with <code>$BEEHIVE_HOME</code> below. -</p> - <p>To build the Petstore web application, run the following target: + <p>To copy the runtime JARs into the application source and compile, run the following target: </p> <source>ant -f %BEEHIVE_HOME%\ant\buildWebapp.xml - deploy.beehive.webapp.runtime build.webapp - -Dwebapp.dir=%BEEHIVE_HOME%\samples\petstoreWeb -</source> - <p>This will copy the Beehive webapp runtime into -</p> - <source> BEEHIVE_HOME/samples/petstoreWeb/WEB-INF/lib</source> - <p>and run the Beehive webapp build process on the petstoreWeb application. - -</p> + -Dwebapp.dir=C:/beehive_projects/petstoreWeb + deploy.beehive.webapp.runtime + build.webapp</source> + <p>This will copy the Beehive webapp runtime JARs into </p> + <source> C:/beehive_projects/petstoreWeb/WEB-INF/lib</source> + <p>and run the Beehive webapp build process on the petstoreWeb application.</p> + </section> + <section> + <title>Start Tomcat</title> + <p>To start Tomcat, run the following Ant command:</p> + <source>%CATALINA_HOME%\bin\startup.bat</source> </section> <section> - <title>Deploying and Running + <title>Deploying to Tomcat and Running </title> <p>Petstore can be deployed to a running version of Tomcat in one of two ways:</p> @@ -144,11 +166,17 @@ </p> <source>ant -f %BEEHIVE_HOME%\ant\buildWebapp.xml deploy - -Dwebapp.dir=%BEEHIVE_HOME%\samples\petstoreWeb + -Dwebapp.dir=C:\beehive_projects\petstoreWeb -Dcontext.path=petstoreWeb</source> - <p>To hit the running application, use the URL: + <p>If petstoreWeb is already deployed on the server, run the undeploy target first.</p> + <source>ant + -f %BEEHIVE_HOME%\ant\buildWebapp.xml + undeploy + -Dwebapp.dir=C:\beehive_projects\petstoreWeb + -Dcontext.path=petstoreWeb</source> + <p>To see the running application, visit the URL: </p> - <source> http://localhost:8080/petstoreWeb/Controller.jpf</source> + <p> <link href=" http://localhost:8080/petstoreWeb/Controller.jpf";>http://localhost:8080/petstoreWeb/Controller.jpf</link></p> </section> </section> </body> Modified: incubator/beehive/site/src/documentation/content/xdocs/wsm/tutorial_wsm.xml ============================================================================== --- incubator/beehive/site/src/documentation/content/xdocs/wsm/tutorial_wsm.xml (original) +++ incubator/beehive/site/src/documentation/content/xdocs/wsm/tutorial_wsm.xml Mon Nov 8 14:54:09 2004 @@ -96,29 +96,39 @@ <p>On your C: drive, create a directory called <code>beehive_projects</code>.</p> <p>In the <code>beehive_projects</code> directory, create a directory called ws_tutorial.</p> <p>Before proceeding, confirm that the following directory structure exists:</p> - <source>C: - beehive_projects - ws_tutorial</source> + <source>C: + beehive_projects + ws_tutorial</source> </section> <section> <title>To Copy the Web Services Application Template</title> - <p>[todo: what is the wsm template? What is in there?]</p> - <p>Copy the <em>contents</em> of the folder</p> + <p>In this step you will copy the Web Services project template into your project folder. The project template contains a simple web service and a test JSP page.</p> + <p>Copy the contents of the folder</p> <source>BEEHIVE_HOME/samples/wsm-blank</source> - <p>into</p> + <p>into your project folder</p> <source>C:/beehive_projects/ws_tutorial</source> - <p>It important that you copy the <em>contents</em> of <code>wsm-blank</code>; do not copy the folder <code>wsm-blank</code> itself.</p> + <p>It is important that you copy the <em>contents</em> of <code>wsm-blank</code>; do not copy the folder <code>wsm-blank</code> itself.</p> <p>Before proceeding, confirm that the following directory structure exists:</p> <source>C: - beehive_projects - ws_tutorial - WEB-INF - happyaxis.jsp - index.html</source> + beehive_projects + ws_tutorial + WEB-INF + happyaxis.jsp + index.html</source> + </section> + <section> + <title>Copy the Runtime JARs into the Project Folder</title> + <p>To copy the runtime JARs into your project, run the following Ant command:</p> +<source>ant + -Dwebapp.dir=C:\beehive_projects\ws_tutorial + -f ant\buildWebapp.xml + deploy.wsm.webapp.runtime</source> + <p>This will copy the JAR files from <code>BEEHIVE_HOME/lib/wsm</code> into <code>C:/beehive_projects/ws_tutorial/WEB-INF/lib</code>.</p> </section> <section> <title>Examine the Blank.jws Web Service</title> - <p>Lets examine some web service code. In a text editor of your choice, open the file <code>C:/beehive_projects/ws_tutorial/WEB-INF/src/template/Blank.jws</code>. The file extension 'JWS' stands for Java Web Service. Beehive web services do not require the JWS extension, but it is recommended that you use JWS, especially when working in conjunction Beehive Controls and Page Flows.</p> + <p>You are now ready to compile and run your web service.</p> + <p>Before proceeding, lets examine the web service code. In a text editor of your choice, open the file <code>C:/beehive_projects/ws_tutorial/WEB-INF/src/template/Blank.jws</code>. The file extension 'JWS' stands for Java Web Service. Beehive web services do not require the JWS extension, but it is recommended that you use JWS, especially when working in conjunction Beehive Controls and Page Flows.</p> <source><