X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fws%2Fjws2%2FJws2Discoverer.java;h=16d83e8c495a2741070a732df358ed9fec201453;hb=ad15cff29620f960119f80176f1fd443da9f6763;hp=2724d29cc3cc335cbcad92ed12a2ebf32cd63775;hpb=8d60f5c3375c9e0deaddf0dd8b9e06ebe3ee0908;p=jalview.git diff --git a/src/jalview/ws/jws2/Jws2Discoverer.java b/src/jalview/ws/jws2/Jws2Discoverer.java index 2724d29..16d83e8 100644 --- a/src/jalview/ws/jws2/Jws2Discoverer.java +++ b/src/jalview/ws/jws2/Jws2Discoverer.java @@ -1,19 +1,22 @@ /* - * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8) - * Copyright (C) 2012 J Procter, AM Waterhouse, LM Lui, J Engelhardt, G Barton, M Clamp, S Searle + * 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. + * 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 . + * 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; @@ -21,6 +24,7 @@ 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.jws2.jabaws2.Jws2Instance; import jalview.ws.params.ParamDatastoreI; @@ -30,6 +34,8 @@ 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; @@ -38,6 +44,7 @@ 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; @@ -55,9 +62,48 @@ import compbio.ws.client.Services; */ 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 + */ + final static String JWS2HOSTURLS = "JWS2HOSTURLS"; + + /* + * Singleton instance + */ + private static Jws2Discoverer discoverer; + + /* + * Override for testing only + */ + private static List testUrls = null; + + // preferred url has precedence over others + private String preferredUrl; + + private PropertyChangeSupport changeSupport = new PropertyChangeSupport( this); + Vector invalidServiceUrls = null, urlsWithoutServices = null, + validServiceUrls = null; + + boolean running = false, aborted = false; + + Thread oldthread = null; + + /** + * holds list of services. + */ + protected Vector services; + + /** + * Private constructor enforces use of singleton via getDiscoverer() + */ + private Jws2Discoverer() + { + } + /** * change listeners are notified of "services" property changes * @@ -82,8 +128,6 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI changeSupport.removePropertyChangeListener(listener); } - boolean running = false, aborted = false; - /** * @return the aborted */ @@ -99,12 +143,11 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI public void setAborted(boolean aborted) { this.aborted = aborted; - } - - Thread oldthread = null; + } public void run() { + if (running && oldthread != null && oldthread.isAlive()) { if (!aborted) @@ -126,6 +169,16 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI 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("\\|")) + { + ignoredServices.add(ignored); + } + changeSupport.firePropertyChange("services", services, new Vector()); oldthread = Thread.currentThread(); try @@ -160,16 +213,19 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI ArrayList svctypes = new ArrayList(); List qrys = new ArrayList(); - for (final String jwsservers : getServiceUrls()) + for (final String jwsserver : getServiceUrls()) { - JabaWsServerQuery squery = new JabaWsServerQuery(this, jwsservers); + JabaWsServerQuery squery = new JabaWsServerQuery(this, jwsserver); if (svctypes.size() == 0) { // TODO: remove this ugly hack to get Canonical JABA service ordering // for all possible services for (Services sv : squery.JABAWS2SERVERS) { - svctypes.add(sv.toString()); + if (!ignoredServices.contains(sv.toString())) + { + svctypes.add(sv.toString()); + } } } @@ -189,8 +245,9 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI ; for (JabaWsServerQuery squery : qrys) { - if (squery.isRunning()){ - finished=false; + if (squery.isRunning()) + { + finished = false; } } if (aborted) @@ -213,7 +270,7 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI Jws2Instance[] svcs = new Jws2Instance[services.size()]; int[] spos = new int[services.size()]; int ipos = 0; - Vector svcUrls = getServiceUrls(); + List svcUrls = getServiceUrls(); for (Jws2Instance svc : services) { svcs[ipos] = svc; @@ -224,7 +281,10 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI services = new Vector(); for (Jws2Instance svc : svcs) { - services.add(svc); + if (!ignoredServices.contains(svc.serviceType)) + { + services.add(svc); + } } } } @@ -267,11 +327,6 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI } /** - * holds list of services. - */ - protected Vector services; - - /** * attach all available web services to the appropriate submenu in the given * JMenu */ @@ -365,14 +420,14 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI } }); hitm.setToolTipText(JvSwingUtils - .wrapTooltip("Opens the JABAWS server's homepage in web browser")); + .wrapTooltip(false, MessageManager.getString("label.open_jabaws_web_page "))); service.attachWSMenuEntry(atpoint, alignFrame); if (alternates.containsKey(service.serviceType)) { - atpoint.add(hitm = new JMenu("Switch server")); + atpoint.add(hitm = new JMenu(MessageManager.getString("label.switch_server"))); hitm.setToolTipText(JvSwingUtils - .wrapTooltip("Choose a server for running this service")); + .wrapTooltip(false, MessageManager.getString("label.choose_jabaws_server"))); for (final Jws2Instance sv : alternates.get(service.serviceType)) { JMenuItem itm; @@ -461,7 +516,7 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI atpoint = JvSwingUtils.findOrCreateMenu(atpoint, host); if (atpoint.getToolTipText() == null) { - atpoint.setToolTipText("Services at " + host); + atpoint.setToolTipText(MessageManager.formatMessage("label.services_at", new String[]{host})); } } if (bytype) @@ -506,7 +561,7 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI } }); hitm.setToolTipText(JvSwingUtils - .wrapTooltip("Opens the JABAWS server's homepage in web browser")); + .wrapTooltip(true, MessageManager.getString("label.open_jabaws_web_page"))); lasthostFor.put(service.action, host); } hostLabels.add(host + service.serviceType @@ -522,7 +577,7 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI { if (args.length > 0) { - testUrls = new Vector(); + testUrls = new ArrayList(); for (String url : args) { testUrls.add(url); @@ -569,8 +624,11 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI } } - private static Jws2Discoverer discoverer; - + /** + * Returns the singleton instance of this class. + * + * @return + */ public static Jws2Discoverer getDiscoverer() { if (discoverer == null) @@ -582,7 +640,6 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI public boolean hasServices() { - // TODO Auto-generated method stub return !running && services != null && services.size() > 0; } @@ -591,24 +648,19 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI return running; } - /** - * the jalview .properties entry for JWS2 URLS - */ - final static String JWS2HOSTURLS = "JWS2HOSTURLS"; - - public static void setServiceUrls(Vector urls) + public void setServiceUrls(List wsUrls) { - if (urls != null) + if (wsUrls != null && !wsUrls.isEmpty()) { - StringBuffer urlbuffer = new StringBuffer(); + StringBuilder urls = new StringBuilder(128); String sep = ""; - for (String url : urls) + for (String url : wsUrls) { - urlbuffer.append(sep); - urlbuffer.append(url); + urls.append(sep); + urls.append(url); sep = ","; } - Cache.setProperty(JWS2HOSTURLS, urlbuffer.toString()); + Cache.setProperty(JWS2HOSTURLS, urls.toString()); } else { @@ -616,18 +668,27 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI } } - private static Vector testUrls = null; - - public static Vector getServiceUrls() + /** + * Returns web service URLs, in the order in which they should be tried (or an + * empty list). + * + * @return + */ + public List getServiceUrls() { if (testUrls != null) { // return test urls, if there are any, instead of touching cache return testUrls; } - String surls = Cache.getDefault(JWS2HOSTURLS, - "http://www.compbio.dundee.ac.uk/jabaws"); - Vector urls = new Vector(); + List urls = new ArrayList(); + + if (this.preferredUrl != null) + { + urls.add(preferredUrl); + } + + String surls = Cache.getDefault(JWS2HOSTURLS, COMPBIO_JABAWS); try { StringTokenizer st = new StringTokenizer(surls, ","); @@ -636,40 +697,37 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI String url = null; try { - java.net.URL u = new java.net.URL(url = st.nextToken()); + url = st.nextToken(); + new URL(url); if (!urls.contains(url)) { urls.add(url); } else { - jalview.bin.Cache.log.info("Ignoring duplicate url in " + Cache.log.warn("Ignoring duplicate url " + url + " in " + JWS2HOSTURLS + " list"); } - } catch (Exception ex) + } catch (MalformedURLException ex) { - jalview.bin.Cache.log + Cache.log .warn("Problem whilst trying to make a URL from '" + ((url != null) ? url : "") + "'"); - jalview.bin.Cache.log + Cache.log .warn("This was probably due to a malformed comma separated list" + " in the " + JWS2HOSTURLS + " entry of $(HOME)/.jalview_properties)"); - jalview.bin.Cache.log.debug("Exception was ", ex); + Cache.log.debug("Exception was ", ex); } } } catch (Exception ex) { - jalview.bin.Cache.log.warn( + Cache.log.warn( "Error parsing comma separated list of urls in " + JWS2HOSTURLS + " preference.", ex); } - if (urls.size() >= 0) - { - return urls; - } - return null; + return urls; } public Vector getServices() @@ -727,9 +785,6 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI return thr; } - Vector invalidServiceUrls = null, urlsWithoutServices = null, - validServiceUrls = null; - /** * @return the invalidServiceUrls */ @@ -842,7 +897,9 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI return 1; } if (urlsWithoutServices != null && urlsWithoutServices.contains(url)) + { return 0; + } if (invalidServiceUrls != null && invalidServiceUrls.contains(url)) { return -1; @@ -956,4 +1013,21 @@ public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI { 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. + * + * @param value + * @throws MalformedURLException + */ + public void setPreferredUrl(String value) throws MalformedURLException + { + if (value != null && value.trim().length() > 0) + { + new URL(value); + preferredUrl = value; + } + } }