git://source.jalview.org / jabaws.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
web pages updates to point to new download location also the redirect servlet
[jabaws.git] / website / dm_javadoc / compbio / ws / client / Jws2Client.html
diff --git a/website/dm_javadoc/compbio/ws/client/Jws2Client.html b/website/dm_javadoc/compbio/ws/client/Jws2Client.html
index d1d337c..67eb620 100644 (file)
--- a/website/dm_javadoc/compbio/ws/client/Jws2Client.html
+++ b/website/dm_javadoc/compbio/ws/client/Jws2Client.html
@@ -2,12 +2,12 @@
 <!--NewPage-->\r
 <HTML>\r
 <HEAD>\r
-<!-- Generated by javadoc (build 1.6.0_21) on Tue Dec 21 18:32:59 GMT 2010 -->\r
+<!-- Generated by javadoc (build 1.6.0_24) on Fri Aug 12 14:32:03 BST 2011 -->\r
 <TITLE>\r
 Jws2Client\r
 </TITLE>\r
 \r
-<META NAME="date" CONTENT="2010-12-21">\r
+<META NAME="date" CONTENT="2011-08-12">\r
 \r
 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">\r
 \r
@@ -130,7 +130,24 @@ A command line client for JAva Bioinformatics Analysis Web Services
         <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;Connects to a web service by the host and the service name</TD>\r
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Connects to a web service by the host and the service name web service
+ type</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="../../../compbio/data/msa/RegistryWS.html" title="interface in compbio.data.msa">RegistryWS</A></CODE></FONT></TD>\r
+<TD><CODE><B><A HREF="../../../compbio/ws/client/Jws2Client.html#connectToRegistry(java.lang.String)">connectToRegistry</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;host)</CODE>\r
+\r
+<BR>\r
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get a connection of JABAWS registry</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/util/Set.html?is-external=true" title="class or interface in java.util">Set</A>&lt;<A HREF="../../../compbio/ws/client/Services.html" title="enum in compbio.ws.client">Services</A>&gt;</CODE></FONT></TD>\r
+<TD><CODE><B><A HREF="../../../compbio/ws/client/Jws2Client.html#getServices(java.lang.String)">getServices</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)</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
@@ -142,6 +159,16 @@ A command line client for JAva Bioinformatics Analysis Web Services
 </TR>\r
 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
+<CODE>static&nbsp;void</CODE></FONT></TD>\r
+<TD><CODE><B><A HREF="../../../compbio/ws/client/Jws2Client.html#testService(java.lang.String, compbio.ws.client.Services, java.io.PrintWriter)">testService</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="../../../compbio/ws/client/Services.html" title="enum in compbio.ws.client">Services</A>&nbsp;service,\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;Asks registry to test the service on the host hostname</TD>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 <CODE>static&nbsp;boolean</CODE></FONT></TD>\r
 <TD><CODE><B><A HREF="../../../compbio/ws/client/Jws2Client.html#validURL(java.lang.String)">validURL</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;urlstr)</CODE>\r
 \r
@@ -185,20 +212,83 @@ public static boolean <B>validURL</B>(<A HREF="http://java.sun.com/javase/6/docs
 </DL>\r
 <HR>\r
 \r
+<A NAME="testService(java.lang.String, compbio.ws.client.Services, java.io.PrintWriter)"><!-- --></A><H3>\r
+testService</H3>\r
+<PRE>\r
+public static void <B>testService</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="../../../compbio/ws/client/Services.html" title="enum in compbio.ws.client">Services</A>&nbsp;service,\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)\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>Asks registry to test the service on the host hostname\r
+<P>\r
+<DD><DL>\r
+<DT><B>Parameters:</B><DD><CODE>hostname</CODE> - <DD><CODE>service</CODE> - <DD><CODE>writer</CODE> - \r
+<DT><B>Throws:</B>\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>\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></DL>\r
+</DD>\r
+</DL>\r
+<HR>\r
+\r
+<A NAME="getServices(java.lang.String)"><!-- --></A><H3>\r
+getServices</H3>\r
+<PRE>\r
+public static <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</A>&lt;<A HREF="../../../compbio/ws/client/Services.html" title="enum in compbio.ws.client">Services</A>&gt; <B>getServices</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
+                                 throws <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>,\r
+                                        <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></PRE>\r
+<DL>\r
+<DD><DL>\r
+\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
+<HR>\r
+\r
 <A NAME="connect(java.lang.String, compbio.ws.client.Services)"><!-- --></A><H3>\r
 connect</H3>\r
 <PRE>\r
 public static <A HREF="../../../compbio/data/msa/JABAService.html" title="interface in compbio.data.msa">JABAService</A> <B>connect</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;host,\r
                                   <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/javax/xml/ws/WebServiceException.html?is-external=true" title="class or interface in javax.xml.ws">WebServiceException</A></PRE>\r
+                           throws <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>,\r
+                                  <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></PRE>\r
 <DL>\r
-<DD>Connects to a web service by the host and the service name\r
+<DD>Connects to a web service by the host and the service name web service
+ type\r
 <P>\r
 <DD><DL>\r
-<DT><B>Parameters:</B><DD><CODE>T</CODE> - web service type<DD><CODE>host</CODE> - <DD><CODE>service</CODE> - \r
-<DT><B>Returns:</B><DD>MsaWS<T>\r
+<DT><B>Parameters:</B><DD><CODE>host</CODE> - the fully qualified name of JABAWS server including JABAWS
+            context name e.g
+            http://nanna.cluster.lifesci.dundee.ac.uk:8080/jaba<DD><CODE>service</CODE> - the name of the JABAWS service to connect to\r
+<DT><B>Returns:</B><DD>JABAService<T>\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></DL>\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> - if fails to connect to the service on the host</DL>\r
+</DD>\r
+</DL>\r
+<HR>\r
+\r
+<A NAME="connectToRegistry(java.lang.String)"><!-- --></A><H3>\r
+connectToRegistry</H3>\r
+<PRE>\r
+public static <A HREF="../../../compbio/data/msa/RegistryWS.html" title="interface in compbio.data.msa">RegistryWS</A> <B>connectToRegistry</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;host)\r
+                                    throws <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>,\r
+                                           <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></PRE>\r
+<DL>\r
+<DD>Get a connection of JABAWS registry\r
+<P>\r
+<DD><DL>\r
+<DT><B>Parameters:</B><DD><CODE>host</CODE> - the fully qualified name of JABAWS server including JABAWS
+            context name e.g
+            http://nanna.cluster.lifesci.dundee.ac.uk:8080/jaba\r
+<DT><B>Returns:</B><DD>compbio.data.msa.RegistryWS - instance of a RegistryWS web
+         service\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
 <HR>\r
@@ -209,7 +299,7 @@ main</H3>
 public static 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)</PRE>\r
 <DL>\r
 <DD>Starts command line client, if no parameter are supported print help. Two
- parameters are required for successfull call the JWS2 host name and a
+ parameters are required for successful call the JWS2 host name and a
  service name.\r
 <P>\r
 <DD><DL>\r