Author: benlc
Date: 2010-11-01 08:39:23 -0400 (Mon, 01 Nov 2010)
New Revision: 26156
Added:
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/images/image-jbt-test_resteasy_JAX-RS_01.png
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/images/image-jbt-test_resteasy_JAX-RS_02.png
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/images/image-jbt-test_resteasy_JAX-RS_03.png
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/images/image-jbt-test_resteasy_JAX-RS_04.png
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/images/image-jbt-test_resteasy_JAX-RS_05.png
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/images/image-jbt-test_resteasy_JAX-RS_06.png
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/images/image-jbt-test_resteasy_JAX-RS_07.png
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/images/image-jbt-test_resteasy_JAX-RS_08.png
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/images/image-jbt-test_resteasy_JAX-RS_09.png
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/images/image-jbt-test_resteasy_JAX-RS_10.png
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/images/image-jbt-test_restfulsample_JAX-RS_01.png
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/images/image-jbt-test_restfulsample_JAX-RS_02.png
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/images/image-jbt-test_restfulsample_JAX-RS_03.png
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/introduction.xml
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/preliminaries-web_service_test_view.xml
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/proc-jbt-test_resteasy_JAX-RS.xml
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/proc-jbt-test_restfulsample_JAX-RS.xml
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/proc-jbt-test_web_service_prelim.xml
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/resteasy_sample_project-web_service_test_view.xml
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/restfulsample_project-web_service_test_view.xml
Modified:
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/Author_Group.xml
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/JBoss_Web_Services_User_Guide.xml
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/proc-jbt-test_JAX-RS.xml
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/proc-jbt-test_JAX-WS.xml
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/sample_web_service_wizards.xml
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/testing_a_restful_web_service-web_service_test_view.xml
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/web_service_test_view.xml
Log:
'committing latest material'
Modified:
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/Author_Group.xml
===================================================================
---
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/Author_Group.xml 2010-11-01
11:47:47 UTC (rev 26155)
+++
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/Author_Group.xml 2010-11-01
12:39:23 UTC (rev 26156)
@@ -5,13 +5,22 @@
]>
<authorgroup>
<author>
- <firstname>Dude</firstname>
- <surname>McPants</surname>
+ <firstname>Brian </firstname>
+ <surname>Fitzpatrick</surname>
<affiliation>
- <orgname>Somewhere</orgname>
- <orgdiv>Someone</orgdiv>
+ <orgname>Red Hat</orgname>
+ <orgdiv></orgdiv>
</affiliation>
- <email>Dude.McPants(a)example.com</email>
+ <email>bfitzpatrick(a)redhat.com</email>
</author>
+ <author>
+ <firstname>Ben </firstname>
+ <surname>Clare</surname>
+ <affiliation>
+ <orgname>Red Hat</orgname>
+ <orgdiv></orgdiv>
+ </affiliation>
+ <email>bclare(a)redhat.com</email>
+ </author>
</authorgroup>
Modified:
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/JBoss_Web_Services_User_Guide.xml
===================================================================
---
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/JBoss_Web_Services_User_Guide.xml 2010-11-01
11:47:47 UTC (rev 26155)
+++
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/JBoss_Web_Services_User_Guide.xml 2010-11-01
12:39:23 UTC (rev 26156)
@@ -6,6 +6,7 @@
<book>
<xi:include href="Book_Info.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="Preface.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="introduction.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="sample_web_service_wizards.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="resteasy_simple_project_example.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="web_service_test_view.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
Added:
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/images/image-jbt-test_resteasy_JAX-RS_01.png
===================================================================
(Binary files differ)
Property changes on:
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/images/image-jbt-test_resteasy_JAX-RS_01.png
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added:
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/images/image-jbt-test_resteasy_JAX-RS_02.png
===================================================================
(Binary files differ)
Property changes on:
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/images/image-jbt-test_resteasy_JAX-RS_02.png
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added:
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/images/image-jbt-test_resteasy_JAX-RS_03.png
===================================================================
(Binary files differ)
Property changes on:
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/images/image-jbt-test_resteasy_JAX-RS_03.png
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added:
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/images/image-jbt-test_resteasy_JAX-RS_04.png
===================================================================
(Binary files differ)
Property changes on:
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/images/image-jbt-test_resteasy_JAX-RS_04.png
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added:
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/images/image-jbt-test_resteasy_JAX-RS_05.png
===================================================================
(Binary files differ)
Property changes on:
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/images/image-jbt-test_resteasy_JAX-RS_05.png
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added:
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/images/image-jbt-test_resteasy_JAX-RS_06.png
===================================================================
(Binary files differ)
Property changes on:
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/images/image-jbt-test_resteasy_JAX-RS_06.png
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added:
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/images/image-jbt-test_resteasy_JAX-RS_07.png
===================================================================
(Binary files differ)
Property changes on:
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/images/image-jbt-test_resteasy_JAX-RS_07.png
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added:
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/images/image-jbt-test_resteasy_JAX-RS_08.png
===================================================================
(Binary files differ)
Property changes on:
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/images/image-jbt-test_resteasy_JAX-RS_08.png
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added:
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/images/image-jbt-test_resteasy_JAX-RS_09.png
===================================================================
(Binary files differ)
Property changes on:
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/images/image-jbt-test_resteasy_JAX-RS_09.png
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added:
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/images/image-jbt-test_resteasy_JAX-RS_10.png
===================================================================
(Binary files differ)
Property changes on:
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/images/image-jbt-test_resteasy_JAX-RS_10.png
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added:
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/images/image-jbt-test_restfulsample_JAX-RS_01.png
===================================================================
(Binary files differ)
Property changes on:
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/images/image-jbt-test_restfulsample_JAX-RS_01.png
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added:
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/images/image-jbt-test_restfulsample_JAX-RS_02.png
===================================================================
(Binary files differ)
Property changes on:
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/images/image-jbt-test_restfulsample_JAX-RS_02.png
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added:
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/images/image-jbt-test_restfulsample_JAX-RS_03.png
===================================================================
(Binary files differ)
Property changes on:
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/images/image-jbt-test_restfulsample_JAX-RS_03.png
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added:
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/introduction.xml
===================================================================
---
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/introduction.xml
(rev 0)
+++
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/introduction.xml 2010-11-01
12:39:23 UTC (rev 26156)
@@ -0,0 +1,42 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "JBoss_Web_Services_User_Guide.ent">
+%BOOK_ENTITIES;
+]>
+<chapter id="introduction">
+ <title>Introduction</title>
+ <para>
+ A new tool has been incorporated into <application>JBoss Developer
Studio</application> to enable the web service testing. The <guilabel>Web
Service Tester</guilabel> is designed to provide basic web service testing
capabilities and simplify common development tasks.
+ </para>
+ <para>
+ The requirements for the tool to test a Java API for XML Web Services
(<acronym>JAX-WS</acronym>) web service included the ability to create a
sample SOAP request message by selecting an operation in a WSDL file. Additional
requirements were the ability to invoke the service, passing the request message, and
viewing the response headers and body.
+ </para>
+ <para>
+ For a Java API for RESTful Web Services (<acronym>JAX-WS</acronym>) web
service the requirements included the ability to use REST and standard HTTP operations to
interact with a RESTful web service on a framework like RestEasy. The ability to see the
response headers and any response message returned were also important requirements.
+ </para>
+ <para>
+ The following chapters discuss the use of the <guilabel>Web Service
Tester</guilabel> view including:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Setting up a dynamic web project necessary for the creation of web services.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Using the Sample Web Service wizards.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Setting up the <application>RESTEasy</application>
<guilabel>Project Example</guilabel>.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Outlining the features and use of the <guilabel>Web Service
Tester</guilabel> view using the generated projects.
+ </para>
+ </listitem>
+ </itemizedlist>
+</chapter>
\ No newline at end of file
Added:
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/preliminaries-web_service_test_view.xml
===================================================================
---
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/preliminaries-web_service_test_view.xml
(rev 0)
+++
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/preliminaries-web_service_test_view.xml 2010-11-01
12:39:23 UTC (rev 26156)
@@ -0,0 +1,12 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "JBoss_Web_Services_User_Guide.ent">
+%BOOK_ENTITIES;
+]>
+<section
id="web_service_test_view-testing_a_restful_web_service-preliminaries">
+ <title>Preliminaries</title>
+ <para>
+ The following procedure describes the steps to perform before testing a web service.
+ </para>
+ <xi:include href="proc-jbt-test_web_service_prelim.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
+</section>
\ No newline at end of file
Modified:
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/proc-jbt-test_JAX-RS.xml
===================================================================
---
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/proc-jbt-test_JAX-RS.xml 2010-11-01
11:47:47 UTC (rev 26155)
+++
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/proc-jbt-test_JAX-RS.xml 2010-11-01
12:39:23 UTC (rev 26156)
@@ -1,150 +1,282 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM
"JBoss_Tools_Reference_Guide_Template.ent">
+<!ENTITY % BOOK_ENTITIES SYSTEM "JBoss_Web_Services_User_Guide.ent">
%BOOK_ENTITIES;
]>
-<procedure id="proc-jbt-test_JAX-RS">
- <title>Testing a JAX-RS web service</title>
- <step><title>Preliminary steps</title>
+<procedure id="proc-jbt-test_resteasy_JAX-RS">
+ <title>Testing a JAX-RS web service- POST and GET requests</title>
+ <step>
+ <substeps>
+ <step><title>Query the available options</title>
<para>
- Prior to testing a JAX-RS web service:
+ Following the preliminary steps described in <xref
linkend="proc-jbt-test_web_service_prelim"/>, select the
<guilabel>OPTIONS</guilabel> method from the operations text area.
</para>
- <substeps>
- <step>
- <para>
- The <guilabel>Web Service Test View</guilabel> should be opened as
described in <xref
linkend="proc-jbt-web_service_test_view"></xref>;
- </para>
- <formalpara><title>Result:</title>
+ </step>
+ <step>
+ <para>
+ Enter the url of the web service in the editable drop-down list
<uri>http://localhost:8080/simple/rest-services/customers</uri>.
+ </para>
+ </step>
+ <step>
+ <para>
+ Click the <guilabel>Invoke</guilabel> button
+ </para>
+ <formalpara><title>Result:</title>
<para>
- The <guilabel>Web Service Test View</guilabel> displays.
+ The <guilabel>Response Headers</guilabel> text area indicates that
the allowed options are <code>[POST, OPTIONS]</code> as shown in <xref
linkend="figure-jbt-test_resteasy_JAX-RS_02"/>.
</para>
</formalpara>
- <figure id="proc-jbt-test_JAX-RS_01">
- <title>Web Service Test View</title>
+ <figure id="figure-jbt-test_resteasy_JAX-RS_02">
+ <title>JAX-RS RESTEasy project Body Text</title>
<mediaobject>
<imageobject>
- <imagedata fileref="images/image-jbt-test_JAX-RS_01.png"
format="PNG"/>
+ <imagedata fileref="images/image-jbt-test_resteasy_JAX-RS_02.png"
format="PNG"/>
</imageobject>
<textobject>
- <para>Web Service Test View</para>
+ <para>JAX-WS RESTEasy project Body Text</para>
</textobject>
</mediaobject>
</figure>
- </step>
- <step>
- <para>
- A JAX-WS web service has been deployed to the
<filename>deploy</filename> directory of the chosen server profile as
described in <xref linkend="proc-jbt-export-war_export"/>;
- </para>
- </step>
- <step>
- <para>
- The server has been started with <command>run.sh -c
<profile></command>
- </para>
- </step>
- </substeps>
<para>&HORIZ_LINE;</para>
+ </step>
+ </substeps>
</step>
+ <step><title>Test the POST option</title>
+ <substeps>
<step>
<para>
- Select <guilabel>JAX-WS</guilabel> from the available combo box
options
+ Select <guilabel>POST</guilabel> method in the the operations drop-down
list.
</para>
+ </step>
+ <step>
+ <para>
+ We will post xml data to this particular web service. Complete the header details
by entering <code>content-type=application/xml</code> in the text area and
click <guibutton>Add</guibutton> to add it to the
<guilabel>Headers</guilabel> list.
+ </para>
<formalpara><title>Result:</title>
<para>
- The SOAP message details are displayed in the <guilabel>Body
Text</guilabel> textbox of the <guilabel>Request Details</guilabel>
panel .
+ The <guilabel>content-type</guilabel> is added to the
<guilabel>Headers</guilabel> list as shown in <xref
linkend="figure-jbt-test_resteasy_JAX-RS_03"/>.
</para>
</formalpara>
- <figure id="figure-jbt-test_JAX-RS_02">
- <title>JAX-WS Body Text</title>
+ <figure id="figure-jbt-test_resteasy_JAX-RS_03">
+ <title>content-type header</title>
<mediaobject>
<imageobject>
- <imagedata fileref="images/image-jbt-test_JAX-RS_02.png"
format="PNG"/>
+ <imagedata fileref="images/image-jbt-test_resteasy_JAX-RS_03.png"
format="PNG"/>
</imageobject>
<textobject>
- <para>JAX-WS Body Text</para>
+ <para>JAX-WS RESTEasy project Body Text</para>
</textobject>
</mediaobject>
- </figure>
+ </figure>
<para>&HORIZ_LINE;</para>
+ </step>
+ <step><title>Enter customer details</title>
+ <para>
+ Enter the customer details in the <guilabel>Body Text</guilabel> area
as displayed in <xref linkend="figure-jbt-test_resteasy_JAX-RS_04"/>.
+ </para>
+ <figure id="figure-jbt-test_resteasy_JAX-RS_04">
+ <title>Customer data</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/image-jbt-test_resteasy_JAX-RS_04.png"
format="PNG"/>
+ </imageobject>
+ <textobject>
+ <para>Customer data</para>
+ </textobject>
+ </mediaobject>
+ </figure>
+ <para>&HORIZ_LINE;</para>
+ </step>
+ <step>
+ <para>Click the <guibutton>Invoke</guibutton> button.</para>
+ <formalpara><title>Result:</title>
+ <para>
+ The <guilabel>Response Headers</guilabel> area indicated that a
record was created and lists the location as
<uri>http://localhost:8080/simple/rest-services/cuntomers/1</uri> as shown in
<xref linkend="figure-jbt-test_resteasy_JAX-RS_05"/>.
+ </para>
+ </formalpara>
+ <figure id="figure-jbt-test_resteasy_JAX-RS_05">
+ <title>Customer added</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/image-jbt-test_resteasy_JAX-RS_05.png"
format="PNG"/>
+ </imageobject>
+ <textobject>
+ <para>Customer added</para>
+ </textobject>
+ </mediaobject>
+ </figure>
+ <para>The console also indicates the successful creation of the customer:
<code>10:44:33,846 INFO [STDOUT] Created customer 1</code></para>
+ <para>&HORIZ_LINE;</para>
+ </step>
+ </substeps>
</step>
+
+ <step id="getStart"><title>Test the GET option</title>
+ <substeps>
<step>
<para>
- Enter the location of the WSDL file in the editable dropdown list. The location for
the <application>WebServiceSample</application> web service is <uri>
http://localhost:8080/WebServiceSample/HelloWorldResource</uri>
+ Select the <guilabel>GET</guilabel> method in the the operations
drop-down list.
</para>
- <para>&HORIZ_LINE;</para>
- </step>
- <step>
+ </step>
+ <step>
<para>
- Click the <guibutton>Invoke</guibutton> button
+ We will retrieve the record created in the previous step. Enter the url for the
record returned in the previous step
<uri>http://localhost:8080/simple/rest-services/customers/1</uri>
</para>
-
+ </step>
+ <step id="getFinish">
+ <para>
+ Click the <guibutton>Invoke</guibutton> button.
+ </para>
<formalpara><title>Result:</title>
<para>
- The <guilabel>Select WDSL</guilabel> dialog appears.
+ The <guilabel>Response Headers</guilabel> area indicates a
<code>[HTTP/1.1 200 OK]</code> response and the customer data is retrieved and
displayed in the <guilabel>Response Body</guilabel> area as shown in <xref
linkend="figure-jbt-test_resteasy_JAX-RS_06"/>.
</para>
</formalpara>
- <figure id="figure-jbt-test_JAX-RS_03">
- <title>Select WSDL</title>
+ <figure id="figure-jbt-test_resteasy_JAX-RS_06">
+ <title>GET response</title>
<mediaobject>
<imageobject>
- <imagedata fileref="images/image-jbt-test_JAX-RS_03.png"
format="PNG"/>
+ <imagedata fileref="images/image-jbt-test_resteasy_JAX-RS_06.png"
format="PNG"/>
</imageobject>
<textobject>
- <para>Select WSDL</para>
+ <para>GET response</para>
</textobject>
</mediaobject>
- </figure>
+ </figure>
<para>&HORIZ_LINE;</para>
- </step>
- <step>
- <title>Select the required service attributes</title>
+ </step>
+ </substeps>
+ </step>
+
+
+ <step><title>Test the PUT option</title>
+ <substeps>
+ <step>
<para>
- Select the <guilabel>Service</guilabel>,
<guibutton>Port</guibutton> and <guibutton>Operation</guibutton>
from the combo boxes and click <guibutton>OK</guibutton>
+ Editing a record is achieved by using the <guilabel>PUT</guilabel>
method. Select the <guilabel>PUT</guilabel> method in the operations
drop-down list.
</para>
+ </step>
+ <step>
+ <para>
+ Enter the url of the record to be edited
<uri>http://localhost:8080/simple/rest-services/customers/1</uri>
+ </para>
+ </step>
+ <step>
+ <para>
+ Enter the data in the <guilabel>Body Text</guilabel> area. Replace
the first-name with a different entry as in <xref
linkend="figure-jbt-test_resteasy_JAX-RS_07"/>
+ </para>
+ <figure id="figure-jbt-test_resteasy_JAX-RS_07">
+ <title>Updated customer data</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/image-jbt-test_resteasy_JAX-RS_07.png"
format="PNG"/>
+ </imageobject>
+ <textobject>
+ <para>Updated customer data</para>
+ </textobject>
+ </mediaobject>
+ </figure>
+ <para>&HORIZ_LINE;</para>
+ </step>
+ <step>
+ <para>
+ Ensure that the <code>content-type=application/xml</code> header is in
the <guilabel>Headers</guilabel> list.
+ </para>
+ </step>
+ <step>
+ <para>Click the <guibutton>Invoke</guibutton> button.</para>
<formalpara><title>Result:</title>
<para>
- The <soap:Body/> section of the SOAP message is filled with the
SayHello message details;
+ The <guilabel>Response Headers</guilabel> area indicates a No
Response (<code>[HTTP/1.1 204 No Content]</code>) <xref
linkend="figure-jbt-test_resteasy_JAX-RS_08"/>.
</para>
</formalpara>
- <figure id="figure-jbt-test_JAX-RS_04">
- <title>JBoss Tools Project Creation</title>
+ <figure id="figure-jbt-test_resteasy_JAX-RS_08">
+ <title>Response header following PUT</title>
<mediaobject>
<imageobject>
- <imagedata fileref="images/image-jbt-test_JAX-RS_04.png"
format="PNG"/>
+ <imagedata fileref="images/image-jbt-test_resteasy_JAX-RS_08.png"
format="PNG"/>
</imageobject>
<textobject>
- <para>The New Project Dialog.</para>
+ <para>Response header following PUT</para>
</textobject>
</mediaobject>
- </figure>
- <para>
- the response header details are returned;
- </para>
- <figure id="figure-jbt-test_JAX-RS_05">
- <title>JBoss Tools Project Creation</title>
+ </figure>
+ <para>In this instance, the console does not indicate an update was
performed, however, the console may provide useful information following an
operation.</para>
+ <para>&HORIZ_LINE;</para>
+ </step>
+ </substeps>
+ </step>
+ <step><title>Check the updated data with a GET</title>
+ <para>
+ Perform a GET operation by following the steps in <xref
linkend="getStart"/>.
+ </para>
+ <formalpara><title>Result:</title>
+ <para>
+ The <guilabel>Response Body</guilabel> area displays the updated
data.
+ </para>
+ </formalpara>
+ <figure id="figure-jbt-test_resteasy_JAX-RS_09">
+ <title>Custmer data updated</title>
<mediaobject>
<imageobject>
- <imagedata fileref="images/image-jbt-test_JAX-RS_05.png"
format="PNG"/>
+ <imagedata fileref="images/image-jbt-test_resteasy_JAX-RS_09.png"
format="PNG"/>
</imageobject>
<textobject>
- <para>The New Project Dialog.</para>
+ <para>Customer data updated</para>
</textobject>
</mediaobject>
- </figure>
+ </figure>
+ <para>&HORIZ_LINE;</para>
+ </step>
+
+ <step><title>Test the DELETE option</title>
+ <substeps>
+ <step>
<para>
- and the response message body is displayed in the <guilabel>Response
Body</guilabel> textbox, all of which indicate a successful test
+ Deleting a record is a similar process to posting. Select the
<guilabel>DELETE</guilabel> method in the operations drop-down list.
</para>
- <figure id="figure-jbt-test_JAX-RS_06">
- <title>JBoss Tools Project Creation</title>
+ </step>
+ <step>
+ <para>
+ Enter the url of the record to be deleted
<uri>http://localhost:8080/simple/rest-services/customers/1</uri>
+ </para>
+ </step>
+ <step>
+ <para>Click the <guibutton>Invoke</guibutton> button.</para>
+ <formalpara><title>Result:</title>
+ <para>
+ The <guilabel>Response Headers</guilabel> area indicates a No
Response (<code>[HTTP/1.1 204 No Content]</code>) as was the case for the PUT
operation in <xref linkend="figure-jbt-test_resteasy_JAX-RS_08"/>.
+ </para>
+ </formalpara>
+ <para>Once again, the console does not indicate an update was performed,
however, the console may provide useful information following an operation.</para>
+ <para>&HORIZ_LINE;</para>
+ </step>
+ </substeps>
+ </step>
+ <step><title>Check the DELETE operation with a GET</title>
+ <para>
+ Perform a GET operation by following the steps in <xref
linkend="getStart"/>.
+ </para>
+ <formalpara><title>Result:</title>
+ <para>
+ The <guilabel>Response Body</guilabel> area returns an error report
indicating that <code>The requested resource () is not available</code> and
the <guilabel>Response Headers</guilabel> area returns a <code>[HTTP/1.1
404 Not Found]</code>.
+ </para>
+ </formalpara>
+ <figure id="figure-jbt-test_resteasy_JAX-RS_10">
+ <title>Custmer data deleted</title>
<mediaobject>
<imageobject>
- <imagedata fileref="images/image-jbt-test_JAX-RS_06.png"
format="PNG"/>
+ <imagedata fileref="images/image-jbt-test_resteasy_JAX-RS_10.png"
format="PNG"/>
</imageobject>
<textobject>
- <para>The New Project Dialog.</para>
+ <para>Customer data deleted</para>
</textobject>
</mediaobject>
- </figure>
- <para>&HORIZ_LINE;</para>
+ </figure>
+ <para>The response header and body messages indicate that the data was
successfully deleted.</para>
+ <para>&HORIZ_LINE;</para>
</step>
+
+
</procedure>
Modified:
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/proc-jbt-test_JAX-WS.xml
===================================================================
---
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/proc-jbt-test_JAX-WS.xml 2010-11-01
11:47:47 UTC (rev 26155)
+++
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/proc-jbt-test_JAX-WS.xml 2010-11-01
12:39:23 UTC (rev 26156)
@@ -5,48 +5,9 @@
]>
<procedure id="proc-jbt-test_JAX-WS">
<title>Testing a JAX-WS web service</title>
- <step><title>Preliminary steps</title>
- <para>
- Prior to testing a JAX-WS web service:
- </para>
- <substeps>
- <step>
- <para>
- The <guilabel>Web Service Test View</guilabel> should be opened as
described in <xref
linkend="proc-jbt-web_service_test_view"></xref>.
- </para>
- <formalpara><title>Result:</title>
- <para>
- The <guilabel>Web Service Test View</guilabel> is displayed.
- </para>
- </formalpara>
- <figure id="proc-jbt-test_JAX-WS_01">
- <title>Web Service Test View</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/image-jbt-test_JAX-WS_01.png"
format="PNG"/>
- </imageobject>
- <textobject>
- <para>Web Service Test View</para>
- </textobject>
- </mediaobject>
- </figure>
- </step>
- <step>
- <para>
- A JAX-WS web service has been deployed to the
<filename>deploy</filename> directory of the chosen server profile as
described in <xref linkend="proc-jbt-export-war_export"/>.
- </para>
- </step>
- <step>
- <para>
- The server has been started with <command>run.sh -c
<profile></command>.
- </para>
- </step>
- </substeps>
- <para>&HORIZ_LINE;</para>
- </step>
<step>
<para>
- Select <guilabel>JAX-WS</guilabel> from the available combo box
options
+ Following the preliminary steps described in <xref
linkend="proc-jbt-test_web_service_prelim"/>, select
<guilabel>JAX-WS</guilabel> from the available combo box options.
</para>
<formalpara><title>Result:</title>
<para>
@@ -74,7 +35,7 @@
</step>
<step>
<para>
- Click the <guibutton>Invoke</guibutton> button
+ Click the <guibutton>Invoke</guibutton> button.
</para>
<formalpara><title>Result:</title>
@@ -98,7 +59,7 @@
<step>
<title>Select the required service attributes</title>
<para>
- Select the <guilabel>Service</guilabel>,
<guibutton>Port</guibutton> and <guibutton>Operation</guibutton>
from the combo boxes and click <guibutton>OK</guibutton>
+ Select the <guilabel>Service</guilabel>,
<guibutton>Port</guibutton> and <guibutton>Operation</guibutton>
from the combo boxes and click <guibutton>OK</guibutton>.
</para>
<formalpara><title>Results:</title>
<para>
Added:
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/proc-jbt-test_resteasy_JAX-RS.xml
===================================================================
---
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/proc-jbt-test_resteasy_JAX-RS.xml
(rev 0)
+++
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/proc-jbt-test_resteasy_JAX-RS.xml 2010-11-01
12:39:23 UTC (rev 26156)
@@ -0,0 +1,282 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "JBoss_Web_Services_User_Guide.ent">
+%BOOK_ENTITIES;
+]>
+<procedure id="proc-jbt-test_resteasy_JAX-RS">
+ <title>Testing a JAX-RS web service- POST and GET requests</title>
+ <step>
+ <substeps>
+ <step><title>Query the available options</title>
+ <para>
+ Following the preliminary steps described in <xref
linkend="proc-jbt-test_web_service_prelim"/>, select the
<guilabel>OPTIONS</guilabel> method from the operations text area.
+ </para>
+ </step>
+ <step>
+ <para>
+ Enter the url of the web service in the editable drop-down list
<uri>http://localhost:8080/simple/rest-services/customers</uri>.
+ </para>
+ </step>
+ <step>
+ <para>
+ Click the <guilabel>Invoke</guilabel> button
+ </para>
+ <formalpara><title>Result:</title>
+ <para>
+ The <guilabel>Response Headers</guilabel> text area indicates that
the allowed options are <code>[POST, OPTIONS]</code> as shown in <xref
linkend="figure-jbt-test_resteasy_JAX-RS_02"/>.
+ </para>
+ </formalpara>
+ <figure id="figure-jbt-test_resteasy_JAX-RS_02">
+ <title>JAX-RS RESTEasy project Body Text</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/image-jbt-test_resteasy_JAX-RS_02.png"
format="PNG"/>
+ </imageobject>
+ <textobject>
+ <para>JAX-WS RESTEasy project Body Text</para>
+ </textobject>
+ </mediaobject>
+ </figure>
+ <para>&HORIZ_LINE;</para>
+ </step>
+ </substeps>
+ </step>
+ <step><title>Test the POST option</title>
+ <substeps>
+ <step>
+ <para>
+ Select <guilabel>POST</guilabel> method in the the operations drop-down
list.
+ </para>
+ </step>
+ <step>
+ <para>
+ We will post xml data to this particular web service. Complete the header details
by entering <code>content-type=application/xml</code> in the text area and
click <guibutton>Add</guibutton> to add it to the
<guilabel>Headers</guilabel> list.
+ </para>
+ <formalpara><title>Result:</title>
+ <para>
+ The <guilabel>content-type</guilabel> is added to the
<guilabel>Headers</guilabel> list as shown in <xref
linkend="figure-jbt-test_resteasy_JAX-RS_03"/>.
+ </para>
+ </formalpara>
+ <figure id="figure-jbt-test_resteasy_JAX-RS_03">
+ <title>content-type header</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/image-jbt-test_resteasy_JAX-RS_03.png"
format="PNG"/>
+ </imageobject>
+ <textobject>
+ <para>JAX-WS RESTEasy project Body Text</para>
+ </textobject>
+ </mediaobject>
+ </figure>
+ <para>&HORIZ_LINE;</para>
+ </step>
+ <step><title>Enter customer details</title>
+ <para>
+ Enter the customer details in the <guilabel>Body Text</guilabel> area
as displayed in <xref linkend="figure-jbt-test_resteasy_JAX-RS_04"/>.
+ </para>
+ <figure id="figure-jbt-test_resteasy_JAX-RS_04">
+ <title>Customer data</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/image-jbt-test_resteasy_JAX-RS_04.png"
format="PNG"/>
+ </imageobject>
+ <textobject>
+ <para>Customer data</para>
+ </textobject>
+ </mediaobject>
+ </figure>
+ <para>&HORIZ_LINE;</para>
+ </step>
+ <step>
+ <para>Click the <guibutton>Invoke</guibutton> button.</para>
+ <formalpara><title>Result:</title>
+ <para>
+ The <guilabel>Response Headers</guilabel> area indicated that a
record was created and lists the location as
<uri>http://localhost:8080/simple/rest-services/cuntomers/1</uri> as shown in
<xref linkend="figure-jbt-test_resteasy_JAX-RS_05"/>.
+ </para>
+ </formalpara>
+ <figure id="figure-jbt-test_resteasy_JAX-RS_05">
+ <title>Customer added</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/image-jbt-test_resteasy_JAX-RS_05.png"
format="PNG"/>
+ </imageobject>
+ <textobject>
+ <para>Customer added</para>
+ </textobject>
+ </mediaobject>
+ </figure>
+ <para>The console also indicates the successful creation of the customer:
<code>10:44:33,846 INFO [STDOUT] Created customer 1</code></para>
+ <para>&HORIZ_LINE;</para>
+ </step>
+ </substeps>
+ </step>
+
+ <step id="getStart"><title>Test the GET option</title>
+ <substeps>
+ <step>
+ <para>
+ Select the <guilabel>GET</guilabel> method in the the operations
drop-down list.
+ </para>
+ </step>
+ <step>
+ <para>
+ We will retrieve the record created in the previous step. Enter the url for the
record returned in the previous step
<uri>http://localhost:8080/simple/rest-services/customers/1</uri>
+ </para>
+ </step>
+ <step id="getFinish">
+ <para>
+ Click the <guibutton>Invoke</guibutton> button.
+ </para>
+ <formalpara><title>Result:</title>
+ <para>
+ The <guilabel>Response Headers</guilabel> area indicates a
<code>[HTTP/1.1 200 OK]</code> response and the customer data is retrieved and
displayed in the <guilabel>Response Body</guilabel> area as shown in <xref
linkend="figure-jbt-test_resteasy_JAX-RS_06"/>.
+ </para>
+ </formalpara>
+ <figure id="figure-jbt-test_resteasy_JAX-RS_06">
+ <title>GET response</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/image-jbt-test_resteasy_JAX-RS_06.png"
format="PNG"/>
+ </imageobject>
+ <textobject>
+ <para>GET response</para>
+ </textobject>
+ </mediaobject>
+ </figure>
+ <para>&HORIZ_LINE;</para>
+ </step>
+ </substeps>
+ </step>
+
+
+ <step><title>Test the PUT option</title>
+ <substeps>
+ <step>
+ <para>
+ Editing a record is achieved by using the <guilabel>PUT</guilabel>
method. Select the <guilabel>PUT</guilabel> method in the operations
drop-down list.
+ </para>
+ </step>
+ <step>
+ <para>
+ Enter the url of the record to be edited
<uri>http://localhost:8080/simple/rest-services/customers/1</uri>
+ </para>
+ </step>
+ <step>
+ <para>
+ Enter the data in the <guilabel>Body Text</guilabel> area. Replace
the first-name with a different entry as in <xref
linkend="figure-jbt-test_resteasy_JAX-RS_07"/>
+ </para>
+ <figure id="figure-jbt-test_resteasy_JAX-RS_07">
+ <title>Updated customer data</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/image-jbt-test_resteasy_JAX-RS_07.png"
format="PNG"/>
+ </imageobject>
+ <textobject>
+ <para>Updated customer data</para>
+ </textobject>
+ </mediaobject>
+ </figure>
+ <para>&HORIZ_LINE;</para>
+ </step>
+ <step>
+ <para>
+ Ensure that the <code>content-type=application/xml</code> header is in
the <guilabel>Headers</guilabel> list.
+ </para>
+ </step>
+ <step>
+ <para>Click the <guibutton>Invoke</guibutton> button.</para>
+ <formalpara><title>Result:</title>
+ <para>
+ The <guilabel>Response Headers</guilabel> area indicates a No
Response (<code>[HTTP/1.1 204 No Content]</code>) <xref
linkend="figure-jbt-test_resteasy_JAX-RS_08"/>.
+ </para>
+ </formalpara>
+ <figure id="figure-jbt-test_resteasy_JAX-RS_08">
+ <title>Response header following PUT</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/image-jbt-test_resteasy_JAX-RS_08.png"
format="PNG"/>
+ </imageobject>
+ <textobject>
+ <para>Response header following PUT</para>
+ </textobject>
+ </mediaobject>
+ </figure>
+ <para>In this instance, the console does not indicate an update was
performed, however, the console may provide useful information following an
operation.</para>
+ <para>&HORIZ_LINE;</para>
+ </step>
+ </substeps>
+ </step>
+ <step><title>Check the updated data with a GET</title>
+ <para>
+ Perform a GET operation by following the steps in <xref
linkend="getStart"/>.
+ </para>
+ <formalpara><title>Result:</title>
+ <para>
+ The <guilabel>Response Body</guilabel> area displays the updated
data.
+ </para>
+ </formalpara>
+ <figure id="figure-jbt-test_resteasy_JAX-RS_09">
+ <title>Custmer data updated</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/image-jbt-test_resteasy_JAX-RS_09.png"
format="PNG"/>
+ </imageobject>
+ <textobject>
+ <para>Customer data updated</para>
+ </textobject>
+ </mediaobject>
+ </figure>
+ <para>&HORIZ_LINE;</para>
+ </step>
+
+ <step><title>Test the DELETE option</title>
+ <substeps>
+ <step>
+ <para>
+ Deleting a record is a similar process to posting. Select the
<guilabel>DELETE</guilabel> method in the operations drop-down list.
+ </para>
+ </step>
+ <step>
+ <para>
+ Enter the url of the record to be deleted
<uri>http://localhost:8080/simple/rest-services/customers/1</uri>
+ </para>
+ </step>
+ <step>
+ <para>Click the <guibutton>Invoke</guibutton> button.</para>
+ <formalpara><title>Result:</title>
+ <para>
+ The <guilabel>Response Headers</guilabel> area indicates a No
Response (<code>[HTTP/1.1 204 No Content]</code>) as was the case for the PUT
operation in <xref linkend="figure-jbt-test_resteasy_JAX-RS_08"/>.
+ </para>
+ </formalpara>
+ <para>Once again, the console does not indicate an update was performed,
however, the console may provide useful information following an operation.</para>
+ <para>&HORIZ_LINE;</para>
+ </step>
+ </substeps>
+ </step>
+ <step><title>Check the DELETE operation with a GET</title>
+ <para>
+ Perform a GET operation by following the steps in <xref
linkend="getStart"/>.
+ </para>
+ <formalpara><title>Result:</title>
+ <para>
+ The <guilabel>Response Body</guilabel> area returns an error report
indicating that <code>The requested resource () is not available</code> and
the <guilabel>Response Headers</guilabel> area returns a <code>[HTTP/1.1
404 Not Found]</code>.
+ </para>
+ </formalpara>
+ <figure id="figure-jbt-test_resteasy_JAX-RS_10">
+ <title>Custmer data deleted</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/image-jbt-test_resteasy_JAX-RS_10.png"
format="PNG"/>
+ </imageobject>
+ <textobject>
+ <para>Customer data deleted</para>
+ </textobject>
+ </mediaobject>
+ </figure>
+ <para>The response header and body messages indicate that the data was
successfully deleted.</para>
+ <para>&HORIZ_LINE;</para>
+ </step>
+
+
+</procedure>
+
Property changes on:
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/proc-jbt-test_resteasy_JAX-RS.xml
___________________________________________________________________
Name: svn:executable
+ *
Added:
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/proc-jbt-test_restfulsample_JAX-RS.xml
===================================================================
---
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/proc-jbt-test_restfulsample_JAX-RS.xml
(rev 0)
+++
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/proc-jbt-test_restfulsample_JAX-RS.xml 2010-11-01
12:39:23 UTC (rev 26156)
@@ -0,0 +1,78 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM
"JBoss_Tools_Reference_Guide_Template.ent">
+%BOOK_ENTITIES;
+]>
+<procedure id="proc-jbt-test_restfulsample_JAX-RS">
+ <title>RestfulSample test</title>
+ <step>
+ <substeps>
+ <step><title>Query the available options</title>
+ <para>
+ Select <guilabel>OPTIONS</guilabel> from the available combo box
options.
+ </para>
+ </step>
+ <step>
+ <para>
+ Enter the url of the web service in the editable drop-down list:
<uri>http://localhost:8080/RestfulSample/MyRESTApplication</uri>.
+ </para>
+ </step>
+ <step>
+ <para>
+ Click the <guilabel>Invoke</guilabel> button
+ </para>
+ <formalpara><title>Result:</title>
+ <para>
+ The <guilabel>Response Headers</guilabel> text area indicates that
the allowed options are <code>[GET, OPTIONS, HEAD]</code> as shown in <xref
linkend="figure-jbt-test_restfulsample_JAX-RS_02"/>.
+ </para>
+ </formalpara>
+ <figure id="figure-jbt-test_restfulsample_JAX-RS_02">
+ <title>JAX-RS Response Header Text</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/image-jbt-test_restfulsample_JAX-RS_02.png"
format="PNG"/>
+ </imageobject>
+ <textobject>
+ <para>JAX-RS Response Header Text</para>
+ </textobject>
+ </mediaobject>
+ </figure>
+ <para>&HORIZ_LINE;</para>
+ </step>
+ </substeps>
+ </step>
+ <step>
+ <title>Test the GET request</title>
+ <substeps>
+ <step>
+ <para>
+ Having established that the <guilabel>GET</guilabel> request is valid,
select <guilabel>GET</guilabel> from the available combo box options.
+ </para>
+ </step>
+ <step>
+ <para>
+ Click the <guilabel>Invoke</guilabel> button.
+ </para>
+ <formalpara><title>Result:</title>
+ <para>
+ The <guilabel>Response Body</guilabel> text area displays the
expected <quote>Hello World</quote> text as shown in <xref
linkend="figure-jbt-test_restfulsample_JAX-RS_03"/>.
+ </para>
+ </formalpara>
+ <figure id="figure-jbt-test_restfulsample_JAX-RS_03">
+ <title>JAX-RS Response Body Text</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/image-jbt-test_restfulsample_JAX-RS_03.png"
format="PNG"/>
+ </imageobject>
+ <textobject>
+ <para>JAX-RS Response Body Text</para>
+ </textobject>
+ </mediaobject>
+ </figure>
+ </step>
+ </substeps>
+ <para>&HORIZ_LINE;</para>
+ </step>
+</procedure>
+
+
Property changes on:
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/proc-jbt-test_restfulsample_JAX-RS.xml
___________________________________________________________________
Name: svn:executable
+ *
Added:
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/proc-jbt-test_web_service_prelim.xml
===================================================================
---
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/proc-jbt-test_web_service_prelim.xml
(rev 0)
+++
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/proc-jbt-test_web_service_prelim.xml 2010-11-01
12:39:23 UTC (rev 26156)
@@ -0,0 +1,60 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "JBoss_Web_Services_User_Guide.ent">
+%BOOK_ENTITIES;
+]>
+<procedure id="proc-jbt-test_web_service_prelim">
+ <title>Testing a JAX-RS web service</title>
+ <step><title>Preliminary steps</title>
+ <para>
+ Prior to testing a web service:
+ </para>
+ <substeps>
+ <step>
+ <para>
+ The <guilabel>Web Service Test View</guilabel> should be opened as
described in <xref
linkend="proc-jbt-web_service_test_view"></xref>;
+ </para>
+ <formalpara><title>Result:</title>
+ <para>
+ The <guilabel>Web Service Test View</guilabel> displays.
+ </para>
+ </formalpara>
+ <figure id="proc-jbt-test_web_service_01">
+ <title>Web Service Test View</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/image-jbt-web_service_test_view_01.png"
format="PNG"/>
+ </imageobject>
+ <textobject>
+ <para>Web Service Test View</para>
+ </textobject>
+ </mediaobject>
+ </figure>
+ </step>
+ <step>
+ <para>
+ A web service has been deployed to the <filename>deploy</filename>
directory of the chosen server profile as described in:
+ <itemizedlist>
+ <listitem>
+ <para>
+ <xref linkend="proc-jbt-export-war_export"/> for the
<application>RestfulSample</application> project; or
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <xref linkend="proc-jbt-new_project_example"/> for the
<application>RESTEasy</application> sample project.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </step>
+ <step>
+ <para>
+ The server has been started with <command>run.sh -c
<profile></command>
+ </para>
+ </step>
+ </substeps>
+ <para>&HORIZ_LINE;</para>
+ </step>
+</procedure>
+
Property changes on:
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/proc-jbt-test_web_service_prelim.xml
___________________________________________________________________
Name: svn:executable
+ *
Added:
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/resteasy_sample_project-web_service_test_view.xml
===================================================================
---
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/resteasy_sample_project-web_service_test_view.xml
(rev 0)
+++
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/resteasy_sample_project-web_service_test_view.xml 2010-11-01
12:39:23 UTC (rev 26156)
@@ -0,0 +1,12 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "JBoss_Web_Services_User_Guide.ent">
+%BOOK_ENTITIES;
+]>
+<section
id="web_service_test_view-testing_a_restful_web_service-resteasy_sample_project">
+ <title>RESTEasy sample project</title>
+ <para>
+
+ </para>
+ <xi:include href="proc-jbt-test_resteasy_JAX-RS.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
+</section>
\ No newline at end of file
Added:
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/restfulsample_project-web_service_test_view.xml
===================================================================
---
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/restfulsample_project-web_service_test_view.xml
(rev 0)
+++
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/restfulsample_project-web_service_test_view.xml 2010-11-01
12:39:23 UTC (rev 26156)
@@ -0,0 +1,12 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "JBoss_Web_Services_User_Guide.ent">
+%BOOK_ENTITIES;
+]>
+<section
id="web_service_test_view-testing_a_restful_web_service-restfulsample_project">
+ <title>RestfulSample project</title>
+ <para>
+
+ </para>
+ <xi:include href="proc-jbt-test_restfulsample_JAX-RS.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
+</section>
\ No newline at end of file
Modified:
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/sample_web_service_wizards.xml
===================================================================
---
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/sample_web_service_wizards.xml 2010-11-01
11:47:47 UTC (rev 26155)
+++
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/sample_web_service_wizards.xml 2010-11-01
12:39:23 UTC (rev 26156)
@@ -11,12 +11,12 @@
<itemizedlist>
<listitem>
<para>
- <guilabel>Create a sample Web Service</guilabel> for a Java API for
XML Web Services (<acronym>JAX-WS</acronym>) Web Service; and
+ <guilabel>Create a sample Web Service</guilabel> for a JAX-WS web
service; and
</para>
</listitem>
<listitem>
<para>
- <guilabel>Create a sample RESTful Web Service</guilabel> for a Java
API for RESTful Web Services (<acronym>JAX-WS</acronym>) Web Service.
+ <guilabel>Create a sample RESTful Web Service</guilabel> for a JAX-WS
web service.
</para>
</listitem>
</itemizedlist>
Modified:
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/testing_a_restful_web_service-web_service_test_view.xml
===================================================================
---
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/testing_a_restful_web_service-web_service_test_view.xml 2010-11-01
11:47:47 UTC (rev 26155)
+++
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/testing_a_restful_web_service-web_service_test_view.xml 2010-11-01
12:39:23 UTC (rev 26156)
@@ -8,6 +8,45 @@
<para>
Testing a RESTful (<acronym>JAX-RS</acronym>) web service is achieved by
following a similar procedure to testing a JAX-WS web service. Instead of selecting the
JAX-WS option in the combo box, the JAX-RS service is invoked by sending HTTP method
requests of the form OPTIONS, GET, POST, PUT and DELETE. As there is no WSDL file
associated with a JAX-RS service, the available options can be determined by selecting
<guilabel>OPTIONS</guilabel> in the combo box.
</para>
-
-
+ <para>
+ A JAX-RS web service can be tested by using the <guilabel>Web Service Tester
View </guilabel> displayed in <xref
linkend="figure-jbt-web_service_test_view"/>. The JAX-RS test is specified
by:
+ </para>
+ <orderedlist>
+ <listitem>
+ <para>
+ Selecting the <guilabel>OPTIONS</guilabel> combo box option.
+ </para>
+ </listitem>
+ <listitem id="restful_step2">
+ <para>
+ Entering the url of the JAX-RS web service.
+ </para>
+ </listitem>
+ </orderedlist>
+ <para>
+ The test procedure is discussed in the following sections for both the
<application>RestfulSample</application> and the
<application>RESTEasy</application> sample projects developed earlier.
+ </para>
+ <xi:include href="restfulsample_project-web_service_test_view.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="resteasy_sample_project-web_service_test_view.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <!--
+ <formalpara><title>Testing a JAX-RS web service -
Preliminaries</title>
+ <para>
+ <xref linkend="proc-jbt-test_JAX-RS_prelim"/> lists the
preliminary steps required before testing a JAX-RS web service project.
+ </para>
+ </formalpara>
+ <xi:include href="proc-jbt-test_JAX-RS_prelim.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
+
+ <formalpara><title>Testing a basic JAX-RS web service - The RestfulSample
project.</title>
+ <para>
+ <xref linkend="proc-jbt-test_basic_JAX-RS"/> demonstrates testing the
<application>RestfulSample</application> project developed in <xref
linkend="proc-jbt-generate_a_sample_restful_web_service"/>.
+ </para>
+ </formalpara>
+ <xi:include href="proc-jbt-test_basic_JAX-RS.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <formalpara><title>Testing a JAX-RS web service with POST and DELETE
options- The simple project.</title>
+ <para>
+ <xref linkend="proc-jbt-test_JAX-RS"/> demonstrates testing the
<application>simple</application> project developed in <xref
linkend="proc-jbt-new_project_example"/>.
+ </para>
+ </formalpara>
+ <xi:include href="proc-jbt-test_JAX-RS.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
+ -->
</section>
\ No newline at end of file
Modified:
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/web_service_test_view.xml
===================================================================
---
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/web_service_test_view.xml 2010-11-01
11:47:47 UTC (rev 26155)
+++
trunk/ws/docs/Web_Service_Test_View/JBoss_Web_Services_User_Guide/en-US/web_service_test_view.xml 2010-11-01
12:39:23 UTC (rev 26156)
@@ -11,8 +11,9 @@
<xi:include href="proc-jbt-web_service_test_view.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
<para>
- The following sections describe testing <acronym>JAX-WS</acronym> and
<acronym>JAX-RS</acronym> web services.
- </para>
+ The following sections describe testing <acronym>JAX-WS</acronym> and
<acronym>JAX-RS</acronym> web services including the necessary preliminary
steps.
+ </para>
+ <xi:include href="preliminaries-web_service_test_view.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="testing_a_web_service-web_service_test_view.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="testing_a_restful_web_service-web_service_test_view.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
</chapter>
\ No newline at end of file