Author: steveh Date: Wed Nov 17 09:10:02 2004 New Revision: 76151 Modified: incubator/beehive/site/build/site/wsm/tutorial_wsm.html incubator/beehive/site/src/documentation/content/xdocs/wsm/tutorial_wsm.xml Log: Fixing ws tutorial bug based on user feedback. (Removing (name="greetee") property from step 4.)
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 17 09:10:02 2004 @@ -353,7 +353,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-N10189">Compile and Redeploy the Web Service</a> +<a href="#Compile+and+Redeploy+the+Web+Service-N10192">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> @@ -490,22 +490,34 @@ <div style="margin-left: 0 ; border: 2px"> <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 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> +<p>If the application is already deployed on Tomcat (which may happen if this is your second time executing the tutorial), use the redeploy command below:</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="N10114"></a><a name="To+Run+the+Web+Service+Provided+in+the+Template"></a> +<a name="N1011C"></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> +<p>Visit the index.jsp page: <a target="_blank" href="http://localhost:8080/ws_tutorial/index.html";>http://localhost:8080/ws_tutorial/index.html</a>.</p> <p>Click the "Validate" link for an evaluation of the resources available to your web service. Note that you will need to download additional resources to take full advantage of Beehive web services. For example, for Axis to work properly with SOAP attachments, additional, external jars (activation.jar and mailapi.jar) are required. You will download those resources in later steps in the tutorial.</p> <p>Click the "WSDL" link to see the web service's WSDL. </p> -<p>Click the "sayHelloWorld()" to see a SOAP response from the web service's sayHelloWorld() method.</p> +<p>Click the "sayHelloWorld()" link to see a SOAP response from the web service's sayHelloWorld() method.</p> </div> </div> -<a name="N1012C"></a><a name="step_3"></a> +<a name="N10134"></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="N10132"></a><a name="Edit+the+JWS+File"></a> +<a name="N1013A"></a><a name="Edit+the+JWS+File"></a> <h4>Edit the JWS File</h4> <div style="margin-left: 0 ; border: 2px"> <p></p> @@ -536,18 +548,25 @@ }</pre> <p>The <span class="codefrag">@WebParam</span> you just added lets you pass a String parameter to the method over the web.</p> </div> -<a name="N10152"></a><a name="Compile+and+Redeploy+the+Web+Service"></a> +<a name="N1015A"></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> +<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="N1016A"></a><a name="Test+the+Parameterized+Method"></a> +<a name="N10172"></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> -<p>http://localhost:8080/ws_tutorial/template/Blank.jws?method=sayHello&greetee=Moon</p> +<p> +<a target="_blank" href="http://localhost:8080/ws_tutorial/template/Blank.jws?method=sayHello&greetee=Moon";>http://localhost:8080/ws_tutorial/template/Blank.jws?method=sayHello&greetee=Moon</a> +</p> <p>The following SOAP response appears in the browser:</p> <pre class="code"><soapenv:Envelope> <soapenv:Body> @@ -560,7 +579,7 @@ </div> </div> -<a name="N10180"></a><a name="Step+4%3A+Add+a+Non-Web+Invokable+Method"></a> +<a name="N1018A"></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. Code to add appears in bold type.</p> @@ -580,7 +599,7 @@ } @WebMethod - public String sayHello( @WebParam(name="greetee") String greetee ) + public String sayHello( @WebParam String greetee ) { if( greetee.equals("") ) { greetee = "World"; } @@ -595,18 +614,25 @@ } </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="N10197"></a><a name="Compile+and+Redeploy+the+Web+Service-N10189"></a> +<a name="N101A1"></a><a name="Compile+and+Redeploy+the+Web+Service-N10192"></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> +<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="N101AF"></a><a name="To+Test+the+Non-Web+Invokable+Method"></a> +<a name="N101B9"></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> -<p>http://localhost:8080/ws_tutorial/template/Blank.jws?method=sayNothingOverTheWeb</p> +<p> +<a target="_blank" href="http://localhost:8080/ws_tutorial/template/Blank.jws?method=sayNothingOverTheWeb";>http://localhost:8080/ws_tutorial/template/Blank.jws?method=sayNothingOverTheWeb</a> +</p> <p>The following SOAP response appears in the browser, indicating that the method sayNothingOverTheWeb() cannot be invoked through the web service (although it can be called by other methods within the web service).</p> <pre class="code"><soapenv:Envelope> <soapenv:Body> @@ -620,7 +646,7 @@ </soapenv:Body> </soapenv:Envelope> </pre> </div> -<a name="N101C4"></a><a name="Step+5%3A+Change+the+SOAP+Style"></a> +<a name="N101D0"></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> @@ -643,7 +669,7 @@ } @WebMethod - public String sayHello( @WebParam(name="greetee") String greetee ) + public String sayHello( @WebParam String greetee ) { if( greetee.equals("") ) { greetee = "World"; } @@ -656,17 +682,24 @@ return "Not for for Web consumption!"; } }</pre> -<a name="N101DE"></a><a name="Compile+and+Redeploy+the+Web+Service-N101CD"></a> +<a name="N101EA"></a><a name="Compile+and+Redeploy+the+Web+Service-N101D8"></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> +<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="N101ED"></a><a name="To+Test+the+Non-Web+Invokable+Method-N101DB"></a> +<a name="N101F9"></a><a name="To+Test+the+Non-Web+Invokable+Method-N101E6"></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> -<p>http://localhost:8080/ws_tutorial/template/Blank.jws?method=sayHelloWorld</p> +<p> +<a target="_blank" href="http://localhost:8080/ws_tutorial/template/Blank.jws?method=sayHelloWorld";>http://localhost:8080/ws_tutorial/template/Blank.jws?method=sayHelloWorld</a> +</p> <p>The following SOAP response appears in the browser. Compare the RPC style below with the DOC style above.</p> <pre class="code"><soapenv:Envelope> <soapenv: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 Wed Nov 17 09:10:02 2004 @@ -114,14 +114,26 @@ <title>Compile and Deploy the Web Service</title> <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> - <source>ant -f %BEEHIVE_HOME%\ant\buildWebapp.xml -Dwebapp.dir=C:\beehive_projects\ws_tutorial -Dcontext.path=ws_tutorial build.webapp deploy</source> + <source> ant + -f %BEEHIVE_HOME%\ant\buildWebapp.xml + -Dwebapp.dir=C:\beehive_projects\ws_tutorial + -Dcontext.path=ws_tutorial + build.webapp + deploy</source> + <p>If the application is already deployed on Tomcat (which may happen if this is your second time executing the tutorial), use the redeploy command below:</p> + <source> ant + -f %BEEHIVE_HOME%\ant\buildWebapp.xml + -Dwebapp.dir=C:\beehive_projects\ws_tutorial + -Dcontext.path=ws_tutorial + build.webapp + redeploy</source> </section> <section> <title>To Run the Web Service Provided in the Template</title> - <p>Visit the index.jsp page: <fork href="http://localhost:8080/ws_tutorial/index.jsp";>http://localhost:8080/ws_tutorial/index.jsp</fork>.</p> + <p>Visit the index.jsp page: <fork href="http://localhost:8080/ws_tutorial/index.html";>http://localhost:8080/ws_tutorial/index.html</fork>.</p> <p>Click the "Validate" link for an evaluation of the resources available to your web service. Note that you will need to download additional resources to take full advantage of Beehive web services. For example, for Axis to work properly with SOAP attachments, additional, external jars (activation.jar and mailapi.jar) are required. You will download those resources in later steps in the tutorial.</p> <p>Click the "WSDL" link to see the web service's WSDL. </p> - <p>Click the "sayHelloWorld()" to see a SOAP response from the web service's sayHelloWorld() method.</p> + <p>Click the "sayHelloWorld()" link to see a SOAP response from the web service's sayHelloWorld() method.</p> </section> </section> <section id="step_3"> @@ -159,13 +171,18 @@ <section> <title>Compile and Redeploy the Web Service</title> <p>At the command prompt, enter the following Ant command:</p> - <source>ant -f %BEEHIVE_HOME%\ant\buildWebapp.xml -Dwebapp.dir=C:\beehive_projects\ws_tutorial -Dcontext.path=ws_tutorial build.webapp redeploy</source> + <source> ant + -f %BEEHIVE_HOME%\ant\buildWebapp.xml + -Dwebapp.dir=C:\beehive_projects\ws_tutorial + -Dcontext.path=ws_tutorial + build.webapp + redeploy</source> <p>This Ant command compiles the app, undeploys it, and then deploys it. Calling <code>ant ... redeploy</code> is equivalent to calling <code>ant ... undeploy deploy</code>.</p> </section> <section> <title>Test the Parameterized Method</title> <p>Enter the following URL in the address bar of your browser. </p> - <p>http://localhost:8080/ws_tutorial/template/Blank.jws?method=sayHello&greetee=Moon</p> + <p><fork href="http://localhost:8080/ws_tutorial/template/Blank.jws?method=sayHello&greetee=Moon";>http://localhost:8080/ws_tutorial/template/Blank.jws?method=sayHello&greetee=Moon</fork></p> <p>The following SOAP response appears in the browser:</p> <source><