blob: da0d93d12c4950b234ace4ed344a0643d6fb2e3f [file] [log] [blame]
<?xml version="1.0" encoding="utf-8"?>
<?xml-stylesheet type="text/xsl" href="../../../../wtp.xsl"?>
<html>
<head>
<meta name="root" content="../../../../../" />
<title>JST Web Services Design Documents</title>
</head>
<body>
<h1>Web Service Test Framework</h1>
<h2>Credits</h2>
<table cellspacing="5" cellpadding="2" border="1">
<tr valign="top">
<td>Enhancement</td>
<td>Bugzilla # 110988</td>
</tr>
<tr valign="top">
<td>Version</td>
<td>1.0 Draft</td>
</tr>
<tr valign="top">
<td>Last Updated</td>
<td>2005.10.04</td>
</tr>
<tr valign="top">
<td>Target Release</td>
<td>WTP 1.0</td>
</tr>
<tr valign="top">
<td>Target Milestone</td>
<td>M9</td>
</tr>
<tr valign="top">
<td>Contributors</td>
<td>
Gilbert Andrews<br/>
Chris Brealey<br/>
Kathy Chan<br/>
Joan Haggarty<br/>
Rupam Kuehner<br/>
Peter Moogk<br/>
Seng Phung-Lu<br/>
</td>
</tr>
</table>
<h2>Index</h2>
<ol>
<li><a href="#overview">Overview</a></li>
<li><a href="#requirements">Requirements</a></li>
<ol>
<li><a href="#r1">Web Service Test Extensibility</a></li>
</ol>
<li><a href="#concepts">Conceptual Design</a></li>
<li><a href="#details">Detailed Design</a></li>
</ol>
<h2><a name="overview"/>1.0 - Overview</h2>
<p>
Extenders of WTP can contribute Web service and Web service client test
facilities. The goal of this document is to present a high level design
of the Web serivce test framework that enables this extensibility
</p>
<h2><a name="requirements"/>2.0 - Requirements</h2>
<h3><a name="r1"/>Web Service Test Extensibility</h3>
<p>
Extenders of WTP can contribute Web service and Web service client test
facilities.
</p>
<h2><a name="concepts"/>3.0 - Conceptual Design</h2>
<p>
Once a Web service or Web service client has been created, the user has the
option of testing it using a test facility contributed via the org.eclipse.wst.ws.testFacilities
extension point.
<TABLE cellpadding="10">
<TR>
<TD bgcolor="#C0C0C0"><FONT size="-1" face="Arial">
<P><B> Extension XML for the Sample JSP test facility:</B></P>
</FONT> <FONT size="+0"><PRE>
&lt;extension point="org.eclipse.wst.ws.testFacilities">
&lt;testFacility
id=&quot;<FONT size="+0">org.eclipse.jst.ws.internal.consumption.ui.widgets.test.WebServiceSampleTest</FONT>&quot;
label=&quot;<FONT size="+0">%SAMPLE_TYPE_WEBSERVICES_ID</FONT>&quot;
icon=&quot;<FONT size="+0">./icons/WebServiceSampleTest.gif</FONT>&quot;
description=&quot;<FONT size="+0">%SAMPLE_TYPE_WEBSERVICES_DESC</FONT>&quot;
supportsWSDL=&quot;<FONT size="+0">false</FONT>&quot;
class=&quot;<FONT size="+0">org.eclipse.jst.ws.internal.consumption.ui.widgets.test.wssample.GSTCWebServiceTester</FONT>&quot;&gt;
&lt;clientRuntime
clientImplementationTypeId=&quot;org.eclipse.jst.ws.client.type.java&quot;
runtimeId=&quot;org.eclipse.jst.ws.axis.axis12&quot; /&gt;
&lt;/testFacility&gt;
&lt;/extension>
&lt;extension point="org.eclipse.wst.ws.testFacilities">
&lt;testFacilityLauncher
id=&quot;<FONT size="+0">org.eclipse.jst.ws.internal.consumption.ui.widgets.test.WebServiceSampleTestLauncher</FONT>&quot;
label=&quot;<FONT size="+0">%SAMPLE_TYPE_LAUNCHER_WEBSERVICES_ID</FONT>&quot;
icon=&quot;<FONT size="+0">./icons/WebServiceSampleTestLauncher.gif</FONT>&quot;
description=&quot;<FONT size="+0">%SAMPLE_TYPE_WEBSERVICES_LAUNCHER_DESC</FONT>&quot;
testFacilityId=&quot;org.eclipse.jst.ws.internal.consumption.ui.widgets.test.WebServiceSampleTest&quot;
class=&quot;<FONT size="+0">org.eclipse.jst.ws.internal.consumption.ui.widgets.test.wssample.GSTCWebServiceTestFacilityLauncher</FONT>&quot;/&gt;
&lt;/extension>
</PRE></FONT></TD>
</TR>
</TABLE>
<ul>
<li><b>testFacility</b></li>
<ul>
<li><b>id</b> - a unique identifier used to reference this Web service test facility</li>
<li><b>label</b> - a translatable label which will be displayed to the user</li>
<li><b>icon</b> - a relative path of an icon that can be displayed with the label</li>
<li><b>description</b> - a short translatable description</li>
<li><b>testWSDL</b> - "true" if this test facility can test a Web service with only the WSDL
as input. "false" otherwise.</li>
<li><b>class</b> - the fully qualified name of a class which implements IWebServiceTestFacility
and has a zero argument constructor.</li>
<li><b>clientRuntime</b> (0 or more) - combination of client implementation type and runtime that this test facility supports.
if no clientRuntimes are specified, support for all combinations is assumed.</li>
<ul>
<li>clientImplementationTypeId - id of a Web service client implementation type</li>
<li>runtimeId - id of a Web service runtime</li>
</ul>
</ul>
<li><b>testFacilityLauncher</b></li>
<ul>
<li><b>id</b> - a unique identifier used to reference this Web service test facility launcher</li>
<li><b>label</b> - a translatable label which will be displayed to the user</li>
<li><b>icon</b> - a relative path of an icon that can be displayed with the label</li>
<li><b>description</b> - a short translatable description</li>
<li><b>testFacilityId</b> - the id of the Web service test facility that this launcher can launch</li>
<li><b>class</b> - the fully qualified name of a class which implements IWebServiceTestFacilityLauncher
and has a zero argument constructor.</li>
</ul>
</ul>
<p><img SRC="110988/wstest-classdiagram.jpeg" height="242" width="777"/></p>
<hr WIDTH="100%"/>
<br/>
</p>
<h2><a name="details"/>4.0 - Detailed Design</h2>
<p>
Write any detailed, internal design material here.
</p>
</body>
</html>