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.Desktop;
  25 import jalview.util.MessageManager;
  26
  27 import java.util.Hashtable;
  28 import java.util.StringTokenizer;
  29 import java.util.Vector;
  30
  31 import javax.swing.JOptionPane;
  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
  40 {
  41   ext.vamsas.IRegistry registry; // the root registry service.
  42
  43   private java.beans.PropertyChangeSupport changeSupport = new java.beans.PropertyChangeSupport(
  44           this);
  45
  46   /**
  47    * change listeners are notified of "services" property changes
  48    *
  49    * @param listener
  50    *          to be added that consumes new services Hashtable object.
  51    */
  52   public void addPropertyChangeListener(
  53           java.beans.PropertyChangeListener listener)
  54   {
  55     changeSupport.addPropertyChangeListener(listener);
  56   }
  57
  58   /**
  59    *
  60    *
  61    * @param listener
  62    *          to be removed
  63    */
  64   public void removePropertyChangeListener(
  65           java.beans.PropertyChangeListener listener)
  66   {
  67     changeSupport.removePropertyChangeListener(listener);
  68   }
  69
  70   /**
  71    * Property change listener firing routine
  72    *
  73    * @param prop
  74    *          services
  75    * @param oldvalue
  76    *          old services hash
  77    * @param newvalue
  78    *          new services hash
  79    */
  80   public void firePropertyChange(String prop, Object oldvalue,
  81           Object newvalue)
  82   {
  83     changeSupport.firePropertyChange(prop, oldvalue, newvalue);
  84   }
  85
  86   /**
  87    * Initializes the server field with a valid service implementation.
  88    *
  89    * @return true if service was located.
  90    */
  91   private IRegistry locateWebService(java.net.URL WsURL)
  92   {
  93     IRegistryServiceLocator loc = new IRegistryServiceLocator(); // Default
  94     IRegistry server = null;
  95     try
  96     {
  97       server = loc.getRegistryService(WsURL);
  98       ((RegistryServiceSoapBindingStub) server).setTimeout(60000); // One
  99       // minute
 100       // timeout
 101     } catch (Exception ex)
 102     {
 103       Cache.log
 104               .error("Serious!  Service location failed\nfor URL :" + WsURL
 105                       + "\n", ex);
 106
 107       return null;
 108     }
 109
 110     loc.getEngine().setOption("axis", "1");
 111
 112     return server;
 113   }
 114
 115   static private java.net.URL RootServiceURL = null;
 116
 117   static public Vector ServiceURLList = null;
 118
 119   static private boolean reallyDiscoverServices = true;
 120
 121   public static java.util.Hashtable services = null; // vectors of services
 122
 123   // stored by
 124   // abstractServiceType
 125   // string
 126
 127   public static java.util.Vector serviceList = null; // flat list of services
 128
 129   static private Vector getDiscoveryURLS()
 130   {
 131     Vector urls = new Vector();
 132     String RootServiceURLs = Cache
 133             .getDefault("DISCOVERY_URLS",
 134                     "http://www.compbio.dundee.ac.uk/JalviewWS/services/ServiceRegistry");
 135
 136     try
 137     {
 138       StringTokenizer st = new StringTokenizer(RootServiceURLs, ",");
 139       while (st.hasMoreElements())
 140       {
 141         String url = null;
 142         try
 143         {
 144           java.net.URL u = new java.net.URL(url = st.nextToken());
 145           if (!urls.contains(u))
 146           {
 147             urls.add(u);
 148           }
 149           else
 150           {
 151             Cache.log
 152                     .info("Ignoring duplicate url in DISCOVERY_URLS list");
 153           }
 154         } catch (Exception ex)
 155         {
 156           Cache.log
 157                   .warn("Problem whilst trying to make a URL from '"
 158                           + ((url != null) ? url : "<null>") + "'");
 159           Cache.log
 160                   .warn("This was probably due to a malformed comma separated list"
 161                           + " in the DISCOVERY_URLS entry of $(HOME)/.jalview_properties)");
 162           Cache.log.debug("Exception was ", ex);
 163         }
 164       }
 165     } catch (Exception ex)
 166     {
 167       Cache.log
 168               .warn("Error parsing comma separated list of urls in DISCOVERY_URLS.",
 169                       ex);
 170     }
 171     if (urls.size() > 0)
 172     {
 173       return urls;
 174     }
 175     return null;
 176   }
 177
 178   /**
 179    * fetch new services or reset to hardwired defaults depending on preferences.
 180    */
 181   static public void doDiscovery()
 182   {
 183     Cache.log
 184             .debug("(Re)-Initialising the discovery URL list.");
 185     try
 186     {
 187       reallyDiscoverServices = Cache.getDefault(
 188               "DISCOVERY_START", false);
 189       if (reallyDiscoverServices)
 190       {
 191         ServiceURLList = getDiscoveryURLS();
 192       }
 193       else
 194       {
 195         Cache.log.debug("Setting default services");
 196         services = new Hashtable();
 197         // Muscle, Clustal and JPred.
 198         ServiceHandle[] defServices =
 199         {
 200             new ServiceHandle(
 201                     "MsaWS",
 202                     "Edgar, Robert C. (2004), MUSCLE: multiple sequence alignment "
 203                             + "with high accuracy and high throughput, Nucleic Acids Research 32(5), 1792-97.",
 204                     "http://www.compbio.dundee.ac.uk/JalviewWS/services/MuscleWS",
 205                     MessageManager.getString("label.muscle_multiple_protein_sequence_alignment")),
 206             new ServiceHandle(
 207                     "MsaWS",
 208                     "Katoh, K., K. Kuma, K., Toh, H.,  and Miyata, T. (2005) "
 209                             + "\"MAFFT version 5: improvement in accuracy of multiple sequence alignment.\""
 210                             + " Nucleic Acids Research, 33 511-518",
 211                     "http://www.compbio.dundee.ac.uk/JalviewWS/services/MafftWS",
 212                     MessageManager.getString("label.mafft_multiple_sequence_alignment")),
 213             new ServiceHandle(
 214                     "MsaWS",
 215                     "Thompson, J.D., Higgins, D.G. and Gibson, T.J. (1994) CLUSTAL W: improving the sensitivity of progressive multiple"
 216                             + " sequence alignment through sequence weighting, position specific gap penalties and weight matrix choice."
 217                             + " Nucleic Acids Research, 22 4673-4680",
 218                     "http://www.compbio.dundee.ac.uk/JalviewWS/services/ClustalWS",
 219                     MessageManager.getString("label.clustalw_multiple_sequence_alignment")),
 220             new ServiceHandle(
 221                     "SecStrPred",
 222                     "Drozdetskiy A, Cole C, Procter J & Barton GJ. (2015)\nJPred4: a protein secondary structure prediction server"
 223                             + "\nNucleic Acids Research, Web Server issue (first published 15th April 2015)"
 224                             + "\ndoi://10.1093/nar/gkv332",
 225                     "http://www.compbio.dundee.ac.uk/JalviewWS/services/jpred",
 226                     "JNet Secondary Structure Prediction") };
 227         services = new Hashtable();
 228         serviceList = new Vector();
 229         buildServiceLists(defServices, serviceList, services);
 230       }
 231
 232     } catch (Exception e)
 233     {
 234       System.err
 235               .println("jalview.rootRegistry is not a proper url!\nWas set to "
 236                       + RootServiceURL + "\n" + e);
 237     }
 238
 239   }
 240
 241   // TODO: JBPNote : make this discover more services based on list of
 242   // discovery service urls, break cyclic references to the same url and
 243   // duplicate service entries (same endpoint *and* same interface)
 244   private ServiceHandle[] getServices(java.net.URL location)
 245   {
 246     ServiceHandles shs = null;
 247     try
 248     {
 249       Cache.log.debug("Discovering services using " + location);
 250       shs = locateWebService(location).getServices();
 251     } catch (org.apache.axis.AxisFault f)
 252     {
 253       // JBPNote - should do this a better way!
 254       if (f.getFaultReason().indexOf("(407)") > -1)
 255       {
 256         if (Desktop.desktop != null)
 257         {
 258           JOptionPane.showMessageDialog(Desktop.desktop, MessageManager
 259                   .getString("label.set_proxy_settings"), MessageManager
 260                   .getString("label.proxy_authorization_failed"),
 261                   JOptionPane.WARNING_MESSAGE);
 262         }
 263       }
 264       else
 265       {
 266         Cache.log.warn("No Discovery service at " + location);
 267         Cache.log.debug("Axis Fault", f);
 268       }
 269     } catch (Exception e)
 270     {
 271       Cache.log.warn("No Discovery service at " + location);
 272       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         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                 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               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       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         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   public void run()
 386   {
 387     final Discoverer discoverer = this;
 388     Thread discoverThread = new Thread()
 389     {
 390       public void run()
 391       {
 392         discoverer.doDiscovery();
 393         discoverer.discoverServices();
 394       }
 395     };
 396     discoverThread.start();
 397   }
 398
 399   /**
 400    * binding service abstract name to handler class
 401    */
 402   private static Hashtable serviceClientBindings;
 403
 404   public static WS1Client getServiceClient(ServiceHandle sh)
 405   {
 406     if (serviceClientBindings == null)
 407     {
 408       // get a list from Config or create below
 409       serviceClientBindings = new Hashtable();
 410       serviceClientBindings.put("MsaWS", new MsaWSClient());
 411       serviceClientBindings.put("SecStrPred", new JPredClient());
 412       serviceClientBindings.put("SeqSearch", new SeqSearchWSClient());
 413     }
 414     WS1Client instance = (WS1Client) serviceClientBindings.get(sh
 415             .getAbstractName());
 416     if (instance == null)
 417     {
 418       System.err
 419               .println("WARNING - POSSIBLE IMPLEMENTATION ERROR - cannot find WSClient implementation for "
 420                       + sh.getAbstractName());
 421     }
 422     else
 423     {
 424       instance.serviceHandle = sh;
 425     }
 426     return instance;
 427   }
 428   /**
 429    * notes on discovery service 1. need to allow multiple discovery source urls.
 430    * 2. user interface to add/control list of urls in preferences notes on
 431    * wsclient discovery 1. need a classpath property with list of additional
 432    * plugin directories 2. optional config to cite specific bindings between
 433    * class name and Abstract service name. 3. precedence for automatic discovery
 434    * by using getAbstractName for WSClient - user added plugins override default
 435    * plugins ? notes on wsclient gui code for gui attachment now moved to
 436    * wsclient implementation. Needs more abstraction but approach seems to work.
 437    * is it possible to 'generalise' the data retrieval calls further ? current
 438    * methods are very specific (gatherForMSA or gatherForSeqOrMsaSecStrPred),
 439    * new methods for conservation (group or alignment), treecalc (aligned
 440    * profile), seqannot (sequences selected from dataset, annotation back to
 441    * dataset).
 442    *
 443    */
 444 }