X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;ds=inline;f=src%2Fjalview%2Fws%2Fjws2%2FJws2Discoverer.java;h=0aa488125c1ec2a332b9af774da70a5a86c930d3;hb=ab58313e7bb31264ddb2715a1c548cdc789d7fa6;hp=172b393d1772d59cc32bba527cb6ab4b46dd4fac;hpb=77ecb160b47e44406ebdb597c89470612544fee4;p=jalview.git
diff --git a/src/jalview/ws/jws2/Jws2Discoverer.java b/src/jalview/ws/jws2/Jws2Discoverer.java
index 172b393..0aa4881 100644
--- a/src/jalview/ws/jws2/Jws2Discoverer.java
+++ b/src/jalview/ws/jws2/Jws2Discoverer.java
@@ -1,27 +1,58 @@
+/*
+ * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
+ * Copyright (C) $$Year-Rel$$ The Jalview Authors
+ *
+ * This file is part of Jalview.
+ *
+ * Jalview is free software: you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation, either version 3
+ * of the License, or (at your option) any later version.
+ *
+ * Jalview is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty
+ * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
+ * PURPOSE. See the GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with Jalview. If not, see .
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
+ */
package jalview.ws.jws2;
-import java.awt.event.ActionEvent;
-import java.awt.event.ActionListener;
+import jalview.bin.Cache;
+import jalview.bin.Console;
+import jalview.bin.ApplicationSingletonProvider;
+import jalview.bin.ApplicationSingletonProvider.ApplicationSingletonI;
+import jalview.gui.AlignFrame;
+import jalview.util.MessageManager;
+import jalview.ws.ServiceChangeListener;
+import jalview.ws.WSDiscovererI;
+import jalview.ws.api.ServiceWithParameters;
+import jalview.ws.jws2.jabaws2.Jws2Instance;
+import jalview.ws.params.ParamDatastoreI;
+
import java.beans.PropertyChangeEvent;
import java.beans.PropertyChangeListener;
-import java.net.ConnectException;
+import java.beans.PropertyChangeSupport;
+import java.net.MalformedURLException;
+import java.net.URL;
+import java.util.ArrayList;
+import java.util.Collections;
import java.util.HashSet;
+import java.util.List;
+import java.util.Set;
+import java.util.StringTokenizer;
import java.util.Vector;
+import java.util.concurrent.CompletableFuture;
+import java.util.concurrent.CopyOnWriteArraySet;
+import java.util.concurrent.ExecutionException;
+import java.util.concurrent.Future;
+import java.util.concurrent.FutureTask;
import javax.swing.JMenu;
-import javax.swing.JMenuItem;
-import org.apache.log4j.Level;
-
-import jalview.bin.Cache;
-import jalview.datamodel.AlignmentView;
-import jalview.gui.AlignFrame;
-import jalview.ws.WSMenuEntryProviderI;
-import compbio.data.msa.MsaWS;
-import compbio.metadata.Preset;
-import compbio.metadata.PresetManager;
-import compbio.ws.client.Jws2Base;
-import compbio.ws.client.Jws2Base.Services;
+import compbio.ws.client.Services;
/**
* discoverer for jws2 services. Follows the lightweight service discoverer
@@ -30,89 +61,242 @@ import compbio.ws.client.Jws2Base.Services;
* @author JimP
*
*/
-public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
+public class Jws2Discoverer implements WSDiscovererI, Runnable, ApplicationSingletonI
{
- private java.beans.PropertyChangeSupport changeSupport = new java.beans.PropertyChangeSupport(this);
-
/**
- * change listeners are notified of "services" property changes
+ * Returns the singleton instance of this class.
*
- * @param listener
- * to be added that consumes new services Hashtable object.
+ * @return
*/
- public void addPropertyChangeListener(
- java.beans.PropertyChangeListener listener)
+ public static Jws2Discoverer getInstance()
{
- changeSupport.addPropertyChangeListener(listener);
+ return ApplicationSingletonProvider.getInstance(Jws2Discoverer.class);
}
+ public static final String COMPBIO_JABAWS = "http://www.compbio.dundee.ac.uk/jabaws";
+
+ /*
+ * the .jalview_properties entry for JWS2 URLS
+ */
+ private final static String JWS2HOSTURLS = "JWS2HOSTURLS";
+
+ /*
+ * Override for testing only
+ */
+ private List testUrls = null;
+
+ // preferred url has precedence over others
+ private String preferredUrl;
+
+
+ private Set serviceListeners = new CopyOnWriteArraySet<>();
+
+ private Vector invalidServiceUrls = null;
+
+ private Vector urlsWithoutServices = null;
+
+ private Vector validServiceUrls = null;
+
+ private volatile boolean running = false;
+
+ private volatile boolean aborted = false;
+
+
+ private volatile Thread oldthread = null;
/**
- *
- *
- * @param listener
- * to be removed
+ * holds list of services.
+ */
+ protected Vector services;
+
+ /**
+ * Private constructor enforces use of singleton via getDiscoverer()
+ */
+ private Jws2Discoverer()
+ {
+ }
+
+ @Override
+ public void addServiceChangeListener(ServiceChangeListener listener)
+ {
+ serviceListeners.add(listener);
+ }
+
+ @Override
+ public void removeServiceChangeListener(ServiceChangeListener listener)
+ {
+ serviceListeners.remove(listener);
+ }
+
+ private void notifyServiceListeners(List extends ServiceWithParameters> services)
+ {
+ if (services == null) services = this.services;
+ for (var listener : serviceListeners) {
+ listener.servicesChanged(this, services);
+ }
+ }
+
+ /**
+ * @return the aborted
+ */
+ public boolean isAborted()
+ {
+ return aborted;
+ }
+
+ /**
+ * @param aborted
+ * the aborted to set
*/
- public void removePropertyChangeListener(
- java.beans.PropertyChangeListener listener)
+ public void setAborted(boolean aborted)
{
- changeSupport.removePropertyChangeListener(listener);
+ this.aborted = aborted;
}
- boolean running=false;
@Override
public void run()
{
- if (running)
+
+ if (running && oldthread != null && oldthread.isAlive())
{
- return;
+ if (!aborted)
+ {
+ return;
+ }
+ while (running)
+ {
+ try
+ {
+ Console.debug(
+ "Waiting around for old discovery thread to finish.");
+ // wait around until old discoverer dies
+ Thread.sleep(100);
+ } catch (Exception e)
+ {
+ }
+ }
+ aborted = false;
+ Console.debug("Old discovery thread has finished.");
}
- running=true;
-// Cache.initLogger();
-// Cache.log.setLevel(Level.DEBUG);
- // TODO: Document and PACK JWS2
- String jwsservers = Cache.getDefault("JWS2HOSTURLS",
- "http://webservices.compbio.dundee.ac.uk:8084/jws2");
+ running = true;
+
+ // first set up exclusion list if needed
+ final Set ignoredServices = new HashSet<>();
+ for (String ignored : Cache
+ .getDefault("IGNORED_JABAWS_SERVICETYPES", "").split("\\|"))
+ {
+ ignoredServices.add(ignored);
+ }
+
+ notifyServiceListeners(Collections.emptyList());
+ oldthread = Thread.currentThread();
try
{
- if (Jws2Base.validURL(jwsservers))
+ getClass().getClassLoader().loadClass("compbio.ws.client.Jws2Client");
+ } catch (ClassNotFoundException e)
+ {
+ 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;
+ }
+ // reinitialise records of good and bad service URLs
+ if (services != null)
+ {
+ services.removeAllElements();
+ }
+ if (urlsWithoutServices != null)
+ {
+ urlsWithoutServices.removeAllElements();
+ }
+ if (invalidServiceUrls != null)
+ {
+ invalidServiceUrls.removeAllElements();
+ }
+ if (validServiceUrls != null)
+ {
+ validServiceUrls.removeAllElements();
+ }
+ ArrayList svctypes = new ArrayList<>();
+
+ List qrys = new ArrayList<>();
+ for (final String jwsserver : getServiceUrls())
+ {
+ JabaWsServerQuery squery = new JabaWsServerQuery(this, jwsserver);
+ if (svctypes.size() == 0)
{
- // look for services
- for (Services srv : Jws2Base.Services.values())
+ // TODO: remove this ugly hack to get Canonical JABA service ordering
+ // for all possible services
+ for (Services sv : squery.JABAWS2SERVERS)
{
- MsaWS service = null;
- try
+ if (!ignoredServices.contains(sv.toString()))
{
- service = Jws2Base.connect(jwsservers, srv);
- }
- catch (Exception e)
- {
- System.err.println("Jws2 Discoverer: Problem with "+jwsservers+" with service "+srv+":\n"+e.getMessage());
- if (!(e instanceof javax.xml.ws.WebServiceException)) {
- e.printStackTrace();
- }
- }
- ;
- if (service != null)
- {
- addService(jwsservers, srv, service);
+ svctypes.add(sv.toString());
}
}
}
- else
+ qrys.add(squery);
+ new Thread(squery).start();
+ }
+ boolean finished = true;
+ do
+ {
+ finished = true;
+ try
+ {
+ Thread.sleep(100);
+ } catch (Exception e)
{
- Cache.log.info("Ignoring invalid Jws2 service url " + jwsservers);
}
- } catch (Exception e)
- {
- e.printStackTrace();
- Cache.log.warn("Exception when discovering Jws2 services.", e);
- } catch (Error e)
+ for (JabaWsServerQuery squery : qrys)
+ {
+ if (squery.isRunning())
+ {
+ finished = false;
+ }
+ }
+ if (aborted)
+ {
+ Console.debug(
+ "Aborting " + qrys.size() + " JABAWS discovery threads.");
+ for (JabaWsServerQuery squery : qrys)
+ {
+ squery.setQuit(true);
+ }
+ }
+ } while (!aborted && !finished);
+ if (!aborted)
{
- Cache.log.error("Exception when discovering Jws2 services.", e);
+ // resort services according to order found in jabaws service list
+ // also ensure services for each host are ordered in same way.
+
+ if (services != null && services.size() > 0)
+ {
+ Jws2Instance[] svcs = new Jws2Instance[services.size()];
+ int[] spos = new int[services.size()];
+ int ipos = 0;
+ List svcUrls = getServiceUrls();
+ for (Jws2Instance svc : services)
+ {
+ svcs[ipos] = svc;
+ spos[ipos++] = 1000 * svcUrls.indexOf(svc.getHostURL()) + 1
+ + svctypes.indexOf(svc.getName());
+ }
+ jalview.util.QuickSort.sort(spos, svcs);
+ services = new Vector<>();
+ for (Jws2Instance svc : svcs)
+ {
+ if (!ignoredServices.contains(svc.getName()))
+ {
+ services.add(svc);
+ }
+ }
+ }
}
- running=false;
- changeSupport.firePropertyChange("services", new Vector(), services);
+ oldthread = null;
+ running = false;
+ notifyServiceListeners(services);
}
/**
@@ -122,136 +306,399 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
* @param srv
* @param service2
*/
- private void addService(String jwsservers, Services srv, MsaWS service2)
+ synchronized void addService(String jwsservers, Jws2Instance service)
{
- if (services==null) {
- services = new Vector();
+ if (services == null)
+ {
+ services = new Vector<>();
+ }
+ System.out.println(
+ "Discovered service: " + jwsservers + " " + service.toString());
+ // Jws2Instance service = new Jws2Instance(jwsservers, srv.toString(),
+ // service2);
+
+ services.add(service);
+ // retrieve the presets and parameter set and cache now
+ ParamDatastoreI pds = service.getParamStore();
+ if (pds != null)
+ {
+ pds.getPresets();
+ }
+ service.hasParameters();
+ if (validServiceUrls == null)
+ {
+ validServiceUrls = new Vector<>();
}
- System.out.println("Discovered service: " + jwsservers + " "
- + srv.toString());
- services.add(new Jws2Instance(jwsservers, "Align with "
- + srv.toString(), service2));
+ validServiceUrls.add(jwsservers);
}
- public class Jws2Instance
+ /**
+ *
+ * @param args
+ * @j2sIgnore
+ */
+ public static void main(String[] args)
{
- String hosturl;
+ Jws2Discoverer instance = getInstance();
+ if (args.length > 0)
+ {
+ instance.testUrls = new ArrayList<>();
+ for (String url : args)
+ {
+ instance.testUrls.add(url);
+ }
+ }
+ var discoverer = getInstance();
+ discoverer.addServiceChangeListener((_discoverer, _services) -> {
+ if (discoverer.services != null)
+ {
+ System.out.println("Changesupport: There are now "
+ + discoverer.services.size() + " services");
+ int i = 1;
+ for (ServiceWithParameters s_instance : discoverer.services)
+ {
+ System.out.println(
+ "Service " + i++ + " " + s_instance.getClass()
+ + "@" + s_instance.getHostURL() + ": "
+ + s_instance.getActionText());
+ }
- String serviceType;
+ }
+ });
+ try
+ {
+ discoverer.startDiscoverer().get();
+ } catch (InterruptedException | ExecutionException e)
+ {
+ }
+ try
+ {
+ Thread.sleep(50);
+ } catch (InterruptedException x)
+ {
+ }
+ }
- MsaWS service;
- public Jws2Instance(String hosturl, String serviceType, MsaWS service)
+ @Override
+ public boolean hasServices()
+ {
+ return !running && services != null && services.size() > 0;
+ }
+
+ @Override
+ public boolean isRunning()
+ {
+ return running;
+ }
+
+ @Override
+ public void setServiceUrls(List wsUrls)
+ {
+ if (wsUrls != null && !wsUrls.isEmpty())
{
- super();
- this.hosturl = hosturl;
- this.serviceType = serviceType;
- this.service = service;
+ StringBuilder urls = new StringBuilder(128);
+ String sep = "";
+ for (String url : wsUrls)
+ {
+ urls.append(sep);
+ urls.append(url);
+ sep = ",";
+ }
+ Cache.setProperty(JWS2HOSTURLS, urls.toString());
}
- PresetManager presets = null;
- /**
- * non thread safe - gets the presets for this service (blocks whilst it calls the service to get the preset set)
- * @return service presets or null if exceptions were raised.
- */
- public PresetManager getPresets() {
- if (presets == null)
+ else
+ {
+ Cache.removeProperty(JWS2HOSTURLS);
+ }
+ }
+
+ /**
+ * Returns web service URLs, in the order in which they should be tried (or an
+ * empty list).
+ *
+ * @return
+ */
+ @Override
+ public List getServiceUrls()
+ {
+ if (testUrls != null)
+ {
+ // return test urls, if there are any, instead of touching cache
+ return testUrls;
+ }
+ List urls = new ArrayList<>();
+
+ if (this.preferredUrl != null)
+ {
+ urls.add(preferredUrl);
+ }
+
+ String surls = Cache.getDefault(JWS2HOSTURLS, COMPBIO_JABAWS);
+ try
+ {
+ StringTokenizer st = new StringTokenizer(surls, ",");
+ while (st.hasMoreElements())
{
- try {
- presets = service.getPresets();
- } catch (Exception ex)
+ String url = null;
+ try
+ {
+ url = st.nextToken();
+ new URL(url);
+ if (!urls.contains(url))
+ {
+ urls.add(url);
+ }
+ else
+ {
+ Console.warn("Ignoring duplicate url " + url + " in "
+ + JWS2HOSTURLS + " list");
+ }
+ } catch (MalformedURLException ex)
{
- System.err.println("Exception when retrieving presets for service "+serviceType+" at "+hosturl);
+ Console.warn("Problem whilst trying to make a URL from '"
+ + ((url != null) ? url : "") + "'");
+ Console.warn(
+ "This was probably due to a malformed comma separated list"
+ + " in the " + JWS2HOSTURLS
+ + " entry of $(HOME)/.jalview_properties)");
+ Console.debug("Exception was ", ex);
}
}
- return presets;
+ } catch (Exception ex)
+ {
+ Console.warn("Error parsing comma separated list of urls in "
+ + JWS2HOSTURLS + " preference.", ex);
}
- };
+ return urls;
+ }
+
+ @Override
+ public Vector getServices()
+ {
+ return (services == null) ? new Vector<>() : new Vector<>(services);
+ }
/**
- * holds list of services.
+ * test the given URL with the JabaWS test code
+ *
+ * @param foo
+ * @return
*/
- Vector services;
-
@Override
- public void attachWSMenuEntry(JMenu wsmenu, final AlignFrame alignFrame)
+ public boolean testServiceUrl(URL foo)
{
- if (running || services==null || services.size() == 0)
+ try
{
- return;
+ compbio.ws.client.WSTester
+ .main(new String[]
+ { "-h=" + foo.toString() });
+ } catch (Exception e)
+ {
+ e.printStackTrace();
+ return false;
+ } catch (OutOfMemoryError e)
+ {
+ e.printStackTrace();
+ return false;
+ } catch (Error e)
+ {
+ e.printStackTrace();
+ return false;
}
- /**
- * eventually, JWS2 services will appear under the same align/etc submenus.
- * for moment we keep them separate.
- */
- JMenu jws2 = new JMenu("JWS2 Alignment");
- MsaWSClient msacl = new MsaWSClient();
- for (final Jws2Instance service : services)
- {
- msacl.attachWSMenuEntry(jws2, service, alignFrame);
- /*JMenuItem sitem = new JMenuItem(service.serviceType);
- sitem.setToolTipText("Hosted at " + service.hosturl);
- sitem.addActionListener(new ActionListener()
+
+ return true;
+ }
+
+ public boolean restart()
+ {
+ synchronized (this)
+ {
+ if (running)
{
+ aborted = true;
+ }
+ else
+ {
+ running = true;
+ }
+ return aborted;
+ }
+ }
- @Override
- public void actionPerformed(ActionEvent e)
+ /**
+ * 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
+ * started.
+ *
+ * @param changeSupport2
+ * @return new thread
+ */
+ @Override
+ public CompletableFuture startDiscoverer()
+ {
+ /* if (restart())
+ {
+ return;
+ }
+ else
{
- AlignmentView msa = alignFrame.gatherSequencesForAlignment();
- MsaWSClient client = new MsaWSClient(service,
- "JWS2 Alignment of " + alignFrame.getTitle(), msa, false,
- true, alignFrame.getViewport().getAlignment().getDataset(),
- alignFrame);
+ Thread thr = new Thread(this);
+ thr.start();
}
- });*/
+ */
+ if (isRunning())
+ {
+ setAborted(true);
}
- if (services.size()>0)
+ CompletableFuture task = CompletableFuture
+ .supplyAsync(() -> {
+ run();
+ return Jws2Discoverer.this;
+ });
+ return task;
+ }
+
+ /**
+ * @return the invalidServiceUrls
+ */
+ public Vector getInvalidServiceUrls()
+ {
+ return invalidServiceUrls;
+ }
+
+ /**
+ * @return the urlsWithoutServices
+ */
+ public Vector getUrlsWithoutServices()
+ {
+ return urlsWithoutServices;
+ }
+
+ /**
+ * add an 'empty' JABA server to the list. Only servers not already in the
+ * 'bad URL' list will be added to this list.
+ *
+ * @param jwsservers
+ */
+ public synchronized void addUrlwithnoservices(String jwsservers)
+ {
+ if (urlsWithoutServices == null)
{
- wsmenu.add(jws2);
+ urlsWithoutServices = new Vector<>();
+ }
+
+ if ((invalidServiceUrls == null
+ || !invalidServiceUrls.contains(jwsservers))
+ && !urlsWithoutServices.contains(jwsservers))
+ {
+ urlsWithoutServices.add(jwsservers);
}
-
}
- public static void main(String[] args)
+
+ /**
+ * add a bad URL to the list
+ *
+ * @param jwsservers
+ */
+ public synchronized void addInvalidServiceUrl(String jwsservers)
{
- Thread runner = new Thread(getDiscoverer());
- getDiscoverer().addPropertyChangeListener(new PropertyChangeListener() {
+ if (invalidServiceUrls == null)
+ {
+ invalidServiceUrls = new Vector<>();
+ }
+ if (!invalidServiceUrls.contains(jwsservers))
+ {
+ invalidServiceUrls.add(jwsservers);
+ }
+ }
- @Override
- public void propertyChange(PropertyChangeEvent evt)
+ /**
+ *
+ * @return a human readable report of any problems with the service URLs used
+ * for discovery
+ */
+ @Override
+ public String getErrorMessages()
+ {
+ if (!isRunning() && !isAborted())
+ {
+ StringBuffer ermsg = new StringBuffer();
+ boolean list = false;
+ if (getInvalidServiceUrls() != null
+ && getInvalidServiceUrls().size() > 0)
{
- System.out.println("Changesupport: There are now "+getDiscoverer().services.size()+" services");
+ ermsg.append(MessageManager.getString("warn.urls_not_contacted")
+ + ": \n");
+ for (String svcurl : getInvalidServiceUrls())
+ {
+ if (list)
+ {
+ ermsg.append(", ");
+ }
+ list = true;
+ ermsg.append(svcurl);
+ }
+ ermsg.append("\n\n");
}
- });
- runner.start();
- while (runner.isAlive())
- {
- try
+ list = false;
+ if (getUrlsWithoutServices() != null
+ && getUrlsWithoutServices().size() > 0)
{
- Thread.sleep(50);
- } catch (InterruptedException e)
+ ermsg.append(
+ MessageManager.getString("warn.urls_no_jaba") + ": \n");
+ for (String svcurl : getUrlsWithoutServices())
+ {
+ if (list)
+ {
+ ermsg.append(", ");
+ }
+ list = true;
+ ermsg.append(svcurl);
+ }
+ ermsg.append("\n");
+ }
+ if (ermsg.length() > 1)
{
+ return ermsg.toString();
}
- ;
+
}
+ return null;
}
- private static Jws2Discoverer discoverer;
- public static Jws2Discoverer getDiscoverer()
+
+ @Override
+ public int getServerStatusFor(String url)
{
- if (discoverer==null)
+ if (validServiceUrls != null && validServiceUrls.contains(url))
{
- discoverer = new Jws2Discoverer();
+ return STATUS_OK;
}
- return discoverer;
- }
-
- public boolean hasServices()
- {
- // TODO Auto-generated method stub
- return !running && services!=null && services.size()>0;
+ if (urlsWithoutServices != null && urlsWithoutServices.contains(url))
+ {
+ return STATUS_NO_SERVICES;
+ }
+ if (invalidServiceUrls != null && invalidServiceUrls.contains(url))
+ {
+ return STATUS_INVALID;
+ }
+ return STATUS_UNKNOWN;
}
- public boolean isRunning()
+ /**
+ * 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.
+ *
+ * @param value
+ * @throws MalformedURLException
+ */
+ public void setPreferredUrl(String value) throws MalformedURLException
{
- return running;
+ if (value != null && value.trim().length() > 0)
+ {
+ new URL(value);
+ preferredUrl = value;
+ }
}
-
}