src/jalview/ws/jws1/Discoverer.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
   4  *
   5  * This file is part of Jalview.
   6  *
   7  * Jalview is free software: you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation, either version 3
  10  * of the License, or (at your option) any later version.
  11  *
  12  * Jalview is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty
  14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE.  See the GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  19  * The Jalview Authors are detailed in the 'AUTHORS' file.
  20  */
  21 package jalview.ws.jws1;
  22
  23 import jalview.bin.Cache;
  24 import jalview.gui.JvOptionPane;
  25 import jalview.util.MessageManager;
  26
  27 import java.net.URL;
  28 import java.util.Hashtable;
  29 import java.util.StringTokenizer;
  30 import java.util.Vector;
  31
  32 import ext.vamsas.IRegistry;
  33 import ext.vamsas.IRegistryServiceLocator;
  34 import ext.vamsas.RegistryServiceSoapBindingStub;
  35 import ext.vamsas.ServiceHandle;
  36 import ext.vamsas.ServiceHandles;
  37
  38 public class Discoverer implements Runnable
  39 {
  40   ext.vamsas.IRegistry registry; // the root registry service.
  41
  42   private java.beans.PropertyChangeSupport changeSupport = new java.beans.PropertyChangeSupport(
  43           this);
  44
  45   /**
  46    * change listeners are notified of "services" property changes
  47    *
  48    * @param listener
  49    *          to be added that consumes new services Hashtable object.
  50    */
  51   public void addPropertyChangeListener(
  52           java.beans.PropertyChangeListener listener)
  53   {
  54     changeSupport.addPropertyChangeListener(listener);
  55   }
  56
  57   /**
  58    *
  59    *
  60    * @param listener
  61    *          to be removed
  62    */
  63   public void removePropertyChangeListener(
  64           java.beans.PropertyChangeListener listener)
  65   {
  66     changeSupport.removePropertyChangeListener(listener);
  67   }
  68
  69   /**
  70    * Property change listener firing routine
  71    *
  72    * @param prop
  73    *          services
  74    * @param oldvalue
  75    *          old services hash
  76    * @param newvalue
  77    *          new services hash
  78    */
  79   public void firePropertyChange(String prop, Object oldvalue,
  80           Object newvalue)
  81   {
  82     changeSupport.firePropertyChange(prop, oldvalue, newvalue);
  83   }
  84
  85   /**
  86    * Initializes the server field with a valid service implementation.
  87    *
  88    * @return true if service was located.
  89    */
  90   private IRegistry locateWebService(java.net.URL WsURL)
  91   {
  92     IRegistryServiceLocator loc = new IRegistryServiceLocator(); // Default
  93     IRegistry server = null;
  94     try
  95     {
  96       server = loc.getRegistryService(WsURL);
  97       ((RegistryServiceSoapBindingStub) server).setTimeout(60000); // One
  98       // minute
  99       // timeout
 100     } catch (Exception ex)
 101     {
 102       jalview.bin.Cache.log.error(
 103               "Serious!  Service location failed\nfor URL :" + WsURL + "\n",
 104               ex);
 105
 106       return null;
 107     }
 108
 109     loc.getEngine().setOption("axis", "1");
 110
 111     return server;
 112   }
 113
 114   static private java.net.URL RootServiceURL = null;
 115
 116   static public Vector<URL> ServiceURLList = null;
 117
 118   static private boolean reallyDiscoverServices = true;
 119
 120   public static java.util.Hashtable<String, Vector<ServiceHandle>> services = null;
 121   // stored by
 122   // abstractServiceType
 123   // string
 124
 125   public static java.util.Vector<ServiceHandle> serviceList = null;
 126
 127   static private Vector<URL> getDiscoveryURLS()
 128   {
 129     Vector<URL> urls = new Vector<>();
 130     String RootServiceURLs = jalview.bin.Cache.getDefault("DISCOVERY_URLS",
 131             "http://www.compbio.dundee.ac.uk/JalviewWS/services/ServiceRegistry");
 132
 133     try
 134     {
 135       StringTokenizer st = new StringTokenizer(RootServiceURLs, ",");
 136       while (st.hasMoreElements())
 137       {
 138         String url = null;
 139         try
 140         {
 141           java.net.URL u = new java.net.URL(url = st.nextToken());
 142           if (!urls.contains(u))
 143           {
 144             urls.add(u);
 145           }
 146           else
 147           {
 148             jalview.bin.Cache.log
 149                     .info("Ignoring duplicate url in DISCOVERY_URLS list");
 150           }
 151         } catch (Exception ex)
 152         {
 153           jalview.bin.Cache.log
 154                   .warn("Problem whilst trying to make a URL from '"
 155                           + ((url != null) ? url : "<null>") + "'");
 156           jalview.bin.Cache.log.warn(
 157                   "This was probably due to a malformed comma separated list"
 158                           + " in the DISCOVERY_URLS entry of $(HOME)/.jalview_properties)");
 159           jalview.bin.Cache.log.debug("Exception was ", ex);
 160         }
 161       }
 162     } catch (Exception ex)
 163     {
 164       jalview.bin.Cache.log.warn(
 165               "Error parsing comma separated list of urls in DISCOVERY_URLS.",
 166               ex);
 167     }
 168     if (urls.size() > 0)
 169     {
 170       return urls;
 171     }
 172     return null;
 173   }
 174
 175   /**
 176    * fetch new services or reset to hardwired defaults depending on preferences.
 177    */
 178   static public void doDiscovery()
 179   {
 180     jalview.bin.Cache.log
 181             .debug("(Re)-Initialising the discovery URL list.");
 182     try
 183     {
 184       reallyDiscoverServices = jalview.bin.Cache
 185               .getDefault("DISCOVERY_START", false);
 186       if (reallyDiscoverServices)
 187       {
 188         ServiceURLList = getDiscoveryURLS();
 189       }
 190       else
 191       {
 192         jalview.bin.Cache.log.debug("Setting default services");
 193         services = new Hashtable<>();
 194         // Muscle, Clustal and JPred.
 195         ServiceHandle[] defServices = { new ServiceHandle("MsaWS",
 196                 "Edgar, Robert C. (2004), MUSCLE: multiple sequence alignment "
 197                         + "with high accuracy and high throughput, Nucleic Acids Research 32(5), 1792-97.",
 198                 "http://www.compbio.dundee.ac.uk/JalviewWS/services/MuscleWS",
 199                 MessageManager.getString(
 200                         "label.muscle_multiple_protein_sequence_alignment")),
 201             new ServiceHandle("MsaWS",
 202                     "Katoh, K., K. Kuma, K., Toh, H.,  and Miyata, T. (2005) "
 203                             + "\"MAFFT version 5: improvement in accuracy of multiple sequence alignment.\""
 204                             + " Nucleic Acids Research, 33 511-518",
 205                     "http://www.compbio.dundee.ac.uk/JalviewWS/services/MafftWS",
 206                     MessageManager.getString(
 207                             "label.mafft_multiple_sequence_alignment")),
 208             new ServiceHandle("MsaWS",
 209                     "Thompson, J.D., Higgins, D.G. and Gibson, T.J. (1994) CLUSTAL W: improving the sensitivity of progressive multiple"
 210                             + " sequence alignment through sequence weighting, position specific gap penalties and weight matrix choice."
 211                             + " Nucleic Acids Research, 22 4673-4680",
 212                     "http://www.compbio.dundee.ac.uk/JalviewWS/services/ClustalWS",
 213                     MessageManager.getString(
 214                             "label.clustalw_multiple_sequence_alignment")),
 215             new ServiceHandle("SecStrPred",
 216                     "Drozdetskiy A, Cole C, Procter J & Barton GJ. (2015)\nJPred4: a protein secondary structure prediction server"
 217                             + "\nNucleic Acids Research, Web Server issue (first published 15th April 2015)"
 218                             + "\ndoi://10.1093/nar/gkv332",
 219                     "http://www.compbio.dundee.ac.uk/JalviewWS/services/jpred",
 220                     "JPred Secondary Structure Prediction") };
 221         services = new Hashtable<>();
 222         serviceList = new Vector<>();
 223         buildServiceLists(defServices, serviceList, services);
 224       }
 225
 226     } catch (Exception e)
 227     {
 228       System.err.println(
 229               "jalview.rootRegistry is not a proper url!\nWas set to "
 230                       + RootServiceURL + "\n" + e);
 231     }
 232
 233   }
 234
 235   // TODO: JBPNote : make this discover more services based on list of
 236   // discovery service urls, break cyclic references to the same url and
 237   // duplicate service entries (same endpoint *and* same interface)
 238   private ServiceHandle[] getServices(java.net.URL location)
 239   {
 240     ServiceHandles shs = null;
 241     try
 242     {
 243       jalview.bin.Cache.log.debug("Discovering services using " + location);
 244       shs = locateWebService(location).getServices();
 245     } catch (org.apache.axis.AxisFault f)
 246     {
 247       // JBPNote - should do this a better way!
 248       if (f.getFaultReason().indexOf("(407)") > -1)
 249       {
 250         if (jalview.gui.Desktop.desktop != null)
 251         {
 252           JvOptionPane.showMessageDialog(jalview.gui.Desktop.desktop,
 253                   MessageManager.getString("label.set_proxy_settings"),
 254                   MessageManager
 255                           .getString("label.proxy_authorization_failed"),
 256                   JvOptionPane.WARNING_MESSAGE);
 257         }
 258       }
 259       else
 260       {
 261         jalview.bin.Cache.log.warn("No Discovery service at " + location);
 262         jalview.bin.Cache.log.debug("Axis Fault", f);
 263       }
 264     } catch (Exception e)
 265     {
 266       jalview.bin.Cache.log.warn("No Discovery service at " + location);
 267       jalview.bin.Cache.log.debug("Discovery Service General Exception", e);
 268     }
 269     if ((shs != null) && shs.getServices().length > 0)
 270     {
 271       return shs.getServices();
 272     }
 273     return null;
 274   }
 275
 276   /**
 277    * Adds a list of services to the service catalog and categorised catalog
 278    * returns true if ServiceURLList was modified with a new DiscoveryService URL
 279    *
 280    * @param sh
 281    *          ServiceHandle[]
 282    * @param cat
 283    *          Vector
 284    * @param sscat
 285    *          Hashtable
 286    * @return boolean
 287    */
 288   static private boolean buildServiceLists(ServiceHandle[] sh,
 289           Vector<ServiceHandle> cat,
 290           Hashtable<String, Vector<ServiceHandle>> sscat)
 291   {
 292     boolean seenNewDiscovery = false;
 293     for (int i = 0, j = sh.length; i < j; i++)
 294     {
 295       if (!cat.contains(sh[i]))
 296       {
 297         jalview.bin.Cache.log.debug("A " + sh[i].getAbstractName()
 298                 + " service called " + sh[i].getName() + " exists at "
 299                 + sh[i].getEndpointURL() + "\n");
 300         if (!sscat.containsKey(sh[i].getAbstractName()))
 301         {
 302           sscat.put(sh[i].getAbstractName(), cat = new Vector<>());
 303         }
 304         else
 305         {
 306           cat = sscat.get(sh[i].getAbstractName());
 307         }
 308         cat.add(sh[i]);
 309         if (sh[i].getAbstractName().equals("Registry"))
 310         {
 311           for (int s = 0, sUrls = ServiceURLList.size(); s < sUrls; s++)
 312           {
 313             java.net.URL disc_serv = null;
 314             try
 315             {
 316               disc_serv = new java.net.URL(sh[i].getEndpointURL());
 317               if (!ServiceURLList.contains(disc_serv))
 318               {
 319                 jalview.bin.Cache.log.debug(
 320                         "Adding new discovery service at " + disc_serv);
 321                 ServiceURLList.add(disc_serv);
 322                 seenNewDiscovery = true;
 323               }
 324             } catch (Exception e)
 325             {
 326               jalview.bin.Cache.log
 327                       .debug("Ignoring bad discovery service URL "
 328                               + sh[i].getEndpointURL(), e);
 329             }
 330           }
 331         }
 332       }
 333     }
 334     return seenNewDiscovery;
 335   }
 336
 337   public void discoverServices()
 338   {
 339     Hashtable<String, Vector<ServiceHandle>> sscat = new Hashtable<>();
 340     Vector<ServiceHandle> cat = new Vector<>();
 341     ServiceHandle sh[] = null;
 342     int s_url = 0;
 343     if (ServiceURLList == null)
 344     {
 345       jalview.bin.Cache.log
 346               .debug("No service endpoints to use for service discovery.");
 347       return;
 348     }
 349     while (s_url < ServiceURLList.size())
 350     {
 351       if ((sh = getServices(
 352               ServiceURLList.get(s_url))) != null)
 353       {
 354
 355         buildServiceLists(sh, cat, sscat);
 356       }
 357       else
 358       {
 359         jalview.bin.Cache.log.warn("No services at "
 360                 + (ServiceURLList.get(s_url))
 361                 + " - check DISCOVERY_URLS property in .jalview_properties");
 362       }
 363       s_url++;
 364     }
 365     // TODO: decide on correct semantics for services list - PropertyChange
 366     // provides a way of passing the new object around
 367     // so no need to access original discovery thread.
 368     // Curent decision is to change properties then notify listeners with old
 369     // and new values.
 370     Hashtable<String, Vector<ServiceHandle>> oldServices = services;
 371     // Vector oldServicelist = serviceList;
 372     services = sscat;
 373     serviceList = cat;
 374     changeSupport.firePropertyChange("services", oldServices, services);
 375   }
 376
 377   /**
 378    * creates a new thread to call discoverServices()
 379    */
 380   @Override
 381   public void run()
 382   {
 383     Cache.log.info("Discovering jws1 services");
 384     Discoverer.doDiscovery();
 385     discoverServices();
 386   }
 387
 388   /**
 389    * binding service abstract name to handler class
 390    */
 391   private static Hashtable<String, WS1Client> serviceClientBindings;
 392
 393   public static WS1Client getServiceClient(ServiceHandle sh)
 394   {
 395     if (serviceClientBindings == null)
 396     {
 397       // get a list from Config or create below
 398       serviceClientBindings = new Hashtable<>();
 399       serviceClientBindings.put("MsaWS", new MsaWSClient());
 400       serviceClientBindings.put("SecStrPred", new JPredClient());
 401       serviceClientBindings.put("SeqSearch", new SeqSearchWSClient());
 402     }
 403     WS1Client instance = serviceClientBindings
 404             .get(sh.getAbstractName());
 405     if (instance == null)
 406     {
 407       System.err.println(
 408               "WARNING - POSSIBLE IMPLEMENTATION ERROR - cannot find WSClient implementation for "
 409                       + sh.getAbstractName());
 410     }
 411     else
 412     {
 413       instance.serviceHandle = sh;
 414     }
 415     return instance;
 416   }
 417   /**
 418    * notes on discovery service 1. need to allow multiple discovery source urls.
 419    * 2. user interface to add/control list of urls in preferences notes on
 420    * wsclient discovery 1. need a classpath property with list of additional
 421    * plugin directories 2. optional config to cite specific bindings between
 422    * class name and Abstract service name. 3. precedence for automatic discovery
 423    * by using getAbstractName for WSClient - user added plugins override default
 424    * plugins ? notes on wsclient gui code for gui attachment now moved to
 425    * wsclient implementation. Needs more abstraction but approach seems to work.
 426    * is it possible to 'generalise' the data retrieval calls further ? current
 427    * methods are very specific (gatherForMSA or gatherForSeqOrMsaSecStrPred),
 428    * new methods for conservation (group or alignment), treecalc (aligned
 429    * profile), seqannot (sequences selected from dataset, annotation back to
 430    * dataset).
 431    *
 432    */
 433 }