Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Difference between revisions of "Using Web Service Explorer to test a Web service"

(New page: By Kathy Chan December 22, 2005 Introduction This document is one of a series of tutorials to demonstrate the use of the Web Services tools in the Web Tools Platform Project using...)
 
Line 1: Line 1:
−
By Kathy Chan
+
<TABLE WIDTH="800" CELLSPACING=12 align=center>
−
December 22, 2005
+
<tr>
 +
<td valign="top" align="right">&nbsp;</td><td valign="top">
  
−
Introduction
+
<b>By Trung Ha</b>
−
+
<BR>
−
+
Jan 30, 2008<BR>
  
−
This document is one of a series of tutorials to demonstrate the use of the Web Services tools in the Web Tools Platform Project using a WTP 1.0 driver.
+
<BR>
−
+
  
−
This tutorial shows how to use the Web Service Explorer to test a Web service via native WSDL and SOAP. It demonstrates how to use the Web Services Explorer to invoke operations on a Web service named " Delayed Stock Quote " as available from XMethods on the internet.
+
<P>
−
+
This tutorial will use the catalog.xsd from the "Editing and validating XML files" Examples.  To create it,
 +
select New -&gt; Examples... to launch the wizard.  Follow the instructions described in the wizard, then click Finish to create the example project.
 +
</P>
  
−
The only prerequisite is that you be connected to the internet. If you are connected via a firewall, you can use the Internet preferences page (choose Preferences -> Internet from the main menu). Otherwise, you can begin with a completely fresh workspace and no installed servers.
 
−
 
−
Using the Web Services Explorer to test a Web service
 
−
 
−
 
  
−
  1. Launch the Eclipse WTP workbench.
+
<P>
−
  2. From the main menu bar, select Run -> Launch the Web Services Explorer. This will take a few moments the first time while Eclipse's internal Tomcat server starts up and loads the Web Services Explorer application.
+
Once created, under the PublicationCatalogue folder, locate the Catalogue.xsd file and double click the file to open it in the XML Schema Editor. As shown below, an Outline and Properties view is provided in addition
−
  3. After the Web Browser view opens, maximize it. Result:
+
to the editor pane. At the bottom of the editor area you'll see that there is a 'Source' and a 'Design' tab at the bottom of the editor area. The 'Source' tab is used
 +
for  basic XML source editing. The 'Design' tab is used for higher level graphical editing. Select  the 'Design' tab so that you're looking at the Graph view. As shown
 +
below you should see a 'top-level' view of the XML Schema that summarizes all of the components (e.g. elements and types) that are defined in the schema.
 +
<BR>
  
−
  4. In the Web Service Explorer's toolbar (top-right), click on the WSDL Page icon,
+
<BR>
  
 +
[[Image:Xsdeditor-figure1.JPG]]
 +
</P>
  
−
  5. Click on the WSDL Main icon. Result:
 
  
−
  6. In the WSDL URL field, enter the URL http://services.xmethods.net/soap/urn:xmethods-delayed-quotes.wsdl , then click on Go . Result:
+
<P>In order to see these components in detail you can 'drill down' on a component of interest by double clicking on it. For example,
 +
if we double click on the 'BookType' component, the editor will display the structure of the 'BookType' type as shown below.
 +
To return to the 'top-level' view, press the back button
 +
[[Image:Xsdeditor-toplevelbutton.JPG]]
 +
at the top left of the editor, or right clicking within the editor and selecting 'Back to Schema' from the context menu.<BR>
  
−
  7. Under Operations in the right hand pane, click on getQuote. Result:
+
<BR>
 +
[[Image:Xsdeditor-figure2.JPG]]
 +
</P>
 +
<BR>
  
−
  8. In the symbol String entry field, enter ibm, then click on Go . In the Status pane, you should see an answer like this:
+
<P>Editing the schema is achieved by invoking context menu actions on selected objects in the Graph view and
 +
using the properties view to modify the properties of the selected object. Go back to the top-level view and follow the steps below to create a new element
 +
declaration and define its content.</P>
  
−
      return (float): 79.28
+
<OL>
 +
 +
<LI>right click on the header of the 'Elements' section of the top level schema and choose 'Add Element'</LI>
 +
 +
<LI>use the properties view to change the name of the element to 'Paper'
 +
  [[Image:Xsdeditor-figure3.JPG]]
 +
  <BR>
 +
  <BR>
 +
  <BR>
 +
</LI>
 +
 +
<LI>
  
−
      You may need to move the horizontal bar separating the Actions and Status panes upwards a bit to get a better view. Result:
+
right click on Paper and select 'Set Type'->'New..." to create a new type for the element.<BR>
 +
  [[Image:Xsdeditor-figure4.JPG]]
 +
  <BR>
 +
  <BR>
 +
  <BR>
 +
 +
</LI>
 +
 +
<LI>select 'Complex Type' and check 'Create as anonymous type'. Click 'OK'.<BR>
 +
 
 +
[[Image:Xsdeditor-figure5.JPG]]
 +
  <BR> 
 +
  <BR>
 +
  <BR>
 +
</LI>
 +
 +
<LI>
 +
Double click on 'Paper' to explore this element, note that 'PaperType'
 +
is surrounded by parenthesis to indicate anonymity of this type. Click on this type to invoke the
 +
properties sheet for its. <BR>
 +
 
 +
<BR>
 +
 
 +
</LI>
  
−
Explanation
+
<LI>
−
+
On the Properties sheet, select the 'Inherit From:' combo and then select 'Browse...' as shown below.
−
+
 +
  [[Image:Xsdeditor-figure6.JPG]]
 +
  <BR>
 +
  <BR>
 +
  <BR> 
 +
</LI>
 +
   
 +
<LI>
 +
    The Set Type dialog will appear. Select 'PublicationType', and click OK.<BR>
 +
   
 +
[[Image:Xsdeditor-figure7.JPG]]
 +
  <BR>
 +
  <BR>
 +
  <BR> 
 +
</LI>
 +
   
 +
<LI>
 +
    Double click on Paper's type to edit its structure as shown below. Then right click on the '(PaperType)' and select 'Add Element'<BR>
 +
   
 +
[[Image:xsdeditor-figure8.JPG]]
 +
  <BR>
 +
  <BR>
 +
  <BR>
 +
</LI>
 +
 
 +
<LI>
 +
  Name the newly added element 'URL' because, say, the paper is found on the web.<BR>
 +
   
 +
[[Image:xsdeditor-figure9.JPG]]
 +
  <BR>   
 +
  <BR> 
 +
  <BR>
 +
</LI>
 +
 +
<LI>The type of URL can be changed in the main editor panel by clicking on its current type 'string'. A combo box will be shown as below (For now we don't change the the type of URL yet)
 +
<BR>
 +
   
 +
[[Image:xsdeditor-figure10.JPG]]
 +
    <BR>
 +
    <BR>
 +
  <BR>
 +
</LI>
  
−
The Web Services Explorer is a JSP Web application hosted on the Apache Tomcat servlet engine contained within Eclipse. It is integrated into Eclipse on two levels: visually by virtue of it running in the embedded browser, and logically by virtue of it running as a thread in the Eclipse JRE. Though not demonstrated in this scenario, this latter type of integration allows the Web Services Explorer to access resources in the workspace, write resources into the workspace, and launch various Web services wizards.
+
<LI>Right click on '(PaperType)', select 'Add Element Ref' to create element reference. Initally, the editor will pick a random element to be referred. In this case, it's 'Book'
−
+
as shown below.
  
−
The Web Services Explorer provides three key services to the user:
+
<BR>
−
+
   
 +
[[Image:xsdeditor-figure11.JPG]]
 +
    <BR>
 +
    <BR>
 +
  <BR>
 +
</LI>
  
−
  1. Comprehensive support for discovering Web services in WS-Inspection 1.0 documents, and in UDDI v2 or v3 registries using the UDDI v2 protocol.
+
<LI>We can change the element to be referred to in the main editor panel by click on 'Book'. A Combo will be shown as below.
−
  2. Comprehensive support for publishing Web services to UDDI v2 or v3 registries using the UDDI v2 protocol.
+
−
  3. Comprehensive support for browsing and invoking Web services natively via their WSDL and XSD.
+
  
−
+
<BR>
 +
   
 +
[[Image:xsdeditor-figure12.JPG]]
 +
    <BR>
 +
    <BR>
 +
  <BR>
 +
</LI>
  
−
Note:
+
<LI>
−
A key point of the scenario above is that no code was generated and no servers were required in order to invoke operations on the WSDL.
+
 
 +
Now that we've finished editing the XML Schema you can save the file.
 +
</LI>
 +
 
 +
</OL>
 +
 
 +
</td>
 +
</tr>
 +
 
 +
</TABLE>

Revision as of 17:24, 25 January 2008

 

By Trung Ha
Jan 30, 2008


This tutorial will use the catalog.xsd from the "Editing and validating XML files" Examples. To create it, select New -> Examples... to launch the wizard. Follow the instructions described in the wizard, then click Finish to create the example project.


Once created, under the PublicationCatalogue folder, locate the Catalogue.xsd file and double click the file to open it in the XML Schema Editor. As shown below, an Outline and Properties view is provided in addition to the editor pane. At the bottom of the editor area you'll see that there is a 'Source' and a 'Design' tab at the bottom of the editor area. The 'Source' tab is used for basic XML source editing. The 'Design' tab is used for higher level graphical editing. Select the 'Design' tab so that you're looking at the Graph view. As shown below you should see a 'top-level' view of the XML Schema that summarizes all of the components (e.g. elements and types) that are defined in the schema.

Xsdeditor-figure1.JPG


In order to see these components in detail you can 'drill down' on a component of interest by double clicking on it. For example, if we double click on the 'BookType' component, the editor will display the structure of the 'BookType' type as shown below. To return to the 'top-level' view, press the back button Xsdeditor-toplevelbutton.JPG at the top left of the editor, or right clicking within the editor and selecting 'Back to Schema' from the context menu.

Xsdeditor-figure2.JPG


Editing the schema is achieved by invoking context menu actions on selected objects in the Graph view and using the properties view to modify the properties of the selected object. Go back to the top-level view and follow the steps below to create a new element declaration and define its content.

  1. right click on the header of the 'Elements' section of the top level schema and choose 'Add Element'
  2. use the properties view to change the name of the element to 'Paper' Xsdeditor-figure3.JPG


  3. right click on Paper and select 'Set Type'->'New..." to create a new type for the element.
    Xsdeditor-figure4.JPG


  4. select 'Complex Type' and check 'Create as anonymous type'. Click 'OK'.
    Xsdeditor-figure5.JPG


  5. Double click on 'Paper' to explore this element, note that 'PaperType' is surrounded by parenthesis to indicate anonymity of this type. Click on this type to invoke the properties sheet for its.

  6. On the Properties sheet, select the 'Inherit From:' combo and then select 'Browse...' as shown below. Xsdeditor-figure6.JPG


  7. The Set Type dialog will appear. Select 'PublicationType', and click OK.
    Xsdeditor-figure7.JPG


  8. Double click on Paper's type to edit its structure as shown below. Then right click on the '(PaperType)' and select 'Add Element'
    Xsdeditor-figure8.JPG


  9. Name the newly added element 'URL' because, say, the paper is found on the web.
    Xsdeditor-figure9.JPG


  10. The type of URL can be changed in the main editor panel by clicking on its current type 'string'. A combo box will be shown as below (For now we don't change the the type of URL yet)
    Xsdeditor-figure10.JPG


  11. Right click on '(PaperType)', select 'Add Element Ref' to create element reference. Initally, the editor will pick a random element to be referred. In this case, it's 'Book' as shown below.
    Xsdeditor-figure11.JPG


  12. We can change the element to be referred to in the main editor panel by click on 'Book'. A Combo will be shown as below.
    Xsdeditor-figure12.JPG


  13. Now that we've finished editing the XML Schema you can save the file.
Retrieved from "https://wiki.eclipse.org/index.php?title=Using_Web_Service_Explorer_to_test_a_Web_service&oldid=77264"

Back to the top