X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=website%2Ffull_javadoc%2Fcompbio%2Fws%2Fclient%2FJws2Client.html;fp=website%2Ffull_javadoc%2Fcompbio%2Fws%2Fclient%2FJws2Client.html;h=97c55bf2995c416a1fc4229b8f4b72fbe3bac2cb;hb=b413eee53fa3cc22a6bd4e03c9ac64bf26b7c834;hp=0000000000000000000000000000000000000000;hpb=cb685a2bc244abd07798cda3042953b4afed2407;p=jabaws.git diff --git a/website/full_javadoc/compbio/ws/client/Jws2Client.html b/website/full_javadoc/compbio/ws/client/Jws2Client.html new file mode 100644 index 0000000..97c55bf --- /dev/null +++ b/website/full_javadoc/compbio/ws/client/Jws2Client.html @@ -0,0 +1,375 @@ + + + + + + +Jws2Client + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +compbio.ws.client +
+Class Jws2Client

+
+java.lang.Object
+  extended by compbio.ws.client.Jws2Client
+
+
+
+
public class Jws2Client
extends java.lang.Object
+ + +

+A command line client for Jalview Web Services version 2 +

+ +

+

+
Author:
+
pvtroshin
+
+
+ +

+ + + + + + + + + + + +
+Nested Class Summary
+static classJws2Client.Services + +
+          List of web services currently supported by JWS2
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+static + + + + +
+<T> MsaWS<T>
+		connect(java.lang.String host, + Jws2Client.Services service) + +
+          Connects to a web service by the host and the service name
+static java.lang.StringgetHost(java.lang.String[] cmd) + +
+          Extracts host name from the command line
+static java.lang.StringgetServiceName(java.lang.String[] cmd) + +
+          Extracts service name from the command line
+static voidmain(java.lang.String[] args) + +
+          Starts command line client, if no parameter are supported print help.
+static booleanvalidURL(java.lang.String urlstr) + +
+          Attempt to construct the URL object from the string
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Method Detail
+ +

+validURL

+
+public static boolean validURL(java.lang.String urlstr)
+
+
Attempt to construct the URL object from the string +

+

+
Parameters:
urlstr - +
Returns:
true if it succeed false otherwise
+
+
+
+ +

+getServiceName

+
+public static java.lang.String getServiceName(java.lang.String[] cmd)
+
+
Extracts service name from the command line +

+

+
Parameters:
cmd - command line options +
Returns:
service name or null if it is not defined
+
+
+
+ +

+getHost

+
+public static java.lang.String getHost(java.lang.String[] cmd)
+
+
Extracts host name from the command line +

+

+
Parameters:
cmd - command line options +
Returns:
host name or null if it is not defined
+
+
+
+ +

+connect

+
+public static <T> MsaWS<T> connect(java.lang.String host,
+                                   Jws2Client.Services service)
+                        throws javax.xml.ws.WebServiceException
+
+
Connects to a web service by the host and the service name +

+

+
Type Parameters:
T - web service type
Parameters:
host -
service - +
Returns:
MsaWS +
Throws: +
javax.xml.ws.WebServiceException
+
+
+
+ +

+main

+
+public static void main(java.lang.String[] args)
+
+
Starts command line client, if no parameter are supported print help. Two + parameters are required for successfull call the JWS2 host name and a + service name. +

+

+
Parameters:
args - Usage: -h=host_and_context + -s=serviceName ACTION [OPTIONS] + + -h= - a full URL to the JWS2 web server + including context path e.g. http://10.31.1.159:8080/ws + + -s= - one of [MafftWS, MuscleWS, ClustalWS, + TcoffeeWS, ProbconsWS] ACTIONS: + + -i= - full path to fasta formatted sequence file, + from which to align sequences + + -parameters - lists parameters supported by web service + + -presets - lists presets supported by web service + + -limits - lists web services limits Please note that if input + file is specified other actions are ignored + + OPTIONS: (only for use with -i action): + + -r= - name of the preset to use + + -o= - full path to the file where to write an + alignment -f= - the name of the file with + the list of parameters to use. Please note that -r and -f + options cannot be used together. Alignment is done with either + preset or a parameters from the file, but not both!
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + +