updated javadoc
[jabaws.git] / website / dm_javadoc / compbio / ws / client / WSTester.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">\r
2 <!--NewPage-->\r
3 <HTML>\r
4 <HEAD>\r
5 <!-- Generated by javadoc (build 1.6.0_24) on Fri Aug 12 14:32:03 BST 2011 -->\r
6 <TITLE>\r
7 WSTester\r
8 </TITLE>\r
9 \r
10 <META NAME="date" CONTENT="2011-08-12">\r
11 \r
12 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">\r
13 \r
14 <SCRIPT type="text/javascript">\r
15 function windowTitle()\r
16 {\r
17     if (location.href.indexOf('is-external=true') == -1) {\r
18         parent.document.title="WSTester";\r
19     }\r
20 }\r
21 </SCRIPT>\r
22 <NOSCRIPT>\r
23 </NOSCRIPT>\r
24 \r
25 </HEAD>\r
26 \r
27 <BODY BGCOLOR="white" onload="windowTitle();">\r
28 <HR>\r
29 \r
30 \r
31 <!-- ========= START OF TOP NAVBAR ======= -->\r
32 <A NAME="navbar_top"><!-- --></A>\r
33 <A HREF="#skip-navbar_top" title="Skip navigation links"></A>\r
34 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
35 <TR>\r
36 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
37 <A NAME="navbar_top_firstrow"><!-- --></A>\r
38 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
39   <TR ALIGN="center" VALIGN="top">\r
40   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
41   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
42   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
43   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/WSTester.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>\r
44   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
45   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
46   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
47   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
48   </TR>\r
49 </TABLE>\r
50 </TD>\r
51 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
52 </EM>\r
53 </TD>\r
54 </TR>\r
55 \r
56 <TR>\r
57 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
58 &nbsp;<A HREF="../../../compbio/ws/client/ServicesUtil.html" title="class in compbio.ws.client"><B>PREV CLASS</B></A>&nbsp;\r
59 &nbsp;NEXT CLASS</FONT></TD>\r
60 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
61   <A HREF="../../../index.html?compbio/ws/client/WSTester.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
62 &nbsp;<A HREF="WSTester.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
63 &nbsp;<SCRIPT type="text/javascript">\r
64   <!--\r
65   if(window==top) {\r
66     document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
67   }\r
68   //-->\r
69 </SCRIPT>\r
70 <NOSCRIPT>\r
71   <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>\r
72 </NOSCRIPT>\r
73 \r
74 \r
75 </FONT></TD>\r
76 </TR>\r
77 <TR>\r
78 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
79   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
80 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
81 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
82 </TR>\r
83 </TABLE>\r
84 <A NAME="skip-navbar_top"></A>\r
85 <!-- ========= END OF TOP NAVBAR ========= -->\r
86 \r
87 <HR>\r
88 <!-- ======== START OF CLASS DATA ======== -->\r
89 <H2>\r
90 <FONT SIZE="-1">\r
91 compbio.ws.client</FONT>\r
92 <BR>\r
93 Class WSTester</H2>\r
94 <PRE>\r
95 <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A>\r
96   <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>compbio.ws.client.WSTester</B>\r
97 </PRE>\r
98 <HR>\r
99 <DL>\r
100 <DT><PRE>public class <B>WSTester</B><DT>extends <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></DL>\r
101 </PRE>\r
102 \r
103 <P>\r
104 Class for testing web services\r
105 <P>\r
106 \r
107 <P>\r
108 <DL>\r
109 <DT><B>Version:</B></DT>\r
110   <DD>1.0 February 2010</DD>\r
111 <DT><B>Author:</B></DT>\r
112   <DD>pvtroshin</DD>\r
113 </DL>\r
114 <HR>\r
115 \r
116 <P>\r
117 \r
118 <!-- ======== CONSTRUCTOR SUMMARY ======== -->\r
119 \r
120 <A NAME="constructor_summary"><!-- --></A>\r
121 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
122 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
123 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
124 <B>Constructor Summary</B></FONT></TH>\r
125 </TR>\r
126 <TR BGCOLOR="white" CLASS="TableRowColor">\r
127 <TD><CODE><B><A HREF="../../../compbio/ws/client/WSTester.html#WSTester(java.lang.String, java.io.PrintWriter)">WSTester</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;hostname,\r
128          <A HREF="http://java.sun.com/javase/6/docs/api/java/io/PrintWriter.html?is-external=true" title="class or interface in java.io">PrintWriter</A>&nbsp;writer)</CODE>\r
129 \r
130 <BR>\r
131 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Construct an instance of JABAWS tester</TD>\r
132 </TR>\r
133 </TABLE>\r
134 &nbsp;\r
135 <!-- ========== METHOD SUMMARY =========== -->\r
136 \r
137 <A NAME="method_summary"><!-- --></A>\r
138 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
139 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
140 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
141 <B>Method Summary</B></FONT></TH>\r
142 </TR>\r
143 <TR BGCOLOR="white" CLASS="TableRowColor">\r
144 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
145 <CODE>&nbsp;boolean</CODE></FONT></TD>\r
146 <TD><CODE><B><A HREF="../../../compbio/ws/client/WSTester.html#checkService(compbio.ws.client.Services)">checkService</A></B>(<A HREF="../../../compbio/ws/client/Services.html" title="enum in compbio.ws.client">Services</A>&nbsp;service)</CODE>\r
147 \r
148 <BR>\r
149 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Test JABA web service</TD>\r
150 </TR>\r
151 <TR BGCOLOR="white" CLASS="TableRowColor">\r
152 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
153 <CODE>static\r
154 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY="">\r
155 <TR ALIGN="right" VALIGN="">\r
156 <TD NOWRAP><FONT SIZE="-1">\r
157 <CODE>&lt;T&gt; void</CODE></FONT></TD>\r
158 </TR>\r
159 </TABLE>\r
160 </CODE></FONT></TD>\r
161 <TD><CODE><B><A HREF="../../../compbio/ws/client/WSTester.html#main(java.lang.String[])">main</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>[]&nbsp;args)</CODE>\r
162 \r
163 <BR>\r
164 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Test JWS2 web services</TD>\r
165 </TR>\r
166 </TABLE>\r
167 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>\r
168 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
169 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
170 <TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH>\r
171 </TR>\r
172 <TR BGCOLOR="white" CLASS="TableRowColor">\r
173 <TD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>\r
174 </TR>\r
175 </TABLE>\r
176 &nbsp;\r
177 <P>\r
178 \r
179 <!-- ========= CONSTRUCTOR DETAIL ======== -->\r
180 \r
181 <A NAME="constructor_detail"><!-- --></A>\r
182 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
183 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
184 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
185 <B>Constructor Detail</B></FONT></TH>\r
186 </TR>\r
187 </TABLE>\r
188 \r
189 <A NAME="WSTester(java.lang.String, java.io.PrintWriter)"><!-- --></A><H3>\r
190 WSTester</H3>\r
191 <PRE>\r
192 public <B>WSTester</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;hostname,\r
193                 <A HREF="http://java.sun.com/javase/6/docs/api/java/io/PrintWriter.html?is-external=true" title="class or interface in java.io">PrintWriter</A>&nbsp;writer)</PRE>\r
194 <DL>\r
195 <DD>Construct an instance of JABAWS tester\r
196 <P>\r
197 <DL>\r
198 <DT><B>Parameters:</B><DD><CODE>hostname</CODE> - - fully qualified host and context name of JABAWS e.g.
199             http://nanna.cluster.lifesci.dundee.ac.uk:8080/jaba<DD><CODE>writer</CODE> - a PrintWriter instance to writer test log to.</DL>\r
200 </DL>\r
201 \r
202 <!-- ============ METHOD DETAIL ========== -->\r
203 \r
204 <A NAME="method_detail"><!-- --></A>\r
205 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
206 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
207 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
208 <B>Method Detail</B></FONT></TH>\r
209 </TR>\r
210 </TABLE>\r
211 \r
212 <A NAME="main(java.lang.String[])"><!-- --></A><H3>\r
213 main</H3>\r
214 <PRE>\r
215 public static &lt;T&gt; void <B>main</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>[]&nbsp;args)\r
216                  throws <A HREF="http://java.sun.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE>\r
217 <DL>\r
218 <DD>Test JWS2 web services\r
219 <P>\r
220 <DD><DL>\r
221 <DT><B>Type Parameters:</B><DD><CODE>T</CODE> - web service type<DT><B>Parameters:</B><DD><CODE>args</CODE> - -h=<Your web application server host name, port and JWS2
222             context path>
223  
224             -s=<ServiceName> which is optional. If service name is not
225             provided then all known JWS2 web services are tested\r
226 <DT><B>Throws:</B>\r
227 <DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE></DL>\r
228 </DD>\r
229 </DL>\r
230 <HR>\r
231 \r
232 <A NAME="checkService(compbio.ws.client.Services)"><!-- --></A><H3>\r
233 checkService</H3>\r
234 <PRE>\r
235 public boolean <B>checkService</B>(<A HREF="../../../compbio/ws/client/Services.html" title="enum in compbio.ws.client">Services</A>&nbsp;service)\r
236                      throws <A HREF="http://java.sun.com/javase/6/docs/api/java/net/ConnectException.html?is-external=true" title="class or interface in java.net">ConnectException</A>,\r
237                             <A HREF="http://java.sun.com/javase/6/docs/api/javax/xml/ws/WebServiceException.html?is-external=true" title="class or interface in javax.xml.ws">WebServiceException</A></PRE>\r
238 <DL>\r
239 <DD>Test JABA web service\r
240 <P>\r
241 <DD><DL>\r
242 <DT><B>Parameters:</B><DD><CODE>service</CODE> - the service to test\r
243 <DT><B>Returns:</B><DD>true if the service works as expected, false otherwise\r
244 <DT><B>Throws:</B>\r
245 <DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/javax/xml/ws/WebServiceException.html?is-external=true" title="class or interface in javax.xml.ws">WebServiceException</A></CODE>\r
246 <DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/net/ConnectException.html?is-external=true" title="class or interface in java.net">ConnectException</A></CODE></DL>\r
247 </DD>\r
248 </DL>\r
249 <!-- ========= END OF CLASS DATA ========= -->\r
250 <HR>\r
251 \r
252 \r
253 <!-- ======= START OF BOTTOM NAVBAR ====== -->\r
254 <A NAME="navbar_bottom"><!-- --></A>\r
255 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>\r
256 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
257 <TR>\r
258 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
259 <A NAME="navbar_bottom_firstrow"><!-- --></A>\r
260 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
261   <TR ALIGN="center" VALIGN="top">\r
262   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
263   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
264   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
265   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/WSTester.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>\r
266   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
267   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
268   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
269   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
270   </TR>\r
271 </TABLE>\r
272 </TD>\r
273 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
274 </EM>\r
275 </TD>\r
276 </TR>\r
277 \r
278 <TR>\r
279 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
280 &nbsp;<A HREF="../../../compbio/ws/client/ServicesUtil.html" title="class in compbio.ws.client"><B>PREV CLASS</B></A>&nbsp;\r
281 &nbsp;NEXT CLASS</FONT></TD>\r
282 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
283   <A HREF="../../../index.html?compbio/ws/client/WSTester.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
284 &nbsp;<A HREF="WSTester.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
285 &nbsp;<SCRIPT type="text/javascript">\r
286   <!--\r
287   if(window==top) {\r
288     document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
289   }\r
290   //-->\r
291 </SCRIPT>\r
292 <NOSCRIPT>\r
293   <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>\r
294 </NOSCRIPT>\r
295 \r
296 \r
297 </FONT></TD>\r
298 </TR>\r
299 <TR>\r
300 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
301   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
302 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
303 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
304 </TR>\r
305 </TABLE>\r
306 <A NAME="skip-navbar_bottom"></A>\r
307 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
308 \r
309 <HR>\r
310 \r
311 </BODY>\r
312 </HTML>\r