JAL-1953 2.11.2 with Archeopteryx!
[jalview.git] / src / jalview / ws / jws2 / Jws2Discoverer.java
index 1b2c708..1fe9495 100644 (file)
@@ -21,6 +21,7 @@
 package jalview.ws.jws2;
 
 import jalview.bin.Cache;
+import jalview.bin.Console;
 import jalview.gui.AlignFrame;
 import jalview.gui.Desktop;
 import jalview.gui.JvSwingUtils;
@@ -67,7 +68,7 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
   /*
    * the .jalview_properties entry for JWS2 URLS
    */
-  final static String JWS2HOSTURLS = "JWS2HOSTURLS";
+  private final static String JWS2HOSTURLS = "JWS2HOSTURLS";
 
   /*
    * Singleton instance
@@ -85,12 +86,17 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
   private PropertyChangeSupport changeSupport = new PropertyChangeSupport(
           this);
 
-  Vector<String> invalidServiceUrls = null, urlsWithoutServices = null,
-          validServiceUrls = null;
+  private Vector<String> invalidServiceUrls = null;
 
-  boolean running = false, aborted = false;
+  private Vector<String> urlsWithoutServices = null;
 
-  Thread oldthread = null;
+  private Vector<String> validServiceUrls = null;
+
+  private volatile boolean running = false;
+
+  private volatile boolean aborted = false;
+
+  private Thread oldthread = null;
 
   /**
    * holds list of services.
@@ -143,9 +149,9 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
   public void setAborted(boolean aborted)
   {
     this.aborted = aborted;
-
   }
 
+  @Override
   public void run()
   {
 
@@ -159,36 +165,38 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
       {
         try
         {
-          Cache.log
-                  .debug("Waiting around for old discovery thread to finish.");
+          Console.debug(
+                  "Waiting around for old discovery thread to finish.");
           // wait around until old discoverer dies
           Thread.sleep(100);
         } catch (Exception e)
         {
         }
       }
-      Cache.log.debug("Old discovery thread has finished.");
+      aborted = false;
+      Console.debug("Old discovery thread has finished.");
     }
     running = true;
 
     // first set up exclusion list if needed
-    final Set<String> ignoredServices = new HashSet<String>();
-    for (String ignored : Cache.getDefault("IGNORED_JABAWS_SERVICETYPES",
-            "").split("\\|"))
+    final Set<String> ignoredServices = new HashSet<>();
+    for (String ignored : Cache
+            .getDefault("IGNORED_JABAWS_SERVICETYPES", "").split("\\|"))
     {
       ignoredServices.add(ignored);
     }
 
-    changeSupport.firePropertyChange("services", services, new Vector());
+    changeSupport.firePropertyChange("services", services,
+            new Vector<Jws2Instance>());
     oldthread = Thread.currentThread();
     try
     {
-      Class foo = getClass().getClassLoader().loadClass(
-              "compbio.ws.client.Jws2Client");
+      Class foo = getClass().getClassLoader()
+              .loadClass("compbio.ws.client.Jws2Client");
     } catch (ClassNotFoundException e)
     {
-      System.err
-              .println("Not enabling JABA Webservices : client jar is not available."
+      System.err.println(
+              "Not enabling JABA Webservices : client jar is not available."
                       + "\nPlease check that your webstart JNLP file is up to date!");
       running = false;
       return;
@@ -210,9 +218,9 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
     {
       validServiceUrls.removeAllElements();
     }
-    ArrayList<String> svctypes = new ArrayList<String>();
+    ArrayList<String> svctypes = new ArrayList<>();
 
-    List<JabaWsServerQuery> qrys = new ArrayList<JabaWsServerQuery>();
+    List<JabaWsServerQuery> qrys = new ArrayList<>();
     for (final String jwsserver : getServiceUrls())
     {
       JabaWsServerQuery squery = new JabaWsServerQuery(this, jwsserver);
@@ -230,7 +238,7 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
 
       }
       qrys.add(squery);
-      new Thread(squery).start();
+      new Thread(squery, "JabaQuery").start();
     }
     boolean finished = true;
     do
@@ -242,7 +250,6 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
       } catch (Exception e)
       {
       }
-      ;
       for (JabaWsServerQuery squery : qrys)
       {
         if (squery.isRunning())
@@ -252,8 +259,8 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
       }
       if (aborted)
       {
-        Cache.log.debug("Aborting " + qrys.size()
-                + " JABAWS discovery threads.");
+        Console.debug(
+                "Aborting " + qrys.size() + " JABAWS discovery threads.");
         for (JabaWsServerQuery squery : qrys)
         {
           squery.setQuit(true);
@@ -263,7 +270,7 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
     if (!aborted)
     {
       // resort services according to order found in jabaws service list
-      // also ensure servics for each host are ordered in same way.
+      // also ensure services for each host are ordered in same way.
 
       if (services != null && services.size() > 0)
       {
@@ -278,7 +285,7 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
                   + svctypes.indexOf(svc.serviceType);
         }
         jalview.util.QuickSort.sort(spos, svcs);
-        services = new Vector<Jws2Instance>();
+        services = new Vector<>();
         for (Jws2Instance svc : svcs)
         {
           if (!ignoredServices.contains(svc.serviceType))
@@ -290,7 +297,8 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
     }
     oldthread = null;
     running = false;
-    changeSupport.firePropertyChange("services", new Vector(), services);
+    changeSupport.firePropertyChange("services", new Vector<Jws2Instance>(),
+            services);
   }
 
   /**
@@ -304,10 +312,10 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
   {
     if (services == null)
     {
-      services = new Vector<Jws2Instance>();
+      services = new Vector<>();
     }
-    System.out.println("Discovered service: " + jwsservers + " "
-            + service.toString());
+    System.out.println(
+            "Discovered service: " + jwsservers + " " + service.toString());
     // Jws2Instance service = new Jws2Instance(jwsservers, srv.toString(),
     // service2);
 
@@ -321,7 +329,7 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
     service.hasParameters();
     if (validServiceUrls == null)
     {
-      validServiceUrls = new Vector();
+      validServiceUrls = new Vector<>();
     }
     validServiceUrls.add(jwsservers);
   }
@@ -330,6 +338,7 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
    * attach all available web services to the appropriate submenu in the given
    * JMenu
    */
+  @Override
   public void attachWSMenuEntry(JMenu wsmenu, final AlignFrame alignFrame)
   {
     // dynamically regenerate service list.
@@ -348,17 +357,16 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
     {
       return;
     }
-    boolean byhost = Cache.getDefault("WSMENU_BYHOST", false), bytype = Cache
-            .getDefault("WSMENU_BYTYPE", false);
+
     /**
      * eventually, JWS2 services will appear under the same align/etc submenus.
      * for moment we keep them separate.
      */
     JMenu atpoint;
-    List<Jws2Instance> enumerableServices = new ArrayList<Jws2Instance>();
+    List<Jws2Instance> enumerableServices = new ArrayList<>();
     // jws2al.removeAll();
-    Map<String, Jws2Instance> preferredHosts = new HashMap<String, Jws2Instance>();
-    Map<String, List<Jws2Instance>> alternates = new HashMap<String, List<Jws2Instance>>();
+    Map<String, Jws2Instance> preferredHosts = new HashMap<>();
+    Map<String, List<Jws2Instance>> alternates = new HashMap<>();
     for (Jws2Instance service : services.toArray(new Jws2Instance[0]))
     {
       if (!isRecalculable(service.action))
@@ -387,7 +395,7 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
         {
           if (ph == null)
           {
-            ph = new ArrayList<Jws2Instance>();
+            ph = new ArrayList<>();
           }
           ph.add(service);
           alternates.put(service.serviceType, ph);
@@ -425,8 +433,8 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
       service.attachWSMenuEntry(atpoint, alignFrame);
       if (alternates.containsKey(service.serviceType))
       {
-        atpoint.add(hitm = new JMenu(MessageManager
-                .getString("label.switch_server")));
+        atpoint.add(hitm = new JMenu(
+                MessageManager.getString("label.switch_server")));
         hitm.setToolTipText(JvSwingUtils.wrapTooltip(false,
                 MessageManager.getString("label.choose_jabaws_server")));
         for (final Jws2Instance sv : alternates.get(service.serviceType))
@@ -442,27 +450,18 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
             {
               new Thread(new Runnable()
               {
+                @Override
                 public void run()
                 {
                   setPreferredServiceFor(alignFrame, sv.serviceType,
                           sv.action, sv);
                   changeSupport.firePropertyChange("services",
-                          new Vector(), services);
+                          new Vector<Jws2Instance>(), services);
                 };
-              }).start();
-
+              }, "LoadPreferredService").start();
             }
           });
         }
-        /*
-         * hitm.addActionListener(new ActionListener() {
-         * 
-         * @Override public void actionPerformed(ActionEvent arg0) { new
-         * Thread(new Runnable() {
-         * 
-         * @Override public void run() { new SetPreferredServer(alignFrame,
-         * service.serviceType, service.action); } }).start(); } });
-         */
       }
     }
   }
@@ -472,27 +471,27 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
    * submenus to index by host and service program type
    */
   private void addEnumeratedServices(final JMenu jws2al,
-          final AlignFrame alignFrame, List<Jws2Instance> enumerableServices)
+          final AlignFrame alignFrame,
+          List<Jws2Instance> enumerableServices)
   {
-    boolean byhost = Cache.getDefault("WSMENU_BYHOST", false), bytype = Cache
-            .getDefault("WSMENU_BYTYPE", false);
+    boolean byhost = Cache.getDefault("WSMENU_BYHOST", false),
+            bytype = Cache.getDefault("WSMENU_BYTYPE", false);
     /**
      * eventually, JWS2 services will appear under the same align/etc submenus.
      * for moment we keep them separate.
      */
     JMenu atpoint;
-    MsaWSClient msacl = new MsaWSClient();
-    List<String> hostLabels = new ArrayList<String>();
-    Hashtable<String, String> lasthostFor = new Hashtable<String, String>();
-    Hashtable<String, ArrayList<Jws2Instance>> hosts = new Hashtable<String, ArrayList<Jws2Instance>>();
-    ArrayList<String> hostlist = new ArrayList<String>();
+
+    List<String> hostLabels = new ArrayList<>();
+    Hashtable<String, String> lasthostFor = new Hashtable<>();
+    Hashtable<String, ArrayList<Jws2Instance>> hosts = new Hashtable<>();
+    ArrayList<String> hostlist = new ArrayList<>();
     for (Jws2Instance service : enumerableServices)
     {
       ArrayList<Jws2Instance> hostservices = hosts.get(service.getHost());
       if (hostservices == null)
       {
-        hosts.put(service.getHost(),
-                hostservices = new ArrayList<Jws2Instance>());
+        hosts.put(service.getHost(), hostservices = new ArrayList<>());
         hostlist.add(service.getHost());
       }
       hostservices.add(service);
@@ -500,8 +499,8 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
     // now add hosts in order of the given array
     for (String host : hostlist)
     {
-      Jws2Instance orderedsvcs[] = hosts.get(host).toArray(
-              new Jws2Instance[1]);
+      Jws2Instance orderedsvcs[] = hosts.get(host)
+              .toArray(new Jws2Instance[1]);
       String sortbytype[] = new String[orderedsvcs.length];
       for (int i = 0; i < sortbytype.length; i++)
       {
@@ -517,8 +516,9 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
           atpoint = JvSwingUtils.findOrCreateMenu(atpoint, host);
           if (atpoint.getToolTipText() == null)
           {
-            atpoint.setToolTipText(MessageManager.formatMessage(
-                    "label.services_at", new String[] { host }));
+            atpoint.setToolTipText(MessageManager
+                    .formatMessage("label.services_at", new String[]
+                    { host }));
           }
         }
         if (bytype)
@@ -529,9 +529,8 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
             atpoint.setToolTipText(service.getActionText());
           }
         }
-        if (!byhost
-                && !hostLabels.contains(host + service.serviceType
-                        + service.getActionText()))
+        if (!byhost && !hostLabels.contains(
+                host + service.serviceType + service.getActionText()))
         // !hostLabels.contains(host + (bytype ?
         // service.serviceType+service.getActionText() : "")))
         {
@@ -562,12 +561,13 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
                 Desktop.showUrl(service.getHost());
               }
             });
-            hitm.setToolTipText(JvSwingUtils.wrapTooltip(true,
-                    MessageManager.getString("label.open_jabaws_web_page")));
+            hitm.setToolTipText(
+                    JvSwingUtils.wrapTooltip(true, MessageManager
+                            .getString("label.open_jabaws_web_page")));
             lasthostFor.put(service.action, host);
           }
-          hostLabels.add(host + service.serviceType
-                  + service.getActionText());
+          hostLabels.add(
+                  host + service.serviceType + service.getActionText());
         }
 
         service.attachWSMenuEntry(atpoint, alignFrame);
@@ -575,21 +575,26 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
     }
   }
 
+  /**
+   * 
+   * @param args
+   * @j2sIgnore
+   */
   public static void main(String[] args)
   {
     if (args.length > 0)
     {
-      testUrls = new ArrayList<String>();
+      testUrls = new ArrayList<>();
       for (String url : args)
       {
         testUrls.add(url);
       }
-      ;
     }
-    Thread runner = getDiscoverer().startDiscoverer(
-            new PropertyChangeListener()
+    Thread runner = getDiscoverer()
+            .startDiscoverer(new PropertyChangeListener()
             {
 
+              @Override
               public void propertyChange(PropertyChangeEvent evt)
               {
                 if (getDiscoverer().services != null)
@@ -600,9 +605,8 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
                   for (Jws2Instance instance : getDiscoverer().services)
                   {
                     System.out.println("Service " + i++ + " "
-                            + instance.getClass() + "@"
-                            + instance.getHost() + ": "
-                            + instance.getActionText());
+                            + instance.getClass() + "@" + instance.getHost()
+                            + ": " + instance.getActionText());
                   }
 
                 }
@@ -616,7 +620,6 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
       } catch (InterruptedException e)
       {
       }
-      ;
     }
     try
     {
@@ -683,7 +686,7 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
       // return test urls, if there are any, instead of touching cache
       return testUrls;
     }
-    List<String> urls = new ArrayList<String>();
+    List<String> urls = new ArrayList<>();
 
     if (this.preferredUrl != null)
     {
@@ -707,24 +710,23 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
           }
           else
           {
-            Cache.log.warn("Ignoring duplicate url " + url + " in "
+            Console.warn("Ignoring duplicate url " + url + " in "
                     + JWS2HOSTURLS + " list");
           }
         } catch (MalformedURLException ex)
         {
-          Cache.log.warn("Problem whilst trying to make a URL from '"
+          Console.warn("Problem whilst trying to make a URL from '"
                   + ((url != null) ? url : "<null>") + "'");
-          Cache.log
-                  .warn("This was probably due to a malformed comma separated list"
-                          + " in the "
-                          + JWS2HOSTURLS
+          Console.warn(
+                  "This was probably due to a malformed comma separated list"
+                          + " in the " + JWS2HOSTURLS
                           + " entry of $(HOME)/.jalview_properties)");
-          Cache.log.debug("Exception was ", ex);
+          Console.debug("Exception was ", ex);
         }
       }
     } catch (Exception ex)
     {
-      Cache.log.warn("Error parsing comma separated list of urls in "
+      Console.warn("Error parsing comma separated list of urls in "
               + JWS2HOSTURLS + " preference.", ex);
     }
     return urls;
@@ -733,7 +735,7 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
   public Vector<Jws2Instance> getServices()
   {
     return (services == null) ? new Vector<Jws2Instance>()
-            : new Vector<Jws2Instance>(services);
+            : new Vector<>(services);
   }
 
   /**
@@ -747,7 +749,8 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
     try
     {
       compbio.ws.client.WSTester
-              .main(new String[] { "-h=" + foo.toString() });
+              .main(new String[]
+              { "-h=" + foo.toString() });
     } catch (Exception e)
     {
       e.printStackTrace();
@@ -765,6 +768,22 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
     return true;
   }
 
+  public boolean restart()
+  {
+    synchronized (this)
+    {
+      if (running)
+      {
+        aborted = true;
+      }
+      else
+      {
+        running = true;
+      }
+      return aborted;
+    }
+  }
+
   /**
    * Start a fresh discovery thread and notify the given object when we're
    * finished. Any known existing threads will be killed before this one is
@@ -775,6 +794,16 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
    */
   public Thread startDiscoverer(PropertyChangeListener changeSupport2)
   {
+    /*    if (restart())
+        {
+          return;
+        }
+        else
+        {
+          Thread thr = new Thread(this);
+          thr.start();
+        }
+       */
     if (isRunning())
     {
       setAborted(true);
@@ -811,11 +840,11 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
   {
     if (urlsWithoutServices == null)
     {
-      urlsWithoutServices = new Vector<String>();
+      urlsWithoutServices = new Vector<>();
     }
 
-    if ((invalidServiceUrls == null || !invalidServiceUrls
-            .contains(jwsservers))
+    if ((invalidServiceUrls == null
+            || !invalidServiceUrls.contains(jwsservers))
             && !urlsWithoutServices.contains(jwsservers))
     {
       urlsWithoutServices.add(jwsservers);
@@ -831,7 +860,7 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
   {
     if (invalidServiceUrls == null)
     {
-      invalidServiceUrls = new Vector<String>();
+      invalidServiceUrls = new Vector<>();
     }
     if (!invalidServiceUrls.contains(jwsservers))
     {
@@ -870,7 +899,8 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
       if (getUrlsWithoutServices() != null
               && getUrlsWithoutServices().size() > 0)
       {
-        ermsg.append(MessageManager.getString("warn.urls_no_jaba") + ": \n");
+        ermsg.append(
+                MessageManager.getString("warn.urls_no_jaba") + ": \n");
         for (String svcurl : getUrlsWithoutServices())
         {
           if (list)
@@ -918,7 +948,7 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
    */
   public Jws2Instance getPreferredServiceFor(String[] serviceURLs)
   {
-    HashSet<String> urls = new HashSet<String>();
+    HashSet<String> urls = new HashSet<>();
     urls.addAll(Arrays.asList(serviceURLs));
     Jws2Instance match = null;
     if (services != null)
@@ -945,7 +975,7 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
     return match;
   }
 
-  Map<String, Map<String, String>> preferredServiceMap = new HashMap<String, Map<String, String>>();;
+  Map<String, Map<String, String>> preferredServiceMap = new HashMap<>();
 
   /**
    * get current preferred service of the given type, or global default
@@ -997,12 +1027,12 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
     String afid = (af == null) ? "" : af.getViewport().getSequenceSetId();
     if (preferredServiceMap == null)
     {
-      preferredServiceMap = new HashMap<String, Map<String, String>>();
+      preferredServiceMap = new HashMap<>();
     }
     Map<String, String> prefmap = preferredServiceMap.get(afid);
     if (prefmap == null)
     {
-      prefmap = new HashMap<String, String>();
+      prefmap = new HashMap<>();
       preferredServiceMap.put(afid, prefmap);
     }
     prefmap.put(serviceType, selectedServer.getHost());
@@ -1012,7 +1042,8 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
   public void setPreferredServiceFor(String serviceType,
           String serviceAction, Jws2Instance selectedServer)
   {
-    setPreferredServiceFor(null, serviceType, serviceAction, selectedServer);
+    setPreferredServiceFor(null, serviceType, serviceAction,
+            selectedServer);
   }
 
   /**