Fix core WST file
[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 Wed Dec 07 12:08:24 GMT 2011 -->\r
6 <TITLE>\r
7 WSTester\r
8 </TITLE>\r
9 \r
10 <META NAME="date" CONTENT="2011-12-07">\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;<A HREF="#field_summary">FIELD</A>&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;<A HREF="#field_detail">FIELD</A>&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 java.lang.Object\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 java.lang.Object</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 <!-- =========== FIELD SUMMARY =========== -->\r
118 \r
119 <A NAME="field_summary"><!-- --></A>\r
120 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
121 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
122 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
123 <B>Field Summary</B></FONT></TH>\r
124 </TR>\r
125 <TR BGCOLOR="white" CLASS="TableRowColor">\r
126 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
127 <CODE>static&nbsp;java.lang.String</CODE></FONT></TD>\r
128 <TD><CODE><B><A HREF="../../../compbio/ws/client/WSTester.html#fastaAlignment">fastaAlignment</A></B></CODE>\r
129 \r
130 <BR>\r
131 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
132 </TR>\r
133 <TR BGCOLOR="white" CLASS="TableRowColor">\r
134 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
135 <CODE>static&nbsp;java.lang.String</CODE></FONT></TD>\r
136 <TD><CODE><B><A HREF="../../../compbio/ws/client/WSTester.html#fastaInput">fastaInput</A></B></CODE>\r
137 \r
138 <BR>\r
139 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sequences to be used as input for all WS</TD>\r
140 </TR>\r
141 </TABLE>\r
142 &nbsp;\r
143 <!-- ======== CONSTRUCTOR SUMMARY ======== -->\r
144 \r
145 <A NAME="constructor_summary"><!-- --></A>\r
146 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
147 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
148 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
149 <B>Constructor Summary</B></FONT></TH>\r
150 </TR>\r
151 <TR BGCOLOR="white" CLASS="TableRowColor">\r
152 <TD><CODE><B><A HREF="../../../compbio/ws/client/WSTester.html#WSTester(java.lang.String, java.io.PrintWriter)">WSTester</A></B>(java.lang.String&nbsp;hostname,\r
153          java.io.PrintWriter&nbsp;writer)</CODE>\r
154 \r
155 <BR>\r
156 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Construct an instance of JABAWS tester</TD>\r
157 </TR>\r
158 </TABLE>\r
159 &nbsp;\r
160 <!-- ========== METHOD SUMMARY =========== -->\r
161 \r
162 <A NAME="method_summary"><!-- --></A>\r
163 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
164 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
165 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
166 <B>Method Summary</B></FONT></TH>\r
167 </TR>\r
168 <TR BGCOLOR="white" CLASS="TableRowColor">\r
169 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
170 <CODE>&nbsp;boolean</CODE></FONT></TD>\r
171 <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
172 \r
173 <BR>\r
174 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Test JABA web service</TD>\r
175 </TR>\r
176 <TR BGCOLOR="white" CLASS="TableRowColor">\r
177 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
178 <CODE>static\r
179 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY="">\r
180 <TR ALIGN="right" VALIGN="">\r
181 <TD NOWRAP><FONT SIZE="-1">\r
182 <CODE>&lt;T&gt; void</CODE></FONT></TD>\r
183 </TR>\r
184 </TABLE>\r
185 </CODE></FONT></TD>\r
186 <TD><CODE><B><A HREF="../../../compbio/ws/client/WSTester.html#main(java.lang.String[])">main</A></B>(java.lang.String[]&nbsp;args)</CODE>\r
187 \r
188 <BR>\r
189 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Test JWS2 web services</TD>\r
190 </TR>\r
191 </TABLE>\r
192 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>\r
193 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
194 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
195 <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>\r
196 </TR>\r
197 <TR BGCOLOR="white" CLASS="TableRowColor">\r
198 <TD><CODE>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>\r
199 </TR>\r
200 </TABLE>\r
201 &nbsp;\r
202 <P>\r
203 \r
204 <!-- ============ FIELD DETAIL =========== -->\r
205 \r
206 <A NAME="field_detail"><!-- --></A>\r
207 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
208 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
209 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
210 <B>Field Detail</B></FONT></TH>\r
211 </TR>\r
212 </TABLE>\r
213 \r
214 <A NAME="fastaInput"><!-- --></A><H3>\r
215 fastaInput</H3>\r
216 <PRE>\r
217 public static final java.lang.String <B>fastaInput</B></PRE>\r
218 <DL>\r
219 <DD>Sequences to be used as input for all WS\r
220 <P>\r
221 <DL>\r
222 <DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#compbio.ws.client.WSTester.fastaInput">Constant Field Values</A></DL>\r
223 </DL>\r
224 <HR>\r
225 \r
226 <A NAME="fastaAlignment"><!-- --></A><H3>\r
227 fastaAlignment</H3>\r
228 <PRE>\r
229 public static final java.lang.String <B>fastaAlignment</B></PRE>\r
230 <DL>\r
231 <DL>\r
232 <DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#compbio.ws.client.WSTester.fastaAlignment">Constant Field Values</A></DL>\r
233 </DL>\r
234 \r
235 <!-- ========= CONSTRUCTOR DETAIL ======== -->\r
236 \r
237 <A NAME="constructor_detail"><!-- --></A>\r
238 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
239 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
240 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
241 <B>Constructor Detail</B></FONT></TH>\r
242 </TR>\r
243 </TABLE>\r
244 \r
245 <A NAME="WSTester(java.lang.String, java.io.PrintWriter)"><!-- --></A><H3>\r
246 WSTester</H3>\r
247 <PRE>\r
248 public <B>WSTester</B>(java.lang.String&nbsp;hostname,\r
249                 java.io.PrintWriter&nbsp;writer)</PRE>\r
250 <DL>\r
251 <DD>Construct an instance of JABAWS tester\r
252 <P>\r
253 <DL>\r
254 <DT><B>Parameters:</B><DD><CODE>hostname</CODE> - - fully qualified host and context name of JABAWS e.g.
255             http://nanna.cluster.lifesci.dundee.ac.uk:8080/jaba<DD><CODE>writer</CODE> - a PrintWriter instance to writer test log to.</DL>\r
256 </DL>\r
257 \r
258 <!-- ============ METHOD DETAIL ========== -->\r
259 \r
260 <A NAME="method_detail"><!-- --></A>\r
261 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
262 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
263 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
264 <B>Method Detail</B></FONT></TH>\r
265 </TR>\r
266 </TABLE>\r
267 \r
268 <A NAME="main(java.lang.String[])"><!-- --></A><H3>\r
269 main</H3>\r
270 <PRE>\r
271 public static &lt;T&gt; void <B>main</B>(java.lang.String[]&nbsp;args)\r
272                  throws java.io.IOException</PRE>\r
273 <DL>\r
274 <DD>Test JWS2 web services\r
275 <P>\r
276 <DD><DL>\r
277 <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
278             context path>
279  
280             -s=<ServiceName> which is optional. If service name is not
281             provided then all known JWS2 web services are tested\r
282 <DT><B>Throws:</B>\r
283 <DD><CODE>java.io.IOException</CODE></DL>\r
284 </DD>\r
285 </DL>\r
286 <HR>\r
287 \r
288 <A NAME="checkService(compbio.ws.client.Services)"><!-- --></A><H3>\r
289 checkService</H3>\r
290 <PRE>\r
291 public boolean <B>checkService</B>(<A HREF="../../../compbio/ws/client/Services.html" title="enum in compbio.ws.client">Services</A>&nbsp;service)\r
292                      throws java.net.ConnectException,\r
293                             javax.xml.ws.WebServiceException</PRE>\r
294 <DL>\r
295 <DD>Test JABA web service\r
296 <P>\r
297 <DD><DL>\r
298 <DT><B>Parameters:</B><DD><CODE>service</CODE> - the service to test\r
299 <DT><B>Returns:</B><DD>true if the service works as expected, false otherwise\r
300 <DT><B>Throws:</B>\r
301 <DD><CODE>javax.xml.ws.WebServiceException</CODE>\r
302 <DD><CODE>java.net.ConnectException</CODE></DL>\r
303 </DD>\r
304 </DL>\r
305 <!-- ========= END OF CLASS DATA ========= -->\r
306 <HR>\r
307 \r
308 \r
309 <!-- ======= START OF BOTTOM NAVBAR ====== -->\r
310 <A NAME="navbar_bottom"><!-- --></A>\r
311 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>\r
312 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
313 <TR>\r
314 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
315 <A NAME="navbar_bottom_firstrow"><!-- --></A>\r
316 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
317   <TR ALIGN="center" VALIGN="top">\r
318   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
319   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
320   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
321   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/WSTester.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>\r
322   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
323   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
324   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
325   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
326   </TR>\r
327 </TABLE>\r
328 </TD>\r
329 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
330 </EM>\r
331 </TD>\r
332 </TR>\r
333 \r
334 <TR>\r
335 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
336 &nbsp;<A HREF="../../../compbio/ws/client/ServicesUtil.html" title="class in compbio.ws.client"><B>PREV CLASS</B></A>&nbsp;\r
337 &nbsp;NEXT CLASS</FONT></TD>\r
338 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
339   <A HREF="../../../index.html?compbio/ws/client/WSTester.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
340 &nbsp;<A HREF="WSTester.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
341 &nbsp;<SCRIPT type="text/javascript">\r
342   <!--\r
343   if(window==top) {\r
344     document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
345   }\r
346   //-->\r
347 </SCRIPT>\r
348 <NOSCRIPT>\r
349   <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>\r
350 </NOSCRIPT>\r
351 \r
352 \r
353 </FONT></TD>\r
354 </TR>\r
355 <TR>\r
356 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
357   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
358 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
359 DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
360 </TR>\r
361 </TABLE>\r
362 <A NAME="skip-navbar_bottom"></A>\r
363 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
364 \r
365 <HR>\r
366 \r
367 </BODY>\r
368 </HTML>\r