src/jalview/ws/AWSThread.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
   4  *
   5  * This file is part of Jalview.
   6  *
   7  * Jalview is free software: you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation, either version 3
  10  * of the License, or (at your option) any later version.
  11  *
  12  * Jalview is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty
  14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE.  See the GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  19  * The Jalview Authors are detailed in the 'AUTHORS' file.
  20  */
  21 package jalview.ws;
  22
  23 import jalview.bin.Cache;
  24 import jalview.datamodel.AlignedCodonFrame;
  25 import jalview.datamodel.Alignment;
  26 import jalview.datamodel.AlignmentI;
  27 import jalview.datamodel.AlignmentView;
  28 import jalview.datamodel.SequenceI;
  29 import jalview.gui.AlignFrame;
  30 import jalview.gui.OOMWarning;
  31 import jalview.gui.WebserviceInfo;
  32 import jalview.util.MessageManager;
  33 import jalview.viewmodel.seqfeatures.FeatureRendererSettings;
  34
  35 import java.util.LinkedHashSet;
  36 import java.util.Set;
  37
  38 public abstract class AWSThread extends Thread
  39 {
  40
  41   /**
  42    * view that this job was associated with
  43    */
  44   protected AlignmentI currentView = null;
  45
  46   /**
  47    * feature settings from view that job was associated with
  48    */
  49   protected FeatureRendererSettings featureSettings = null;
  50
  51   /**
  52    * metadata about this web service
  53    */
  54   protected WebserviceInfo wsInfo = null;
  55
  56   /**
  57    * original input data for this job
  58    */
  59   protected AlignmentView input = null;
  60
  61   /**
  62    * dataset sequence relationships to be propagated onto new results
  63    */
  64   protected Set<AlignedCodonFrame> codonframe = null;
  65
  66   /**
  67    * are there jobs still running in this thread.
  68    */
  69   protected boolean jobComplete = false;
  70
  71   /**
  72    * one or more jobs being managed by this thread.
  73    */
  74   protected AWsJob jobs[] = null;
  75
  76   /**
  77    * full name of service
  78    */
  79   protected String WebServiceName = null;
  80
  81   protected char defGapChar = '-';
  82
  83   /**
  84    * header prepended to all output from job
  85    */
  86   protected String OutputHeader;
  87
  88   /**
  89    * only used when reporting a web service out of memory error - the job ID
  90    * will be concatenated to the URL
  91    */
  92   protected String WsUrl = null;
  93
  94   /*
  95    * The AlignFrame from which the service was requested.
  96    */
  97   private AlignFrame alignFrame;
  98
  99   /**
 100    * generic web service job/subjob poll loop
 101    */
 102   public void run()
 103   {
 104     JobStateSummary jstate = null;
 105     if (jobs == null)
 106     {
 107       jobComplete = true;
 108     }
 109     while (!jobComplete)
 110     {
 111       jstate = new JobStateSummary();
 112       for (int j = 0; j < jobs.length; j++)
 113       {
 114
 115         if (!jobs[j].submitted && jobs[j].hasValidInput())
 116         {
 117           StartJob(jobs[j]);
 118         }
 119
 120         if (jobs[j].submitted && !jobs[j].subjobComplete)
 121         {
 122           try
 123           {
 124             pollJob(jobs[j]);
 125             if (!jobs[j].hasResponse())
 126             {
 127               throw (new Exception(
 128                       "Timed out when communicating with server\nTry again later.\n"));
 129             }
 130             Cache.log.debug("Job " + j + " Result state "
 131                     + jobs[j].getState() + "(ServerError="
 132                     + jobs[j].isServerError() + ")");
 133           } catch (Exception ex)
 134           {
 135             // Deal with Transaction exceptions
 136             wsInfo.appendProgressText(jobs[j].jobnum, MessageManager
 137                     .formatMessage("info.server_exception", new Object[]
 138                     { WebServiceName, ex.getMessage() }));
 139             // always output the exception's stack trace to the log
 140             Cache.log.warn(WebServiceName + " job(" + jobs[j].jobnum
 141                     + ") Server exception.");
 142             // todo: could limit trace to cause if this is a SOAPFaultException.
 143             ex.printStackTrace();
 144
 145             if (jobs[j].allowedServerExceptions > 0)
 146             {
 147               jobs[j].allowedServerExceptions--;
 148               Cache.log.debug("Sleeping after a server exception.");
 149               try
 150               {
 151                 Thread.sleep(5000);
 152               } catch (InterruptedException ex1)
 153               {
 154               }
 155             }
 156             else
 157             {
 158               Cache.log.warn("Dropping job " + j + " " + jobs[j].jobId);
 159               jobs[j].subjobComplete = true;
 160               wsInfo.setStatus(jobs[j].jobnum,
 161                       WebserviceInfo.STATE_STOPPED_SERVERERROR);
 162             }
 163           } catch (OutOfMemoryError er)
 164           {
 165             jobComplete = true;
 166             jobs[j].subjobComplete = true;
 167             jobs[j].clearResponse(); // may contain out of date result data
 168             wsInfo.setStatus(jobs[j].jobnum,
 169                     WebserviceInfo.STATE_STOPPED_ERROR);
 170             Cache.log.error("Out of memory when retrieving Job " + j
 171                     + " id:" + WsUrl + "/" + jobs[j].jobId, er);
 172             new OOMWarning("retrieving result for " + WebServiceName, er);
 173             System.gc();
 174           }
 175         }
 176         jstate.updateJobPanelState(wsInfo, OutputHeader, jobs[j]);
 177       }
 178       // Decide on overall state based on collected jobs[] states
 179       updateGlobalStatus(jstate);
 180       if (!jobComplete)
 181       {
 182         try
 183         {
 184           Thread.sleep(5000);
 185         } catch (InterruptedException e)
 186         {
 187           Cache.log
 188                   .debug("Interrupted sleep waiting for next job poll.", e);
 189         }
 190         // System.out.println("I'm alive "+alTitle);
 191       }
 192     }
 193     if (jobComplete && jobs != null)
 194     {
 195       parseResult(); // tidy up and make results available to user
 196     }
 197     else
 198     {
 199       Cache.log
 200               .debug("WebServiceJob poll loop finished with no jobs created.");
 201       wsInfo.setStatus(WebserviceInfo.STATE_STOPPED_ERROR);
 202       wsInfo.appendProgressText(MessageManager
 203               .getString("info.no_jobs_ran"));
 204       wsInfo.setFinishedNoResults();
 205     }
 206   }
 207
 208   protected void updateGlobalStatus(JobStateSummary jstate)
 209   {
 210     if (jstate.running > 0)
 211     {
 212       wsInfo.setStatus(WebserviceInfo.STATE_RUNNING);
 213     }
 214     else if (jstate.queuing > 0)
 215     {
 216       wsInfo.setStatus(WebserviceInfo.STATE_QUEUING);
 217     }
 218     else
 219     {
 220       jobComplete = true;
 221       if (jstate.finished > 0)
 222       {
 223         wsInfo.setStatus(WebserviceInfo.STATE_STOPPED_OK);
 224       }
 225       else if (jstate.error > 0)
 226       {
 227         wsInfo.setStatus(WebserviceInfo.STATE_STOPPED_ERROR);
 228       }
 229       else if (jstate.serror > 0)
 230       {
 231         wsInfo.setStatus(WebserviceInfo.STATE_STOPPED_SERVERERROR);
 232       }
 233     }
 234   }
 235
 236   public AWSThread()
 237   {
 238     super();
 239   }
 240
 241   public AWSThread(Runnable target)
 242   {
 243     super(target);
 244   }
 245
 246   public AWSThread(String name)
 247   {
 248     super(name);
 249   }
 250
 251   public AWSThread(ThreadGroup group, Runnable target)
 252   {
 253     super(group, target);
 254   }
 255
 256   public AWSThread(ThreadGroup group, String name)
 257   {
 258     super(group, name);
 259   }
 260
 261   public AWSThread(Runnable target, String name)
 262   {
 263     super(target, name);
 264   }
 265
 266   public AWSThread(ThreadGroup group, Runnable target, String name)
 267   {
 268     super(group, target, name);
 269   }
 270
 271   /**
 272    * query web service for status of job. on return, job.result must not be null
 273    * - if it is then it will be assumed that the job status query timed out and
 274    * a server exception will be logged.
 275    *
 276    * @param job
 277    * @throws Exception
 278    *           will be logged as a server exception for this job
 279    */
 280   public abstract void pollJob(AWsJob job) throws Exception;
 281
 282   /**
 283    * submit job to web service
 284    *
 285    * @param job
 286    */
 287   public abstract void StartJob(AWsJob job);
 288
 289   /**
 290    * process the set of AWsJob objects into a set of results, and tidy up.
 291    */
 292   public abstract void parseResult();
 293
 294   /**
 295    * helper function to conserve dataset references to sequence objects returned
 296    * from web services 1. Propagates AlCodonFrame data from
 297    * <code>codonframe</code> to <code>al</code> TODO: refactor to datamodel
 298    *
 299    * @param al
 300    */
 301   public void propagateDatasetMappings(Alignment al)
 302   {
 303     if (codonframe != null)
 304     {
 305       SequenceI[] alignment = al.getSequencesArray();
 306       for (int sq = 0; sq < alignment.length; sq++)
 307       {
 308         for (AlignedCodonFrame acf : codonframe)
 309         {
 310           final SequenceI seq = alignment[sq];
 311           if (acf != null && acf.involvesSequence(seq))
 312           {
 313             al.addCodonFrame(acf);
 314             break;
 315           }
 316         }
 317       }
 318     }
 319   }
 320
 321   public AWSThread(ThreadGroup group, Runnable target, String name,
 322           long stackSize)
 323   {
 324     super(group, target, name, stackSize);
 325   }
 326
 327   /**
 328    *
 329    * @return gap character to use for any alignment generation
 330    */
 331   public char getGapChar()
 332   {
 333     return defGapChar;
 334   }
 335
 336   /**
 337    *
 338    * @param alignFrame
 339    *          reference for copying mappings across
 340    * @param wsInfo
 341    *          gui attachment point
 342    * @param input
 343    *          input data for the calculation
 344    * @param webServiceName
 345    *          name of service
 346    * @param wsUrl
 347    *          url of the service being invoked
 348    */
 349   public AWSThread(AlignFrame alignFrame, WebserviceInfo wsinfo,
 350           AlignmentView input, String webServiceName, String wsUrl)
 351   {
 352     this(alignFrame, wsinfo, input, wsUrl);
 353     WebServiceName = webServiceName;
 354   }
 355
 356   /**
 357    * Extracts additional info from alignment view's context.
 358    *
 359    * @param alframe
 360    *          - reference for copying mappings and display styles across
 361    * @param wsinfo2
 362    *          - gui attachment point - may be null
 363    * @param alview
 364    *          - input data for the calculation
 365    * @param wsurl2
 366    *          - url of the service being invoked
 367    */
 368   public AWSThread(AlignFrame alframe, WebserviceInfo wsinfo2,
 369           AlignmentView alview, String wsurl2)
 370   {
 371     super();
 372     this.alignFrame = alframe;
 373     currentView = alframe.getCurrentView().getAlignment();
 374     featureSettings = alframe.getFeatureRenderer().getSettings();
 375     defGapChar = alframe.getViewport().getGapCharacter();
 376     this.wsInfo = wsinfo2;
 377     this.input = alview;
 378     WsUrl = wsurl2;
 379     if (alframe != null)
 380     {
 381       Set<AlignedCodonFrame> cf = alframe.getViewport().getAlignment()
 382               .getCodonFrames();
 383       if (cf != null)
 384       {
 385         codonframe = new LinkedHashSet<AlignedCodonFrame>();
 386         codonframe.addAll(cf);
 387       }
 388     }
 389   }
 390
 391   protected AlignFrame getRequestingAlignFrame()
 392   {
 393     return this.alignFrame;
 394   }
 395 }