src/jalview/ws/MsaWSClient.java

   1 /*\r
   2  * Jalview - A Sequence Alignment Editor and Viewer\r
   3  * Copyright (C) 2005 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle\r
   4  *\r
   5  * This program is free software; you can redistribute it and/or\r
   6  * modify it under the terms of the GNU General Public License\r
   7  * as published by the Free Software Foundation; either version 2\r
   8  * of the License, or (at your option) any later version.\r
   9  *\r
  10  * This program is distributed in the hope that it will be useful,\r
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
  13  * GNU General Public License for more details.\r
  14  *\r
  15  * You should have received a copy of the GNU General Public License\r
  16  * along with this program; if not, write to the Free Software\r
  17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA\r
  18  */\r
  19 package jalview.ws;\r
  20 \r
  21 import ext.vamsas.*;\r
  22 \r
  23 import jalview.analysis.AlignSeq;\r
  24 \r
  25 import jalview.datamodel.*;\r
  26 \r
  27 import jalview.gui.*;\r
  28 \r
  29 import java.util.*;\r
  30 \r
  31 import javax.swing.*;\r
  32 \r
  33 /**\r
  34  * DOCUMENT ME!\r
  35  *\r
  36  * @author $author$\r
  37  * @version $Revision$\r
  38  */\r
  39 public class MsaWSClient\r
  40     extends WSClient\r
  41 {\r
  42   /**\r
  43    * server is a WSDL2Java generated stub for an archetypal MsaWSI service.\r
  44    */\r
  45   ext.vamsas.MuscleWS server;\r
  46 \r
  47 \r
  48   /**\r
  49    * Creates a new MsaWSClient object that uses a service\r
  50    * given by an externally retrieved ServiceHandle\r
  51    *\r
  52    * @param sh service handle of type AbstractName(MsaWS)\r
  53    * @param altitle DOCUMENT ME!\r
  54    * @param msa DOCUMENT ME!\r
  55    * @param submitGaps DOCUMENT ME!\r
  56    * @param preserveOrder DOCUMENT ME!\r
  57    */\r
  58 \r
  59   public MsaWSClient(ext.vamsas.ServiceHandle sh, String altitle, SequenceI[] msa,\r
  60                      boolean submitGaps, boolean preserveOrder)\r
  61   {\r
  62 \r
  63     if (!sh.getAbstractName().equals("MsaWS"))\r
  64     {\r
  65       JOptionPane.showMessageDialog(Desktop.desktop,\r
  66                                     "The Service called \n" + sh.getName() +\r
  67           "\nis not a \nMultiple Sequence Alignment Service !",\r
  68                                     "Internal Jalview Error",\r
  69                                     JOptionPane.WARNING_MESSAGE);\r
  70 \r
  71       return;\r
  72     }\r
  73 \r
  74     if ((wsInfo = this.setWebService(sh))==null)\r
  75      {\r
  76        JOptionPane.showMessageDialog(Desktop.desktop,\r
  77                                      "The Multiple Sequence Alignment Service named " +\r
  78                                      sh.getName() +\r
  79                                      " is unknown", "Internal Jalview Error",\r
  80                                      JOptionPane.WARNING_MESSAGE);\r
  81 \r
  82        return;\r
  83      }\r
  84     startMsaWSClient(altitle, msa, submitGaps, preserveOrder);\r
  85 \r
  86   }\r
  87 \r
  88 \r
  89   private void startMsaWSClient(String altitle, SequenceI[] msa,\r
  90                      boolean submitGaps, boolean preserveOrder)\r
  91   {\r
  92     if (!locateWebService())\r
  93     {\r
  94       return;\r
  95     }\r
  96 \r
  97     wsInfo.setProgressText( ( (submitGaps) ? "Re-alignment" : "Alignment") +\r
  98                            " of " + altitle + "\nJob details\n");\r
  99 \r
 100     MsaWSThread musclethread = new MsaWSThread(WebServiceName +\r
 101                                                " alignment of " + altitle, msa,\r
 102                                                submitGaps, preserveOrder);\r
 103     wsInfo.setthisService(musclethread);\r
 104     musclethread.start();\r
 105   }\r
 106 \r
 107   /**\r
 108    * Initializes the server field with a valid service implementation.\r
 109    *\r
 110    * @return true if service was located.\r
 111    */\r
 112   private boolean locateWebService()\r
 113   {\r
 114     // TODO: MuscleWS transmuted to generic MsaWS client\r
 115     MuscleWSServiceLocator loc = new MuscleWSServiceLocator(); // Default\r
 116 \r
 117     try\r
 118     {\r
 119       this.server = (MuscleWS) loc.getMuscleWS(new java.net.URL(WsURL));\r
 120       ( (MuscleWSSoapBindingStub)this.server).setTimeout(60000); // One minute timeout\r
 121     }\r
 122     catch (Exception ex)\r
 123     {\r
 124       wsInfo.setProgressText("Serious! " + WebServiceName +\r
 125                              " Service location failed\nfor URL :" + WsURL +\r
 126                              "\n" +\r
 127                              ex.getMessage());\r
 128       wsInfo.setStatus(wsInfo.ERROR);\r
 129       ex.printStackTrace();\r
 130 \r
 131       return false;\r
 132     }\r
 133 \r
 134     loc.getEngine().setOption("axis", "1");\r
 135 \r
 136     return true;\r
 137   }\r
 138 \r
 139   protected class MsaWSThread\r
 140       extends Thread implements WSClientI\r
 141   {\r
 142     String ServiceName = WebServiceName;\r
 143     String OutputHeader;\r
 144     vamsas.objects.simple.MsaResult result = null;\r
 145     vamsas.objects.simple.SequenceSet seqs = new vamsas.objects.simple.\r
 146         SequenceSet();\r
 147     Hashtable SeqNames = null;\r
 148     boolean submitGaps = false; // and always store and recover sequence order\r
 149     boolean preserveOrder = true; // and always store and recover sequence order\r
 150     String jobId;\r
 151     String alTitle; // name which will be used to form new alignment window.\r
 152     int allowedServerExceptions = 3; // thread dies if too many exceptions.\r
 153     boolean jobComplete = false;\r
 154 \r
 155     MsaWSThread(String title, SequenceI[] msa, boolean subgaps,\r
 156                 boolean presorder)\r
 157     {\r
 158       alTitle = title;\r
 159       submitGaps = subgaps;\r
 160       preserveOrder = presorder;\r
 161 \r
 162       OutputHeader = wsInfo.getProgressText();\r
 163       SeqNames = new Hashtable();\r
 164 \r
 165       vamsas.objects.simple.Sequence[] seqarray = new vamsas.objects.simple.\r
 166           Sequence[msa.length];\r
 167 \r
 168       for (int i = 0; i < msa.length; i++)\r
 169       {\r
 170         String newname = jalview.analysis.SeqsetUtils.unique_name(i);\r
 171 \r
 172         // uniquify as we go\r
 173         // TODO: JBPNote: this is a ubiquitous transformation - set of jalview seq objects to vamsas sequences with name preservation\r
 174         SeqNames.put(newname,\r
 175                      jalview.analysis.SeqsetUtils.SeqCharacterHash(msa[i]));\r
 176         seqarray[i] = new vamsas.objects.simple.Sequence();\r
 177         seqarray[i].setId(newname);\r
 178         seqarray[i].setSeq( (submitGaps) ? msa[i].getSequence()\r
 179                            : AlignSeq.extractGaps(\r
 180                                jalview.util.Comparison.GapChars,\r
 181                                msa[i].getSequence()));\r
 182       }\r
 183 \r
 184       this.seqs = new vamsas.objects.simple.SequenceSet();\r
 185       this.seqs.setSeqs(seqarray);\r
 186     }\r
 187 \r
 188     public boolean isCancellable()\r
 189     {\r
 190       return true;\r
 191     }\r
 192 \r
 193     public void cancelJob()\r
 194     {\r
 195       if ( (jobId != null) && !jobId.equals("") && !jobComplete)\r
 196       {\r
 197         String cancelledMessage = "";\r
 198 \r
 199         try\r
 200         {\r
 201           vamsas.objects.simple.WsJobId cancelledJob = server.cancel(jobId);\r
 202 \r
 203           if (cancelledJob.getStatus() == 2)\r
 204           {\r
 205             // CANCELLED_JOB\r
 206             cancelledMessage = "Job cancelled.";\r
 207             wsInfo.setStatus(WebserviceInfo.STATE_CANCELLED_OK);\r
 208             jobComplete = true;\r
 209             jobsRunning--;\r
 210             result = null;\r
 211           }\r
 212           else if (cancelledJob.getStatus() == 3)\r
 213           {\r
 214             // VALID UNSTOPPABLE JOB\r
 215             cancelledMessage +=\r
 216                 "Server cannot cancel this job. just close the window.\n";\r
 217           }\r
 218 \r
 219           if (cancelledJob.getJobId() != null)\r
 220           {\r
 221             cancelledMessage += ("[" + cancelledJob.getJobId() +\r
 222                                  "]");\r
 223           }\r
 224 \r
 225           cancelledMessage += "\n";\r
 226         }\r
 227         catch (Exception exc)\r
 228         {\r
 229           cancelledMessage +=\r
 230               ("\nProblems cancelling the job : Exception received...\n" +\r
 231                exc + "\n");\r
 232           exc.printStackTrace();\r
 233         }\r
 234 \r
 235         wsInfo.setProgressText(OutputHeader + cancelledMessage + "\n");\r
 236       }\r
 237       else\r
 238       {\r
 239         if (!jobComplete)\r
 240         {\r
 241           wsInfo.setProgressText(OutputHeader +\r
 242                                  "Server cannot cancel this job because it has not been submitted properly. just close the window.\n");\r
 243         }\r
 244       }\r
 245     }\r
 246 \r
 247     public void run()\r
 248     {\r
 249       StartJob();\r
 250 \r
 251       while (!jobComplete && (allowedServerExceptions > 0))\r
 252       {\r
 253         try\r
 254         {\r
 255           if ( (result = server.getResult(jobId)) == null)\r
 256           {\r
 257             throw (new Exception(\r
 258                 "Timed out when communicating with server\nTry again later.\n"));\r
 259           }\r
 260           jalview.bin.Jalview.log.debug("Result state " + result.getState() +\r
 261                                         "(ServerError=" + result.isServerError() +\r
 262                                         ")");\r
 263           if (result.isRunning())\r
 264           {\r
 265             wsInfo.setStatus(WebserviceInfo.STATE_RUNNING);\r
 266           }\r
 267           else if (result.isQueued())\r
 268           {\r
 269             wsInfo.setStatus(WebserviceInfo.STATE_QUEUING);\r
 270           }\r
 271 \r
 272           if (result.isFinished())\r
 273           {\r
 274             wsInfo.setStatus(WebserviceInfo.STATE_STOPPED_OK);\r
 275             parseResult();\r
 276             jobComplete = true;\r
 277             jobsRunning--;\r
 278           }\r
 279           else\r
 280           {\r
 281             if (result.getStatus() != null)\r
 282             {\r
 283               wsInfo.setProgressText(OutputHeader + "\n" +\r
 284                                      result.getStatus());\r
 285             }\r
 286             if (result.isServerError())\r
 287             {\r
 288               jobComplete = true;\r
 289               jobsRunning--;\r
 290 \r
 291               break;\r
 292             }\r
 293             if (! (result.isJobFailed() || result.isServerError() ||\r
 294                    result.isBroken() || result.isFailed()))\r
 295             {\r
 296               Thread.sleep(5000);\r
 297 \r
 298               //  System.out.println("I'm alive "+seqid+" "+jobid);\r
 299             }\r
 300             else\r
 301             {\r
 302               jobComplete = true;\r
 303               jobsRunning--;\r
 304               break;\r
 305             }\r
 306           }\r
 307         }\r
 308         catch (Exception ex)\r
 309         {\r
 310           allowedServerExceptions--;\r
 311           wsInfo.appendProgressText("\n" + ServiceName +\r
 312                                     " Server exception!\n" + ex.getMessage());\r
 313           System.err.println(ServiceName + " Server exception: " +\r
 314                              ex.getMessage());\r
 315 \r
 316           //          ex.printStackTrace(); JBPNote Debug\r
 317           try\r
 318           {\r
 319             if (allowedServerExceptions > 0)\r
 320             {\r
 321               Thread.sleep(5000);\r
 322             }\r
 323           }\r
 324           catch (InterruptedException ex1)\r
 325           {\r
 326           }\r
 327         }\r
 328       }\r
 329 \r
 330       if (allowedServerExceptions == 0)\r
 331       {\r
 332         wsInfo.setStatus(WebserviceInfo.STATE_STOPPED_SERVERERROR);\r
 333       }\r
 334       else\r
 335       {\r
 336         if (result != null)\r
 337         {\r
 338           if ( !(result.isJobFailed() || result.isServerError()))\r
 339           {\r
 340             wsInfo.setStatus(WebserviceInfo.STATE_STOPPED_OK);\r
 341           }\r
 342 \r
 343           if (result.isBroken() || result.isFailed())\r
 344           {\r
 345             wsInfo.setStatus(WebserviceInfo.STATE_STOPPED_ERROR);\r
 346           }\r
 347 \r
 348           if (result.isServerError())\r
 349           {\r
 350             wsInfo.setStatus(WebserviceInfo.STATE_STOPPED_SERVERERROR);\r
 351           }\r
 352         }\r
 353       }\r
 354     }\r
 355 \r
 356     void StartJob()\r
 357     {\r
 358       try\r
 359       {\r
 360         vamsas.objects.simple.WsJobId jobsubmit = server.align(seqs);\r
 361 \r
 362         if ( (jobsubmit != null) && (jobsubmit.getStatus() == 1))\r
 363         {\r
 364           jobId = jobsubmit.getJobId();\r
 365           System.out.println(WsURL + " Job Id '" + jobId + "'");\r
 366         }\r
 367         else\r
 368         {\r
 369           if (jobsubmit == null)\r
 370           {\r
 371             throw new Exception("Server at " + WsURL +\r
 372                                 " returned null object, it probably cannot be contacted. Try again later ?");\r
 373           }\r
 374 \r
 375           throw new Exception(jobsubmit.getJobId());\r
 376         }\r
 377       }\r
 378       catch (Exception e)\r
 379       {\r
 380         // TODO: JBPNote catch timeout or other fault types explicitly\r
 381         // For unexpected errors\r
 382         System.err.println(WebServiceName +\r
 383                            "Client: Failed to submit the sequences for alignment (probably a server side problem)\n" +\r
 384                            "When contacting Server:" + WsURL + "\n" +\r
 385                            e.toString() +\r
 386                            "\n");\r
 387         this.allowedServerExceptions = 0;\r
 388         wsInfo.setStatus(wsInfo.STATE_STOPPED_SERVERERROR);\r
 389         wsInfo.appendProgressText(\r
 390             "Failed to submit sequences for alignment.\n" +\r
 391             "It is most likely that there is a problem with the server.\n" +\r
 392             "Just close the window\n");\r
 393 \r
 394         // e.printStackTrace(); // TODO: JBPNote DEBUG\r
 395       }\r
 396     }\r
 397 \r
 398     private jalview.datamodel.Sequence[] getVamsasAlignment(\r
 399         vamsas.objects.simple.Alignment valign)\r
 400     {\r
 401       vamsas.objects.simple.Sequence[] seqs = valign.getSeqs().getSeqs();\r
 402       jalview.datamodel.Sequence[] msa = new jalview.datamodel.Sequence[seqs.\r
 403           length];\r
 404 \r
 405       for (int i = 0, j = seqs.length; i < j; i++)\r
 406       {\r
 407         msa[i] = new jalview.datamodel.Sequence(seqs[i].getId(),\r
 408                                                 seqs[i].getSeq());\r
 409       }\r
 410 \r
 411       return msa;\r
 412     }\r
 413 \r
 414     void parseResult()\r
 415     {\r
 416       SequenceI[] seqs = null;\r
 417 \r
 418       try\r
 419       {\r
 420         // OutputHeader = output.getText();\r
 421         if (result.isFailed())\r
 422         {\r
 423           OutputHeader += "Job failed.\n";\r
 424         }\r
 425 \r
 426         if (result.getStatus() != null)\r
 427         {\r
 428           OutputHeader += ("\n" + result.getStatus());\r
 429         }\r
 430 \r
 431         if (result.getMsa() != null)\r
 432         {\r
 433           OutputHeader += "\nAlignment Object Method Notes\n";\r
 434 \r
 435           String[] lines = result.getMsa().getMethod();\r
 436 \r
 437           for (int line = 0; line < lines.length; line++)\r
 438           {\r
 439             OutputHeader += (lines[line] + "\n");\r
 440           }\r
 441 \r
 442           // JBPNote The returned files from a webservice could be hidden behind icons in the monitor window that, when clicked, pop up their corresponding data\r
 443           seqs = getVamsasAlignment(result.getMsa());\r
 444         }\r
 445 \r
 446         wsInfo.setProgressText(OutputHeader);\r
 447 \r
 448         if (seqs != null)\r
 449         {\r
 450           AlignmentOrder msaorder = new AlignmentOrder(seqs);\r
 451 \r
 452           if (preserveOrder)\r
 453           {\r
 454             jalview.analysis.AlignmentSorter.recoverOrder(seqs);\r
 455           }\r
 456 \r
 457           jalview.analysis.SeqsetUtils.deuniquify(SeqNames, seqs);\r
 458 \r
 459           Alignment al = new Alignment(seqs);\r
 460 \r
 461           // TODO: JBPNote Should also rename the query sequence sometime...\r
 462           AlignFrame af = new AlignFrame(al);\r
 463           af.addSortByOrderMenuItem(ServiceName + " Ordering",\r
 464                                     msaorder);\r
 465 \r
 466           Desktop.addInternalFrame(af, alTitle,\r
 467                                    AlignFrame.NEW_WINDOW_WIDTH,\r
 468                                    AlignFrame.NEW_WINDOW_HEIGHT);\r
 469         }\r
 470       }\r
 471       catch (Exception ex)\r
 472       {\r
 473         ex.printStackTrace();\r
 474       }\r
 475     }\r
 476   }\r
 477 }\r