Client threads for discovered web services.
authorjprocter <Jim Procter>
Wed, 17 Aug 2005 16:31:27 +0000 (16:31 +0000)
committerjprocter <Jim Procter>
Wed, 17 Aug 2005 16:31:27 +0000 (16:31 +0000)
src/jalview/ws/Discoverer.java
src/jalview/ws/JPredClient.java
src/jalview/ws/MsaWSClient.java
src/jalview/ws/MsaWServices.java [deleted file]
src/jalview/ws/WSClient.java

index bc2f613..40d29e7 100755 (executable)
@@ -98,7 +98,7 @@ public class Discoverer
 
     try
     {
-      reallyDiscoverServices = jalview.bin.Cache.getDefault("DISCOVER_SERVICES", false);
+      reallyDiscoverServices = jalview.bin.Cache.getDefault("DISCOVERY_START", false);
       if (reallyDiscoverServices)
       {
         RootServiceURL = new java.net.URL(
index e6f3899..c7508df 100755 (executable)
@@ -33,10 +33,27 @@ public class JPredClient
   ext.vamsas.JPredWS server;\r
   String altitle = "";\r
   java.util.Hashtable SequenceInfo = null;\r
+  public JPredClient(ext.vamsas.ServiceHandle sh, String title, SequenceI seq) {\r
+    wsInfo = setWebService(sh);\r
+    startJPredClient(title, seq);\r
+  }\r
+  public JPredClient(ext.vamsas.ServiceHandle sh, String title, SequenceI[] msa) {\r
+    wsInfo = setWebService(sh);\r
+    startJPredClient(title, msa);\r
+  }\r
+\r
+  public JPredClient(String title, SequenceI[] msf) {\r
+    startJPredClient(title, msf);\r
+  }\r
 \r
-  public JPredClient(String title, SequenceI[] msf)\r
+  public JPredClient(String title, SequenceI seq) {\r
+    startJPredClient(title, seq);\r
+  }\r
+\r
+  private void startJPredClient(String title, SequenceI[] msf)\r
   {\r
-    wsInfo = setWebService();\r
+    if (wsInfo==null)\r
+      wsInfo = setWebService();\r
 \r
     SequenceI seq = msf[0];\r
     altitle = "JNet prediction on " + seq.getName() +\r
@@ -58,9 +75,10 @@ public class JPredClient
     jthread.start();\r
   }\r
 \r
-  public JPredClient(String title, SequenceI seq)\r
+  public void startJPredClient(String title, SequenceI seq)\r
   {\r
-    wsInfo = setWebService();\r
+    if (wsInfo==null)\r
+      wsInfo = setWebService();\r
     wsInfo.setProgressText("Job details for prediction on sequence :\n>" +\r
                            seq.getName() + "\n" +\r
                            AlignSeq.extractGaps("-. ", seq.getSequence()) +\r
@@ -284,6 +302,8 @@ public class JPredClient
       }\r
     }\r
 \r
+\r
+\r
     private void addFloatAnnotations(Alignment al, int[] gapmap,\r
                                      Vector values, String Symname,\r
                                      String Visname, float min,\r
index 0d5c22e..7f754e0 100755 (executable)
@@ -1,21 +1,21 @@
 /*\r
-* Jalview - A Sequence Alignment Editor and Viewer\r
-* Copyright (C) 2005 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle\r
-*\r
-* This program is free software; you can redistribute it and/or\r
-* modify it under the terms of the GNU General Public License\r
-* as published by the Free Software Foundation; either version 2\r
-* of the License, or (at your option) any later version.\r
-*\r
-* This program is distributed in the hope that it will be useful,\r
-* but WITHOUT ANY WARRANTY; without even the implied warranty of\r
-* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
-* GNU General Public License for more details.\r
-*\r
-* You should have received a copy of the GNU General Public License\r
-* along with this program; if not, write to the Free Software\r
-* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA\r
-*/\r
+ * Jalview - A Sequence Alignment Editor and Viewer\r
+ * Copyright (C) 2005 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle\r
+ *\r
+ * This program is free software; you can redistribute it and/or\r
+ * modify it under the terms of the GNU General Public License\r
+ * as published by the Free Software Foundation; either version 2\r
+ * of the License, or (at your option) any later version.\r
+ *\r
+ * This program is distributed in the hope that it will be useful,\r
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
+ * GNU General Public License for more details.\r
+ *\r
+ * You should have received a copy of the GNU General Public License\r
+ * along with this program; if not, write to the Free Software\r
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA\r
+ */\r
 package jalview.ws;\r
 \r
 import ext.vamsas.*;\r
@@ -30,439 +30,448 @@ import java.util.*;
 \r
 import javax.swing.*;\r
 \r
-\r
 /**\r
  * DOCUMENT ME!\r
  *\r
  * @author $author$\r
  * @version $Revision$\r
  */\r
-public class MsaWSClient extends WSClient\r
+public class MsaWSClient\r
+    extends WSClient\r
 {\r
-    /**\r
-    * server is a WSDL2Java generated stub for an archetypal MsaWSI service.\r
-    */\r
-    ext.vamsas.MuscleWS server;\r
-\r
-    /**\r
-     * Creates a new MsaWSClient object.\r
-     *\r
-     * @param MsaWSName DOCUMENT ME!\r
-     * @param altitle DOCUMENT ME!\r
-     * @param msa DOCUMENT ME!\r
-     * @param submitGaps DOCUMENT ME!\r
-     * @param preserveOrder DOCUMENT ME!\r
-     */\r
-    public MsaWSClient(String MsaWSName, String altitle, SequenceI[] msa,\r
-        boolean submitGaps, boolean preserveOrder)\r
+  /**\r
+   * server is a WSDL2Java generated stub for an archetypal MsaWSI service.\r
+   */\r
+  ext.vamsas.MuscleWS server;\r
+\r
+\r
+  /**\r
+   * Creates a new MsaWSClient object that uses a service\r
+   * given by an externally retrieved ServiceHandle\r
+   *\r
+   * @param sh service handle of type AbstractName(MsaWS)\r
+   * @param altitle DOCUMENT ME!\r
+   * @param msa DOCUMENT ME!\r
+   * @param submitGaps DOCUMENT ME!\r
+   * @param preserveOrder DOCUMENT ME!\r
+   */\r
+\r
+  public MsaWSClient(ext.vamsas.ServiceHandle sh, String altitle, SequenceI[] msa,\r
+                     boolean submitGaps, boolean preserveOrder)\r
+  {\r
+\r
+    if (!sh.getAbstractName().equals("MsaWS"))\r
     {\r
-        if (setWebService(MsaWSName) == false)\r
-        {\r
-            JOptionPane.showMessageDialog(Desktop.desktop,\r
-                "The Multiple Sequence Alignment Service named " + MsaWSName +\r
-                " is unknown", "Internal Jalview Error",\r
-                JOptionPane.WARNING_MESSAGE);\r
+      JOptionPane.showMessageDialog(Desktop.desktop,\r
+                                    "The Service called \n" + sh.getName() +\r
+          "\nis not a \nMultiple Sequence Alignment Service !",\r
+                                    "Internal Jalview Error",\r
+                                    JOptionPane.WARNING_MESSAGE);\r
 \r
-            return;\r
-        }\r
+      return;\r
+    }\r
 \r
-        wsInfo = new jalview.gui.WebserviceInfo(WebServiceJobTitle,\r
-                WebServiceReference);\r
+    if ((wsInfo = this.setWebService(sh))==null)\r
+     {\r
+       JOptionPane.showMessageDialog(Desktop.desktop,\r
+                                     "The Multiple Sequence Alignment Service named " +\r
+                                     sh.getName() +\r
+                                     " is unknown", "Internal Jalview Error",\r
+                                     JOptionPane.WARNING_MESSAGE);\r
 \r
-        if (!locateWebService())\r
-        {\r
-            return;\r
-        }\r
+       return;\r
+     }\r
+    startMsaWSClient(altitle, msa, submitGaps, preserveOrder);\r
+\r
+  }\r
 \r
-        wsInfo.setProgressText(((submitGaps) ? "Re-alignment" : "Alignment") +\r
-            " of " + altitle + "\nJob details\n");\r
 \r
-        MsaWSThread musclethread = new MsaWSThread(WebServiceName +\r
-                " alignment of " + altitle, msa, submitGaps, preserveOrder);\r
-        wsInfo.setthisService(musclethread);\r
-        musclethread.start();\r
+  private void startMsaWSClient(String altitle, SequenceI[] msa,\r
+                     boolean submitGaps, boolean preserveOrder)\r
+  {\r
+    if (!locateWebService())\r
+    {\r
+      return;\r
     }\r
 \r
-    // JBPNote Nasty object-global state setting methods shouldn't be allowed\r
-    private boolean setWebService(String MsaWSName)\r
+    wsInfo.setProgressText( ( (submitGaps) ? "Re-alignment" : "Alignment") +\r
+                           " of " + altitle + "\nJob details\n");\r
+\r
+    MsaWSThread musclethread = new MsaWSThread(WebServiceName +\r
+                                               " alignment of " + altitle, msa,\r
+                                               submitGaps, preserveOrder);\r
+    wsInfo.setthisService(musclethread);\r
+    musclethread.start();\r
+  }\r
+\r
+  /**\r
+   * Initializes the server field with a valid service implementation.\r
+   *\r
+   * @return true if service was located.\r
+   */\r
+  private boolean locateWebService()\r
+  {\r
+    // TODO: MuscleWS transmuted to generic MsaWS client\r
+    MuscleWSServiceLocator loc = new MuscleWSServiceLocator(); // Default\r
+\r
+    try\r
     {\r
-        if (MsaWServices.info.containsKey(MsaWSName))\r
-        {\r
-            WebServiceName = MsaWSName;\r
+      this.server = (MuscleWS) loc.getMuscleWS(new java.net.URL(WsURL));\r
+      ( (MuscleWSSoapBindingStub)this.server).setTimeout(60000); // One minute timeout\r
+    }\r
+    catch (Exception ex)\r
+    {\r
+      wsInfo.setProgressText("Serious! " + WebServiceName +\r
+                             " Service location failed\nfor URL :" + WsURL +\r
+                             "\n" +\r
+                             ex.getMessage());\r
+      wsInfo.setStatus(wsInfo.ERROR);\r
+      ex.printStackTrace();\r
+\r
+      return false;\r
+    }\r
 \r
-            String[] wsinfo = (String[]) MsaWServices.info.get(MsaWSName);\r
-            WsURL = wsinfo[0];\r
-            WebServiceJobTitle = wsinfo[1];\r
-            WebServiceReference = wsinfo[2];\r
+    loc.getEngine().setOption("axis", "1");\r
+\r
+    return true;\r
+  }\r
+\r
+  protected class MsaWSThread\r
+      extends Thread implements WSClientI\r
+  {\r
+    String ServiceName = WebServiceName;\r
+    String OutputHeader;\r
+    vamsas.objects.simple.MsaResult result = null;\r
+    vamsas.objects.simple.SequenceSet seqs = new vamsas.objects.simple.\r
+        SequenceSet();\r
+    Hashtable SeqNames = null;\r
+    boolean submitGaps = false; // and always store and recover sequence order\r
+    boolean preserveOrder = true; // and always store and recover sequence order\r
+    String jobId;\r
+    String alTitle; // name which will be used to form new alignment window.\r
+    int allowedServerExceptions = 3; // thread dies if too many exceptions.\r
+    boolean jobComplete = false;\r
+\r
+    MsaWSThread(String title, SequenceI[] msa, boolean subgaps,\r
+                boolean presorder)\r
+    {\r
+      alTitle = title;\r
+      submitGaps = subgaps;\r
+      preserveOrder = presorder;\r
+\r
+      OutputHeader = wsInfo.getProgressText();\r
+      SeqNames = new Hashtable();\r
+\r
+      vamsas.objects.simple.Sequence[] seqarray = new vamsas.objects.simple.\r
+          Sequence[msa.length];\r
+\r
+      for (int i = 0; i < msa.length; i++)\r
+      {\r
+        String newname = jalview.analysis.SeqsetUtils.unique_name(i);\r
+\r
+        // uniquify as we go\r
+        // TODO: JBPNote: this is a ubiquitous transformation - set of jalview seq objects to vamsas sequences with name preservation\r
+        SeqNames.put(newname,\r
+                     jalview.analysis.SeqsetUtils.SeqCharacterHash(msa[i]));\r
+        seqarray[i] = new vamsas.objects.simple.Sequence();\r
+        seqarray[i].setId(newname);\r
+        seqarray[i].setSeq( (submitGaps) ? msa[i].getSequence()\r
+                           : AlignSeq.extractGaps(\r
+                               jalview.util.Comparison.GapChars,\r
+                               msa[i].getSequence()));\r
+      }\r
+\r
+      this.seqs = new vamsas.objects.simple.SequenceSet();\r
+      this.seqs.setSeqs(seqarray);\r
+    }\r
 \r
-            return true;\r
-        }\r
-        else\r
-        {\r
-            return false;\r
-        }\r
+    public boolean isCancellable()\r
+    {\r
+      return true;\r
     }\r
 \r
-    /**\r
-     * DOCUMENT ME!\r
-     *\r
-     * @return DOCUMENT ME!\r
-     */\r
-    private boolean locateWebService()\r
+    public void cancelJob()\r
     {\r
-        // TODO: MuscleWS transmuted to generic MsaWS client\r
-        MuscleWSServiceLocator loc = new MuscleWSServiceLocator(); // Default\r
+      if ( (jobId != null) && !jobId.equals("") && !jobComplete)\r
+      {\r
+        String cancelledMessage = "";\r
 \r
         try\r
         {\r
-            this.server = (MuscleWS) loc.getMuscleWS(new java.net.URL(WsURL));\r
-            ((MuscleWSSoapBindingStub) this.server).setTimeout(60000); // One minute timeout\r
+          vamsas.objects.simple.WsJobId cancelledJob = server.cancel(jobId);\r
+\r
+          if (cancelledJob.getStatus() == 2)\r
+          {\r
+            // CANCELLED_JOB\r
+            cancelledMessage = "Job cancelled.";\r
+            wsInfo.setStatus(WebserviceInfo.STATE_CANCELLED_OK);\r
+            jobComplete = true;\r
+            jobsRunning--;\r
+            result = null;\r
+          }\r
+          else if (cancelledJob.getStatus() == 3)\r
+          {\r
+            // VALID UNSTOPPABLE JOB\r
+            cancelledMessage +=\r
+                "Server cannot cancel this job. just close the window.\n";\r
+          }\r
+\r
+          if (cancelledJob.getJobId() != null)\r
+          {\r
+            cancelledMessage += ("[" + cancelledJob.getJobId() +\r
+                                 "]");\r
+          }\r
+\r
+          cancelledMessage += "\n";\r
         }\r
-        catch (Exception ex)\r
+        catch (Exception exc)\r
         {\r
-            wsInfo.setProgressText("Serious! " + WebServiceName +\r
-                " Service location failed\nfor URL :" + WsURL + "\n" +\r
-                ex.getMessage());\r
-            wsInfo.setStatus(wsInfo.ERROR);\r
-            ex.printStackTrace();\r
-\r
-            return false;\r
+          cancelledMessage +=\r
+              ("\nProblems cancelling the job : Exception received...\n" +\r
+               exc + "\n");\r
+          exc.printStackTrace();\r
         }\r
 \r
-        loc.getEngine().setOption("axis", "1");\r
-\r
-        return true;\r
-    }\r
-\r
-    protected class MsaWSThread extends Thread implements WSClientI\r
-    {\r
-        String ServiceName = WebServiceName;\r
-        String OutputHeader;\r
-        vamsas.objects.simple.MsaResult result = null;\r
-        vamsas.objects.simple.SequenceSet seqs = new vamsas.objects.simple.SequenceSet();\r
-        Hashtable SeqNames = null;\r
-        boolean submitGaps = false; // and always store and recover sequence order\r
-        boolean preserveOrder = true; // and always store and recover sequence order\r
-        String jobId;\r
-        String alTitle; // name which will be used to form new alignment window.\r
-        int allowedServerExceptions = 3; // thread dies if too many exceptions.\r
-        boolean jobComplete = false;\r
-\r
-        MsaWSThread(String title, SequenceI[] msa, boolean subgaps,\r
-            boolean presorder)\r
+        wsInfo.setProgressText(OutputHeader + cancelledMessage + "\n");\r
+      }\r
+      else\r
+      {\r
+        if (!jobComplete)\r
         {\r
-            alTitle = title;\r
-            submitGaps = subgaps;\r
-            preserveOrder = presorder;\r
-\r
-            OutputHeader = wsInfo.getProgressText();\r
-            SeqNames = new Hashtable();\r
-\r
-            vamsas.objects.simple.Sequence[] seqarray = new vamsas.objects.simple.Sequence[msa.length];\r
-\r
-            for (int i = 0; i < msa.length; i++)\r
-            {\r
-                String newname = jalview.analysis.SeqsetUtils.unique_name(i);\r
-\r
-                // uniquify as we go\r
-                // TODO: JBPNote: this is a ubiquitous transformation - set of jalview seq objects to vamsas sequences with name preservation\r
-                SeqNames.put(newname,\r
-                    jalview.analysis.SeqsetUtils.SeqCharacterHash(msa[i]));\r
-                seqarray[i] = new vamsas.objects.simple.Sequence();\r
-                seqarray[i].setId(newname);\r
-                seqarray[i].setSeq((submitGaps) ? msa[i].getSequence()\r
-                                                : AlignSeq.extractGaps(\r
-                        jalview.util.Comparison.GapChars, msa[i].getSequence()));\r
-            }\r
-\r
-            this.seqs = new vamsas.objects.simple.SequenceSet();\r
-            this.seqs.setSeqs(seqarray);\r
+          wsInfo.setProgressText(OutputHeader +\r
+                                 "Server cannot cancel this job because it has not been submitted properly. just close the window.\n");\r
         }\r
+      }\r
+    }\r
 \r
-        public boolean isCancellable()\r
-        {\r
-            return true;\r
-        }\r
+    public void run()\r
+    {\r
+      StartJob();\r
 \r
-        public void cancelJob()\r
+      while (!jobComplete && (allowedServerExceptions > 0))\r
+      {\r
+        try\r
         {\r
-            if ((jobId != null) && !jobId.equals("") && !jobComplete)\r
+          if ( (result = server.getResult(jobId)) == null)\r
+          {\r
+            throw (new Exception(\r
+                "Timed out when communicating with server\nTry again later.\n"));\r
+          }\r
+          jalview.bin.Jalview.log.debug("Result state " + result.getState() +\r
+                                        "(ServerError=" + result.isServerError() +\r
+                                        ")");\r
+          if (result.isRunning())\r
+          {\r
+            wsInfo.setStatus(WebserviceInfo.STATE_RUNNING);\r
+          }\r
+          else if (result.isQueued())\r
+          {\r
+            wsInfo.setStatus(WebserviceInfo.STATE_QUEUING);\r
+          }\r
+\r
+          if (result.isFinished())\r
+          {\r
+            wsInfo.setStatus(WebserviceInfo.STATE_STOPPED_OK);\r
+            parseResult();\r
+            jobComplete = true;\r
+            jobsRunning--;\r
+          }\r
+          else\r
+          {\r
+            if (result.getStatus() != null)\r
             {\r
-                String cancelledMessage = "";\r
-\r
-                try\r
-                {\r
-                    vamsas.objects.simple.WsJobId cancelledJob = server.cancel(jobId);\r
-\r
-                    if (cancelledJob.getStatus() == 2)\r
-                    {\r
-                        // CANCELLED_JOB\r
-                        cancelledMessage = "Job cancelled.";\r
-                        wsInfo.setStatus(WebserviceInfo.STATE_CANCELLED_OK);\r
-                        jobComplete = true;\r
-                        jobsRunning--;\r
-                        result = null;\r
-                    }\r
-                    else if (cancelledJob.getStatus() == 3)\r
-                    {\r
-                        // VALID UNSTOPPABLE JOB\r
-                        cancelledMessage += "Server cannot cancel this job. just close the window.\n";\r
-                    }\r
-\r
-                    if (cancelledJob.getJobId() != null)\r
-                    {\r
-                        cancelledMessage += ("[" + cancelledJob.getJobId() +\r
-                        "]");\r
-                    }\r
-\r
-                    cancelledMessage += "\n";\r
-                }\r
-                catch (Exception exc)\r
-                {\r
-                    cancelledMessage += ("\nProblems cancelling the job : Exception received...\n" +\r
-                    exc + "\n");\r
-                    exc.printStackTrace();\r
-                }\r
-\r
-                wsInfo.setProgressText(OutputHeader + cancelledMessage + "\n");\r
+              wsInfo.setProgressText(OutputHeader + "\n" +\r
+                                     result.getStatus());\r
             }\r
-            else\r
+            if (result.isServerError())\r
             {\r
-                if (!jobComplete)\r
-                {\r
-                    wsInfo.setProgressText(OutputHeader +\r
-                        "Server cannot cancel this job because it has not been submitted properly. just close the window.\n");\r
-                }\r
-            }\r
-        }\r
+              jobComplete = true;\r
+              jobsRunning--;\r
 \r
-        public void run()\r
-        {\r
-            StartJob();\r
-\r
-            while (!jobComplete && (allowedServerExceptions > 0))\r
-            {\r
-                try\r
-                {\r
-                    if ((result = server.getResult(jobId)) == null)\r
-                    {\r
-                        throw (new Exception(\r
-                            "Timed out when communicating with server\nTry again later.\n"));\r
-                    }\r
-\r
-                    if (result.isRunning())\r
-                    {\r
-                        wsInfo.setStatus(WebserviceInfo.STATE_RUNNING);\r
-                    }\r
-                    else if (result.isQueued())\r
-                    {\r
-                        wsInfo.setStatus(WebserviceInfo.STATE_QUEUING);\r
-                    }\r
-\r
-                    if (result.isFinished())\r
-                    {\r
-                        parseResult();\r
-                        jobComplete = true;\r
-                        jobsRunning--;\r
-                    }\r
-                    else\r
-                    {\r
-                        if (result.getStatus() != null)\r
-                        {\r
-                            wsInfo.setProgressText(OutputHeader + "\n" +\r
-                                result.getStatus());\r
-                        }\r
-\r
-                        if (!(result.isJobFailed() || result.isServerError()))\r
-                        {\r
-                            Thread.sleep(5000);\r
-\r
-                            //  System.out.println("I'm alive "+seqid+" "+jobid);\r
-                        }\r
-                        else\r
-                        {\r
-                            break;\r
-                        }\r
-                    }\r
-                }\r
-                catch (Exception ex)\r
-                {\r
-                    allowedServerExceptions--;\r
-                    wsInfo.appendProgressText("\n" + ServiceName +\r
-                        " Server exception!\n" + ex.getMessage());\r
-                    System.err.println(ServiceName + " Server exception: " +\r
-                        ex.getMessage());\r
-\r
-                    //          ex.printStackTrace(); JBPNote Debug\r
-                    try\r
-                    {\r
-                        if (allowedServerExceptions > 0)\r
-                        {\r
-                            Thread.sleep(5000);\r
-                        }\r
-                    }\r
-                    catch (InterruptedException ex1)\r
-                    {\r
-                    }\r
-                }\r
+              break;\r
             }\r
-\r
-            if (allowedServerExceptions == 0)\r
+            if (! (result.isJobFailed() || result.isServerError() ||\r
+                   result.isBroken() || result.isFailed()))\r
             {\r
-                wsInfo.setStatus(WebserviceInfo.STATE_STOPPED_SERVERERROR);\r
+              Thread.sleep(5000);\r
+\r
+              //  System.out.println("I'm alive "+seqid+" "+jobid);\r
             }\r
             else\r
             {\r
-                if (!((result != null) &&\r
-                        (result.isJobFailed() || result.isServerError())))\r
-                {\r
-                    wsInfo.setStatus(WebserviceInfo.STATE_STOPPED_OK);\r
-                }\r
-                else\r
-                {\r
-                    if (result.isFailed())\r
-                    {\r
-                        wsInfo.setStatus(WebserviceInfo.STATE_STOPPED_ERROR);\r
-                    }\r
-\r
-                    if (result.isServerError())\r
-                    {\r
-                        wsInfo.setStatus(WebserviceInfo.STATE_STOPPED_SERVERERROR);\r
-                    }\r
-                }\r
+              jobComplete = true;\r
+              jobsRunning--;\r
+              break;\r
             }\r
+          }\r
         }\r
-\r
-        void StartJob()\r
+        catch (Exception ex)\r
         {\r
-            try\r
-            {\r
-                vamsas.objects.simple.WsJobId jobsubmit = server.align(seqs);\r
-\r
-                if ((jobsubmit != null) && (jobsubmit.getStatus() == 1))\r
-                {\r
-                    jobId = jobsubmit.getJobId();\r
-                    System.out.println(WsURL + " Job Id '" + jobId + "'");\r
-                }\r
-                else\r
-                {\r
-                    if (jobsubmit == null)\r
-                    {\r
-                        throw new Exception("Server at " + WsURL +\r
-                            " returned null object, it probably cannot be contacted. Try again later ?");\r
-                    }\r
-\r
-                    throw new Exception(jobsubmit.getJobId());\r
-                }\r
-            }\r
-            catch (Exception e)\r
+          allowedServerExceptions--;\r
+          wsInfo.appendProgressText("\n" + ServiceName +\r
+                                    " Server exception!\n" + ex.getMessage());\r
+          System.err.println(ServiceName + " Server exception: " +\r
+                             ex.getMessage());\r
+\r
+          //          ex.printStackTrace(); JBPNote Debug\r
+          try\r
+          {\r
+            if (allowedServerExceptions > 0)\r
             {\r
-                // TODO: JBPNote catch timeout or other fault types explicitly\r
-                // For unexpected errors\r
-                System.err.println(WebServiceName +\r
-                    "Client: Failed to submit the sequences for alignment (probably a server side problem)\n" +\r
-                    "When contacting Server:" + WsURL + "\n" + e.toString() +\r
-                    "\n");\r
-                this.allowedServerExceptions = 0;\r
-                wsInfo.setStatus(wsInfo.STATE_STOPPED_SERVERERROR);\r
-                wsInfo.appendProgressText(\r
-                    "Failed to submit sequences for alignment.\n" +\r
-                    "It is most likely that there is a problem with the server.\n" +\r
-                    "Just close the window\n");\r
-\r
-                // e.printStackTrace(); // TODO: JBPNote DEBUG\r
+              Thread.sleep(5000);\r
             }\r
+          }\r
+          catch (InterruptedException ex1)\r
+          {\r
+          }\r
         }\r
-\r
-        private void addFloatAnnotations(Alignment al, int[] gapmap,\r
-            Vector values, String Symname, String Visname, float min,\r
-            float max, int winLength)\r
+      }\r
+\r
+      if (allowedServerExceptions == 0)\r
+      {\r
+        wsInfo.setStatus(WebserviceInfo.STATE_STOPPED_SERVERERROR);\r
+      }\r
+      else\r
+      {\r
+        if (result != null)\r
         {\r
-            Annotation[] annotations = new Annotation[al.getWidth()];\r
+          if ( !(result.isJobFailed() || result.isServerError()))\r
+          {\r
+            wsInfo.setStatus(WebserviceInfo.STATE_STOPPED_OK);\r
+          }\r
+\r
+          if (result.isBroken() || result.isFailed())\r
+          {\r
+            wsInfo.setStatus(WebserviceInfo.STATE_STOPPED_ERROR);\r
+          }\r
+\r
+          if (result.isServerError())\r
+          {\r
+            wsInfo.setStatus(WebserviceInfo.STATE_STOPPED_SERVERERROR);\r
+          }\r
+        }\r
+      }\r
+    }\r
 \r
-            for (int j = 0; j < values.size(); j++)\r
-            {\r
-                float value = Float.parseFloat(values.get(j).toString());\r
-                annotations[gapmap[j]] = new Annotation("", value + "", ' ',\r
-                        value);\r
-            }\r
+    void StartJob()\r
+    {\r
+      try\r
+      {\r
+        vamsas.objects.simple.WsJobId jobsubmit = server.align(seqs);\r
 \r
-            al.addAnnotation(new AlignmentAnnotation(Symname, Visname,\r
-                    annotations, min, max, winLength));\r
+        if ( (jobsubmit != null) && (jobsubmit.getStatus() == 1))\r
+        {\r
+          jobId = jobsubmit.getJobId();\r
+          System.out.println(WsURL + " Job Id '" + jobId + "'");\r
         }\r
-\r
-        private jalview.datamodel.Sequence[] getVamsasAlignment(\r
-            vamsas.objects.simple.Alignment valign)\r
+        else\r
         {\r
-            vamsas.objects.simple.Sequence[] seqs = valign.getSeqs().getSeqs();\r
-            jalview.datamodel.Sequence[] msa = new jalview.datamodel.Sequence[seqs.length];\r
+          if (jobsubmit == null)\r
+          {\r
+            throw new Exception("Server at " + WsURL +\r
+                                " returned null object, it probably cannot be contacted. Try again later ?");\r
+          }\r
 \r
-            for (int i = 0, j = seqs.length; i < j; i++)\r
-                msa[i] = new jalview.datamodel.Sequence(seqs[i].getId(),\r
-                        seqs[i].getSeq());\r
-\r
-            return msa;\r
+          throw new Exception(jobsubmit.getJobId());\r
         }\r
+      }\r
+      catch (Exception e)\r
+      {\r
+        // TODO: JBPNote catch timeout or other fault types explicitly\r
+        // For unexpected errors\r
+        System.err.println(WebServiceName +\r
+                           "Client: Failed to submit the sequences for alignment (probably a server side problem)\n" +\r
+                           "When contacting Server:" + WsURL + "\n" +\r
+                           e.toString() +\r
+                           "\n");\r
+        this.allowedServerExceptions = 0;\r
+        wsInfo.setStatus(wsInfo.STATE_STOPPED_SERVERERROR);\r
+        wsInfo.appendProgressText(\r
+            "Failed to submit sequences for alignment.\n" +\r
+            "It is most likely that there is a problem with the server.\n" +\r
+            "Just close the window\n");\r
+\r
+        // e.printStackTrace(); // TODO: JBPNote DEBUG\r
+      }\r
+    }\r
 \r
-        void parseResult()\r
-        {\r
-            SequenceI[] seqs = null;\r
+    private jalview.datamodel.Sequence[] getVamsasAlignment(\r
+        vamsas.objects.simple.Alignment valign)\r
+    {\r
+      vamsas.objects.simple.Sequence[] seqs = valign.getSeqs().getSeqs();\r
+      jalview.datamodel.Sequence[] msa = new jalview.datamodel.Sequence[seqs.\r
+          length];\r
 \r
-            try\r
-            {\r
-                // OutputHeader = output.getText();\r
-                if (result.isFailed())\r
-                {\r
-                    OutputHeader += "Job failed.\n";\r
-                }\r
+      for (int i = 0, j = seqs.length; i < j; i++)\r
+      {\r
+        msa[i] = new jalview.datamodel.Sequence(seqs[i].getId(),\r
+                                                seqs[i].getSeq());\r
+      }\r
+\r
+      return msa;\r
+    }\r
+\r
+    void parseResult()\r
+    {\r
+      SequenceI[] seqs = null;\r
+\r
+      try\r
+      {\r
+        // OutputHeader = output.getText();\r
+        if (result.isFailed())\r
+        {\r
+          OutputHeader += "Job failed.\n";\r
+        }\r
 \r
-                if (result.getStatus() != null)\r
-                {\r
-                    OutputHeader += ("\n" + result.getStatus());\r
-                }\r
+        if (result.getStatus() != null)\r
+        {\r
+          OutputHeader += ("\n" + result.getStatus());\r
+        }\r
 \r
-                if (result.getMsa() != null)\r
-                {\r
-                    OutputHeader += "\nAlignment Object Method Notes\n";\r
+        if (result.getMsa() != null)\r
+        {\r
+          OutputHeader += "\nAlignment Object Method Notes\n";\r
 \r
-                    String[] lines = result.getMsa().getMethod();\r
+          String[] lines = result.getMsa().getMethod();\r
 \r
-                    for (int line = 0; line < lines.length; line++)\r
-                        OutputHeader += (lines[line] + "\n");\r
+          for (int line = 0; line < lines.length; line++)\r
+          {\r
+            OutputHeader += (lines[line] + "\n");\r
+          }\r
 \r
-                    // 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
-                    seqs = getVamsasAlignment(result.getMsa());\r
-                }\r
+          // 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
+          seqs = getVamsasAlignment(result.getMsa());\r
+        }\r
 \r
-                wsInfo.setProgressText(OutputHeader);\r
+        wsInfo.setProgressText(OutputHeader);\r
 \r
-                if (seqs != null)\r
-                {\r
-                    AlignmentOrder msaorder = new AlignmentOrder(seqs);\r
+        if (seqs != null)\r
+        {\r
+          AlignmentOrder msaorder = new AlignmentOrder(seqs);\r
 \r
-                    if (preserveOrder)\r
-                    {\r
-                        jalview.analysis.AlignmentSorter.recoverOrder(seqs);\r
-                    }\r
+          if (preserveOrder)\r
+          {\r
+            jalview.analysis.AlignmentSorter.recoverOrder(seqs);\r
+          }\r
 \r
-                    jalview.analysis.SeqsetUtils.deuniquify(SeqNames, seqs);\r
+          jalview.analysis.SeqsetUtils.deuniquify(SeqNames, seqs);\r
 \r
-                    Alignment al = new Alignment(seqs);\r
+          Alignment al = new Alignment(seqs);\r
 \r
-                    // TODO: JBPNote Should also rename the query sequence sometime...\r
-                    AlignFrame af = new AlignFrame(al);\r
-                    af.addSortByOrderMenuItem(ServiceName + " Ordering",\r
-                        msaorder);\r
+          // TODO: JBPNote Should also rename the query sequence sometime...\r
+          AlignFrame af = new AlignFrame(al);\r
+          af.addSortByOrderMenuItem(ServiceName + " Ordering",\r
+                                    msaorder);\r
 \r
-                    Desktop.addInternalFrame(af, alTitle,\r
-                        AlignFrame.NEW_WINDOW_WIDTH,\r
-                        AlignFrame.NEW_WINDOW_HEIGHT);\r
-                }\r
-            }\r
-            catch (Exception ex)\r
-            {\r
-                ex.printStackTrace();\r
-            }\r
+          Desktop.addInternalFrame(af, alTitle,\r
+                                   AlignFrame.NEW_WINDOW_WIDTH,\r
+                                   AlignFrame.NEW_WINDOW_HEIGHT);\r
         }\r
+      }\r
+      catch (Exception ex)\r
+      {\r
+        ex.printStackTrace();\r
+      }\r
     }\r
+  }\r
 }\r
diff --git a/src/jalview/ws/MsaWServices.java b/src/jalview/ws/MsaWServices.java
deleted file mode 100755 (executable)
index 75ddf16..0000000
+++ /dev/null
@@ -1,67 +0,0 @@
-/*\r
-* Jalview - A Sequence Alignment Editor and Viewer\r
-* Copyright (C) 2005 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle\r
-*\r
-* This program is free software; you can redistribute it and/or\r
-* modify it under the terms of the GNU General Public License\r
-* as published by the Free Software Foundation; either version 2\r
-* of the License, or (at your option) any later version.\r
-*\r
-* This program is distributed in the hope that it will be useful,\r
-* but WITHOUT ANY WARRANTY; without even the implied warranty of\r
-* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
-* GNU General Public License for more details.\r
-*\r
-* You should have received a copy of the GNU General Public License\r
-* along with this program; if not, write to the Free Software\r
-* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA\r
-*/\r
-package jalview.ws;\r
-\r
-import java.util.Hashtable;\r
-\r
-\r
-/**\r
- * <p>Title: MsaWServices </p>\r
- *\r
- * <p>Description: Registry of MsaWSI style services </p>\r
- *\r
- * <p>Copyright: Copyright (c) 2004</p>\r
- *\r
- * <p>Company: Dundee University</p>\r
- *\r
- * @author not attributable\r
- * @version 1.0\r
- */\r
-/**\r
- * TODO: MsaWServices will be set from properties and be dynamically discovered.\r
- */\r
-public class MsaWServices\r
-{\r
-    /** DOCUMENT ME!! */\r
-    public static Hashtable info;\r
-\r
-    static\r
-    {\r
-        info = new Hashtable();\r
-        info.put("ClustalWS",\r
-            new String[]\r
-            {\r
-                "http://www.compbio.dundee.ac.uk/JalviewWS/services/ClustalWS",\r
-                "ClustalW Alignment job",\r
-                \r
-            "\"Thompson, J.D., Higgins, D.G. and Gibson, T.J. (1994) CLUSTAL W: improving the sensitivity of progressive multiple" +\r
-                " sequence alignment through sequence weighting, position specific gap penalties and weight matrix choice." +\r
-                " Nucleic Acids Research, 22 4673-4680"\r
-            });\r
-        info.put("MuscleWS",\r
-            new String[]\r
-            {\r
-                "http://www.compbio.dundee.ac.uk/JalviewWS/services/MuscleWS",\r
-                "Muscle Alignment job",\r
-                \r
-            "Edgar, Robert C. (2004), MUSCLE: multiple sequence alignment " +\r
-                "with high accuracy and high throughput, Nucleic Acids Research 32(5), 1792-97."\r
-            });\r
-    }\r
-}\r
index 0ffb060..02b513c 100755 (executable)
@@ -19,6 +19,7 @@
 package jalview.ws;
 
 import jalview.gui.*;
+import ext.vamsas.ServiceHandle;
 
 public class WSClient
 {
@@ -33,8 +34,37 @@ public class WSClient
   protected String WsURL;
   protected WebserviceInfo wsInfo;
   int jobsRunning = 0;
-
+  /**
+   * mappings between abstract interface names and menu entries
+   */
+  protected java.util.Hashtable ServiceActions;
+  {
+      ServiceActions = new java.util.Hashtable();
+      ServiceActions.put("MsaWS", "Multiple Sequence Alignment");
+      ServiceActions.put("SecStrPred", "Secondary Structure Prediction");
+  };
   public WSClient()
   {
   }
+
+  protected WebserviceInfo setWebService(ServiceHandle sh)
+  {
+    WebServiceName = sh.getName();
+    if (ServiceActions.containsKey(sh.getAbstractName()))
+    {
+      WebServiceJobTitle = sh.getName(); // TODO: control sh.Name specification properly
+      // add this for short names. +(String) ServiceActions.get(sh.getAbstractName());
+    }
+    else
+    {
+      WebServiceJobTitle = sh.getAbstractName()+" using "+sh.getName();
+
+    }
+    WebServiceReference = sh.getDescription();
+    WsURL = sh.getEndpointURL();
+    WebserviceInfo wsInfo = new WebserviceInfo(WebServiceJobTitle,
+                                               WebServiceReference);
+
+    return wsInfo;
+  }
 }