X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fws%2Fjws2%2FJws2Discoverer.java;h=d11174eff88740d759825fa61366e77cb3958dec;hb=d3f3178a33cb6b9260a9b7431cc37ece20416a94;hp=7a8eee97f13a7268e1d81cb5eb9db07bdf5ed1d8;hpb=2273eba5668e5340354da60fed329c6c716cc439;p=jalview.git diff --git a/src/jalview/ws/jws2/Jws2Discoverer.java b/src/jalview/ws/jws2/Jws2Discoverer.java index 7a8eee9..d11174e 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.2) - * 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. * @@ -22,34 +22,25 @@ package jalview.ws.jws2; import jalview.bin.Cache; import jalview.gui.AlignFrame; -import jalview.gui.Desktop; -import jalview.gui.JvSwingUtils; import jalview.util.MessageManager; import jalview.ws.WSMenuEntryProviderI; +import jalview.ws.api.ServiceWithParameters; import jalview.ws.jws2.jabaws2.Jws2Instance; import jalview.ws.params.ParamDatastoreI; -import java.awt.Color; -import java.awt.event.ActionEvent; -import java.awt.event.ActionListener; import java.beans.PropertyChangeEvent; import java.beans.PropertyChangeListener; import java.beans.PropertyChangeSupport; import java.net.MalformedURLException; import java.net.URL; import java.util.ArrayList; -import java.util.Arrays; -import java.util.HashMap; import java.util.HashSet; -import java.util.Hashtable; import java.util.List; -import java.util.Map; import java.util.Set; import java.util.StringTokenizer; import java.util.Vector; import javax.swing.JMenu; -import javax.swing.JMenuItem; import compbio.ws.client.Services; @@ -67,7 +58,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 +76,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 +139,9 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI public void setAborted(boolean aborted) { this.aborted = aborted; - } + + @Override public void run() { @@ -158,37 +155,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 +208,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 +250,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 +261,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 +272,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 +288,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 +303,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 +320,7 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI service.hasParameters(); if (validServiceUrls == null) { - validServiceUrls = new Vector(); + validServiceUrls = new Vector<>(); } validServiceUrls.add(jwsservers); } @@ -330,264 +329,42 @@ 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. - populateWSMenuEntry(wsmenu, alignFrame, null); - } - - private boolean isRecalculable(String action) - { - return (action != null && action.equalsIgnoreCase("conservation")); - } - - private void populateWSMenuEntry(JMenu jws2al, - final AlignFrame alignFrame, String typeFilter) - { if (running || services == null || services.size() == 0) { 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(); - // jws2al.removeAll(); - Map preferredHosts = new HashMap(); - Map> alternates = new HashMap>(); - for (Jws2Instance service : services.toArray(new Jws2Instance[0])) - { - if (!isRecalculable(service.action)) - { - // add 'one shot' services to be displayed using the classic menu - // structure - enumerableServices.add(service); - } - else - { - if (!preferredHosts.containsKey(service.serviceType)) - { - Jws2Instance preferredInstance = getPreferredServiceFor( - alignFrame, service.serviceType); - if (preferredInstance != null) - { - preferredHosts.put(service.serviceType, preferredInstance); - } - else - { - preferredHosts.put(service.serviceType, service); - } - } - List ph = alternates.get(service.serviceType); - if (preferredHosts.get(service.serviceType) != service) - { - if (ph == null) - { - ph = new ArrayList(); - } - ph.add(service); - alternates.put(service.serviceType, ph); - } - } - - } - - // create GUI element for classic services - addEnumeratedServices(jws2al, alignFrame, enumerableServices); - // and the instantaneous services - for (final Jws2Instance service : preferredHosts.values()) - { - atpoint = JvSwingUtils.findOrCreateMenu(jws2al, service.action); - JMenuItem hitm; - if (atpoint.getItemCount() > 1) - { - // previous service of this type already present - atpoint.addSeparator(); - } - atpoint.add(hitm = new JMenuItem(service.getHost())); - hitm.setForeground(Color.blue); - hitm.addActionListener(new ActionListener() - { - - @Override - public void actionPerformed(ActionEvent e) - { - Desktop.showUrl(service.getHost()); - } - }); - hitm.setToolTipText(JvSwingUtils - .wrapTooltip(false, MessageManager.getString("label.open_jabaws_web_page "))); - - service.attachWSMenuEntry(atpoint, alignFrame); - if (alternates.containsKey(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.serviceType)) - { - JMenuItem itm; - hitm.add(itm = new JMenuItem(sv.getHost())); - itm.setForeground(Color.blue); - itm.addActionListener(new ActionListener() - { - - @Override - public void actionPerformed(ActionEvent arg0) - { - new Thread(new Runnable() - { - public void run() - { - setPreferredServiceFor(alignFrame, sv.serviceType, - sv.action, sv); - changeSupport.firePropertyChange("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(); } }); - */ - } - } + // dynamically regenerate service list. + populateWSMenuEntry(wsmenu, alignFrame, null); } - /** - * add services using the Java 2.5/2.6/2.7 system which optionally creates - * submenus to index by host and service program type - */ - private void addEnumeratedServices(final JMenu jws2al, - final AlignFrame alignFrame, List enumerableServices) + private void populateWSMenuEntry(JMenu jws2al, + final AlignFrame alignFrame, String typeFilter) { - 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(); - for (Jws2Instance service : enumerableServices) - { - ArrayList hostservices = hosts.get(service.getHost()); - if (hostservices == null) - { - hosts.put(service.getHost(), - hostservices = new ArrayList()); - hostlist.add(service.getHost()); - } - 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]); - String sortbytype[] = new String[orderedsvcs.length]; - for (int i = 0; i < sortbytype.length; i++) - { - sortbytype[i] = orderedsvcs[i].serviceType; - } - jalview.util.QuickSort.sort(sortbytype, orderedsvcs); - for (final Jws2Instance service : orderedsvcs) - { - atpoint = JvSwingUtils.findOrCreateMenu(jws2al, service.action); - String type = service.serviceType; - if (byhost) - { - atpoint = JvSwingUtils.findOrCreateMenu(atpoint, host); - if (atpoint.getToolTipText() == null) - { - atpoint.setToolTipText(MessageManager.formatMessage("label.services_at", new String[]{host})); - } - } - if (bytype) - { - atpoint = JvSwingUtils.findOrCreateMenu(atpoint, type); - if (atpoint.getToolTipText() == null) - { - atpoint.setToolTipText(service.getActionText()); - } - } - if (!byhost - && !hostLabels.contains(host + service.serviceType - + service.getActionText())) - // !hostLabels.contains(host + (bytype ? - // service.serviceType+service.getActionText() : ""))) - { - // add a marker indicating where this service is hosted - // relies on services from the same host being listed in a - // contiguous - // group - JMenuItem hitm; - if (hostLabels.contains(host)) - { - atpoint.addSeparator(); - } - else - { - hostLabels.add(host); - } - if (lasthostFor.get(service.action) == null - || !lasthostFor.get(service.action).equals(host)) - { - atpoint.add(hitm = new JMenuItem(host)); - hitm.setForeground(Color.blue); - hitm.addActionListener(new ActionListener() - { - - @Override - public void actionPerformed(ActionEvent e) - { - Desktop.showUrl(service.getHost()); - } - }); - hitm.setToolTipText(JvSwingUtils - .wrapTooltip(true, MessageManager.getString("label.open_jabaws_web_page"))); - lasthostFor.put(service.action, host); - } - hostLabels.add(host + service.serviceType - + service.getActionText()); - } - - service.attachWSMenuEntry(atpoint, alignFrame); - } - } + PreferredServiceRegistry.getRegistry().populateWSMenuEntry( + getServices(), + changeSupport, jws2al, + alignFrame, typeFilter); } public static void main(String[] args) { 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) @@ -595,12 +372,12 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI System.out.println("Changesupport: There are now " + getDiscoverer().services.size() + " services"); int i = 1; - for (Jws2Instance instance : getDiscoverer().services) + for (ServiceWithParameters instance : getDiscoverer().services) { System.out.println("Service " + i++ + " " + instance.getClass() + "@" - + instance.getHost() + ": " - + instance.getActionText()); + + instance.getHostURL() + + ": " + instance.getActionText()); } } @@ -681,7 +458,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 +487,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() + public Vector getServices() { - return (services == null) ? new Vector() - : new Vector(services); + return (services == null) ? new Vector<>() + : new Vector<>(services); } /** @@ -746,8 +520,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 +540,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 +566,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 +612,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 +632,7 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI { if (invalidServiceUrls == null) { - invalidServiceUrls = new Vector(); + invalidServiceUrls = new Vector<>(); } if (!invalidServiceUrls.contains(jwsservers)) { @@ -853,7 +654,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 +671,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) @@ -908,113 +711,6 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI } /** - * pick the user's preferred service based on a set of URLs (jaba server - * locations) and service URIs (specifying version and service interface - * class) - * - * @param serviceURL - * @return null or best match for given uri/ls. - */ - public Jws2Instance getPreferredServiceFor(String[] serviceURLs) - { - HashSet urls = new HashSet(); - urls.addAll(Arrays.asList(serviceURLs)); - Jws2Instance match = null; - if (services != null) - { - for (Jws2Instance svc : services) - { - if (urls.contains(svc.getServiceTypeURI())) - { - if (match == null) - { - // for moment we always pick service from server ordered first in - // user's preferences - match = svc; - } - if (urls.contains(svc.getUri())) - { - // stop and return - we've matched type URI and URI for service - // endpoint - return svc; - } - } - } - } - return match; - } - - Map> preferredServiceMap = new HashMap>();; - - /** - * get current preferred service of the given type, or global default - * - * @param af - * null or a specific alignFrame - * @param serviceType - * Jws2Instance.serviceType 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 serviceurl = null; - synchronized (preferredServiceMap) - { - String afid = (af == null) ? "" : af.getViewport().getSequenceSetId(); - Map prefmap = preferredServiceMap.get(afid); - if (afid.length() > 0 && prefmap == null) - { - // recover global setting, if any - prefmap = preferredServiceMap.get(""); - } - if (prefmap != null) - { - serviceurl = prefmap.get(serviceType); - } - - } - Jws2Instance response = null; - for (Jws2Instance svc : services) - { - if (svc.serviceType.equals(serviceType)) - { - if (serviceurl == null || serviceurl.equals(svc.getHost())) - { - response = svc; - break; - } - } - } - return response; - } - - public void setPreferredServiceFor(AlignFrame af, String serviceType, - String serviceAction, Jws2Instance selectedServer) - { - String afid = (af == null) ? "" : af.getViewport().getSequenceSetId(); - if (preferredServiceMap == null) - { - preferredServiceMap = new HashMap>(); - } - Map prefmap = preferredServiceMap.get(afid); - if (prefmap == null) - { - prefmap = new HashMap(); - preferredServiceMap.put(afid, prefmap); - } - prefmap.put(serviceType, selectedServer.getHost()); - prefmap.put(serviceAction, selectedServer.getHost()); - } - - public void setPreferredServiceFor(String serviceType, - String serviceAction, Jws2Instance selectedServer) - { - setPreferredServiceFor(null, serviceType, serviceAction, selectedServer); - } - - /** * Set a URL to try before any others. For use with command-line parameter to * configure a local Jabaws installation without the need to add to property * files.