website/man_dev.html

   1 <?xml version="1.0" encoding="UTF-8"?>\r
   2 <!DOCTYPE html PUBLIC "XHTML 1.0 Strict"\r
   3 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">\r
   4 <html xmlns="http://www.w3.org/1999/xhtml">\r
   5 <head>\r
   6 <meta name="Last-modified" content="Mon, 4 Apr 2011 12:00:00 GMT"/>\r
   7 <title>Java Bioinformatics Analyses Web Services (JABAWS) client developers manual</title>\r
   8 <link href="ws.css" rel="stylesheet" type="text/css" media=\r
   9 "screen, projection, handheld, tv" />\r
  10 <link rel="stylesheet" type="text/css" media="print" href=\r
  11 "print.css" />\r
  12 <script type="text/javascript" src="prototype-1.6.0.3.js"></script>\r
  13 </head>\r
  14 <body>\r
  15 <div id="page">\r
  16 <div id="banner">\r
  17 <table> \r
  18 <tr><td style="width:158px;"><a href="http://www.dundee.ac.uk"><img src="images/uod_lt_long.gif"  alt="University of Dundee" width="158" height="90" class="logo"  title="University of Dundee" longdesc="http://www.dundee.ac.uk"/></a></td>\r
  19 <td class="bg"><img src="images/jabaws2.png" alt="JABAWS-2.0:Disorder" width="353" height="67" title="JABAWS-2.0:Disorder"/></td>\r
  20 <td class="bg"><img src="images/banner_right.png" alt="Disorder" width="200" height="80"/></td>\r
  21 </tr>\r
  22 </table>\r
  23 </div><!-- banner end-->\r
  24 \r
  25 <div id="wrapper">\r
  26 <div id="panel"><a href="index.html">Home</a> \r
  27  <a href="quick_start.html">Getting Started</a> \r
  28  <a class="selected" href="man_about.html">Manual</a> \r
  29         <div id="submenu">\r
  30                 <a href="man_about.html">About</a>\r
  31                 <a href="man_servervm.html" title="JABAWS Server as Virtual Appliance">Server VA</a>\r
  32                 <a href="man_awscloud.html" title="JABAWS Server in the Amazon EC2 Cloud">Server in the Cloud</a>\r
  33                 <a href="man_serverwar.html" title="JABAWS Server as Web Application aRchive">Server WAR</a>\r
  34                 <a href="man_configuration.html" >Server<br/>\r
  35                 Configuration</a>\r
  36                 <a href="man_client.html" title="JABAWS Command Line Client">CMD Client</a>\r
  37                 <a href="man_stats.html" title="JABAWS Usage Statistics">Usage Statistics</a>\r
  38                 <a class="selected" href="man_dev.html" title="Accessing JABAWS from your program">Accessing<br/>\r
  39                 JABAWS</a>      \r
  40                 <a href="man_server_dev.html" >JABAWS Development</a>\r
  41         </div>\r
  42 <a href="download.html">Download</a> \r
  43 <a href="contacts.html">Contact Us</a>\r
  44 <a href="PublicAnnualStat" title="JABAWS server usage statistics">Usage Statistics</a>\r
  45 <a href="http://www.compbio.dundee.ac.uk" title="University of Dundee, The Barton Group" >Barton Group</a>\r
  46 \r
  47 </div>\r
  48 \r
  49 <!-- panel end-->\r
  50 <div id="content">\r
  51 <h2 id="headtitle">JABAWS MANUAL</h2>\r
  52 \r
  53 <h2>Using JABAWS From Your Program </h2>\r
  54 <ul>\r
  55   <li><a href="#wsfunctions">Web services functions overview </a></li>\r
  56   <li><a href="#templatestr">The template client structure</a></li>\r
  57   <li><a href="#connectto">Connecting to JABAWS</a></li>\r
  58   <li><a href="#validnames">Valid JABAWS service names and WSDL files</a></li>\r
  59   <li><a href="#defalign">Aligning sequences</a></li>\r
  60   <li><a href="#checkresults">Checking the status of the calculation </a></li>\r
  61   <li><a href="#presetalign">Aligning with presets</a></li>\r
  62   <li><a href="#customalign">Aligning with custom parameters</a></li>\r
  63   <li><a href="#writingaltofile">Writing alignments to a file</a></li>\r
  64   <li><a href="#compex">A complete client example </a></li>\r
  65   <li><a href="#buildart">Building web services artifacts</a></li>\r
  66 </ul>\r
  67 <h3><a name="wsfunctions" id="wsfunctions"></a>Web services functions overview </h3>\r
  68 <p>All JABA multiple sequence alignment web services comply to the same interface, thus the function described below are available from all the services. </p>\r
  69 <p><strong>Functions for initiating the alignment </strong><span class="code">  String id = align(List&lt;FastaSequence&gt; list)<br />\r
  70   String id = customAlign(List&lt;FastaSequence&gt; sequenceList, List&lt;Option&gt; optionList)<br />\r
  71   String id = presetAlign(List&lt;FastaSequence&gt; sequenceList, Preset preset)</span></p>\r
  72 <p><strong>Functions pertaining to job monitoring and control</strong><br />\r
  73   <span class="code">JobStatus status = getJobStatus(String id)<br />\r
  74   Alignment al = getResult(String id)<br />\r
  75   boolean cancelled = cancelJob(String id)<br />\r
  76   ChunkHolder chunk = pullExecStatistics(String id, long marker)</span></p>\r
  77 <p><strong>Functions relating to service features discovery</strong><br />\r
  78   <span class="code">RunnerConfig rc = getRunnerOptions()<br />\r
  79   Limit limit = getLimit(String name)<br />\r
  80   LimitsManager lm = getLimits()<br />\r
  81   PresetManager pm = getPresets()</span></p>\r
  82 <p>Please refer to a <a href="dm_javadoc/compbio/data/msa/MsaWS.html">data model  javadoc</a> for a detailed description of each methods. </p>\r
  83 <h3><a name="templatestr" id="templatestr"></a>Structure of the template command line client</h3>\r
  84 <table width="100%" border="1">\r
  85   <tr>\r
  86     <td style="width:19%"><strong>Packages</strong></td>\r
  87     <td style="width:81%"><strong>Classes and Interfaces </strong></td>\r
  88   </tr>\r
  89   <tr>\r
  90     <td>compbio.data.msa </td>\r
  91     <td>MsaWS the interface for all multiple sequence alignment web services </td>\r
  92   </tr>\r
  93   <tr>\r
  94     <td>compbio.data.sequence</td>\r
  95     <td>JABAWS data types </td>\r
  96   </tr>\r
  97   <tr>\r
  98     <td>compbio.metadata</td>\r
  99     <td>JABAWS meta data types </td>\r
 100   </tr>\r
 101   <tr>\r
 102     <td>compbio.ws.client</td>\r
 103     <td>JABAWS command line client </td>\r
 104   </tr>\r
 105 </table>\r
 106 <p>Additional utility libraries this client depend upon is the compbio-util-1.3.jar and compbio-annotation-1.0.jar. <br />\r
 107   Please refer to a <a href="dm_javadoc/index.html">data model javadoc</a> for a detailed description of each class and its methods. </p>\r
 108 <h3><a name="connectto" id="connectto"></a>Connecting to JABAWS</h3>\r
 109 <p class="attention">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 <a href="download.html">download page</a>. Please note that for now all the examples are in Java other languages will follow given a sufficient demand. </p>\r
 110 <p>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. </p>\r
 111 <p class="code"> import java.net.URL;<br />\r
 112   import javax.xml.namespace.QName;<br />\r
 113   import javax.xml.ws.Service;<br />\r
 114   ...............<br />\r
 115   1) String qualifiedName = &quot;http://msa.data.compbio/01/01/2010/&quot;;<br />\r
 116   2) URL url = new URL(&quot;http://www.compbio.dundee.ac.uk/jabaws/ClustalWS?wsdl&quot;);<br />\r
 117   3) QName qname = new QName(, &quot;ClustalWS&quot;);<br />\r
 118   4) Service serv = Service.create(url, qname);<br />\r
 119   5) MsaWS msaws = serv.getPort(new QName(qualifiedName, &quot;ClustalWSPort&quot;),\r
 120   MsaWS.class);</p>\r
 121 <p>Line 1 makes a qualified name for JABA web services.<br />\r
 122   Line 2 \r
 123   constructs the URL to the web services WSDL. <br />\r
 124   Line 3 makes a qualified name instance for Clustal JABA web service. <br />\r
 125   Line 4 creates a service instance.<br />\r
 126   Line 5 makes a connection to the server. </p>\r
 127 <p>A more generic connection method would look like this </p>\r
 128 <p class="code"> import java.net.URL;<br />\r
 129   import javax.xml.namespace.QName;<br />\r
 130   import javax.xml.ws.Service;<br />\r
 131   import compbio.ws.client.Services<br />\r
 132   .............. <br />\r
 133   String qualifiedServiceName = &quot;http://msa.data.compbio/01/01/2010/&quot;;<br />\r
 134   String host = &quot;http://www.compbio.dundee.ac.uk/jabaws&quot;;<br />\r
 135   // In real life the service name can come from args<br />\r
 136   Services clustal = Services.ClustalWS;<br />\r
 137   URL url = new URL(host + &quot;/&quot; + clustal.toString() + &quot;?wsdl&quot;);<br />\r
 138   QName qname = new QName(qualifiedServiceName, clustal.toString());<br />\r
 139   Service serv = Service.create(url, qname);<br />\r
 140   MsaWS msaws = serv.getPort(new QName(qualifiedServiceName, clustal<br />\r
 141   + &quot;Port&quot;), MsaWS.class);</p>\r
 142 <p>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 <a href="dm_javadoc/compbio/data/msa/MsaWS.html">javadoc</a>. </p>\r
 143 <h3><a name="validnames" id="validnames"></a>Valid JABAWS service names and WSDL files </h3>\r
 144 <p>Multiple sequence alignment services </p>\r
 145 <ul><li><a href="http://www.compbio.dundee.ac.uk/jabaws/ClustalOWS?wsdl">ClustalOWS</a> (http://www.compbio.dundee.ac.uk/jabaws/ClustalOWS?wsdl) </li>\r
 146   <li><a href="http://www.compbio.dundee.ac.uk/jabaws/ClustalWS?wsdl">ClustalWS</a> (http://www.compbio.dundee.ac.uk/jabaws/ClustalWS?wsdl) </li>\r
 147   <li><a href="http://www.compbio.dundee.ac.uk/jabaws/MuscleWS?wsdl">MuscleWS</a> (http://www.compbio.dundee.ac.uk/jabaws/MuscleWS?wsdl) </li>\r
 148   <li><a href="http://www.compbio.dundee.ac.uk/jabaws/MafftWS?wsdl">MafftWS</a> (http://www.compbio.dundee.ac.uk/jabaws/MafftWS?wsdl) </li>\r
 149   <li><a href="http://www.compbio.dundee.ac.uk/jabaws/TcoffeeWS?wsdl">TcoffeeWS</a> (http://www.compbio.dundee.ac.uk/jabaws/TcoffeeWS?wsdl) </li>\r
 150   <li><a href="http://www.compbio.dundee.ac.uk/jabaws/ProbconsWS?wsdl">ProbconsWS</a> (http://www.compbio.dundee.ac.uk/jabaws/ProbconsWS?wsdl) </li>\r
 151   </ul>\r
 152 <p>Protein disorder prediction services </p>\r
 153 <ul>\r
 154   <li><a href="http://www.compbio.dundee.ac.uk/jabaws/IUPredWS?wsdl">IUPredWS</a> (http://www.compbio.dundee.ac.uk/jabaws/IUPredWS?wsdl) </li>\r
 155   <li><a href="http://www.compbio.dundee.ac.uk/jabaws/GlobPlotWS?wsdl">GlobPlotWS</a> (http://www.compbio.dundee.ac.uk/jabaws/GlobPlotWS?wsdl) </li>\r
 156   <li><a href="http://www.compbio.dundee.ac.uk/jabaws/DisemblWS?wsdl">DisemblWS</a> (http://www.compbio.dundee.ac.uk/jabaws/DisemblWS?wsdl) </li>\r
 157   <li><a href="http://www.compbio.dundee.ac.uk/jabaws/JronnWS?wsdl">JronnWS</a> (http://www.compbio.dundee.ac.uk/jabaws/JronnWS?wsdl) </li>\r
 158   </ul>\r
 159 <p>Amino acid conservation service</p>\r
 160 <ul>\r
 161   <li><a href="http://www.compbio.dundee.ac.uk/jabaws/AAConWS?wsdl">AAConWS</a> (http://www.compbio.dundee.ac.uk/jabaws/AAConWS?wsdl) </li>\r
 162   </ul>\r
 163 <p>Please replace <span class="hightlight">http://www.compbio.dundee.ac.uk/</span> with your JABAWS instance host name, and <span class="hightlight">jabaws</span> with your JABAWS context name to access your local version of JABAWS web services. For example <span class="hightlight">http://localhost:8080/jabaws</span> would be a valid URL for the default Apache-Tomcat installation and jabaws.war file deployment. </p>\r
 164 <h3><a name="defalign" id="defalign"></a>Aligning sequences </h3>\r
 165 <p>Given that <span class="hightlight">msaws</span> is web service proxy, created as described in &quot;Connecting to JABAWS&quot; section, the actual alignment can be obtained as follows: </p>\r
 166 <p class="code">1) List&lt;FastaSequence&gt; fastalist = SequenceUtil.readFasta(new FileInputStream(file));<br />\r
 167   2) String jobId = msaws.align(fastalist); <br />\r
 168   3) Alignment alignment = msaws.getResult(jobId);</p>\r
 169 <p>Line  one loads FASTA sequence from the file<br />\r
 170   Line two submits them to web service represented by msaws proxy <br />\r
 171   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 (<a href="http://www.compbio.dundee.ac.uk/jabaws">www.compbio.dundee.ac.uk/jabaws</a>) 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.<br />\r
 172   Methods and classes mentioned in the excerpt are available from the JABAWS client library. </p>\r
 173 <h3><a name="checkresults" id="checkresults"></a>Checking the status of the calculation </h3>\r
 174 <p> You may have noticed that there was no pause between submitting the job and retrieving of the results. This is because <span class="hightlight">getResult(jobId)</span> method block the processing until the calculation is completed. However, taking into account that the connection holds server resources, our public server (<a href="http://www.compbio.dundee.ac.uk/jabaws">www.compbio.dundee.ac.uk/jabaws</a>) 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: </p>\r
 175 <p> <span class="code">while (msaws.getJobStatus(jobId) != JobStatus.FINISHED) {<br />\r
 176   &nbsp;&nbsp;&nbsp;&nbsp;Thread.sleep(2000); // wait two  seconds, then recheck the status <br />\r
 177   }</span></p>\r
 178 <h3><a name="presetalign" id="presetalign"></a>Aligning with presets</h3>\r
 179 <p class="code">1) PresetManager presetman = msaws.getPresets();<br />\r
 180   2) Preset preset = presetman.getPresetByName(presetName);<br />\r
 181   3) List&lt;FastaSequence&gt; fastalist = SequenceUtil.readFasta(new FileInputStream(file));<br />\r
 182   4) String jobId = msaws.presetAlign(fastalist, preset);<br />\r
 183   5) Alignment alignment = msaws.getResult(jobId);</p>\r
 184 <p>Line one obtains the lists of presets supported by a web service.<br />\r
 185   Line two return a particular Preset \r
 186   by its name<br />\r
 187   Lines three to five  are doing the same job as in the first <a href="#defalign"> aligning sequences example</a>.</p>\r
 188 <h3><a name="customalign" id="customalign"></a>Aligning with  custom parameters</h3>\r
 189 <p class="code"> 1) RunnerConfig options = msaws.getRunnerOptions();<br />\r
 190   2) Argument matrix = options.getArgument(&quot;MATRIX&quot;);<br />\r
 191   3) matrix.setValue(&quot;PAM300&quot;);<br />\r
 192   4) Argument gapopenpenalty = options.getArgument(&quot;GAPOPEN&quot;);<br />\r
 193   5) gapopenpenalty.setValue(&quot;20&quot;);<br />\r
 194   6) List&lt;Argument&gt; arguments = new ArrayList&lt;Argument&gt;(); <br />\r
 195   7) arguments.add(matrix);\r
 196   arguments.add(gapopenpenalty);<br />\r
 197   8) List&lt;FastaSequence&gt; fastalist = SequenceUtil.readFasta(new FileInputStream(file));<br />\r
 198   9) String jobId = msaws.customAlign(fastalist, arguments);<br />\r
 199   10) Alignment alignment = msaws.getResult(jobId);</p>\r
 200 <p>Line one obtains the <span class="hightlight">RunnerConfig</span> object that holds information on supported parameters and their values<br />\r
 201   Line two retrieve a particular parameter from the holder by its name<br />\r
 202   Lines three sets a value to this parameter which will be used in the calculation. <br />\r
 203   Line four and five do the same but for another parameter<br />\r
 204   Line 6 makes a List to hold the parameters <br />\r
 205   Line seven puts the parameters into that list<br />\r
 206   Line eight \r
 207   and ten is the same as in previous examples<br />\r
 208   Line nine submit an alignment request with the sequences and the parameters <br />\r
 209   The names of all the parameters supported by a web service e.g. &quot;PAM300&quot; can be obtained using <span class="hightlight">options.getArguments() </span>method. Further details on the methods available from <span class="hightlight">RunnerConfig</span> object are available from the <a href="dm_javadoc/index.html">javadoc</a>. </p>\r
 210 <h3><a name="writingaltofile" id="writingaltofile"></a>Writing alignments to a file</h3>\r
 211 <p>There is a utility method in the client library that does exactly that. </p>\r
 212 <p> <span class="code">Alignment alignment = align(...) <br />\r
 213   FileOutputStream outStream = new FileOutputStream(file);<br />\r
 214   ClustalAlignmentUtil.writeClustalAlignment(outStream, align);</span></p>\r
 215 <h3><a name="compex" id="compex"></a>A complete client example </h3>\r
 216 <p>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 <a href="Example_template.pdf">PDF version</a> 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 <a href="download.html">JABAWS binary client</a>. Please make sure that the client is in the Java class path before running this example.</p>\r
 217 <pre class="code" style="line-height:1em;">\r
 218 import java.io.ByteArrayInputStream;\r
 219 import java.io.FileNotFoundException;\r
 220 import java.io.IOException;\r
 221 import java.net.URL;\r
 222 import java.util.List;\r
 223 \r
 224 import javax.xml.namespace.QName;\r
 225 import javax.xml.ws.Service;\r
 226 \r
 227 import compbio.data.msa.MsaWS;\r
 228 import compbio.data.sequence.Alignment;\r
 229 import compbio.data.sequence.FastaSequence;\r
 230 import compbio.data.sequence.SequenceUtil;\r
 231 import compbio.metadata.JobSubmissionException;\r
 232 import compbio.metadata.LimitExceededException;\r
 233 import compbio.metadata.Preset;\r
 234 import compbio.metadata.PresetManager;\r
 235 import compbio.metadata.ResultNotAvailableException;\r
 236 import compbio.metadata.UnsupportedRuntimeException;\r
 237 import compbio.metadata.WrongParameterException;\r
 238 \r
 239 public class Example {\r
 240 \r
 241         /*\r
 242          * Input sequences for alignment\r
 243          */\r
 244         static final String input = &quot;&gt;Foo\r\n&quot;\r
 245                         + &quot;MTADGPRELLQLRAAVRHRPQDFVAWLMLADAELGMGDTTAGEMAVQRGLALHPGHPEAVARLGR&quot;\r
 246                         + &quot;VRWTQQRHAEAAVLLQQASDAAPEHPGIALWLGHALEDAGQAEAAAAAYTRAHQLLPEEPYITAQ&quot;\r
 247                         + &quot;LLNWRRRLCDWRALDVLSAQVRAAVAQGVGAVEPFAFLSEDASAAEQLACARTRAQAIAASVRPL&quot;\r
 248                         + &quot;APTRVRSKGPLRVGFVSNGFGAHPTGLLTVALFEALQRRQPDLQMHLFATSGDDGSTLRTRLAQA&quot;\r
 249                         + &quot;STLHDVTALGHLATAKHIRHHGIDLLFDLRGWGGGGRPEVFALRPAPVQVNWLAYPGTSGAPWMD&quot;\r
 250                         + &quot;YVLGDAFALPPALEPFYSEHVLRLQGAFQPSDTSRVVAEPPSRTQCGLPEQGVVLCCFNNSYKLN&quot;\r
 251                         + &quot;PQSMARMLAVLREVPDSVLWLLSGPGEADARLRAFAHAQGVDAQRLVFMPKLPHPQYLARYRHAD&quot;\r
 252                         + &quot;LFLDTHPYNAHTTASDALWTGCPVLTTPGETFAARVAGSLNHHLGLDEMNVADDAAFVAKAVALAS&quot;\r
 253                         + &quot;DPAALTALHARVDVLRRESGVFEMDGFADDFGALLQALARRHGWLGI\r\n&quot;\r
 254                         + &quot;\r\n&quot;\r
 255                         + &quot;&gt;Bar\r\n&quot;\r
 256                         + &quot;MGDTTAGEMAVQRGLALHQQRHAEAAVLLQQASDAAPEHPGIALWLHALEDAGQAEAAAAYTRAH&quot;\r
 257                         + &quot;QLLPEEPYITAQLLNAVAQGVGAVEPFAFLSEDASAAESVRPLAPTRVRSKGPLRVGFVSNGFGA&quot;\r
 258                         + &quot;HPTGLLTVALFEALQRRQPDLQMHLFATSGDDGSTLRTRLAQASTLHDVTALGHLATAKHIRHHG&quot;\r
 259                         + &quot;IDLLFDLRGWGGGGRPEVFALRPAPVQVNWLAYPGTSGAPWMDYVLGDAFALPPALEPFYSEHVL&quot;\r
 260                         + &quot;RLQGAFQPSDTSRVVAEPPSRTQCGLPEQGVVLCCFNNSYKLNPQSMARMLAVLREVPDSVLWLL&quot;\r
 261                         + &quot;SGPGEADARLRAFAHAQGVDAQRLVFMPKLPHPQYLARYRHADLFLDTHPYNAHTTASDALWTGC&quot;\r
 262                         + &quot;PVLTTPGETFAARVAGSLNHHLGLDEMNVADDAAFVAKAVALASDPAALTALHARVDVLRRESGV&quot;\r
 263                         + &quot;FEMDGFADDFGALLQALARRHGWLGI\r\n&quot;\r
 264                         + &quot;\r\n&quot;\r
 265                         + &quot;&gt;Friends\r\n&quot;\r
 266                         + &quot;MTADGPRELLQLRAAVRHRPQDVAWLMLADAELGMGDTTAGEMAVQRGLALHPGHPEAVARLGRV&quot;\r
 267                         + &quot;RWTQQRHAEAAVLLQQASDAAPEHPGIALWLGHALEDHQLLPEEPYITAQLDVLSAQVRAAVAQG&quot;\r
 268                         + &quot;VGAVEPFAFLSEDASAAEQLACARTRAQAIAASVRPLAPTRVRSKGPLRVGFVSNGFGAHPTGLL&quot;\r
 269                         + &quot;TVALFEALQRRQPDLQMHLFATSGDDGSTLRTRLAQASTLHDVTALGHLATAKHIRHHGIDLLFD&quot;\r
 270                         + &quot;LRGWGGGGRPEVFALRPAPVQVNWLAYPGTSGAPWMDYVLGDAFALPPALEPFYSEHVLRLQGAF&quot;\r
 271                         + &quot;QPSDTSRVVAEPPSRTQCGLPEQGVVLCCFNNSYKLNPQSMARMLAVLREVPDSVLWLLSGPGEA&quot;\r
 272                         + &quot;DARLRAFAHAQGVDAQRLVFMPKLPHPQYLARYRHADLFLDTHPYNAHTTASDALWTGCPVLTTP&quot;\r
 273                         + &quot;GETFAARVAGSLNHHLGLDEMNVADDAAFVAKAVALASDPAALTALHARVDVLRRESI&quot;;\r
 274 \r
 275         public static void main(String[] args) throws UnsupportedRuntimeException,\r
 276                         LimitExceededException, JobSubmissionException,\r
 277                         WrongParameterException, FileNotFoundException, IOException,\r
 278                         ResultNotAvailableException, InterruptedException {\r
 279 \r
 280                 String qualifiedServiceName = &quot;http://msa.data.compbio/01/01/2010/&quot;;\r
 281 \r
 282                 /* Make a URL pointing to web service WSDL */\r
 283                 URL url = new URL(\r
 284                                 &quot;http://www.compbio.dundee.ac.uk/jabaws/ClustalWS?wsdl&quot;);\r
 285 \r
 286                 /*\r
 287                  * If you are making a client that connects to different web services\r
 288                  * you can use something like this:\r
 289                  */\r
 290                 // URL url = new URL(host + &quot;/&quot; + Services.ClustalWS.toString() +\r
 291                 // &quot;?wsdl&quot;);\r
 292 \r
 293                 QName qname = new QName(qualifiedServiceName, &quot;ClustalWS&quot;);\r
 294                 Service serv = Service.create(url, qname);\r
 295                 /*\r
 296                  * Multiple sequence alignment interface for Clustal web service\r
 297                  * instance\r
 298                  */\r
 299                 MsaWS msaws = serv.getPort(new QName(qualifiedServiceName, &quot;ClustalWS&quot;\r
 300                                 + &quot;Port&quot;), MsaWS.class);\r
 301 \r
 302                 /* Get the list of available presets */\r
 303                 PresetManager presetman = msaws.getPresets();\r
 304 \r
 305                 /* Get the Preset object by preset name */\r
 306                 Preset preset = presetman\r
 307                                 .getPresetByName(&quot;Disable gap weighting (Speed-oriented)&quot;);\r
 308 \r
 309                 /*\r
 310                  * Load sequences in FASTA format from the file You can use something\r
 311                  * like new FileInputStream(&lt;filename&gt;) to load sequence from the file\r
 312                  */\r
 313                 List&lt;FastaSequence&gt; fastalist = SequenceUtil\r
 314                                 .readFasta(new ByteArrayInputStream(input.getBytes()));\r
 315 \r
 316                 /*\r
 317                  * Submit loaded sequences for an alignment using preset. The job\r
 318                  * identifier is returned by this method, you can retrieve the results\r
 319                  * with it sometime later.\r
 320                  */\r
 321                 String jobId = msaws.presetAlign(fastalist, preset);\r
 322 \r
 323                 /* This method will block for the duration of the calculation */\r
 324                 Alignment alignment = msaws.getResult(jobId);\r
 325 \r
 326                 /*\r
 327                  * This is a better way of obtaining results, it does not involve\r
 328                  * holding the connection open for the duration of the calculation,\r
 329                  * Besides, as the University of Dundee public server will reset the\r
 330                  * connection after 10 minutes of idling, this is the only way to obtain\r
 331                  * the results of long running task from our public server.\r
 332                  */\r
 333                 // while (msaws.getJobStatus(jobId) != JobStatus.FINISHED) {\r
 334                 // Thread.sleep(1000); // wait a second, then recheck the status\r
 335                 // }\r
 336 \r
 337                 /* Output the alignment to standard out */\r
 338                 System.out.println(alignment);\r
 339 \r
 340                 // Alternatively, you can record retrieved alignment into the file in\r
 341                 // ClustalW format\r
 342 \r
 343                 // ClustalAlignmentUtil.writeClustalAlignment(new FileOutputStream(\r
 344                 // &quot;output.al&quot;), alignment);\r
 345 \r
 346         }\r
 347 }\r
 348 </pre>\r
 349 For a more detailed description of all available types and their functions please refer to the <a href="dm_javadoc/index.html">data model javadoc</a>.\r
 350 <h3><a name="buildart" id="buildart"></a>Building web services artifacts</h3>\r
 351 <p>JABAWS are the standard <a href="http://jax-ws.java.net/">JAX-WS</a> SOAP web services, which are <a href="http://www.ws-i.org/">WS-I</a> 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. </p>\r
 352 <p class="code">wsimport -keep http://www.compbio.dundee.ac.uk/jabaws/ClustalWS?wsdl</p>\r
 353 </div>\r
 354 \r
 355 <!-- content end-->\r
 356 <div id="copyright">Last update: 10 August 2011<br />\r
 357  Peter Troshin, Jim Procter and Geoff Barton, The Barton Group, University of\r
 358 Dundee, UK</div>\r
 359 </div>\r
 360 \r
 361 <!-- wrapper end-->\r
 362 </div>\r
 363 <!-- page end-->\r
 364 \r
 365 <!-- Google analitics -->\r
 366 <script type="text/javascript">\r
 367 var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");\r
 368 document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));\r
 369 </script>\r
 370 <script type="text/javascript">\r
 371 try{\r
 372 var pageTracker = _gat._getTracker("UA-5356328-1");\r
 373 pageTracker._trackPageview();\r
 374 } catch(err) {}\r
 375 </script>\r
 376 </body>\r
 377 </html>\r
 378 \r