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