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("JABA 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     for (final Jws2Instance service : services)
 370     {
 371       atpoint = jws2al;
 372       String host = service.getHost();
 373       String type = service.serviceType;
 374       if (byhost)
 375       {
 376         atpoint = findOrCreateMenu(atpoint, host);
 377         if (atpoint.getToolTipText() == null)
 378         {
 379           atpoint.setToolTipText("Services at " + host);
 380         }
 381       }
 382       if (bytype)
 383       {
 384         atpoint = findOrCreateMenu(atpoint, type);
 385         if (atpoint.getToolTipText() == null)
 386         {
 387           atpoint.setToolTipText(service.getActionText());
 388         }
 389       }
 390       if (!byhost && !hostLabels.contains(host + service.getActionText()))
 391       {
 392         // add a marker indicating where this service is hosted
 393         // relies on services from the same host being listed in a contiguous
 394         // group
 395         JMenuItem hitm;
 396         atpoint.addSeparator();
 397         atpoint.add(hitm = new JMenuItem(host));
 398         hitm.setForeground(Color.blue);
 399         hostLabels.addElement(host);
 400       }
 401       msacl.attachWSMenuEntry(atpoint, service, alignFrame);
 402       /*
 403        * JMenuItem sitem = new JMenuItem(service.serviceType);
 404        * sitem.setToolTipText("Hosted at " + service.hosturl);
 405        * sitem.addActionListener(new ActionListener() {
 406        *
 407        * @Override public void actionPerformed(ActionEvent e) { AlignmentView
 408        * msa = alignFrame.gatherSequencesForAlignment(); MsaWSClient client =
 409        * new MsaWSClient(service, "JWS2 Alignment of " + alignFrame.getTitle(),
 410        * msa, false, true, alignFrame.getViewport().getAlignment().getDataset(),
 411        * alignFrame); } });
 412        */
 413     }
 414   }
 415
 416   public static void main(String[] args)
 417   {
 418     Thread runner = new Thread(getDiscoverer());
 419     getDiscoverer().addPropertyChangeListener(new PropertyChangeListener()
 420     {
 421
 422       public void propertyChange(PropertyChangeEvent evt)
 423       {
 424         System.out.println("Changesupport: There are now "
 425                 + getDiscoverer().services.size() + " services");
 426       }
 427     });
 428     runner.start();
 429     while (runner.isAlive())
 430     {
 431       try
 432       {
 433         Thread.sleep(50);
 434       } catch (InterruptedException e)
 435       {
 436       }
 437       ;
 438     }
 439   }
 440
 441   private static Jws2Discoverer discoverer;
 442
 443   public static Jws2Discoverer getDiscoverer()
 444   {
 445     if (discoverer == null)
 446     {
 447       discoverer = new Jws2Discoverer();
 448     }
 449     return discoverer;
 450   }
 451
 452   public boolean hasServices()
 453   {
 454     // TODO Auto-generated method stub
 455     return !running && services != null && services.size() > 0;
 456   }
 457
 458   public boolean isRunning()
 459   {
 460     return running;
 461   }
 462
 463   /**
 464    * the jalview .properties entry for JWS2 URLS
 465    */
 466   final static String JWS2HOSTURLS = "JWS2HOSTURLS";
 467
 468   public static void setServiceUrls(Vector<String> urls)
 469   {
 470     if (urls != null)
 471     {
 472       StringBuffer urlbuffer = new StringBuffer();
 473       String sep = "";
 474       for (String url : urls)
 475       {
 476         urlbuffer.append(sep);
 477         urlbuffer.append(url);
 478         sep = ",";
 479       }
 480       Cache.setProperty(JWS2HOSTURLS, urlbuffer.toString());
 481     }
 482     else
 483     {
 484       Cache.removeProperty(JWS2HOSTURLS);
 485     }
 486   }
 487
 488   public static Vector<String> getServiceUrls()
 489   {
 490     String surls = Cache.getDefault(JWS2HOSTURLS,
 491             "http://www.compbio.dundee.ac.uk/jabaws");
 492     Vector<String> urls = new Vector<String>();
 493     try
 494     {
 495       StringTokenizer st = new StringTokenizer(surls, ",");
 496       while (st.hasMoreElements())
 497       {
 498         String url = null;
 499         try
 500         {
 501           java.net.URL u = new java.net.URL(url = st.nextToken());
 502           if (!urls.contains(url))
 503           {
 504             urls.add(url);
 505           }
 506           else
 507           {
 508             jalview.bin.Cache.log.info("Ignoring duplicate url in "
 509                     + JWS2HOSTURLS + " list");
 510           }
 511         } catch (Exception ex)
 512         {
 513           jalview.bin.Cache.log
 514                   .warn("Problem whilst trying to make a URL from '"
 515                           + ((url != null) ? url : "<null>") + "'");
 516           jalview.bin.Cache.log
 517                   .warn("This was probably due to a malformed comma separated list"
 518                           + " in the "
 519                           + JWS2HOSTURLS
 520                           + " entry of $(HOME)/.jalview_properties)");
 521           jalview.bin.Cache.log.debug("Exception was ", ex);
 522         }
 523       }
 524     } catch (Exception ex)
 525     {
 526       jalview.bin.Cache.log.warn(
 527               "Error parsing comma separated list of urls in "
 528                       + JWS2HOSTURLS + " preference.", ex);
 529     }
 530     if (urls.size() >= 0)
 531     {
 532       return urls;
 533     }
 534     return null;
 535   }
 536
 537   public Vector<Jws2Instance> getServices()
 538   {
 539     return (services == null) ? new Vector<Jws2Instance>()
 540             : new Vector<Jws2Instance>(services);
 541   }
 542
 543   /**
 544    * test the given URL with the JabaWS test code
 545    *
 546    * @param foo
 547    * @return
 548    */
 549   public static boolean testServiceUrl(URL foo)
 550   {
 551     try
 552     {
 553       compbio.ws.client.WSTester.main(new String[]
 554       { "-h=" + foo.toString() });
 555     } catch (Exception e)
 556     {
 557       return false;
 558     } catch (OutOfMemoryError e)
 559     {
 560       return false;
 561     } catch (Error e)
 562     {
 563       return false;
 564     }
 565     return true;
 566   }
 567
 568 }