+/*
+ * 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 <http://www.gnu.org/licenses/>.
+ * 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.gui.AlignFrame;
+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.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.HashSet;
+import java.util.List;
+import java.util.Set;
+import java.util.StringTokenizer;
import java.util.Vector;
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
*/
public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
{
- private java.beans.PropertyChangeSupport changeSupport = new java.beans.PropertyChangeSupport(
+ 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";
+
+ /*
+ * Singleton instance
+ */
+ private static Jws2Discoverer discoverer;
+
+ /*
+ * Override for testing only
+ */
+ private static List<String> testUrls = null;
+
+ // preferred url has precedence over others
+ private String preferredUrl;
+
+ private PropertyChangeSupport changeSupport = new PropertyChangeSupport(
this);
+ private Vector<String> invalidServiceUrls = null;
+
+ private Vector<String> urlsWithoutServices = null;
+
+ private Vector<String> validServiceUrls = null;
+
+ private volatile boolean running = false;
+
+ private volatile boolean aborted = false;
+
+ private Thread oldthread = null;
+
+ /**
+ * holds list of services.
+ */
+ protected Vector<Jws2Instance> services;
+
+ /**
+ * Private constructor enforces use of singleton via getDiscoverer()
+ */
+ private Jws2Discoverer()
+ {
+ }
+
/**
* change listeners are notified of "services" property changes
*
changeSupport.removePropertyChangeListener(listener);
}
- boolean running = false;
+ /**
+ * @return the aborted
+ */
+ public boolean isAborted()
+ {
+ return aborted;
+ }
+
+ /**
+ * @param aborted
+ * the aborted to set
+ */
+ public void setAborted(boolean aborted)
+ {
+ this.aborted = aborted;
+ }
@Override
public void run()
{
- if (running)
+
+ if (running && oldthread != null && oldthread.isAlive())
{
- return;
+ if (!aborted)
+ {
+ return;
+ }
+ while (running)
+ {
+ try
+ {
+ 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<String> ignoredServices = new HashSet<>();
+ for (String ignored : Cache
+ .getDefault("IGNORED_JABAWS_SERVICETYPES", "").split("\\|"))
+ {
+ ignoredServices.add(ignored);
+ }
+
+ changeSupport.firePropertyChange("services", services,
+ new Vector<Jws2Instance>());
+ oldthread = Thread.currentThread();
try
{
- Class foo = getClass().getClassLoader().loadClass(
- "compbio.ws.client.Jws2Base");
+ Class foo = getClass().getClassLoader()
+ .loadClass("compbio.ws.client.Jws2Client");
} catch (ClassNotFoundException e)
{
- System.err
- .println("Not enabling Jalview Webservices version 2: client jar is not available."
- +"\nPlease check that your webstart JNLP file is up to date!");
+ 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;
}
- // 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");
- try
+ // 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)
{
- if (Jws2Base.validURL(jwsservers))
+ validServiceUrls.removeAllElements();
+ }
+ ArrayList<String> svctypes = new ArrayList<>();
+
+ List<JabaWsServerQuery> 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
- {
- 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)
+ if (!ignoredServices.contains(sv.toString()))
{
- 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)
+ {
+ Cache.log.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<String> 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);
+ }
+ }
+ }
}
+ oldthread = null;
running = false;
- changeSupport.firePropertyChange("services", new Vector(), services);
+ changeSupport.firePropertyChange("services", new Vector<Jws2Instance>(),
+ services);
}
/**
* @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<Jws2Instance>();
+ services = new Vector<>();
}
- System.out.println("Discovered service: " + jwsservers + " "
- + srv.toString());
- services.add(new Jws2Instance(jwsservers, "Align with "
- + srv.toString(), service2));
- }
-
- public class Jws2Instance
- {
- String hosturl;
-
- String serviceType;
+ System.out.println(
+ "Discovered service: " + jwsservers + " " + service.toString());
+ // Jws2Instance service = new Jws2Instance(jwsservers, srv.toString(),
+ // service2);
- MsaWS service;
-
- public Jws2Instance(String hosturl, String serviceType, MsaWS service)
+ services.add(service);
+ // retrieve the presets and parameter set and cache now
+ ParamDatastoreI pds = service.getParamStore();
+ if (pds != null)
{
- super();
- this.hosturl = hosturl;
- this.serviceType = serviceType;
- this.service = service;
+ pds.getPresets();
}
-
- 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()
+ service.hasParameters();
+ if (validServiceUrls == null)
{
- if (presets == null)
- {
- try
- {
- presets = service.getPresets();
- } catch (Exception ex)
- {
- System.err
- .println("Exception when retrieving presets for service "
- + serviceType + " at " + hosturl);
- }
- }
- return presets;
+ validServiceUrls = new Vector<>();
}
- };
+ validServiceUrls.add(jwsservers);
+ }
/**
- * holds list of services.
+ * attach all available web services to the appropriate submenu in the given
+ * JMenu
*/
- Vector<Jws2Instance> services;
-
@Override
public void attachWSMenuEntry(JMenu wsmenu, final AlignFrame alignFrame)
{
{
return;
}
- /**
- * 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() {
- *
- * @Override public void actionPerformed(ActionEvent e) { AlignmentView
- * msa = alignFrame.gatherSequencesForAlignment(); MsaWSClient client =
- * new MsaWSClient(service, "JWS2 Alignment of " + alignFrame.getTitle(),
- * msa, false, true, alignFrame.getViewport().getAlignment().getDataset(),
- * alignFrame); } });
- */
- }
- if (services.size() > 0)
- {
- wsmenu.add(jws2);
- }
+ // dynamically regenerate service list.
+ populateWSMenuEntry(wsmenu, alignFrame, null);
+ }
+ private void populateWSMenuEntry(JMenu jws2al,
+ final AlignFrame alignFrame, String typeFilter)
+ {
+ PreferredServiceRegistry.getRegistry().populateWSMenuEntry(
+ getServices(),
+ changeSupport, jws2al,
+ alignFrame, typeFilter);
}
public static void main(String[] args)
{
- Thread runner = new Thread(getDiscoverer());
- getDiscoverer().addPropertyChangeListener(new PropertyChangeListener()
+ if (args.length > 0)
{
-
- @Override
- public void propertyChange(PropertyChangeEvent evt)
+ testUrls = new ArrayList<>();
+ for (String url : args)
{
- System.out.println("Changesupport: There are now "
- + getDiscoverer().services.size() + " services");
+ testUrls.add(url);
}
- });
- runner.start();
+ ;
+ }
+ Thread runner = getDiscoverer()
+ .startDiscoverer(new PropertyChangeListener()
+ {
+
+ @Override
+ public void propertyChange(PropertyChangeEvent evt)
+ {
+ if (getDiscoverer().services != null)
+ {
+ System.out.println("Changesupport: There are now "
+ + getDiscoverer().services.size() + " services");
+ int i = 1;
+ for (ServiceWithParameters instance : getDiscoverer().services)
+ {
+ System.out.println("Service " + i++ + " "
+ + instance.getClass() + "@"
+ + instance.getHostURL()
+ + ": " + instance.getActionText());
+ }
+
+ }
+ }
+ });
while (runner.isAlive())
{
try
}
;
}
+ try
+ {
+ Thread.sleep(50);
+ } catch (InterruptedException x)
+ {
+ }
}
- private static Jws2Discoverer discoverer;
-
+ /**
+ * Returns the singleton instance of this class.
+ *
+ * @return
+ */
public static Jws2Discoverer getDiscoverer()
{
if (discoverer == null)
public boolean hasServices()
{
- // TODO Auto-generated method stub
return !running && services != null && services.size() > 0;
}
return running;
}
+ public void setServiceUrls(List<String> wsUrls)
+ {
+ if (wsUrls != null && !wsUrls.isEmpty())
+ {
+ StringBuilder urls = new StringBuilder(128);
+ String sep = "";
+ for (String url : wsUrls)
+ {
+ urls.append(sep);
+ urls.append(url);
+ sep = ",";
+ }
+ Cache.setProperty(JWS2HOSTURLS, urls.toString());
+ }
+ else
+ {
+ Cache.removeProperty(JWS2HOSTURLS);
+ }
+ }
+
+ /**
+ * Returns web service URLs, in the order in which they should be tried (or an
+ * empty list).
+ *
+ * @return
+ */
+ public List<String> getServiceUrls()
+ {
+ if (testUrls != null)
+ {
+ // return test urls, if there are any, instead of touching cache
+ return testUrls;
+ }
+ List<String> 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())
+ {
+ String url = null;
+ try
+ {
+ url = st.nextToken();
+ new URL(url);
+ if (!urls.contains(url))
+ {
+ urls.add(url);
+ }
+ else
+ {
+ Cache.log.warn("Ignoring duplicate url " + url + " in "
+ + JWS2HOSTURLS + " list");
+ }
+ } catch (MalformedURLException ex)
+ {
+ Cache.log.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
+ + " 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);
+ }
+ return urls;
+ }
+
+ public Vector<ServiceWithParameters> getServices()
+ {
+ return (services == null) ? new Vector<>()
+ : new Vector<>(services);
+ }
+
+ /**
+ * test the given URL with the JabaWS test code
+ *
+ * @param foo
+ * @return
+ */
+ public static boolean testServiceUrl(URL foo)
+ {
+ try
+ {
+ 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;
+ }
+
+ 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
+ * started.
+ *
+ * @param changeSupport2
+ * @return new thread
+ */
+ public Thread startDiscoverer(PropertyChangeListener changeSupport2)
+ {
+ /* if (restart())
+ {
+ return;
+ }
+ else
+ {
+ Thread thr = new Thread(this);
+ thr.start();
+ }
+ */
+ if (isRunning())
+ {
+ setAborted(true);
+ }
+ addPropertyChangeListener(changeSupport2);
+ Thread thr = new Thread(this);
+ thr.start();
+ return thr;
+ }
+
+ /**
+ * @return the invalidServiceUrls
+ */
+ public Vector<String> getInvalidServiceUrls()
+ {
+ return invalidServiceUrls;
+ }
+
+ /**
+ * @return the urlsWithoutServices
+ */
+ public Vector<String> 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)
+ {
+ urlsWithoutServices = new Vector<>();
+ }
+
+ if ((invalidServiceUrls == null
+ || !invalidServiceUrls.contains(jwsservers))
+ && !urlsWithoutServices.contains(jwsservers))
+ {
+ urlsWithoutServices.add(jwsservers);
+ }
+ }
+
+ /**
+ * add a bad URL to the list
+ *
+ * @param jwsservers
+ */
+ public synchronized void addInvalidServiceUrl(String jwsservers)
+ {
+ if (invalidServiceUrls == null)
+ {
+ invalidServiceUrls = new Vector<>();
+ }
+ if (!invalidServiceUrls.contains(jwsservers))
+ {
+ invalidServiceUrls.add(jwsservers);
+ }
+ }
+
+ /**
+ *
+ * @return a human readable report of any problems with the service URLs used
+ * for discovery
+ */
+ public String getErrorMessages()
+ {
+ if (!isRunning() && !isAborted())
+ {
+ StringBuffer ermsg = new StringBuffer();
+ boolean list = false;
+ if (getInvalidServiceUrls() != null
+ && getInvalidServiceUrls().size() > 0)
+ {
+ 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");
+ }
+ list = false;
+ if (getUrlsWithoutServices() != null
+ && getUrlsWithoutServices().size() > 0)
+ {
+ 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;
+ }
+
+ public int getServerStatusFor(String url)
+ {
+ if (validServiceUrls != null && validServiceUrls.contains(url))
+ {
+ return 1;
+ }
+ if (urlsWithoutServices != null && urlsWithoutServices.contains(url))
+ {
+ return 0;
+ }
+ if (invalidServiceUrls != null && invalidServiceUrls.contains(url))
+ {
+ return -1;
+ }
+ return -2;
+ }
+
+ /**
+ * 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
+ {
+ if (value != null && value.trim().length() > 0)
+ {
+ new URL(value);
+ preferredUrl = value;
+ }
+ }
}