src/jalview/ws/Discoverer.java

   1 /*
   2 * Jalview - A Sequence Alignment Editor and Viewer
   3 * Copyright (C) 2005 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle
   4 *
   5 * This program is free software; you can redistribute it and/or
   6 * modify it under the terms of the GNU General Public License
   7 * as published by the Free Software Foundation; either version 2
   8 * of the License, or (at your option) any later version.
   9 *
  10 * This program is distributed in the hope that it will be useful,
  11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 * GNU General Public License for more details.
  14 *
  15 * You should have received a copy of the GNU General Public License
  16 * along with this program; if not, write to the Free Software
  17 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
  18 */
  19 package jalview.ws;
  20
  21 /**
  22  * <p>Title: </p>
  23  *
  24  * <p>Description: </p>
  25  *
  26  * <p>Copyright: Copyright (c) 2004</p>
  27  *
  28  * <p>Company: Dundee University</p>
  29  *
  30  * @author not attributable
  31  * @version 1.0
  32  */
  33 import ext.vamsas.*;
  34 import java.util.Vector;
  35 import java.util.Hashtable;
  36 import java.util.StringTokenizer;
  37 import javax.swing.JOptionPane;
  38
  39 public class Discoverer
  40     extends Thread implements Runnable
  41 {
  42   ext.vamsas.IRegistry registry; // the root registry service.
  43   private java.beans.PropertyChangeSupport changeSupport = new java.beans.
  44       PropertyChangeSupport(this);
  45
  46   /**
  47    * change listeners are notified of "services" property changes
  48    *
  49    * @param listener 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 to be removed
  61    */
  62   public void removePropertyChangeListener(
  63       java.beans.PropertyChangeListener listener)
  64   {
  65     changeSupport.removePropertyChangeListener(listener);
  66   }
  67
  68   /**
  69    * Property change listener firing routine
  70    *
  71    * @param prop services
  72    * @param oldvalue old services hash
  73    * @param newvalue new services hash
  74    */
  75   public void firePropertyChange(String prop, Object oldvalue, Object newvalue)
  76   {
  77     changeSupport.firePropertyChange(prop, oldvalue, newvalue);
  78   }
  79
  80   /**
  81    * Initializes the server field with a valid service implementation.
  82    *
  83    * @return true if service was located.
  84    */
  85   private IRegistry locateWebService(java.net.URL WsURL)
  86   {
  87     IRegistryServiceLocator loc = new IRegistryServiceLocator(); // Default
  88     IRegistry server = null;
  89     try
  90     {
  91       server = loc.getRegistryService(WsURL);
  92       ( (RegistryServiceSoapBindingStub) server).setTimeout(60000); // One minute timeout
  93     }
  94     catch (Exception ex)
  95     {
  96       jalview.bin.Cache.log.error(
  97           "Serious!  Service location failed\nfor URL :" + WsURL +
  98           "\n", ex);
  99
 100       return null;
 101     }
 102
 103     loc.getEngine().setOption("axis", "1");
 104
 105     return server;
 106   }
 107
 108   static private java.net.URL RootServiceURL = null;
 109   static public Vector ServiceURLList = null;
 110   static private boolean reallyDiscoverServices = true;
 111
 112   public static java.util.Hashtable services = null; // vectors of services stored by abstractServiceType string
 113   public static java.util.Vector serviceList = null; // flat list of services
 114   static private Vector getDiscoveryURLS() {
 115     Vector urls = new Vector();
 116     String RootServiceURLs = jalview.bin.Cache.getDefault("DISCOVERY_URLS",
 117         "http://www.compbio.dundee.ac.uk/JalviewWS/services/ServiceRegistry");
 118
 119     try{
 120       StringTokenizer st = new StringTokenizer(RootServiceURLs, ",");
 121       while (st.hasMoreElements())
 122       {
 123         String url = null;
 124         try
 125         {
 126           java.net.URL u = new java.net.URL(url = st.nextToken());
 127           if (!urls.contains(u))
 128             urls.add(u);
 129           else
 130             jalview.bin.Cache.log.info("Ignoring duplicate url in DISCOVERY_URLS list");
 131         }
 132         catch (Exception ex)
 133         {
 134           jalview.bin.Cache.log.warn(
 135               "Problem whilst trying to make a URL from '" +
 136               ( (url != null) ? url : "<null>")+"'");
 137           jalview.bin.Cache.log.warn("This was probably due to a malformed comma separated list"
 138                                        +" in the DISCOVERY_URLS entry of $(HOME)/.jalview_properties)");
 139           jalview.bin.Cache.log.debug("Exception was ",ex);
 140         }
 141       }
 142     }catch(Exception ex)
 143     {jalview.bin.Cache.log.warn("Error parsing comma separated list of urls in DISCOVERY_URLS.",ex);}
 144     if (urls.size()>0)
 145       return urls;
 146     return null;
 147   }
 148
 149   /**
 150    * fetch new services or reset to hardwired defaults depending on preferences.
 151    */
 152   static public void doDiscovery()
 153   {
 154     jalview.bin.Cache.log.debug("(Re)-Initialising the discovery URL list.");
 155     try
 156     {
 157       reallyDiscoverServices = jalview.bin.Cache.getDefault("DISCOVERY_START", false);
 158       if (reallyDiscoverServices)
 159       {
 160         ServiceURLList = getDiscoveryURLS();
 161       }
 162       else
 163       {
 164         jalview.bin.Cache.log.debug("Setting default services");
 165         services = new Hashtable();
 166         // Muscle, Clustal and JPred.
 167         ServiceHandle[] defServices = {
 168             new ServiceHandle(
 169                 "MsaWS",
 170                 "Edgar, Robert C. (2004), MUSCLE: multiple sequence alignment " +
 171                 "with high accuracy and high throughput, Nucleic Acids Research 32(5), 1792-97.",
 172                 "http://www.compbio.dundee.ac.uk/JalviewWS/services/MuscleWS",
 173                 "Muscle Multiple Protein Sequence Alignment"
 174 ),
 175             new ServiceHandle(
 176                 "MsaWS",
 177                 "Katoh, K., K. Kuma, K., Toh, H.,  and Miyata, T. (2005) "+
 178                 "\"MAFFT version 5: improvement in accuracy of multiple sequence alignment.\""+
 179                " Nucleic Acids Research, 33 511-518",
 180                 "http://www.compbio.dundee.ac.uk/JalviewWS/services/MafftWS",
 181                 "MAFFT Multiple Sequence Alignment"),
 182             new ServiceHandle(
 183                 "MsaWS",
 184                 "Thompson, J.D., Higgins, D.G. and Gibson, T.J. (1994) CLUSTAL W: improving the sensitivity of progressive multiple" +
 185                 " sequence alignment through sequence weighting, position specific gap penalties and weight matrix choice." +
 186                 " Nucleic Acids Research, 22 4673-4680",
 187                 "http://www.compbio.dundee.ac.uk/JalviewWS/services/ClustalWS",
 188                 "ClustalW Multiple Sequence Alignment"),
 189             new ServiceHandle(
 190                 "SecStrPred",
 191                 "Cuff J. A and Barton G.J (2000) Application of " +
 192                 "multiple sequence alignment profiles to improve protein secondary structure prediction, " +
 193                 "Proteins 40:502-511",
 194                 "http://www.compbio.dundee.ac.uk/JalviewWS/services/jpred","JNet Secondary Structure Prediction"
 195                 )};
 196         services = new Hashtable();
 197         serviceList = new Vector();
 198         buildServiceLists(defServices, serviceList, services);
 199       }
 200
 201     }
 202     catch (Exception e)
 203     {
 204       System.err.println(
 205           "jalview.rootRegistry is not a proper url!\nWas set to " +
 206           RootServiceURL + "\n" + e);
 207     }
 208
 209   }
 210   // TODO: JBPNote : make this discover more services based on list of
 211   // discovery service urls, break cyclic references to the same url and
 212   // duplicate service entries (same endpoint *and* same interface)
 213   private ServiceHandle[] getServices(java.net.URL location)
 214   {
 215     ServiceHandles shs = null;
 216     try
 217     {
 218       jalview.bin.Cache.log.debug("Discovering services using " + location);
 219       shs = locateWebService(location).getServices();
 220     }
 221     catch (org.apache.axis.AxisFault f) {
 222       // JBPNote - should do this a better way!
 223       if (f.getFaultReason().indexOf("(407)")>-1) {
 224         if (jalview.gui.Desktop.desktop!=null)
 225           JOptionPane.showMessageDialog(jalview.gui.Desktop.desktop, "Please set up your proxy settings in the 'Connections' tab of the Preferences window",
 226                                       "Proxy Authorization Failed",
 227                                       JOptionPane.WARNING_MESSAGE);
 228       } else {
 229         jalview.bin.Cache.log.warn("No Discovery service at " +
 230                                    location);
 231         jalview.bin.Cache.log.debug("Axis Fault", f);
 232       }
 233     }
 234     catch (Exception e) {
 235       jalview.bin.Cache.log.warn("No Discovery service at " +
 236                                  location);
 237       jalview.bin.Cache.log.debug("Discovery Service General Exception", e);
 238     }
 239     if ( (shs != null) && shs.getServices().length > 0)
 240     {
 241       return shs.getServices();
 242     }
 243     return null;
 244   }
 245
 246   /**
 247    * Adds a list of services to the service catalog and categorised catalog
 248    * returns true if ServiceURLList was modified with a new DiscoveryService URL
 249    * @param sh ServiceHandle[]
 250    * @param cat Vector
 251    * @param sscat Hashtable
 252    * @return boolean
 253    */
 254   static private boolean buildServiceLists(ServiceHandle[] sh, Vector cat,
 255                                     Hashtable sscat)
 256   {
 257     boolean seenNewDiscovery = false;
 258     for (int i = 0, j = sh.length; i < j; i++)
 259     {
 260       if (!cat.contains(sh[i]))
 261       {
 262         jalview.bin.Cache.log.debug("A " + sh[i].getAbstractName() +
 263                                       " service called " +
 264                                       sh[i].getName() + " exists at " +
 265                                       sh[i].getEndpointURL() + "\n");
 266         if (!sscat.containsKey(sh[i].getAbstractName()))
 267         {
 268           sscat.put(sh[i].getAbstractName(), cat = new Vector());
 269         }
 270         else
 271         {
 272           cat = (Vector) sscat.get(sh[i].getAbstractName());
 273         }
 274         cat.add(sh[i]);
 275         if (sh[i].getAbstractName().equals("Registry"))
 276         {
 277           for (int s = 0, sUrls = ServiceURLList.size(); s < sUrls; s++)
 278           {
 279             java.net.URL disc_serv = null;
 280             try
 281             {
 282               disc_serv = new java.net.URL(sh[i].getEndpointURL());
 283               if (!ServiceURLList.contains(disc_serv))
 284               {
 285                 jalview.bin.Cache.log.debug(
 286                     "Adding new discovery service at " + disc_serv);
 287                 ServiceURLList.add(disc_serv);
 288                 seenNewDiscovery = true;
 289               }
 290             }
 291             catch (Exception e)
 292             {
 293               jalview.bin.Cache.log.debug(
 294                   "Ignoring bad discovery service URL " + sh[i].getEndpointURL(),
 295                   e);
 296             }
 297           }
 298         }
 299       }
 300     }
 301     return seenNewDiscovery;
 302   }
 303
 304   public void discoverServices()
 305   {
 306     Hashtable sscat = new Hashtable();
 307     Vector cat = new Vector();
 308     ServiceHandle sh[] = null;
 309     int s_url = 0;
 310     if (ServiceURLList==null)
 311     {
 312       jalview.bin.Cache.log.debug("No service endpoints to use for service discovery.");
 313       return;
 314     }
 315     while (s_url < ServiceURLList.size())
 316     {
 317       if ( (sh = getServices( (java.net.URL) ServiceURLList.get(s_url))) != null)
 318       {
 319
 320         buildServiceLists(sh, cat, sscat);
 321       } else {
 322         jalview.bin.Cache.log.warn(
 323             "No services at "
 324             +((java.net.URL) ServiceURLList.get(s_url))
 325             +" - check DISCOVERY_URLS property in .jalview_properties");
 326       }
 327       s_url++;
 328     }
 329     // TODO: decide on correct semantics for services list - PropertyChange
 330     // provides a way of passing the new object around
 331     // so no need to access original discovery thread.
 332     // Curent decision is to change properties then notify listeners with old and new values.
 333     Hashtable oldServices = services;
 334     //Vector oldServicelist = serviceList;
 335     services = sscat;
 336     serviceList = cat;
 337     firePropertyChange("services", oldServices, services);
 338   }
 339
 340   /**
 341    * creates a new thread to call discoverServices()
 342    */
 343   public void run()
 344   {
 345     final Discoverer discoverer = this;
 346     Thread discoverThread = new Thread() {
 347       public void run() {
 348         discoverer.doDiscovery();
 349         discoverer.discoverServices();
 350       }
 351     };
 352     discoverThread.start();
 353   }
 354 }