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+(hosturl.lastIndexOf("/")==(hosturl.length()-1) ? "/" : "") +serviceType;
 284     }
 285     private boolean hasParams=false,lookedForParams=false;
 286     public boolean hasParameters()
 287     {
 288       if (!lookedForParams)
 289       {
 290         lookedForParams=true;
 291       try
 292       {
 293         hasParams = (getRunnerConfig().getArguments().size() > 0);
 294       } catch (Exception e)
 295       {
 296
 297       }
 298       }
 299       return hasParams;
 300     }
 301   };
 302
 303   /**
 304    * holds list of services.
 305    */
 306   protected Vector<Jws2Instance> services;
 307
 308   /**
 309    * find or add a submenu with the given title in the given menu
 310    *
 311    * @param menu
 312    * @param submenu
 313    * @return the new or existing submenu
 314    */
 315   private JMenu findOrCreateMenu(JMenu menu, String submenu)
 316   {
 317     JMenu submenuinstance = null;
 318     for (int i = 0, iSize = menu.getMenuComponentCount(); i < iSize; i++)
 319     {
 320       if (menu.getMenuComponent(i) instanceof JMenu
 321               && ((JMenu) menu.getMenuComponent(i)).getText().equals(
 322                       submenu))
 323       {
 324         submenuinstance = (JMenu) menu.getMenuComponent(i);
 325       }
 326     }
 327     if (submenuinstance == null)
 328     {
 329       submenuinstance = new JMenu(submenu);
 330       menu.add(submenuinstance);
 331     }
 332     return submenuinstance;
 333
 334   }
 335
 336   public void attachWSMenuEntry(JMenu wsmenu, final AlignFrame alignFrame)
 337   {
 338     // dynamically regenerate service list.
 339     final JMenu jws2al = new JMenu("JABAWS Alignment");
 340     jws2al.addMenuListener(new MenuListener()
 341     {
 342       // TODO: future: add menu listener to parent menu - so submenus are
 343       // populated *before* they are selected.
 344       @Override
 345       public void menuSelected(MenuEvent e)
 346       {
 347         populateWSMenuEntry(jws2al, alignFrame);
 348       }
 349
 350       @Override
 351       public void menuDeselected(MenuEvent e)
 352       {
 353         // TODO Auto-generated method stub
 354
 355       }
 356
 357       @Override
 358       public void menuCanceled(MenuEvent e)
 359       {
 360         // TODO Auto-generated method stub
 361
 362       }
 363
 364     });
 365     wsmenu.add(jws2al);
 366
 367   }
 368
 369   private void populateWSMenuEntry(JMenu jws2al, final AlignFrame alignFrame)
 370   {
 371     if (running || services == null || services.size() == 0)
 372     {
 373       return;
 374     }
 375     boolean byhost = Cache.getDefault("WSMENU_BYHOST", true), bytype = Cache
 376             .getDefault("WSMENU_BYTYPE", true);
 377     /**
 378      * eventually, JWS2 services will appear under the same align/etc submenus.
 379      * for moment we keep them separate.
 380      */
 381     JMenu atpoint;
 382     MsaWSClient msacl = new MsaWSClient();
 383     Vector hostLabels = new Vector();
 384     jws2al.removeAll();
 385     String lasthost=null;
 386     for (final Jws2Instance service : services)
 387     {
 388       atpoint = jws2al;
 389       String host = service.getHost();
 390       String type = service.serviceType;
 391       if (byhost)
 392       {
 393         atpoint = findOrCreateMenu(atpoint, host);
 394         if (atpoint.getToolTipText() == null)
 395         {
 396           atpoint.setToolTipText("Services at " + host);
 397         }
 398       }
 399       if (bytype)
 400       {
 401         atpoint = findOrCreateMenu(atpoint, type);
 402         if (atpoint.getToolTipText() == null)
 403         {
 404           atpoint.setToolTipText(service.getActionText());
 405         }
 406       }
 407       if (!byhost && !hostLabels.contains(host + service.getActionText()))
 408       {
 409         // add a marker indicating where this service is hosted
 410         // relies on services from the same host being listed in a contiguous
 411         // group
 412         JMenuItem hitm;
 413         atpoint.addSeparator();
 414         if (lasthost==null || !lasthost.equals(host))
 415         {
 416           atpoint.add(hitm = new JMenuItem(host));
 417           hitm.setForeground(Color.blue);
 418         }
 419         hostLabels.addElement(lasthost=host);
 420       }
 421       msacl.attachWSMenuEntry(atpoint, service, alignFrame);
 422       /*
 423        * JMenuItem sitem = new JMenuItem(service.serviceType);
 424        * sitem.setToolTipText("Hosted at " + service.hosturl);
 425        * sitem.addActionListener(new ActionListener() {
 426        *
 427        * @Override public void actionPerformed(ActionEvent e) { AlignmentView
 428        * msa = alignFrame.gatherSequencesForAlignment(); MsaWSClient client =
 429        * new MsaWSClient(service, "JWS2 Alignment of " + alignFrame.getTitle(),
 430        * msa, false, true, alignFrame.getViewport().getAlignment().getDataset(),
 431        * alignFrame); } });
 432        */
 433     }
 434   }
 435
 436   public static void main(String[] args)
 437   {
 438     Thread runner = new Thread(getDiscoverer());
 439     getDiscoverer().addPropertyChangeListener(new PropertyChangeListener()
 440     {
 441
 442       public void propertyChange(PropertyChangeEvent evt)
 443       {
 444         System.out.println("Changesupport: There are now "
 445                 + getDiscoverer().services.size() + " services");
 446       }
 447     });
 448     runner.start();
 449     while (runner.isAlive())
 450     {
 451       try
 452       {
 453         Thread.sleep(50);
 454       } catch (InterruptedException e)
 455       {
 456       }
 457       ;
 458     }
 459   }
 460
 461   private static Jws2Discoverer discoverer;
 462
 463   public static Jws2Discoverer getDiscoverer()
 464   {
 465     if (discoverer == null)
 466     {
 467       discoverer = new Jws2Discoverer();
 468     }
 469     return discoverer;
 470   }
 471
 472   public boolean hasServices()
 473   {
 474     // TODO Auto-generated method stub
 475     return !running && services != null && services.size() > 0;
 476   }
 477
 478   public boolean isRunning()
 479   {
 480     return running;
 481   }
 482
 483   /**
 484    * the jalview .properties entry for JWS2 URLS
 485    */
 486   final static String JWS2HOSTURLS = "JWS2HOSTURLS";
 487
 488   public static void setServiceUrls(Vector<String> urls)
 489   {
 490     if (urls != null)
 491     {
 492       StringBuffer urlbuffer = new StringBuffer();
 493       String sep = "";
 494       for (String url : urls)
 495       {
 496         urlbuffer.append(sep);
 497         urlbuffer.append(url);
 498         sep = ",";
 499       }
 500       Cache.setProperty(JWS2HOSTURLS, urlbuffer.toString());
 501     }
 502     else
 503     {
 504       Cache.removeProperty(JWS2HOSTURLS);
 505     }
 506   }
 507
 508   public static Vector<String> getServiceUrls()
 509   {
 510     String surls = Cache.getDefault(JWS2HOSTURLS,
 511             "http://www.compbio.dundee.ac.uk/jabaws");
 512     Vector<String> urls = new Vector<String>();
 513     try
 514     {
 515       StringTokenizer st = new StringTokenizer(surls, ",");
 516       while (st.hasMoreElements())
 517       {
 518         String url = null;
 519         try
 520         {
 521           java.net.URL u = new java.net.URL(url = st.nextToken());
 522           if (!urls.contains(url))
 523           {
 524             urls.add(url);
 525           }
 526           else
 527           {
 528             jalview.bin.Cache.log.info("Ignoring duplicate url in "
 529                     + JWS2HOSTURLS + " list");
 530           }
 531         } catch (Exception ex)
 532         {
 533           jalview.bin.Cache.log
 534                   .warn("Problem whilst trying to make a URL from '"
 535                           + ((url != null) ? url : "<null>") + "'");
 536           jalview.bin.Cache.log
 537                   .warn("This was probably due to a malformed comma separated list"
 538                           + " in the "
 539                           + JWS2HOSTURLS
 540                           + " entry of $(HOME)/.jalview_properties)");
 541           jalview.bin.Cache.log.debug("Exception was ", ex);
 542         }
 543       }
 544     } catch (Exception ex)
 545     {
 546       jalview.bin.Cache.log.warn(
 547               "Error parsing comma separated list of urls in "
 548                       + JWS2HOSTURLS + " preference.", ex);
 549     }
 550     if (urls.size() >= 0)
 551     {
 552       return urls;
 553     }
 554     return null;
 555   }
 556
 557   public Vector<Jws2Instance> getServices()
 558   {
 559     return (services == null) ? new Vector<Jws2Instance>()
 560             : new Vector<Jws2Instance>(services);
 561   }
 562
 563   /**
 564    * test the given URL with the JabaWS test code
 565    *
 566    * @param foo
 567    * @return
 568    */
 569   public static boolean testServiceUrl(URL foo)
 570   {
 571     try
 572     {
 573       compbio.ws.client.WSTester.main(new String[]
 574       { "-h=" + foo.toString() });
 575     } catch (Exception e)
 576     {
 577       return false;
 578     } catch (OutOfMemoryError e)
 579     {
 580       return false;
 581     } catch (Error e)
 582     {
 583       return false;
 584     }
 585     return true;
 586   }
 587
 588 }