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