 |
-  |
+  |
 |
Additional utility libraries this client depend upon is the compbio-util-1.3.jar and compbio-annotation-1.0.jar.
+
Additional utility libraries that this client depend upon is the compbio-util-1.3.jar and compbio-annotation-1.0.jar.
Please refer to a data model javadoc for a detailed description of each class and its methods.
Connecting to JABAWS
-For a complete working example of JABAWS command line client please see compbio.ws.client.Jws2Client class. JABAWS command line client source code is available from the download page. Please note that for now all the examples are in Java other languages will follow given a sufficient demand.
-Download a binary JABAWS client. Add the client to the class path. The following code excerpt will connect your program to Clustal web service deployed in the University of Dundee.
++For a complete working example of JABAWS command line client please see compbio.ws.client.Jws2Client class. JABAWS command line client +<<<<<<< HEAD +source code is available from the download page. Please note that for now all +the examples are in Java other languages will follow given a sufficient demand.
+======= +source code is available from the download page. Please note that for now all +the examples are in Java, other languages will follow if there is sufficient demand. +>>>>>>> 42a3637e24a7a65b5a1e6048e581df998b4a4f95 ++Download a binary JABAWS client. Add the client to the class path. The following code excerpt will connect your program to Clustal +web service deployed in the University of Dundee.
import java.net.URL;
import javax.xml.namespace.QName;
import javax.xml.ws.Service;
@@ -118,14 +130,18 @@
3) QName qname = new QName(, "ClustalWS");
4) Service serv = Service.create(url, qname);
5) MsaWS msaws = serv.getPort(new QName(qualifiedName, "ClustalWSPort"),
- MsaWS.class);
Line 1 makes a qualified name for JABA web services.
- Line 2
- constructs the URL to the web services WSDL.
- Line 3 makes a qualified name instance for Clustal JABA web service.
- Line 4 creates a service instance.
- Line 5 makes a connection to the server.
A more generic connection method would look like this
+ MsaWS.class); + +
+ Line 1 makes a qualified name for JABA web services.
+ Line 2 constructs the URL to the web services WSDL.
+ Line 3 makes a qualified name instance for Clustal JABA web service.
+ Line 4 creates a service instance.
+ Line 5 makes a connection to the server.
+
+ A more generic connection method would look like this +
import java.net.URL;
import javax.xml.namespace.QName;
import javax.xml.ws.Service;
@@ -139,40 +155,73 @@
QName qname = new QName(qualifiedServiceName, clustal.toString());
Service serv = Service.create(url, qname);
MsaWS msaws = serv.getPort(new QName(qualifiedServiceName, clustal
- + "Port"), MsaWS.class);
Where Services is enumeration of JABAWS web services. All JABAWS multiple sequence alignment methods confirm to MsaWS specification, thus from the caller point of view all JABAWS web services can be represented by MsaWS interface. The full documentation of MsaWS functions is available from the javadoc.
+ + "Port"), MsaWS.class); + ++ Where Services is enumeration of JABAWS web services. All JABAWS multiple sequence alignment methods confirm to + MsaWS specification, thus from the caller point of view all JABAWS web services can be represented by MsaWS + interface. The full documentation of MsaWS functions is available from the javadoc. +
+ +Valid JABAWS service names and WSDL files
Multiple sequence alignment services
-- ClustalOWS (http://www.compbio.dundee.ac.uk/jabaws/ClustalOWS?wsdl) -
- ClustalWS (http://www.compbio.dundee.ac.uk/jabaws/ClustalWS?wsdl) -
- MuscleWS (http://www.compbio.dundee.ac.uk/jabaws/MuscleWS?wsdl) -
- MafftWS (http://www.compbio.dundee.ac.uk/jabaws/MafftWS?wsdl) -
- TcoffeeWS (http://www.compbio.dundee.ac.uk/jabaws/TcoffeeWS?wsdl) -
- ProbconsWS (http://www.compbio.dundee.ac.uk/jabaws/ProbconsWS?wsdl) -
- ClustalOWS (http://www.compbio.dundee.ac.uk/jabaws-dev/ClustalOWS?wsdl) +
- ClustalWS (http://www.compbio.dundee.ac.uk/jabaws-dev/ClustalWS?wsdl) +
- MuscleWS (http://www.compbio.dundee.ac.uk/jabaws-dev/MuscleWS?wsdl) +
- MafftWS (http://www.compbio.dundee.ac.uk/jabaws-dev/MafftWS?wsdl) +
- TcoffeeWS (http://www.compbio.dundee.ac.uk/jabaws-dev/TcoffeeWS?wsdl) +
- ProbconsWS (http://www.compbio.dundee.ac.uk/jabaws-dev/ProbconsWS?wsdl) +
- MSAprobsWS (http://www.compbio.dundee.ac.uk/jabaws-dev/MSAprobsWS?wsdl) +
- GLprobsWS (http://www.compbio.dundee.ac.uk/jabaws-dev/GLprobsWS?wsdl) +
Protein disorder prediction services
-
-
- IUPredWS (http://www.compbio.dundee.ac.uk/jabaws/IUPredWS?wsdl) -
- GlobPlotWS (http://www.compbio.dundee.ac.uk/jabaws/GlobPlotWS?wsdl) -
- DisemblWS (http://www.compbio.dundee.ac.uk/jabaws/DisemblWS?wsdl) -
- JronnWS (http://www.compbio.dundee.ac.uk/jabaws/JronnWS?wsdl) -
Amino acid conservation service
-
-
- AAConWS (http://www.compbio.dundee.ac.uk/jabaws/AAConWS?wsdl) -
Please replace http://www.compbio.dundee.ac.uk/ with your JABAWS instance host name, and jabaws with your JABAWS context name to access your local version of JABAWS web services. For example http://localhost:8080/jabaws would be a valid URL for the default Apache-Tomcat installation and jabaws.war file deployment.
+Protein and RNA Secondary Structure Prediction
+-
+
- JpredWS (http://www.compbio.dundee.ac.uk/jabaws-dev/JpredWS?wsdl) +
- RNAalifoldWS (http://www.compbio.dundee.ac.uk/jabaws-dev/RNAalifoldWS?wsdl) +
+Please replace http://www.compbio.dundee.ac.uk/ with your JABAWS instance host name, and +jabaws with your JABAWS context name to access your local version of JABAWS web services. +For example http://localhost:8080/jabaws would be a valid URL for the default Apache-Tomcat +installation and jabaws.war file deployment.
+ +Aligning sequences
-Given that msaws is web service proxy, created as described in "Connecting to JABAWS" section, the actual alignment can be obtained as follows:
++Given that msaws is web service proxy, created as described in "Connecting to JABAWS" +section, the actual alignment can be obtained as follows:
1) List<FastaSequence> fastalist = SequenceUtil.readFasta(new FileInputStream(file));
2) String jobId = msaws.align(fastalist);
3) Alignment alignment = msaws.getResult(jobId);
Line one loads FASTA sequence from the file
- Line two submits them to web service represented by msaws proxy
- Line three retrieves the alignment from a web service. This line will block the execution until the result is available. Use this with caution. In general, you should make sure that the calculation has been completed before attempting retrieving results. This is to avoid keeping the connection to the server on hold for a prolonged periods of time. While this may be ok with your local server, our public server (www.compbio.dundee.ac.uk/jabaws) will not let you hold the connection for longer than 10 minutes. This is done to prevent excessive load on the server. The next section describes how to check the status of the calculation.
+
Line one loads FASTA sequence from the file.
+ Line two submits them to web service represented by msaws proxy.
+ Line three retrieves the alignment from a web service. This line will block the execution until the result is available.
+ Use this with caution. In general, you should make sure that the calculation has been completed before attempting
+ retrieving results. This is to avoid keeping the connection to the server on hold for a prolonged periods of time.
+ While this may be ok with your local server, our public server
+ (www.compbio.dundee.ac.uk/jabaws) will not let you hold the connection
+ for longer than 10 minutes. This is done to prevent excessive load on the server. The next section describes how to check
+ the status of the calculation.
Methods and classes mentioned in the excerpt are available from the JABAWS client library.
Checking the status of the calculation
-You may have noticed that there was no pause between submitting the job and retrieving of the results. This is because getResult(jobId) method block the processing until the calculation is completed. However, taking into account that the connection holds server resources, our public server (www.compbio.dundee.ac.uk/jabaws) is configured to reset the connection after 10 minutes of waiting. To work around the connection reset you are encouraged to check whether the calculation has been completed before accessing the results. You can do it like this:
+You may have noticed that there was no pause between submitting the job and retrieving of the results. This is +because getResult(jobId) method block the processing until the calculation is completed. +However, taking into account that the connection holds server resources, our public server +(www.compbio.dundee.ac.uk/jabaws) is configured to reset the +connection after 10 minutes of waiting. To work around the connection reset you are encouraged to check whether the +calculation has been completed before accessing the results. You can do it like this:
while (msaws.getJobStatus(jobId) != JobStatus.FINISHED) {
Thread.sleep(2000); // wait two seconds, then recheck the status
}
Line one obtains the lists of presets supported by a web service.
Line two return a particular Preset
- by its name
+ by its name.
Lines three to five are doing the same job as in the first aligning sequences example.
Aligning with custom parameters
1) RunnerConfig options = msaws.getRunnerOptions();
@@ -199,22 +248,32 @@
9) String jobId = msaws.customAlign(fastalist, arguments);
10) Alignment alignment = msaws.getResult(jobId);
Line one obtains the RunnerConfig object that holds information on supported parameters and their values
- Line two retrieve a particular parameter from the holder by its name
+ Line two retrieve a particular parameter from the holder by its name.
Lines three sets a value to this parameter which will be used in the calculation.
- Line four and five do the same but for another parameter
- Line 6 makes a List to hold the parameters
- Line seven puts the parameters into that list
+ Line four and five do the same but for another parameter.
+ Line 6 makes a List to hold the parameters.
+ Line seven puts the parameters into that list.
Line eight
- and ten is the same as in previous examples
- Line nine submit an alignment request with the sequences and the parameters
- The names of all the parameters supported by a web service e.g. "PAM300" can be obtained using options.getArguments() method. Further details on the methods available from RunnerConfig object are available from the javadoc.
+ Line nine submit an alignment request with the sequences and the parameters.
+ The names of all the parameters supported by a web service e.g. "PAM300" can be obtained + using options.getArguments() method. Further details on the methods + available from RunnerConfig object are available from the + javadoc.
Writing alignments to a file
There is a utility method in the client library that does exactly that.
Alignment alignment = align(...)
FileOutputStream outStream = new FileOutputStream(file);
ClustalAlignmentUtil.writeClustalAlignment(outStream, align);
A complete client example
-Finally, a complete example of the program that connects to JABAWS Clustal service and aligns sequences using one of the Clustal web service preset. Three is also a PDF version of this example with syntax highlighted. The text comments are commented by block style comments e.g. /* comment */, the alternatives given in the code are line commented // comment. You may want to remove line style comments to test alternatives of the functions. All you need for this to work is a JABAWS binary client. Please make sure that the client is in the Java class path before running this example.
++Finally, a complete example of the program that connects to JABAWS Clustal service and aligns sequences using +one of the Clustal web service presets. There is also a PDF version of +this example with syntax highlighted. The text comments are commented by block style comments e.g. /* comment */, +the alternatives given in the code are line commented // comment. You may want to remove line style comments to +test alternatives of the functions. All you need for this to work is a +JABAWS binary client. +Please make sure that the client is in the Java class path before running this example.
import java.io.ByteArrayInputStream;
import java.io.FileNotFoundException;
@@ -281,8 +340,7 @@ public class Example {
String qualifiedServiceName = "http://msa.data.compbio/01/01/2010/";
/* Make a URL pointing to web service WSDL */
- URL url = new URL(
- "http://www.compbio.dundee.ac.uk/jabaws/ClustalWS?wsdl");
+ URL url = new URL("http://www.compbio.dundee.ac.uk/jabaws/ClustalWS?wsdl");
/*
* If you are making a client that connects to different web services
@@ -349,10 +407,14 @@ public class Example {
For a more detailed description of all available types and their functions please refer to the data model javadoc.
Building web services artifacts
-JABAWS are the standard JAX-WS SOAP web services, which are WS-I basic profile compatible. This means that you could use whatever tool your language has to work with web services. Below is how you can generate portable artifacts to work with JABAWS from Java. However, if programming in Java we recommend using our client library as it provides a handful of useful methods in addition to plain data types.
++JABAWS are the standard JAX-WS SOAP web services, which are WS-I +basic profile compatible. This means that you could use whatever tool your language has to work with web services. Below is how you can +generate portable artifacts to work with JABAWS from Java. However if programming in Java, we recommend using our client library as +it provides a handful of useful methods in addition to plain data types.
wsimport -keep http://www.compbio.dundee.ac.uk/jabaws/ClustalWS?wsdl
Peter Troshin, Jim Procter and Geoff Barton, The Barton Group, University of Dundee, UK
Sasha Sherstnev, Peter Troshin, Jim Procter and Geoff Barton, The Barton Group, University of Dundee, UK