X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fws%2Fjws2%2FJws2Discoverer.java;h=e4ff459c6bdc8514e4d40495885924b7c2532910;hb=7692386ccfe778075dd83a753d30a7a27fe507be;hp=dbcecec707b4801ee7cc653c95a32f4a23d7b49f;hpb=ab43013b7e357b84b4abade0dba949668dfb2a0e;p=jalview.git diff --git a/src/jalview/ws/jws2/Jws2Discoverer.java b/src/jalview/ws/jws2/Jws2Discoverer.java index dbcecec..e4ff459 100644 --- a/src/jalview/ws/jws2/Jws2Discoverer.java +++ b/src/jalview/ws/jws2/Jws2Discoverer.java @@ -1,6 +1,6 @@ /* - * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2b1) - * Copyright (C) 2014 The Jalview Authors + * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$) + * Copyright (C) $$Year-Rel$$ The Jalview Authors * * This file is part of Jalview. * @@ -67,7 +67,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 +85,17 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI private PropertyChangeSupport changeSupport = new PropertyChangeSupport( this); - Vector invalidServiceUrls = null, urlsWithoutServices = null, - validServiceUrls = null; + private Vector invalidServiceUrls = null; - boolean running = false, aborted = false; + private Vector urlsWithoutServices = null; - Thread oldthread = null; + private Vector validServiceUrls = null; + + private volatile boolean running = false; + + private volatile boolean aborted = false; + + private Thread oldthread = null; /** * holds list of services. @@ -143,8 +148,9 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI public void setAborted(boolean aborted) { this.aborted = aborted; - } + + @Override public void run() { @@ -158,37 +164,38 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI { try { - Cache.log - .debug("Waiting around for old discovery thread to finish."); + Cache.log.debug( + "Waiting around for old discovery thread to finish."); // wait around until old discoverer dies Thread.sleep(100); } catch (Exception e) { } } + aborted = false; Cache.log.debug("Old discovery thread has finished."); } running = true; // first set up exclusion list if needed - final Set ignoredServices = new HashSet(); - for (String ignored : Cache.getDefault( - "IGNORED_JABAWS_SERVICETYPES", "") - .split("\\|")) + final Set 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()); 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 +217,9 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI { validServiceUrls.removeAllElements(); } - ArrayList svctypes = new ArrayList(); + ArrayList svctypes = new ArrayList<>(); - List qrys = new ArrayList(); + List qrys = new ArrayList<>(); for (final String jwsserver : getServiceUrls()) { JabaWsServerQuery squery = new JabaWsServerQuery(this, jwsserver); @@ -252,8 +259,8 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI } if (aborted) { - Cache.log.debug("Aborting " + qrys.size() - + " JABAWS discovery threads."); + Cache.log.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) { @@ -274,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(); + services = new Vector<>(); for (Jws2Instance svc : svcs) { - if (!ignoredServices.contains(svc.serviceType)) + if (!ignoredServices.contains(svc.getName())) { services.add(svc); } @@ -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(), + services); } /** @@ -304,10 +312,10 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI { if (services == null) { - services = new Vector(); + 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,20 +357,20 @@ 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 enumerableServices = new ArrayList(); + List enumerableServices = new ArrayList<>(); // jws2al.removeAll(); - Map preferredHosts = new HashMap(); - Map> alternates = new HashMap>(); + Map preferredHosts = new HashMap<>(); + Map> 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 @@ -369,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 ph = alternates.get(service.serviceType); - if (preferredHosts.get(service.serviceType) != service) + List ph = alternates.get(service.getName()); + if (preferredHosts.get(service.getName()) != service) { if (ph == null) { - ph = new ArrayList(); + ph = new ArrayList<>(); } ph.add(service); - alternates.put(service.serviceType, ph); + alternates.put(service.getName(), ph); } } @@ -401,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() { @@ -416,22 +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 "))); + 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)) + 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.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() { @@ -441,27 +452,19 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI { new Thread(new Runnable() { + @Override public void run() { - setPreferredServiceFor(alignFrame, sv.serviceType, - sv.action, sv); + setPreferredServiceFor(alignFrame, sv.getName(), + sv.getServiceType(), sv); changeSupport.firePropertyChange("services", - new Vector(), services); + new Vector(), services); }; }).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(); } }); - */ } } } @@ -471,52 +474,57 @@ 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 enumerableServices) + final AlignFrame alignFrame, + List 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 hostLabels = new ArrayList(); - Hashtable lasthostFor = new Hashtable(); - Hashtable> hosts = new Hashtable>(); - ArrayList hostlist = new ArrayList(); + + List hostLabels = new ArrayList<>(); + Hashtable lasthostFor = new Hashtable<>(); + Hashtable> hosts = new Hashtable<>(); + ArrayList hostlist = new ArrayList<>(); for (Jws2Instance service : enumerableServices) { - ArrayList hostservices = hosts.get(service.getHost()); + ArrayList hostservices = hosts + .get(service.getHostURL()); if (hostservices == null) { - hosts.put(service.getHost(), - hostservices = new ArrayList()); - hostlist.add(service.getHost()); + hosts.put(service.getHostURL(), + hostservices = new ArrayList<>()); + hostlist.add(service.getHostURL()); } hostservices.add(service); } // 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++) { - 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); 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) @@ -527,9 +535,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.getName() + service.getActionText())) // !hostLabels.contains(host + (bytype ? // service.serviceType+service.getActionText() : ""))) { @@ -546,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); @@ -557,15 +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); + hitm.setToolTipText( + JvSwingUtils.wrapTooltip(true, MessageManager + .getString("label.open_jabaws_web_page"))); + lasthostFor.put(service.getAction(), host); } - hostLabels.add(host + service.serviceType - + service.getActionText()); + hostLabels.add( + host + service.getName() + service.getActionText()); } service.attachWSMenuEntry(atpoint, alignFrame); @@ -577,17 +585,18 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI { if (args.length > 0) { - testUrls = new ArrayList(); + 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) @@ -599,8 +608,8 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI { System.out.println("Service " + i++ + " " + instance.getClass() + "@" - + instance.getHost() + ": " - + instance.getActionText()); + + instance.getHostURL() + + ": " + instance.getActionText()); } } @@ -681,7 +690,7 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI // return test urls, if there are any, instead of touching cache return testUrls; } - List urls = new ArrayList(); + List urls = new ArrayList<>(); if (this.preferredUrl != null) { @@ -710,30 +719,27 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI } } catch (MalformedURLException ex) { - Cache.log - .warn("Problem whilst trying to make a URL from '" - + ((url != null) ? url : "") + "'"); - Cache.log - .warn("This was probably due to a malformed comma separated list" - + " in the " - + JWS2HOSTURLS + Cache.log.warn("Problem whilst trying to make a URL from '" + + ((url != null) ? url : "") + "'"); + Cache.log.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); } } } catch (Exception ex) { - Cache.log.warn( - "Error parsing comma separated list of urls in " - + JWS2HOSTURLS + " preference.", ex); + Cache.log.warn("Error parsing comma separated list of urls in " + + JWS2HOSTURLS + " preference.", ex); } return urls; } public Vector getServices() { - return (services == null) ? new Vector() - : new Vector(services); + return (services == null) ? new Vector<>() + : new Vector<>(services); } /** @@ -746,8 +752,9 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI { try { - compbio.ws.client.WSTester.main(new String[] - { "-h=" + foo.toString() }); + compbio.ws.client.WSTester + .main(new String[] + { "-h=" + foo.toString() }); } catch (Exception e) { e.printStackTrace(); @@ -765,6 +772,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 +798,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 +844,11 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI { if (urlsWithoutServices == null) { - urlsWithoutServices = new Vector(); + urlsWithoutServices = new Vector<>(); } - if ((invalidServiceUrls == null || !invalidServiceUrls - .contains(jwsservers)) + if ((invalidServiceUrls == null + || !invalidServiceUrls.contains(jwsservers)) && !urlsWithoutServices.contains(jwsservers)) { urlsWithoutServices.add(jwsservers); @@ -831,7 +864,7 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI { if (invalidServiceUrls == null) { - invalidServiceUrls = new Vector(); + invalidServiceUrls = new Vector<>(); } if (!invalidServiceUrls.contains(jwsservers)) { @@ -853,7 +886,8 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI if (getInvalidServiceUrls() != null && getInvalidServiceUrls().size() > 0) { - ermsg.append("URLs that could not be contacted: \n"); + ermsg.append(MessageManager.getString("warn.urls_not_contacted") + + ": \n"); for (String svcurl : getInvalidServiceUrls()) { if (list) @@ -869,7 +903,8 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI if (getUrlsWithoutServices() != null && getUrlsWithoutServices().size() > 0) { - ermsg.append("URLs without any JABA Services : \n"); + ermsg.append( + MessageManager.getString("warn.urls_no_jaba") + ": \n"); for (String svcurl : getUrlsWithoutServices()) { if (list) @@ -917,14 +952,16 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI */ public Jws2Instance getPreferredServiceFor(String[] serviceURLs) { - HashSet urls = new HashSet(); + HashSet 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) { @@ -944,20 +981,21 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI return match; } - Map> preferredServiceMap = new HashMap>();; + Map> 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) @@ -971,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; @@ -990,28 +1028,30 @@ 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>(); + preferredServiceMap = new HashMap<>(); } Map prefmap = preferredServiceMap.get(afid); if (prefmap == null) { - prefmap = new HashMap(); + 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, String serviceAction, Jws2Instance selectedServer) { - setPreferredServiceFor(null, serviceType, serviceAction, selectedServer); + setPreferredServiceFor(null, serviceType, serviceAction, + selectedServer); } /**