src/jalview/ws/jws2/Jws2Discoverer.java

   1 package jalview.ws.jws2;
   2
   3 import java.awt.Color;
   4 import java.awt.event.ActionEvent;
   5 import java.awt.event.ActionListener;
   6 import java.beans.PropertyChangeEvent;
   7 import java.beans.PropertyChangeListener;
   8 import java.io.Closeable;
   9 import java.net.ConnectException;
  10 import java.net.URL;
  11 import java.util.HashSet;
  12 import java.util.Hashtable;
  13 import java.util.StringTokenizer;
  14 import java.util.Vector;
  15
  16 import javax.swing.JMenu;
  17 import javax.swing.JMenuItem;
  18 import javax.swing.event.MenuEvent;
  19 import javax.swing.event.MenuListener;
  20
  21 import org.apache.log4j.Level;
  22
  23 import jalview.bin.Cache;
  24 import jalview.datamodel.AlignmentView;
  25 import jalview.gui.AlignFrame;
  26 import jalview.gui.Desktop;
  27 import jalview.ws.WSMenuEntryProviderI;
  28 import jalview.ws.params.ParamDatastoreI;
  29 import compbio.data.msa.MsaWS;
  30 import compbio.metadata.Option;
  31 import compbio.metadata.Preset;
  32 import compbio.metadata.PresetManager;
  33 import compbio.metadata.RunnerConfig;
  34 import compbio.ws.client.Jws2Client;
  35 import compbio.ws.client.Services;
  36
  37 /**
  38  * discoverer for jws2 services. Follows the lightweight service discoverer
  39  * pattern (archetyped by EnfinEnvision2OneWay)
  40  *
  41  * @author JimP
  42  *
  43  */
  44 public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
  45 {
  46   private java.beans.PropertyChangeSupport changeSupport = new java.beans.PropertyChangeSupport(
  47           this);
  48
  49   /**
  50    * change listeners are notified of "services" property changes
  51    *
  52    * @param listener
  53    *          to be added that consumes new services Hashtable object.
  54    */
  55   public void addPropertyChangeListener(
  56           java.beans.PropertyChangeListener listener)
  57   {
  58     changeSupport.addPropertyChangeListener(listener);
  59   }
  60
  61   /**
  62    *
  63    *
  64    * @param listener
  65    *          to be removed
  66    */
  67   public void removePropertyChangeListener(
  68           java.beans.PropertyChangeListener listener)
  69   {
  70     changeSupport.removePropertyChangeListener(listener);
  71   }
  72
  73   boolean running = false;
  74
  75   Thread oldthread = null;
  76
  77   public void run()
  78   {
  79     if (running && oldthread != null && oldthread.isAlive())
  80     {
  81       return;
  82     }
  83     running = true;
  84     oldthread = Thread.currentThread();
  85     try
  86     {
  87       Class foo = getClass().getClassLoader().loadClass(
  88               "compbio.ws.client.Jws2Client");
  89     } catch (ClassNotFoundException e)
  90     {
  91       System.err
  92               .println("Not enabling Jalview Webservices version 2: client jar is not available."
  93                       + "\nPlease check that your webstart JNLP file is up to date!");
  94       running = false;
  95       return;
  96     }
  97     if (services != null)
  98     {
  99       services.removeAllElements();
 100     }
 101     for (String jwsservers : getServiceUrls())
 102     {
 103       try
 104       {
 105         if (Jws2Client.validURL(jwsservers))
 106         {
 107           // look for services
 108           for (Services srv : Services.values())
 109           {
 110             MsaWS service = null;
 111             try
 112             {
 113               service = Jws2Client.connect(jwsservers, srv);
 114             } catch (Exception e)
 115             {
 116               System.err.println("Jws2 Discoverer: Problem on "
 117                       + jwsservers + " with service " + srv + ":\n"
 118                       + e.getMessage());
 119               if (!(e instanceof javax.xml.ws.WebServiceException))
 120               {
 121                 e.printStackTrace();
 122               }
 123             }
 124             ;
 125             if (service != null)
 126             {
 127               addService(jwsservers, srv, service);
 128             }
 129           }
 130
 131         }
 132         else
 133         {
 134           Cache.log.info("Ignoring invalid Jws2 service url " + jwsservers);
 135         }
 136       } catch (Exception e)
 137       {
 138         e.printStackTrace();
 139         Cache.log.warn("Exception when discovering Jws2 services.", e);
 140       } catch (Error e)
 141       {
 142         Cache.log.error("Exception when discovering Jws2 services.", e);
 143       }
 144     }
 145     oldthread = null;
 146     running = false;
 147     changeSupport.firePropertyChange("services", new Vector(), services);
 148   }
 149
 150   /**
 151    * record this service endpoint so we can use it
 152    *
 153    * @param jwsservers
 154    * @param srv
 155    * @param service2
 156    */
 157   private void addService(String jwsservers, Services srv, MsaWS service2)
 158   {
 159     if (services == null)
 160     {
 161       services = new Vector<Jws2Instance>();
 162     }
 163     System.out.println("Discovered service: " + jwsservers + " "
 164             + srv.toString());
 165     Jws2Instance service = new Jws2Instance(jwsservers, srv.toString(), service2);
 166
 167     services.add(service);
 168     service.getParamStore();
 169   }
 170
 171   public class Jws2Instance
 172   {
 173     public String hosturl;
 174
 175     public String serviceType;
 176
 177     public MsaWS service;
 178
 179     public Jws2Instance(String hosturl, String serviceType, MsaWS service)
 180     {
 181       super();
 182       this.hosturl = hosturl;
 183       this.serviceType = serviceType;
 184       this.service = service;
 185     }
 186
 187     PresetManager presets = null;
 188
 189     public JabaParamStore paramStore = null;
 190
 191     /**
 192      * non thread safe - gets the presets for this service (blocks whilst it
 193      * calls the service to get the preset set)
 194      *
 195      * @return service presets or null if exceptions were raised.
 196      */
 197     public PresetManager getPresets()
 198     {
 199       if (presets == null)
 200       {
 201         try
 202         {
 203           presets = service.getPresets();
 204         } catch (Exception ex)
 205         {
 206           System.err
 207                   .println("Exception when retrieving presets for service "
 208                           + serviceType + " at " + hosturl);
 209         }
 210       }
 211       return presets;
 212     }
 213
 214     public String getHost()
 215     {
 216       return hosturl;
 217       /*
 218        * try { URL serviceurl = new URL(hosturl); if (serviceurl.getPort()!=80)
 219        * { return serviceurl.getHost()+":"+serviceurl.getPort(); } return
 220        * serviceurl.getHost(); } catch (Exception e) {
 221        * System.err.println("Failed to parse service URL '" + hosturl +
 222        * "' as a valid URL!"); } return null;
 223        */
 224     }
 225
 226     /**
 227      * @return short description of what the service will do
 228      */
 229     public String getActionText()
 230     {
 231       return "Align with " + serviceType;
 232     }
 233
 234     /**
 235      * non-thread safe - blocks whilst accessing service to get complete set of
 236      * available options and parameters
 237      *
 238      * @return
 239      */
 240     public RunnerConfig getRunnerConfig()
 241     {
 242       return service.getRunnerOptions();
 243     }
 244
 245     @Override
 246     protected void finalize() throws Throwable
 247     {
 248       if (service != null)
 249       {
 250         try
 251         {
 252           Closeable svc = (Closeable) service;
 253           service = null;
 254           svc.close();
 255         } catch (Exception e)
 256         {
 257         }
 258         ;
 259       }
 260       super.finalize();
 261     }
 262
 263     public ParamDatastoreI getParamStore()
 264     {
 265       if (paramStore == null)
 266       {
 267         try
 268         {
 269           paramStore = new JabaParamStore(this,
 270                   (Desktop.instance != null ? Desktop
 271                           .getUserParameterStore() : null));
 272         } catch (Exception ex)
 273         {
 274         }
 275
 276       }
 277       return paramStore;
 278     }
 279
 280     public String getUri()
 281     {
 282       // this is only valid for Jaba 1.0 - this formula might have to change!
 283       return hosturl+"/"+serviceType;
 284     }
 285   };
 286
 287   /**
 288    * holds list of services.
 289    */
 290   protected Vector<Jws2Instance> services;
 291
 292   /**
 293    * find or add a submenu with the given title in the given menu
 294    *
 295    * @param menu
 296    * @param submenu
 297    * @return the new or existing submenu
 298    */
 299   private JMenu findOrCreateMenu(JMenu menu, String submenu)
 300   {
 301     JMenu submenuinstance = null;
 302     for (int i = 0, iSize = menu.getMenuComponentCount(); i < iSize; i++)
 303     {
 304       if (menu.getMenuComponent(i) instanceof JMenu
 305               && ((JMenu) menu.getMenuComponent(i)).getText().equals(
 306                       submenu))
 307       {
 308         submenuinstance = (JMenu) menu.getMenuComponent(i);
 309       }
 310     }
 311     if (submenuinstance == null)
 312     {
 313       submenuinstance = new JMenu(submenu);
 314       menu.add(submenuinstance);
 315     }
 316     return submenuinstance;
 317
 318   }
 319
 320   public void attachWSMenuEntry(JMenu wsmenu, final AlignFrame alignFrame)
 321   {
 322     // dynamically regenerate service list.
 323     final JMenu jws2al = new JMenu("JABAWS Alignment");
 324     jws2al.addMenuListener(new MenuListener()
 325     {
 326       // TODO: future: add menu listener to parent menu - so submenus are
 327       // populated *before* they are selected.
 328       @Override
 329       public void menuSelected(MenuEvent e)
 330       {
 331         populateWSMenuEntry(jws2al, alignFrame);
 332       }
 333
 334       @Override
 335       public void menuDeselected(MenuEvent e)
 336       {
 337         // TODO Auto-generated method stub
 338
 339       }
 340
 341       @Override
 342       public void menuCanceled(MenuEvent e)
 343       {
 344         // TODO Auto-generated method stub
 345
 346       }
 347
 348     });
 349     wsmenu.add(jws2al);
 350
 351   }
 352
 353   private void populateWSMenuEntry(JMenu jws2al, final AlignFrame alignFrame)
 354   {
 355     if (running || services == null || services.size() == 0)
 356     {
 357       return;
 358     }
 359     boolean byhost = Cache.getDefault("WSMENU_BYHOST", true), bytype = Cache
 360             .getDefault("WSMENU_BYTYPE", true);
 361     /**
 362      * eventually, JWS2 services will appear under the same align/etc submenus.
 363      * for moment we keep them separate.
 364      */
 365     JMenu atpoint;
 366     MsaWSClient msacl = new MsaWSClient();
 367     Vector hostLabels = new Vector();
 368     jws2al.removeAll();
 369     String lasthost=null;
 370     for (final Jws2Instance service : services)
 371     {
 372       atpoint = jws2al;
 373       String host = service.getHost();
 374       String type = service.serviceType;
 375       if (byhost)
 376       {
 377         atpoint = findOrCreateMenu(atpoint, host);
 378         if (atpoint.getToolTipText() == null)
 379         {
 380           atpoint.setToolTipText("Services at " + host);
 381         }
 382       }
 383       if (bytype)
 384       {
 385         atpoint = findOrCreateMenu(atpoint, type);
 386         if (atpoint.getToolTipText() == null)
 387         {
 388           atpoint.setToolTipText(service.getActionText());
 389         }
 390       }
 391       if (!byhost && !hostLabels.contains(host + service.getActionText()))
 392       {
 393         // add a marker indicating where this service is hosted
 394         // relies on services from the same host being listed in a contiguous
 395         // group
 396         JMenuItem hitm;
 397         atpoint.addSeparator();
 398         if (lasthost==null || !lasthost.equals(host))
 399         {
 400           atpoint.add(hitm = new JMenuItem(host));
 401           hitm.setForeground(Color.blue);
 402         }
 403         hostLabels.addElement(lasthost=host);
 404       }
 405       msacl.attachWSMenuEntry(atpoint, service, alignFrame);
 406       /*
 407        * JMenuItem sitem = new JMenuItem(service.serviceType);
 408        * sitem.setToolTipText("Hosted at " + service.hosturl);
 409        * sitem.addActionListener(new ActionListener() {
 410        *
 411        * @Override public void actionPerformed(ActionEvent e) { AlignmentView
 412        * msa = alignFrame.gatherSequencesForAlignment(); MsaWSClient client =
 413        * new MsaWSClient(service, "JWS2 Alignment of " + alignFrame.getTitle(),
 414        * msa, false, true, alignFrame.getViewport().getAlignment().getDataset(),
 415        * alignFrame); } });
 416        */
 417     }
 418   }
 419
 420   public static void main(String[] args)
 421   {
 422     Thread runner = new Thread(getDiscoverer());
 423     getDiscoverer().addPropertyChangeListener(new PropertyChangeListener()
 424     {
 425
 426       public void propertyChange(PropertyChangeEvent evt)
 427       {
 428         System.out.println("Changesupport: There are now "
 429                 + getDiscoverer().services.size() + " services");
 430       }
 431     });
 432     runner.start();
 433     while (runner.isAlive())
 434     {
 435       try
 436       {
 437         Thread.sleep(50);
 438       } catch (InterruptedException e)
 439       {
 440       }
 441       ;
 442     }
 443   }
 444
 445   private static Jws2Discoverer discoverer;
 446
 447   public static Jws2Discoverer getDiscoverer()
 448   {
 449     if (discoverer == null)
 450     {
 451       discoverer = new Jws2Discoverer();
 452     }
 453     return discoverer;
 454   }
 455
 456   public boolean hasServices()
 457   {
 458     // TODO Auto-generated method stub
 459     return !running && services != null && services.size() > 0;
 460   }
 461
 462   public boolean isRunning()
 463   {
 464     return running;
 465   }
 466
 467   /**
 468    * the jalview .properties entry for JWS2 URLS
 469    */
 470   final static String JWS2HOSTURLS = "JWS2HOSTURLS";
 471
 472   public static void setServiceUrls(Vector<String> urls)
 473   {
 474     if (urls != null)
 475     {
 476       StringBuffer urlbuffer = new StringBuffer();
 477       String sep = "";
 478       for (String url : urls)
 479       {
 480         urlbuffer.append(sep);
 481         urlbuffer.append(url);
 482         sep = ",";
 483       }
 484       Cache.setProperty(JWS2HOSTURLS, urlbuffer.toString());
 485     }
 486     else
 487     {
 488       Cache.removeProperty(JWS2HOSTURLS);
 489     }
 490   }
 491
 492   public static Vector<String> getServiceUrls()
 493   {
 494     String surls = Cache.getDefault(JWS2HOSTURLS,
 495             "http://www.compbio.dundee.ac.uk/jabaws");
 496     Vector<String> urls = new Vector<String>();
 497     try
 498     {
 499       StringTokenizer st = new StringTokenizer(surls, ",");
 500       while (st.hasMoreElements())
 501       {
 502         String url = null;
 503         try
 504         {
 505           java.net.URL u = new java.net.URL(url = st.nextToken());
 506           if (!urls.contains(url))
 507           {
 508             urls.add(url);
 509           }
 510           else
 511           {
 512             jalview.bin.Cache.log.info("Ignoring duplicate url in "
 513                     + JWS2HOSTURLS + " list");
 514           }
 515         } catch (Exception ex)
 516         {
 517           jalview.bin.Cache.log
 518                   .warn("Problem whilst trying to make a URL from '"
 519                           + ((url != null) ? url : "<null>") + "'");
 520           jalview.bin.Cache.log
 521                   .warn("This was probably due to a malformed comma separated list"
 522                           + " in the "
 523                           + JWS2HOSTURLS
 524                           + " entry of $(HOME)/.jalview_properties)");
 525           jalview.bin.Cache.log.debug("Exception was ", ex);
 526         }
 527       }
 528     } catch (Exception ex)
 529     {
 530       jalview.bin.Cache.log.warn(
 531               "Error parsing comma separated list of urls in "
 532                       + JWS2HOSTURLS + " preference.", ex);
 533     }
 534     if (urls.size() >= 0)
 535     {
 536       return urls;
 537     }
 538     return null;
 539   }
 540
 541   public Vector<Jws2Instance> getServices()
 542   {
 543     return (services == null) ? new Vector<Jws2Instance>()
 544             : new Vector<Jws2Instance>(services);
 545   }
 546
 547   /**
 548    * test the given URL with the JabaWS test code
 549    *
 550    * @param foo
 551    * @return
 552    */
 553   public static boolean testServiceUrl(URL foo)
 554   {
 555     try
 556     {
 557       compbio.ws.client.WSTester.main(new String[]
 558       { "-h=" + foo.toString() });
 559     } catch (Exception e)
 560     {
 561       return false;
 562     } catch (OutOfMemoryError e)
 563     {
 564       return false;
 565     } catch (Error e)
 566     {
 567       return false;
 568     }
 569     return true;
 570   }
 571
 572 }