Re-formatting the file
[jabaws.git] / website / full_javadoc / compbio / ws / client / WSTester.html
index f138ed2..4b9031c 100644 (file)
@@ -2,12 +2,12 @@
 <!--NewPage-->\r
 <HTML>\r
 <HEAD>\r
-<!-- Generated by javadoc (build 1.6.0_14) on Wed Feb 17 16:46:50 GMT 2010 -->\r
+<!-- Generated by javadoc (build 1.6.0_24) on Wed Dec 07 12:30:41 GMT 2011 -->\r
 <TITLE>\r
 WSTester\r
 </TITLE>\r
 \r
-<META NAME="date" CONTENT="2010-02-17">\r
+<META NAME="date" CONTENT="2011-12-07">\r
 \r
 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">\r
 \r
@@ -55,7 +55,7 @@ function windowTitle()
 \r
 <TR>\r
 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
-&nbsp;<A HREF="../../../compbio/ws/client/Jws2Client.Services.html" title="enum in compbio.ws.client"><B>PREV CLASS</B></A>&nbsp;\r
+&nbsp;<A HREF="../../../compbio/ws/client/ServicesUtil.html" title="class in compbio.ws.client"><B>PREV CLASS</B></A>&nbsp;\r
 &nbsp;NEXT CLASS</FONT></TD>\r
 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
   <A HREF="../../../index.html?compbio/ws/client/WSTester.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
@@ -76,9 +76,9 @@ function windowTitle()
 </TR>\r
 <TR>\r
 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
-  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
+  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
 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
-DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
+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
 </TR>\r
 </TABLE>\r
 <A NAME="skip-navbar_top"></A>\r
@@ -92,12 +92,12 @@ compbio.ws.client</FONT>
 <BR>\r
 Class WSTester</H2>\r
 <PRE>\r
-java.lang.Object\r
+<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
   <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>compbio.ws.client.WSTester</B>\r
 </PRE>\r
 <HR>\r
 <DL>\r
-<DT><PRE>public class <B>WSTester</B><DT>extends java.lang.Object</DL>\r
+<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
 </PRE>\r
 \r
 <P>\r
@@ -106,15 +106,40 @@ Class for testing web services
 \r
 <P>\r
 <DL>\r
+<DT><B>Version:</B></DT>\r
+  <DD>1.0 February 2010</DD>\r
 <DT><B>Author:</B></DT>\r
-  <DD>pvtroshin
-         Date February 2010</DD>\r
+  <DD>pvtroshin</DD>\r
 </DL>\r
 <HR>\r
 \r
 <P>\r
+<!-- =========== FIELD SUMMARY =========== -->\r
+\r
+<A NAME="field_summary"><!-- --></A>\r
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
+<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
+<B>Field Summary</B></FONT></TH>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
+<CODE>static&nbsp;<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></CODE></FONT></TD>\r
+<TD><CODE><B><A HREF="../../../compbio/ws/client/WSTester.html#fastaAlignment">fastaAlignment</A></B></CODE>\r
+\r
+<BR>\r
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
+<CODE>static&nbsp;<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></CODE></FONT></TD>\r
+<TD><CODE><B><A HREF="../../../compbio/ws/client/WSTester.html#fastaInput">fastaInput</A></B></CODE>\r
 \r
+<BR>\r
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sequences to be used as input for all WS</TD>\r
+</TR>\r
+</TABLE>\r
+&nbsp;\r
 <!-- ======== CONSTRUCTOR SUMMARY ======== -->\r
 \r
 <A NAME="constructor_summary"><!-- --></A>\r
@@ -124,10 +149,11 @@ Class for testing web services
 <B>Constructor Summary</B></FONT></TH>\r
 </TR>\r
 <TR BGCOLOR="white" CLASS="TableRowColor">\r
-<TD><CODE><B><A HREF="../../../compbio/ws/client/WSTester.html#WSTester()">WSTester</A></B>()</CODE>\r
+<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
+         <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
 \r
 <BR>\r
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Construct an instance of JABAWS tester</TD>\r
 </TR>\r
 </TABLE>\r
 &nbsp;\r
@@ -141,6 +167,14 @@ Class for testing web services
 </TR>\r
 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
+<CODE>&nbsp;boolean</CODE></FONT></TD>\r
+<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
+\r
+<BR>\r
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Test JABA web service</TD>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 <CODE>static\r
 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY="">\r
 <TR ALIGN="right" VALIGN="">\r
@@ -149,7 +183,7 @@ Class for testing web services
 </TR>\r
 </TABLE>\r
 </CODE></FONT></TD>\r
-<TD><CODE><B><A HREF="../../../compbio/ws/client/WSTester.html#main(java.lang.String[])">main</A></B>(java.lang.String[]&nbsp;args)</CODE>\r
+<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
 \r
 <BR>\r
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Test JWS2 web services</TD>\r
@@ -158,15 +192,46 @@ Class for testing web services
 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>\r
 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
-<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>\r
+<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
 </TR>\r
 <TR BGCOLOR="white" CLASS="TableRowColor">\r
-<TD><CODE>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>\r
+<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
 </TR>\r
 </TABLE>\r
 &nbsp;\r
 <P>\r
 \r
+<!-- ============ FIELD DETAIL =========== -->\r
+\r
+<A NAME="field_detail"><!-- --></A>\r
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
+<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
+<B>Field Detail</B></FONT></TH>\r
+</TR>\r
+</TABLE>\r
+\r
+<A NAME="fastaInput"><!-- --></A><H3>\r
+fastaInput</H3>\r
+<PRE>\r
+public static final <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> <B>fastaInput</B></PRE>\r
+<DL>\r
+<DD>Sequences to be used as input for all WS\r
+<P>\r
+<DL>\r
+<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#compbio.ws.client.WSTester.fastaInput">Constant Field Values</A></DL>\r
+</DL>\r
+<HR>\r
+\r
+<A NAME="fastaAlignment"><!-- --></A><H3>\r
+fastaAlignment</H3>\r
+<PRE>\r
+public static final <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> <B>fastaAlignment</B></PRE>\r
+<DL>\r
+<DL>\r
+<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#compbio.ws.client.WSTester.fastaAlignment">Constant Field Values</A></DL>\r
+</DL>\r
+\r
 <!-- ========= CONSTRUCTOR DETAIL ======== -->\r
 \r
 <A NAME="constructor_detail"><!-- --></A>\r
@@ -177,11 +242,17 @@ Class for testing web services
 </TR>\r
 </TABLE>\r
 \r
-<A NAME="WSTester()"><!-- --></A><H3>\r
+<A NAME="WSTester(java.lang.String, java.io.PrintWriter)"><!-- --></A><H3>\r
 WSTester</H3>\r
 <PRE>\r
-public <B>WSTester</B>()</PRE>\r
+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
+                <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
 <DL>\r
+<DD>Construct an instance of JABAWS tester\r
+<P>\r
+<DL>\r
+<DT><B>Parameters:</B><DD><CODE>hostname</CODE> - - fully qualified host and context name of JABAWS e.g.
+            http://nanna.cluster.lifesci.dundee.ac.uk:8080/jaba<DD><CODE>writer</CODE> - a PrintWriter instance to writer test log to.</DL>\r
 </DL>\r
 \r
 <!-- ============ METHOD DETAIL ========== -->\r
@@ -197,7 +268,8 @@ public <B>WSTester</B>()</PRE>
 <A NAME="main(java.lang.String[])"><!-- --></A><H3>\r
 main</H3>\r
 <PRE>\r
-public static &lt;T&gt; void <B>main</B>(java.lang.String[]&nbsp;args)</PRE>\r
+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
+                 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
 <DL>\r
 <DD>Test JWS2 web services\r
 <P>\r
@@ -206,7 +278,28 @@ public static &lt;T&gt; void <B>main</B>(java.lang.String[]&nbsp;args)</PRE>
             context path>
  
             -s=<ServiceName> which is optional. If service name is not
-            provided then all known JWS2 web services are tested</DL>\r
+            provided then all known JWS2 web services are tested\r
+<DT><B>Throws:</B>\r
+<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
+</DD>\r
+</DL>\r
+<HR>\r
+\r
+<A NAME="checkService(compbio.ws.client.Services)"><!-- --></A><H3>\r
+checkService</H3>\r
+<PRE>\r
+public boolean <B>checkService</B>(<A HREF="../../../compbio/ws/client/Services.html" title="enum in compbio.ws.client">Services</A>&nbsp;service)\r
+                     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
+                            <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
+<DL>\r
+<DD>Test JABA web service\r
+<P>\r
+<DD><DL>\r
+<DT><B>Parameters:</B><DD><CODE>service</CODE> - the service to test\r
+<DT><B>Returns:</B><DD>true if the service works as expected, false otherwise\r
+<DT><B>Throws:</B>\r
+<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
+<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
 </DD>\r
 </DL>\r
 <!-- ========= END OF CLASS DATA ========= -->\r
@@ -240,7 +333,7 @@ public static &lt;T&gt; void <B>main</B>(java.lang.String[]&nbsp;args)</PRE>
 \r
 <TR>\r
 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
-&nbsp;<A HREF="../../../compbio/ws/client/Jws2Client.Services.html" title="enum in compbio.ws.client"><B>PREV CLASS</B></A>&nbsp;\r
+&nbsp;<A HREF="../../../compbio/ws/client/ServicesUtil.html" title="class in compbio.ws.client"><B>PREV CLASS</B></A>&nbsp;\r
 &nbsp;NEXT CLASS</FONT></TD>\r
 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
   <A HREF="../../../index.html?compbio/ws/client/WSTester.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
@@ -261,9 +354,9 @@ public static &lt;T&gt; void <B>main</B>(java.lang.String[]&nbsp;args)</PRE>
 </TR>\r
 <TR>\r
 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
-  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
+  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
 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
-DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
+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
 </TR>\r
 </TABLE>\r
 <A NAME="skip-navbar_bottom"></A>\r