97c55bf2995c416a1fc4229b8f4b72fbe3bac2cb
[jabaws.git] / website / full_javadoc / compbio / ws / client / Jws2Client.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_14) on Wed Feb 17 16:46:50 GMT 2010 -->\r
6 <TITLE>\r
7 Jws2Client\r
8 </TITLE>\r
9 \r
10 <META NAME="date" CONTENT="2010-02-17">\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="Jws2Client";\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/Jws2Client.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;PREV CLASS&nbsp;\r
59 &nbsp;<A HREF="../../../compbio/ws/client/Jws2Client.Services.html" title="enum in compbio.ws.client"><B>NEXT CLASS</B></A></FONT></TD>\r
60 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
61   <A HREF="../../../index.html?compbio/ws/client/Jws2Client.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
62 &nbsp;<A HREF="Jws2Client.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;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&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;CONSTR&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 Jws2Client</H2>\r
94 <PRE>\r
95 java.lang.Object\r
96   <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>compbio.ws.client.Jws2Client</B>\r
97 </PRE>\r
98 <HR>\r
99 <DL>\r
100 <DT><PRE>public class <B>Jws2Client</B><DT>extends java.lang.Object</DL>\r
101 </PRE>\r
102 \r
103 <P>\r
104 A command line client for Jalview Web Services version 2\r
105 <P>\r
106 \r
107 <P>\r
108 <DL>\r
109 <DT><B>Author:</B></DT>\r
110   <DD>pvtroshin</DD>\r
111 </DL>\r
112 <HR>\r
113 \r
114 <P>\r
115 <!-- ======== NESTED CLASS SUMMARY ======== -->\r
116 \r
117 <A NAME="nested_class_summary"><!-- --></A>\r
118 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
119 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
120 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
121 <B>Nested Class Summary</B></FONT></TH>\r
122 </TR>\r
123 <TR BGCOLOR="white" CLASS="TableRowColor">\r
124 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
125 <CODE>static&nbsp;class</CODE></FONT></TD>\r
126 <TD><CODE><B><A HREF="../../../compbio/ws/client/Jws2Client.Services.html" title="enum in compbio.ws.client">Jws2Client.Services</A></B></CODE>\r
127 \r
128 <BR>\r
129 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;List of web services currently supported by JWS2</TD>\r
130 </TR>\r
131 </TABLE>\r
132 &nbsp;\r
133 <!-- ========== METHOD SUMMARY =========== -->\r
134 \r
135 <A NAME="method_summary"><!-- --></A>\r
136 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
137 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
138 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
139 <B>Method Summary</B></FONT></TH>\r
140 </TR>\r
141 <TR BGCOLOR="white" CLASS="TableRowColor">\r
142 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
143 <CODE>static\r
144 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY="">\r
145 <TR ALIGN="right" VALIGN="">\r
146 <TD NOWRAP><FONT SIZE="-1">\r
147 <CODE>&lt;T&gt; <A HREF="../../../compbio/data/msa/MsaWS.html" title="interface in compbio.data.msa">MsaWS</A>&lt;T&gt;</CODE></FONT></TD>\r
148 </TR>\r
149 </TABLE>\r
150 </CODE></FONT></TD>\r
151 <TD><CODE><B><A HREF="../../../compbio/ws/client/Jws2Client.html#connect(java.lang.String, compbio.ws.client.Jws2Client.Services)">connect</A></B>(java.lang.String&nbsp;host,\r
152         <A HREF="../../../compbio/ws/client/Jws2Client.Services.html" title="enum in compbio.ws.client">Jws2Client.Services</A>&nbsp;service)</CODE>\r
153 \r
154 <BR>\r
155 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Connects to a web service by the host and the service name</TD>\r
156 </TR>\r
157 <TR BGCOLOR="white" CLASS="TableRowColor">\r
158 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
159 <CODE>static&nbsp;java.lang.String</CODE></FONT></TD>\r
160 <TD><CODE><B><A HREF="../../../compbio/ws/client/Jws2Client.html#getHost(java.lang.String[])">getHost</A></B>(java.lang.String[]&nbsp;cmd)</CODE>\r
161 \r
162 <BR>\r
163 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Extracts host name from the command line</TD>\r
164 </TR>\r
165 <TR BGCOLOR="white" CLASS="TableRowColor">\r
166 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
167 <CODE>static&nbsp;java.lang.String</CODE></FONT></TD>\r
168 <TD><CODE><B><A HREF="../../../compbio/ws/client/Jws2Client.html#getServiceName(java.lang.String[])">getServiceName</A></B>(java.lang.String[]&nbsp;cmd)</CODE>\r
169 \r
170 <BR>\r
171 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Extracts service name from the command line</TD>\r
172 </TR>\r
173 <TR BGCOLOR="white" CLASS="TableRowColor">\r
174 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
175 <CODE>static&nbsp;void</CODE></FONT></TD>\r
176 <TD><CODE><B><A HREF="../../../compbio/ws/client/Jws2Client.html#main(java.lang.String[])">main</A></B>(java.lang.String[]&nbsp;args)</CODE>\r
177 \r
178 <BR>\r
179 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Starts command line client, if no parameter are supported print help.</TD>\r
180 </TR>\r
181 <TR BGCOLOR="white" CLASS="TableRowColor">\r
182 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
183 <CODE>static&nbsp;boolean</CODE></FONT></TD>\r
184 <TD><CODE><B><A HREF="../../../compbio/ws/client/Jws2Client.html#validURL(java.lang.String)">validURL</A></B>(java.lang.String&nbsp;urlstr)</CODE>\r
185 \r
186 <BR>\r
187 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Attempt to construct the URL object from the string</TD>\r
188 </TR>\r
189 </TABLE>\r
190 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>\r
191 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
192 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
193 <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>\r
194 </TR>\r
195 <TR BGCOLOR="white" CLASS="TableRowColor">\r
196 <TD><CODE>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>\r
197 </TR>\r
198 </TABLE>\r
199 &nbsp;\r
200 <P>\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="validURL(java.lang.String)"><!-- --></A><H3>\r
213 validURL</H3>\r
214 <PRE>\r
215 public static boolean <B>validURL</B>(java.lang.String&nbsp;urlstr)</PRE>\r
216 <DL>\r
217 <DD>Attempt to construct the URL object from the string\r
218 <P>\r
219 <DD><DL>\r
220 <DT><B>Parameters:</B><DD><CODE>urlstr</CODE> - \r
221 <DT><B>Returns:</B><DD>true if it succeed false otherwise</DL>\r
222 </DD>\r
223 </DL>\r
224 <HR>\r
225 \r
226 <A NAME="getServiceName(java.lang.String[])"><!-- --></A><H3>\r
227 getServiceName</H3>\r
228 <PRE>\r
229 public static java.lang.String <B>getServiceName</B>(java.lang.String[]&nbsp;cmd)</PRE>\r
230 <DL>\r
231 <DD>Extracts service name from the command line\r
232 <P>\r
233 <DD><DL>\r
234 <DT><B>Parameters:</B><DD><CODE>cmd</CODE> - command line options\r
235 <DT><B>Returns:</B><DD>service name or null if it is not defined</DL>\r
236 </DD>\r
237 </DL>\r
238 <HR>\r
239 \r
240 <A NAME="getHost(java.lang.String[])"><!-- --></A><H3>\r
241 getHost</H3>\r
242 <PRE>\r
243 public static java.lang.String <B>getHost</B>(java.lang.String[]&nbsp;cmd)</PRE>\r
244 <DL>\r
245 <DD>Extracts host name from the command line\r
246 <P>\r
247 <DD><DL>\r
248 <DT><B>Parameters:</B><DD><CODE>cmd</CODE> - command line options\r
249 <DT><B>Returns:</B><DD>host name or null if it is not defined</DL>\r
250 </DD>\r
251 </DL>\r
252 <HR>\r
253 \r
254 <A NAME="connect(java.lang.String, compbio.ws.client.Jws2Client.Services)"><!-- --></A><H3>\r
255 connect</H3>\r
256 <PRE>\r
257 public static &lt;T&gt; <A HREF="../../../compbio/data/msa/MsaWS.html" title="interface in compbio.data.msa">MsaWS</A>&lt;T&gt; <B>connect</B>(java.lang.String&nbsp;host,\r
258                                    <A HREF="../../../compbio/ws/client/Jws2Client.Services.html" title="enum in compbio.ws.client">Jws2Client.Services</A>&nbsp;service)\r
259                         throws javax.xml.ws.WebServiceException</PRE>\r
260 <DL>\r
261 <DD>Connects to a web service by the host and the service name\r
262 <P>\r
263 <DD><DL>\r
264 <DT><B>Type Parameters:</B><DD><CODE>T</CODE> - web service type<DT><B>Parameters:</B><DD><CODE>host</CODE> - <DD><CODE>service</CODE> - \r
265 <DT><B>Returns:</B><DD>MsaWS<T>\r
266 <DT><B>Throws:</B>\r
267 <DD><CODE>javax.xml.ws.WebServiceException</CODE></DL>\r
268 </DD>\r
269 </DL>\r
270 <HR>\r
271 \r
272 <A NAME="main(java.lang.String[])"><!-- --></A><H3>\r
273 main</H3>\r
274 <PRE>\r
275 public static void <B>main</B>(java.lang.String[]&nbsp;args)</PRE>\r
276 <DL>\r
277 <DD>Starts command line client, if no parameter are supported print help. Two
278  parameters are required for successfull call the JWS2 host name and a
279  service name.\r
280 <P>\r
281 <DD><DL>\r
282 <DT><B>Parameters:</B><DD><CODE>args</CODE> - Usage: <Class or Jar file name> -h=host_and_context
283             -s=serviceName ACTION [OPTIONS]
284  
285             -h=<host_and_context> - a full URL to the JWS2 web server
286             including context path e.g. http://10.31.1.159:8080/ws
287  
288             -s=<ServiceName> - one of [MafftWS, MuscleWS, ClustalWS,
289             TcoffeeWS, ProbconsWS] ACTIONS:
290  
291             -i=<inputFile> - full path to fasta formatted sequence file,
292             from which to align sequences
293  
294             -parameters - lists parameters supported by web service
295  
296             -presets - lists presets supported by web service
297  
298             -limits - lists web services limits Please note that if input
299             file is specified other actions are ignored
300  
301             OPTIONS: (only for use with -i action):
302  
303             -r=<presetName> - name of the preset to use
304  
305             -o=<outputFile> - full path to the file where to write an
306             alignment -f=<parameterInputFile> - the name of the file with
307             the list of parameters to use. Please note that -r and -f
308             options cannot be used together. Alignment is done with either
309             preset or a parameters from the file, but not both!</DL>\r
310 </DD>\r
311 </DL>\r
312 <!-- ========= END OF CLASS DATA ========= -->\r
313 <HR>\r
314 \r
315 \r
316 <!-- ======= START OF BOTTOM NAVBAR ====== -->\r
317 <A NAME="navbar_bottom"><!-- --></A>\r
318 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>\r
319 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
320 <TR>\r
321 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
322 <A NAME="navbar_bottom_firstrow"><!-- --></A>\r
323 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
324   <TR ALIGN="center" VALIGN="top">\r
325   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
326   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
327   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
328   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/Jws2Client.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>\r
329   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
330   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
331   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
332   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
333   </TR>\r
334 </TABLE>\r
335 </TD>\r
336 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
337 </EM>\r
338 </TD>\r
339 </TR>\r
340 \r
341 <TR>\r
342 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
343 &nbsp;PREV CLASS&nbsp;\r
344 &nbsp;<A HREF="../../../compbio/ws/client/Jws2Client.Services.html" title="enum in compbio.ws.client"><B>NEXT CLASS</B></A></FONT></TD>\r
345 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
346   <A HREF="../../../index.html?compbio/ws/client/Jws2Client.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
347 &nbsp;<A HREF="Jws2Client.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
348 &nbsp;<SCRIPT type="text/javascript">\r
349   <!--\r
350   if(window==top) {\r
351     document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
352   }\r
353   //-->\r
354 </SCRIPT>\r
355 <NOSCRIPT>\r
356   <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>\r
357 </NOSCRIPT>\r
358 \r
359 \r
360 </FONT></TD>\r
361 </TR>\r
362 <TR>\r
363 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
364   SUMMARY:&nbsp;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
365 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
366 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
367 </TR>\r
368 </TABLE>\r
369 <A NAME="skip-navbar_bottom"></A>\r
370 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
371 \r
372 <HR>\r
373 \r
374 </BODY>\r
375 </HTML>\r