src/jalview/ws/jws2/Jws2Discoverer.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.jws2;
  22
  23 import jalview.bin.Cache;
  24 import jalview.gui.AlignFrame;
  25 import jalview.gui.Desktop;
  26 import jalview.gui.JvSwingUtils;
  27 import jalview.util.MessageManager;
  28 import jalview.ws.WSMenuEntryProviderI;
  29 import jalview.ws.jws2.jabaws2.Jws2Instance;
  30 import jalview.ws.params.ParamDatastoreI;
  31
  32 import java.awt.Color;
  33 import java.awt.event.ActionEvent;
  34 import java.awt.event.ActionListener;
  35 import java.beans.PropertyChangeEvent;
  36 import java.beans.PropertyChangeListener;
  37 import java.beans.PropertyChangeSupport;
  38 import java.net.MalformedURLException;
  39 import java.net.URL;
  40 import java.util.ArrayList;
  41 import java.util.Arrays;
  42 import java.util.HashMap;
  43 import java.util.HashSet;
  44 import java.util.Hashtable;
  45 import java.util.List;
  46 import java.util.Map;
  47 import java.util.Set;
  48 import java.util.StringTokenizer;
  49 import java.util.Vector;
  50
  51 import javax.swing.JMenu;
  52 import javax.swing.JMenuItem;
  53
  54 import compbio.ws.client.Services;
  55
  56 /**
  57  * discoverer for jws2 services. Follows the lightweight service discoverer
  58  * pattern (archetyped by EnfinEnvision2OneWay)
  59  *
  60  * @author JimP
  61  *
  62  */
  63 public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
  64 {
  65   public static final String COMPBIO_JABAWS = "http://www.compbio.dundee.ac.uk/jabaws";
  66
  67   /*
  68    * the .jalview_properties entry for JWS2 URLS
  69    */
  70   private final static String JWS2HOSTURLS = "JWS2HOSTURLS";
  71
  72   /*
  73    * Singleton instance
  74    */
  75   private static Jws2Discoverer discoverer;
  76
  77   /*
  78    * Override for testing only
  79    */
  80   private static List<String> testUrls = null;
  81
  82   // preferred url has precedence over others
  83   private String preferredUrl;
  84
  85   private PropertyChangeSupport changeSupport = new PropertyChangeSupport(
  86           this);
  87
  88   private Vector<String> invalidServiceUrls = null;
  89
  90   private Vector<String> urlsWithoutServices = null;
  91
  92   private Vector<String> validServiceUrls = null;
  93
  94   private volatile boolean running = false;
  95
  96   private volatile boolean aborted = false;
  97
  98   private Thread oldthread = null;
  99
 100   /**
 101    * holds list of services.
 102    */
 103   protected Vector<Jws2Instance> services;
 104
 105   /**
 106    * Private constructor enforces use of singleton via getDiscoverer()
 107    */
 108   private Jws2Discoverer()
 109   {
 110   }
 111
 112   /**
 113    * change listeners are notified of "services" property changes
 114    *
 115    * @param listener
 116    *          to be added that consumes new services Hashtable object.
 117    */
 118   public void addPropertyChangeListener(
 119           java.beans.PropertyChangeListener listener)
 120   {
 121     changeSupport.addPropertyChangeListener(listener);
 122   }
 123
 124   /**
 125    *
 126    *
 127    * @param listener
 128    *          to be removed
 129    */
 130   public void removePropertyChangeListener(
 131           java.beans.PropertyChangeListener listener)
 132   {
 133     changeSupport.removePropertyChangeListener(listener);
 134   }
 135
 136   /**
 137    * @return the aborted
 138    */
 139   public boolean isAborted()
 140   {
 141     return aborted;
 142   }
 143
 144   /**
 145    * @param aborted
 146    *          the aborted to set
 147    */
 148   public void setAborted(boolean aborted)
 149   {
 150     this.aborted = aborted;
 151   }
 152
 153   @Override
 154   public void run()
 155   {
 156
 157     if (running && oldthread != null && oldthread.isAlive())
 158     {
 159       if (!aborted)
 160       {
 161         return;
 162       }
 163       while (running)
 164       {
 165         try
 166         {
 167           Cache.log.debug(
 168                   "Waiting around for old discovery thread to finish.");
 169           // wait around until old discoverer dies
 170           Thread.sleep(100);
 171         } catch (Exception e)
 172         {
 173         }
 174       }
 175       aborted = false;
 176       Cache.log.debug("Old discovery thread has finished.");
 177     }
 178     running = true;
 179
 180     // first set up exclusion list if needed
 181     final Set<String> ignoredServices = new HashSet<>();
 182     for (String ignored : Cache
 183             .getDefault("IGNORED_JABAWS_SERVICETYPES", "").split("\\|"))
 184     {
 185       ignoredServices.add(ignored);
 186     }
 187
 188     changeSupport.firePropertyChange("services", services,
 189             new Vector<Jws2Instance>());
 190     oldthread = Thread.currentThread();
 191     try
 192     {
 193       Class foo = getClass().getClassLoader()
 194               .loadClass("compbio.ws.client.Jws2Client");
 195     } catch (ClassNotFoundException e)
 196     {
 197       System.err.println(
 198               "Not enabling JABA Webservices : client jar is not available."
 199                       + "\nPlease check that your webstart JNLP file is up to date!");
 200       running = false;
 201       return;
 202     }
 203     // reinitialise records of good and bad service URLs
 204     if (services != null)
 205     {
 206       services.removeAllElements();
 207     }
 208     if (urlsWithoutServices != null)
 209     {
 210       urlsWithoutServices.removeAllElements();
 211     }
 212     if (invalidServiceUrls != null)
 213     {
 214       invalidServiceUrls.removeAllElements();
 215     }
 216     if (validServiceUrls != null)
 217     {
 218       validServiceUrls.removeAllElements();
 219     }
 220     ArrayList<String> svctypes = new ArrayList<>();
 221
 222     List<JabaWsServerQuery> qrys = new ArrayList<>();
 223     for (final String jwsserver : getServiceUrls())
 224     {
 225       JabaWsServerQuery squery = new JabaWsServerQuery(this, jwsserver);
 226       if (svctypes.size() == 0)
 227       {
 228         // TODO: remove this ugly hack to get Canonical JABA service ordering
 229         // for all possible services
 230         for (Services sv : squery.JABAWS2SERVERS)
 231         {
 232           if (!ignoredServices.contains(sv.toString()))
 233           {
 234             svctypes.add(sv.toString());
 235           }
 236         }
 237
 238       }
 239       qrys.add(squery);
 240       new Thread(squery).start();
 241     }
 242     boolean finished = true;
 243     do
 244     {
 245       finished = true;
 246       try
 247       {
 248         Thread.sleep(100);
 249       } catch (Exception e)
 250       {
 251       }
 252       ;
 253       for (JabaWsServerQuery squery : qrys)
 254       {
 255         if (squery.isRunning())
 256         {
 257           finished = false;
 258         }
 259       }
 260       if (aborted)
 261       {
 262         Cache.log.debug(
 263                 "Aborting " + qrys.size() + " JABAWS discovery threads.");
 264         for (JabaWsServerQuery squery : qrys)
 265         {
 266           squery.setQuit(true);
 267         }
 268       }
 269     } while (!aborted && !finished);
 270     if (!aborted)
 271     {
 272       // resort services according to order found in jabaws service list
 273       // also ensure services for each host are ordered in same way.
 274
 275       if (services != null && services.size() > 0)
 276       {
 277         Jws2Instance[] svcs = new Jws2Instance[services.size()];
 278         int[] spos = new int[services.size()];
 279         int ipos = 0;
 280         List<String> svcUrls = getServiceUrls();
 281         for (Jws2Instance svc : services)
 282         {
 283           svcs[ipos] = svc;
 284           spos[ipos++] = 1000 * svcUrls.indexOf(svc.getHost()) + 1
 285                   + svctypes.indexOf(svc.getName());
 286         }
 287         jalview.util.QuickSort.sort(spos, svcs);
 288         services = new Vector<>();
 289         for (Jws2Instance svc : svcs)
 290         {
 291           if (!ignoredServices.contains(svc.getName()))
 292           {
 293             services.add(svc);
 294           }
 295         }
 296       }
 297     }
 298     oldthread = null;
 299     running = false;
 300     changeSupport.firePropertyChange("services", new Vector<Jws2Instance>(),
 301             services);
 302   }
 303
 304   /**
 305    * record this service endpoint so we can use it
 306    *
 307    * @param jwsservers
 308    * @param srv
 309    * @param service2
 310    */
 311   synchronized void addService(String jwsservers, Jws2Instance service)
 312   {
 313     if (services == null)
 314     {
 315       services = new Vector<>();
 316     }
 317     System.out.println(
 318             "Discovered service: " + jwsservers + " " + service.toString());
 319     // Jws2Instance service = new Jws2Instance(jwsservers, srv.toString(),
 320     // service2);
 321
 322     services.add(service);
 323     // retrieve the presets and parameter set and cache now
 324     ParamDatastoreI pds = service.getParamStore();
 325     if (pds != null)
 326     {
 327       pds.getPresets();
 328     }
 329     service.hasParameters();
 330     if (validServiceUrls == null)
 331     {
 332       validServiceUrls = new Vector<>();
 333     }
 334     validServiceUrls.add(jwsservers);
 335   }
 336
 337   /**
 338    * attach all available web services to the appropriate submenu in the given
 339    * JMenu
 340    */
 341   @Override
 342   public void attachWSMenuEntry(JMenu wsmenu, final AlignFrame alignFrame)
 343   {
 344     // dynamically regenerate service list.
 345     populateWSMenuEntry(wsmenu, alignFrame, null);
 346   }
 347
 348   private boolean isRecalculable(String action)
 349   {
 350     return (action != null && action.equalsIgnoreCase("conservation"));
 351   }
 352
 353   private void populateWSMenuEntry(JMenu jws2al,
 354           final AlignFrame alignFrame, String typeFilter)
 355   {
 356     if (running || services == null || services.size() == 0)
 357     {
 358       return;
 359     }
 360
 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     List<Jws2Instance> enumerableServices = new ArrayList<>();
 367     // jws2al.removeAll();
 368     Map<String, Jws2Instance> preferredHosts = new HashMap<>();
 369     Map<String, List<Jws2Instance>> alternates = new HashMap<>();
 370     for (Jws2Instance service : services.toArray(new Jws2Instance[0]))
 371     {
 372       // TODO: check this behaves with refactored serviceType to getName
 373       if (!isRecalculable(service.getName()))
 374       {
 375         // add 'one shot' services to be displayed using the classic menu
 376         // structure
 377         enumerableServices.add(service);
 378       }
 379       else
 380       {
 381         if (!preferredHosts.containsKey(service.getName()))
 382         {
 383           Jws2Instance preferredInstance = getPreferredServiceFor(
 384                   alignFrame, service.getName());
 385           if (preferredInstance != null)
 386           {
 387             preferredHosts.put(service.getName(), preferredInstance);
 388           }
 389           else
 390           {
 391             preferredHosts.put(service.getName(), service);
 392           }
 393         }
 394         List<Jws2Instance> ph = alternates.get(service.getName());
 395         if (preferredHosts.get(service.getName()) != service)
 396         {
 397           if (ph == null)
 398           {
 399             ph = new ArrayList<>();
 400           }
 401           ph.add(service);
 402           alternates.put(service.getName(), ph);
 403         }
 404       }
 405
 406     }
 407
 408     // create GUI element for classic services
 409     addEnumeratedServices(jws2al, alignFrame, enumerableServices);
 410     // and the instantaneous services
 411     for (final Jws2Instance service : preferredHosts.values())
 412     {
 413       atpoint = JvSwingUtils.findOrCreateMenu(jws2al,
 414               service.getServiceType());
 415       JMenuItem hitm;
 416       if (atpoint.getItemCount() > 1)
 417       {
 418         // previous service of this type already present
 419         atpoint.addSeparator();
 420       }
 421       atpoint.add(hitm = new JMenuItem(service.getHost()));
 422       hitm.setForeground(Color.blue);
 423       hitm.addActionListener(new ActionListener()
 424       {
 425
 426         @Override
 427         public void actionPerformed(ActionEvent e)
 428         {
 429           Desktop.showUrl(service.getHost());
 430         }
 431       });
 432       hitm.setToolTipText(JvSwingUtils.wrapTooltip(false,
 433               MessageManager.getString("label.open_jabaws_web_page")));
 434
 435       service.attachWSMenuEntry(atpoint, alignFrame);
 436       if (alternates.containsKey(service.getName()))
 437       {
 438         atpoint.add(hitm = new JMenu(
 439                 MessageManager.getString("label.switch_server")));
 440         hitm.setToolTipText(JvSwingUtils.wrapTooltip(false,
 441                 MessageManager.getString("label.choose_jabaws_server")));
 442         for (final Jws2Instance sv : alternates.get(service.getName()))
 443         {
 444           JMenuItem itm;
 445           hitm.add(itm = new JMenuItem(sv.getHost()));
 446           itm.setForeground(Color.blue);
 447           itm.addActionListener(new ActionListener()
 448           {
 449
 450             @Override
 451             public void actionPerformed(ActionEvent arg0)
 452             {
 453               new Thread(new Runnable()
 454               {
 455                 @Override
 456                 public void run()
 457                 {
 458                   setPreferredServiceFor(alignFrame, sv.getName(),
 459                           sv.getServiceType(), sv);
 460                   changeSupport.firePropertyChange("services",
 461                           new Vector<Jws2Instance>(), services);
 462                 };
 463               }).start();
 464
 465             }
 466           });
 467         }
 468       }
 469     }
 470   }
 471
 472   /**
 473    * add services using the Java 2.5/2.6/2.7 system which optionally creates
 474    * submenus to index by host and service program type
 475    */
 476   private void addEnumeratedServices(final JMenu jws2al,
 477           final AlignFrame alignFrame,
 478           List<Jws2Instance> enumerableServices)
 479   {
 480     boolean byhost = Cache.getDefault("WSMENU_BYHOST", false),
 481             bytype = Cache.getDefault("WSMENU_BYTYPE", false);
 482     /**
 483      * eventually, JWS2 services will appear under the same align/etc submenus.
 484      * for moment we keep them separate.
 485      */
 486     JMenu atpoint;
 487
 488     List<String> hostLabels = new ArrayList<>();
 489     Hashtable<String, String> lasthostFor = new Hashtable<>();
 490     Hashtable<String, ArrayList<Jws2Instance>> hosts = new Hashtable<>();
 491     ArrayList<String> hostlist = new ArrayList<>();
 492     for (Jws2Instance service : enumerableServices)
 493     {
 494       ArrayList<Jws2Instance> hostservices = hosts.get(service.getHost());
 495       if (hostservices == null)
 496       {
 497         hosts.put(service.getHost(),
 498                 hostservices = new ArrayList<>());
 499         hostlist.add(service.getHost());
 500       }
 501       hostservices.add(service);
 502     }
 503     // now add hosts in order of the given array
 504     for (String host : hostlist)
 505     {
 506       Jws2Instance orderedsvcs[] = hosts.get(host)
 507               .toArray(new Jws2Instance[1]);
 508       String sortbytype[] = new String[orderedsvcs.length];
 509       for (int i = 0; i < sortbytype.length; i++)
 510       {
 511         sortbytype[i] = orderedsvcs[i].getName();
 512       }
 513       jalview.util.QuickSort.sort(sortbytype, orderedsvcs);
 514       for (final Jws2Instance service : orderedsvcs)
 515       {
 516         atpoint = JvSwingUtils.findOrCreateMenu(jws2al,
 517                 service.getAction());
 518         String type = service.getName();
 519         if (byhost)
 520         {
 521           atpoint = JvSwingUtils.findOrCreateMenu(atpoint, host);
 522           if (atpoint.getToolTipText() == null)
 523           {
 524             atpoint.setToolTipText(MessageManager
 525                     .formatMessage("label.services_at", new String[]
 526                     { host }));
 527           }
 528         }
 529         if (bytype)
 530         {
 531           atpoint = JvSwingUtils.findOrCreateMenu(atpoint, type);
 532           if (atpoint.getToolTipText() == null)
 533           {
 534             atpoint.setToolTipText(service.getActionText());
 535           }
 536         }
 537         if (!byhost && !hostLabels.contains(
 538                 host + service.getName() + service.getActionText()))
 539         // !hostLabels.contains(host + (bytype ?
 540         // service.serviceType+service.getActionText() : "")))
 541         {
 542           // add a marker indicating where this service is hosted
 543           // relies on services from the same host being listed in a
 544           // contiguous
 545           // group
 546           JMenuItem hitm;
 547           if (hostLabels.contains(host))
 548           {
 549             atpoint.addSeparator();
 550           }
 551           else
 552           {
 553             hostLabels.add(host);
 554           }
 555           if (lasthostFor.get(service.getAction()) == null
 556                   || !lasthostFor.get(service.getAction()).equals(host))
 557           {
 558             atpoint.add(hitm = new JMenuItem(host));
 559             hitm.setForeground(Color.blue);
 560             hitm.addActionListener(new ActionListener()
 561             {
 562
 563               @Override
 564               public void actionPerformed(ActionEvent e)
 565               {
 566                 Desktop.showUrl(service.getHost());
 567               }
 568             });
 569             hitm.setToolTipText(
 570                     JvSwingUtils.wrapTooltip(true, MessageManager
 571                             .getString("label.open_jabaws_web_page")));
 572             lasthostFor.put(service.getAction(), host);
 573           }
 574           hostLabels.add(
 575                   host + service.getName() + service.getActionText());
 576         }
 577
 578         service.attachWSMenuEntry(atpoint, alignFrame);
 579       }
 580     }
 581   }
 582
 583   public static void main(String[] args)
 584   {
 585     if (args.length > 0)
 586     {
 587       testUrls = new ArrayList<>();
 588       for (String url : args)
 589       {
 590         testUrls.add(url);
 591       }
 592       ;
 593     }
 594     Thread runner = getDiscoverer()
 595             .startDiscoverer(new PropertyChangeListener()
 596             {
 597
 598               @Override
 599               public void propertyChange(PropertyChangeEvent evt)
 600               {
 601                 if (getDiscoverer().services != null)
 602                 {
 603                   System.out.println("Changesupport: There are now "
 604                           + getDiscoverer().services.size() + " services");
 605                   int i = 1;
 606                   for (Jws2Instance instance : getDiscoverer().services)
 607                   {
 608                     System.out.println("Service " + i++ + " "
 609                             + instance.getClass() + "@" + instance.getHost()
 610                             + ": " + instance.getActionText());
 611                   }
 612
 613                 }
 614               }
 615             });
 616     while (runner.isAlive())
 617     {
 618       try
 619       {
 620         Thread.sleep(50);
 621       } catch (InterruptedException e)
 622       {
 623       }
 624       ;
 625     }
 626     try
 627     {
 628       Thread.sleep(50);
 629     } catch (InterruptedException x)
 630     {
 631     }
 632   }
 633
 634   /**
 635    * Returns the singleton instance of this class.
 636    *
 637    * @return
 638    */
 639   public static Jws2Discoverer getDiscoverer()
 640   {
 641     if (discoverer == null)
 642     {
 643       discoverer = new Jws2Discoverer();
 644     }
 645     return discoverer;
 646   }
 647
 648   public boolean hasServices()
 649   {
 650     return !running && services != null && services.size() > 0;
 651   }
 652
 653   public boolean isRunning()
 654   {
 655     return running;
 656   }
 657
 658   public void setServiceUrls(List<String> wsUrls)
 659   {
 660     if (wsUrls != null && !wsUrls.isEmpty())
 661     {
 662       StringBuilder urls = new StringBuilder(128);
 663       String sep = "";
 664       for (String url : wsUrls)
 665       {
 666         urls.append(sep);
 667         urls.append(url);
 668         sep = ",";
 669       }
 670       Cache.setProperty(JWS2HOSTURLS, urls.toString());
 671     }
 672     else
 673     {
 674       Cache.removeProperty(JWS2HOSTURLS);
 675     }
 676   }
 677
 678   /**
 679    * Returns web service URLs, in the order in which they should be tried (or an
 680    * empty list).
 681    *
 682    * @return
 683    */
 684   public List<String> getServiceUrls()
 685   {
 686     if (testUrls != null)
 687     {
 688       // return test urls, if there are any, instead of touching cache
 689       return testUrls;
 690     }
 691     List<String> urls = new ArrayList<>();
 692
 693     if (this.preferredUrl != null)
 694     {
 695       urls.add(preferredUrl);
 696     }
 697
 698     String surls = Cache.getDefault(JWS2HOSTURLS, COMPBIO_JABAWS);
 699     try
 700     {
 701       StringTokenizer st = new StringTokenizer(surls, ",");
 702       while (st.hasMoreElements())
 703       {
 704         String url = null;
 705         try
 706         {
 707           url = st.nextToken();
 708           new URL(url);
 709           if (!urls.contains(url))
 710           {
 711             urls.add(url);
 712           }
 713           else
 714           {
 715             Cache.log.warn("Ignoring duplicate url " + url + " in "
 716                     + JWS2HOSTURLS + " list");
 717           }
 718         } catch (MalformedURLException ex)
 719         {
 720           Cache.log.warn("Problem whilst trying to make a URL from '"
 721                   + ((url != null) ? url : "<null>") + "'");
 722           Cache.log.warn(
 723                   "This was probably due to a malformed comma separated list"
 724                           + " in the " + JWS2HOSTURLS
 725                           + " entry of $(HOME)/.jalview_properties)");
 726           Cache.log.debug("Exception was ", ex);
 727         }
 728       }
 729     } catch (Exception ex)
 730     {
 731       Cache.log.warn("Error parsing comma separated list of urls in "
 732               + JWS2HOSTURLS + " preference.", ex);
 733     }
 734     return urls;
 735   }
 736
 737   public Vector<Jws2Instance> getServices()
 738   {
 739     return (services == null) ? new Vector<>()
 740             : new Vector<>(services);
 741   }
 742
 743   /**
 744    * test the given URL with the JabaWS test code
 745    *
 746    * @param foo
 747    * @return
 748    */
 749   public static boolean testServiceUrl(URL foo)
 750   {
 751     try
 752     {
 753       compbio.ws.client.WSTester
 754               .main(new String[]
 755               { "-h=" + foo.toString() });
 756     } catch (Exception e)
 757     {
 758       e.printStackTrace();
 759       return false;
 760     } catch (OutOfMemoryError e)
 761     {
 762       e.printStackTrace();
 763       return false;
 764     } catch (Error e)
 765     {
 766       e.printStackTrace();
 767       return false;
 768     }
 769
 770     return true;
 771   }
 772
 773   public boolean restart()
 774   {
 775     synchronized (this)
 776     {
 777       if (running)
 778       {
 779         aborted = true;
 780       }
 781       else
 782       {
 783         running = true;
 784       }
 785       return aborted;
 786     }
 787   }
 788
 789   /**
 790    * Start a fresh discovery thread and notify the given object when we're
 791    * finished. Any known existing threads will be killed before this one is
 792    * started.
 793    *
 794    * @param changeSupport2
 795    * @return new thread
 796    */
 797   public Thread startDiscoverer(PropertyChangeListener changeSupport2)
 798   {
 799     /*    if (restart())
 800         {
 801           return;
 802         }
 803         else
 804         {
 805           Thread thr = new Thread(this);
 806           thr.start();
 807         }
 808        */
 809     if (isRunning())
 810     {
 811       setAborted(true);
 812     }
 813     addPropertyChangeListener(changeSupport2);
 814     Thread thr = new Thread(this);
 815     thr.start();
 816     return thr;
 817   }
 818
 819   /**
 820    * @return the invalidServiceUrls
 821    */
 822   public Vector<String> getInvalidServiceUrls()
 823   {
 824     return invalidServiceUrls;
 825   }
 826
 827   /**
 828    * @return the urlsWithoutServices
 829    */
 830   public Vector<String> getUrlsWithoutServices()
 831   {
 832     return urlsWithoutServices;
 833   }
 834
 835   /**
 836    * add an 'empty' JABA server to the list. Only servers not already in the
 837    * 'bad URL' list will be added to this list.
 838    *
 839    * @param jwsservers
 840    */
 841   public synchronized void addUrlwithnoservices(String jwsservers)
 842   {
 843     if (urlsWithoutServices == null)
 844     {
 845       urlsWithoutServices = new Vector<>();
 846     }
 847
 848     if ((invalidServiceUrls == null
 849             || !invalidServiceUrls.contains(jwsservers))
 850             && !urlsWithoutServices.contains(jwsservers))
 851     {
 852       urlsWithoutServices.add(jwsservers);
 853     }
 854   }
 855
 856   /**
 857    * add a bad URL to the list
 858    *
 859    * @param jwsservers
 860    */
 861   public synchronized void addInvalidServiceUrl(String jwsservers)
 862   {
 863     if (invalidServiceUrls == null)
 864     {
 865       invalidServiceUrls = new Vector<>();
 866     }
 867     if (!invalidServiceUrls.contains(jwsservers))
 868     {
 869       invalidServiceUrls.add(jwsservers);
 870     }
 871   }
 872
 873   /**
 874    *
 875    * @return a human readable report of any problems with the service URLs used
 876    *         for discovery
 877    */
 878   public String getErrorMessages()
 879   {
 880     if (!isRunning() && !isAborted())
 881     {
 882       StringBuffer ermsg = new StringBuffer();
 883       boolean list = false;
 884       if (getInvalidServiceUrls() != null
 885               && getInvalidServiceUrls().size() > 0)
 886       {
 887         ermsg.append(MessageManager.getString("warn.urls_not_contacted")
 888                 + ": \n");
 889         for (String svcurl : getInvalidServiceUrls())
 890         {
 891           if (list)
 892           {
 893             ermsg.append(", ");
 894           }
 895           list = true;
 896           ermsg.append(svcurl);
 897         }
 898         ermsg.append("\n\n");
 899       }
 900       list = false;
 901       if (getUrlsWithoutServices() != null
 902               && getUrlsWithoutServices().size() > 0)
 903       {
 904         ermsg.append(
 905                 MessageManager.getString("warn.urls_no_jaba") + ": \n");
 906         for (String svcurl : getUrlsWithoutServices())
 907         {
 908           if (list)
 909           {
 910             ermsg.append(", ");
 911           }
 912           list = true;
 913           ermsg.append(svcurl);
 914         }
 915         ermsg.append("\n");
 916       }
 917       if (ermsg.length() > 1)
 918       {
 919         return ermsg.toString();
 920       }
 921
 922     }
 923     return null;
 924   }
 925
 926   public int getServerStatusFor(String url)
 927   {
 928     if (validServiceUrls != null && validServiceUrls.contains(url))
 929     {
 930       return 1;
 931     }
 932     if (urlsWithoutServices != null && urlsWithoutServices.contains(url))
 933     {
 934       return 0;
 935     }
 936     if (invalidServiceUrls != null && invalidServiceUrls.contains(url))
 937     {
 938       return -1;
 939     }
 940     return -2;
 941   }
 942
 943   /**
 944    * pick the user's preferred service based on a set of URLs (jaba server
 945    * locations) and service URIs (specifying version and service interface
 946    * class)
 947    *
 948    * @param serviceURL
 949    * @return null or best match for given uri/ls.
 950    */
 951   public Jws2Instance getPreferredServiceFor(String[] serviceURLs)
 952   {
 953     HashSet<String> urls = new HashSet<>();
 954     urls.addAll(Arrays.asList(serviceURLs));
 955     Jws2Instance match = null;
 956     if (services != null)
 957     {
 958       for (Jws2Instance svc : services)
 959       {
 960         // TODO getNameURI Should return a versioned URI for the service, but
 961         // doesn't as of 2.11
 962         if (urls.contains(svc.getNameURI()))
 963         {
 964           if (match == null)
 965           {
 966             // for moment we always pick service from server ordered first in
 967             // user's preferences
 968             match = svc;
 969           }
 970           if (urls.contains(svc.getUri()))
 971           {
 972             // stop and return - we've matched type URI and URI for service
 973             // endpoint
 974             return svc;
 975           }
 976         }
 977       }
 978     }
 979     return match;
 980   }
 981
 982   Map<String, Map<String, String>> preferredServiceMap = new HashMap<>();;
 983
 984   /**
 985    * get current preferred endpoint of the given Jabaws service, or global
 986    * default
 987    *
 988    * @param af
 989    *          null or a specific alignFrame
 990    * @param serviceName
 991    *          Jws2Instance.getName() for service
 992    * @return null if no service of this type is available, the preferred service
 993    *         for the serviceType and af if specified and if defined.
 994    */
 995   public Jws2Instance getPreferredServiceFor(AlignFrame af,
 996           String serviceName)
 997   {
 998     String serviceurl = null;
 999     synchronized (preferredServiceMap)
1000     {
1001       String afid = (af == null) ? "" : af.getViewport().getSequenceSetId();
1002       Map<String, String> prefmap = preferredServiceMap.get(afid);
1003       if (afid.length() > 0 && prefmap == null)
1004       {
1005         // recover global setting, if any
1006         prefmap = preferredServiceMap.get("");
1007       }
1008       if (prefmap != null)
1009       {
1010         serviceurl = prefmap.get(serviceName);
1011       }
1012
1013     }
1014     Jws2Instance response = null;
1015     for (Jws2Instance svc : services)
1016     {
1017       if (svc.getName().equals(serviceName))
1018       {
1019         if (serviceurl == null || serviceurl.equals(svc.getHost()))
1020         {
1021           response = svc;
1022           break;
1023         }
1024       }
1025     }
1026     return response;
1027   }
1028
1029   public void setPreferredServiceFor(AlignFrame af, String serviceName,
1030           String serviceAction, Jws2Instance selectedServer)
1031   {
1032     // TODO: pull out and generalise for the selectedServer's attributes
1033     String afid = (af == null) ? "" : af.getViewport().getSequenceSetId();
1034     if (preferredServiceMap == null)
1035     {
1036       preferredServiceMap = new HashMap<>();
1037     }
1038     Map<String, String> prefmap = preferredServiceMap.get(afid);
1039     if (prefmap == null)
1040     {
1041       prefmap = new HashMap<>();
1042       preferredServiceMap.put(afid, prefmap);
1043     }
1044     prefmap.put(serviceName, selectedServer.getHost());
1045     prefmap.put(serviceAction, selectedServer.getHost());
1046   }
1047
1048   public void setPreferredServiceFor(String serviceType,
1049           String serviceAction, Jws2Instance selectedServer)
1050   {
1051     setPreferredServiceFor(null, serviceType, serviceAction,
1052             selectedServer);
1053   }
1054
1055   /**
1056    * Set a URL to try before any others. For use with command-line parameter to
1057    * configure a local Jabaws installation without the need to add to property
1058    * files.
1059    *
1060    * @param value
1061    * @throws MalformedURLException
1062    */
1063   public void setPreferredUrl(String value) throws MalformedURLException
1064   {
1065     if (value != null && value.trim().length() > 0)
1066     {
1067       new URL(value);
1068       preferredUrl = value;
1069     }
1070   }
1071 }