Merge branch 'features/mchmmer' into merge/wsinterfaces_mchmmer_JAL-3070_JAL-1950
[jalview.git] / src / jalview / ws / jws2 / Jws2Discoverer.java
index 5319eab..e4ff459 100644 (file)
@@ -178,7 +178,7 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
     running = true;
 
     // first set up exclusion list if needed
-    final Set<String> ignoredServices = new HashSet<String>();
+    final Set<String> ignoredServices = new HashSet<>();
     for (String ignored : Cache
             .getDefault("IGNORED_JABAWS_SERVICETYPES", "").split("\\|"))
     {
@@ -217,9 +217,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);
@@ -281,14 +281,14 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
         for (Jws2Instance svc : services)
         {
           svcs[ipos] = svc;
-          spos[ipos++] = 1000 * svcUrls.indexOf(svc.getHost()) + 1
-                  + svctypes.indexOf(svc.serviceType);
+          spos[ipos++] = 1000 * svcUrls.indexOf(svc.getHostURL()) + 1
+                  + svctypes.indexOf(svc.getName());
         }
         jalview.util.QuickSort.sort(spos, svcs);
-        services = new Vector<Jws2Instance>();
+        services = new Vector<>();
         for (Jws2Instance svc : svcs)
         {
-          if (!ignoredServices.contains(svc.serviceType))
+          if (!ignoredServices.contains(svc.getName()))
           {
             services.add(svc);
           }
@@ -312,7 +312,7 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
   {
     if (services == null)
     {
-      services = new Vector<Jws2Instance>();
+      services = new Vector<>();
     }
     System.out.println(
             "Discovered service: " + jwsservers + " " + service.toString());
@@ -329,7 +329,7 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
     service.hasParameters();
     if (validServiceUrls == null)
     {
-      validServiceUrls = new Vector<String>();
+      validServiceUrls = new Vector<>();
     }
     validServiceUrls.add(jwsservers);
   }
@@ -363,13 +363,14 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
      * 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))
+      // TODO: check this behaves with refactored serviceType to getName
+      if (!isRecalculable(service.getName()))
       {
         // add 'one shot' services to be displayed using the classic menu
         // structure
@@ -377,28 +378,28 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
       }
       else
       {
-        if (!preferredHosts.containsKey(service.serviceType))
+        if (!preferredHosts.containsKey(service.getName()))
         {
           Jws2Instance preferredInstance = getPreferredServiceFor(
-                  alignFrame, service.serviceType);
+                  alignFrame, service.getName());
           if (preferredInstance != null)
           {
-            preferredHosts.put(service.serviceType, preferredInstance);
+            preferredHosts.put(service.getName(), preferredInstance);
           }
           else
           {
-            preferredHosts.put(service.serviceType, service);
+            preferredHosts.put(service.getName(), service);
           }
         }
-        List<Jws2Instance> ph = alternates.get(service.serviceType);
-        if (preferredHosts.get(service.serviceType) != service)
+        List<Jws2Instance> ph = alternates.get(service.getName());
+        if (preferredHosts.get(service.getName()) != service)
         {
           if (ph == null)
           {
-            ph = new ArrayList<Jws2Instance>();
+            ph = new ArrayList<>();
           }
           ph.add(service);
-          alternates.put(service.serviceType, ph);
+          alternates.put(service.getName(), ph);
         }
       }
 
@@ -409,14 +410,15 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
     // and the instantaneous services
     for (final Jws2Instance service : preferredHosts.values())
     {
-      atpoint = JvSwingUtils.findOrCreateMenu(jws2al, service.action);
+      atpoint = JvSwingUtils.findOrCreateMenu(jws2al,
+              service.getServiceType());
       JMenuItem hitm;
       if (atpoint.getItemCount() > 1)
       {
         // previous service of this type already present
         atpoint.addSeparator();
       }
-      atpoint.add(hitm = new JMenuItem(service.getHost()));
+      atpoint.add(hitm = new JMenuItem(service.getHostURL()));
       hitm.setForeground(Color.blue);
       hitm.addActionListener(new ActionListener()
       {
@@ -424,23 +426,23 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
         @Override
         public void actionPerformed(ActionEvent e)
         {
-          Desktop.showUrl(service.getHost());
+          Desktop.showUrl(service.getHostURL());
         }
       });
       hitm.setToolTipText(JvSwingUtils.wrapTooltip(false,
               MessageManager.getString("label.open_jabaws_web_page")));
 
       service.attachWSMenuEntry(atpoint, alignFrame);
-      if (alternates.containsKey(service.serviceType))
+      if (alternates.containsKey(service.getName()))
       {
         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))
+        for (final Jws2Instance sv : alternates.get(service.getName()))
         {
           JMenuItem itm;
-          hitm.add(itm = new JMenuItem(sv.getHost()));
+          hitm.add(itm = new JMenuItem(sv.getHostURL()));
           itm.setForeground(Color.blue);
           itm.addActionListener(new ActionListener()
           {
@@ -453,8 +455,8 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
                 @Override
                 public void run()
                 {
-                  setPreferredServiceFor(alignFrame, sv.serviceType,
-                          sv.action, sv);
+                  setPreferredServiceFor(alignFrame, sv.getName(),
+                          sv.getServiceType(), sv);
                   changeSupport.firePropertyChange("services",
                           new Vector<Jws2Instance>(), services);
                 };
@@ -483,18 +485,19 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
      */
     JMenu atpoint;
 
-    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());
+      ArrayList<Jws2Instance> hostservices = hosts
+              .get(service.getHostURL());
       if (hostservices == null)
       {
-        hosts.put(service.getHost(),
-                hostservices = new ArrayList<Jws2Instance>());
-        hostlist.add(service.getHost());
+        hosts.put(service.getHostURL(),
+                hostservices = new ArrayList<>());
+        hostlist.add(service.getHostURL());
       }
       hostservices.add(service);
     }
@@ -506,13 +509,14 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
       String sortbytype[] = new String[orderedsvcs.length];
       for (int i = 0; i < sortbytype.length; i++)
       {
-        sortbytype[i] = orderedsvcs[i].serviceType;
+        sortbytype[i] = orderedsvcs[i].getName();
       }
       jalview.util.QuickSort.sort(sortbytype, orderedsvcs);
       for (final Jws2Instance service : orderedsvcs)
       {
-        atpoint = JvSwingUtils.findOrCreateMenu(jws2al, service.action);
-        String type = service.serviceType;
+        atpoint = JvSwingUtils.findOrCreateMenu(jws2al,
+                service.getAction());
+        String type = service.getName();
         if (byhost)
         {
           atpoint = JvSwingUtils.findOrCreateMenu(atpoint, host);
@@ -532,7 +536,7 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
           }
         }
         if (!byhost && !hostLabels.contains(
-                host + service.serviceType + service.getActionText()))
+                host + service.getName() + service.getActionText()))
         // !hostLabels.contains(host + (bytype ?
         // service.serviceType+service.getActionText() : "")))
         {
@@ -549,8 +553,8 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
           {
             hostLabels.add(host);
           }
-          if (lasthostFor.get(service.action) == null
-                  || !lasthostFor.get(service.action).equals(host))
+          if (lasthostFor.get(service.getAction()) == null
+                  || !lasthostFor.get(service.getAction()).equals(host))
           {
             atpoint.add(hitm = new JMenuItem(host));
             hitm.setForeground(Color.blue);
@@ -560,16 +564,16 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
               @Override
               public void actionPerformed(ActionEvent e)
               {
-                Desktop.showUrl(service.getHost());
+                Desktop.showUrl(service.getHostURL());
               }
             });
             hitm.setToolTipText(
                     JvSwingUtils.wrapTooltip(true, MessageManager
                             .getString("label.open_jabaws_web_page")));
-            lasthostFor.put(service.action, host);
+            lasthostFor.put(service.getAction(), host);
           }
           hostLabels.add(
-                  host + service.serviceType + service.getActionText());
+                  host + service.getName() + service.getActionText());
         }
 
         service.attachWSMenuEntry(atpoint, alignFrame);
@@ -581,7 +585,7 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
   {
     if (args.length > 0)
     {
-      testUrls = new ArrayList<String>();
+      testUrls = new ArrayList<>();
       for (String url : args)
       {
         testUrls.add(url);
@@ -603,7 +607,8 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
                   for (Jws2Instance instance : getDiscoverer().services)
                   {
                     System.out.println("Service " + i++ + " "
-                            + instance.getClass() + "@" + instance.getHost()
+                            + instance.getClass() + "@"
+                            + instance.getHostURL()
                             + ": " + instance.getActionText());
                   }
 
@@ -685,7 +690,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)
     {
@@ -733,8 +738,8 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
 
   public Vector<Jws2Instance> getServices()
   {
-    return (services == null) ? new Vector<Jws2Instance>()
-            : new Vector<Jws2Instance>(services);
+    return (services == null) ? new Vector<>()
+            : new Vector<>(services);
   }
 
   /**
@@ -839,7 +844,7 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
   {
     if (urlsWithoutServices == null)
     {
-      urlsWithoutServices = new Vector<String>();
+      urlsWithoutServices = new Vector<>();
     }
 
     if ((invalidServiceUrls == null
@@ -859,7 +864,7 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
   {
     if (invalidServiceUrls == null)
     {
-      invalidServiceUrls = new Vector<String>();
+      invalidServiceUrls = new Vector<>();
     }
     if (!invalidServiceUrls.contains(jwsservers))
     {
@@ -947,14 +952,16 @@ 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)
     {
       for (Jws2Instance svc : services)
       {
-        if (urls.contains(svc.getServiceTypeURI()))
+        // TODO getNameURI Should return a versioned URI for the service, but
+        // doesn't as of 2.11
+        if (urls.contains(svc.getNameURI()))
         {
           if (match == null)
           {
@@ -974,20 +981,21 @@ 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
+   * get current preferred endpoint of the given Jabaws service, or global
+   * default
    * 
    * @param af
    *          null or a specific alignFrame
-   * @param serviceType
-   *          Jws2Instance.serviceType for service
+   * @param serviceName
+   *          Jws2Instance.getName() for service
    * @return null if no service of this type is available, the preferred service
    *         for the serviceType and af if specified and if defined.
    */
   public Jws2Instance getPreferredServiceFor(AlignFrame af,
-          String serviceType)
+          String serviceName)
   {
     String serviceurl = null;
     synchronized (preferredServiceMap)
@@ -1001,16 +1009,16 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
       }
       if (prefmap != null)
       {
-        serviceurl = prefmap.get(serviceType);
+        serviceurl = prefmap.get(serviceName);
       }
 
     }
     Jws2Instance response = null;
     for (Jws2Instance svc : services)
     {
-      if (svc.serviceType.equals(serviceType))
+      if (svc.getName().equals(serviceName))
       {
-        if (serviceurl == null || serviceurl.equals(svc.getHost()))
+        if (serviceurl == null || serviceurl.equals(svc.getHostURL()))
         {
           response = svc;
           break;
@@ -1020,22 +1028,23 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
     return response;
   }
 
-  public void setPreferredServiceFor(AlignFrame af, String serviceType,
+  public void setPreferredServiceFor(AlignFrame af, String serviceName,
           String serviceAction, Jws2Instance selectedServer)
   {
+    // TODO: pull out and generalise for the selectedServer's attributes
     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());
-    prefmap.put(serviceAction, selectedServer.getHost());
+    prefmap.put(serviceName, selectedServer.getHostURL());
+    prefmap.put(serviceAction, selectedServer.getHostURL());
   }
 
   public void setPreferredServiceFor(String serviceType,