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.bin.Console;
  25 import jalview.gui.AlignFrame;
  26 import jalview.gui.Desktop;
  27 import jalview.gui.JvSwingUtils;
  28 import jalview.util.MessageManager;
  29 import jalview.ws.WSMenuEntryProviderI;
  30 import jalview.ws.jws2.jabaws2.Jws2Instance;
  31 import jalview.ws.params.ParamDatastoreI;
  32
  33 import java.awt.Color;
  34 import java.awt.event.ActionEvent;
  35 import java.awt.event.ActionListener;
  36 import java.beans.PropertyChangeEvent;
  37 import java.beans.PropertyChangeListener;
  38 import java.beans.PropertyChangeSupport;
  39 import java.net.MalformedURLException;
  40 import java.net.URL;
  41 import java.util.ArrayList;
  42 import java.util.Arrays;
  43 import java.util.HashMap;
  44 import java.util.HashSet;
  45 import java.util.Hashtable;
  46 import java.util.List;
  47 import java.util.Map;
  48 import java.util.Set;
  49 import java.util.StringTokenizer;
  50 import java.util.Vector;
  51
  52 import javax.swing.JMenu;
  53 import javax.swing.JMenuItem;
  54
  55 import compbio.ws.client.Services;
  56
  57 /**
  58  * discoverer for jws2 services. Follows the lightweight service discoverer
  59  * pattern (archetyped by EnfinEnvision2OneWay)
  60  *
  61  * @author JimP
  62  *
  63  */
  64 public class Jws2Discoverer implements Runnable, WSMenuEntryProviderI
  65 {
  66   public static final String COMPBIO_JABAWS = "http://www.compbio.dundee.ac.uk/jabaws";
  67
  68   /*
  69    * the .jalview_properties entry for JWS2 URLS
  70    */
  71   private final static String JWS2HOSTURLS = "JWS2HOSTURLS";
  72
  73   /*
  74    * Singleton instance
  75    */
  76   private static Jws2Discoverer discoverer;
  77
  78   /*
  79    * Override for testing only
  80    */
  81   private static List<String> testUrls = null;
  82
  83   // preferred url has precedence over others
  84   private String preferredUrl;
  85
  86   private PropertyChangeSupport changeSupport = new PropertyChangeSupport(
  87           this);
  88
  89   private Vector<String> invalidServiceUrls = null;
  90
  91   private Vector<String> urlsWithoutServices = null;
  92
  93   private Vector<String> validServiceUrls = null;
  94
  95   private volatile boolean running = false;
  96
  97   private volatile boolean aborted = false;
  98
  99   private Thread oldthread = null;
 100
 101   /**
 102    * holds list of services.
 103    */
 104   protected Vector<Jws2Instance> services;
 105
 106   /**
 107    * Private constructor enforces use of singleton via getDiscoverer()
 108    */
 109   private Jws2Discoverer()
 110   {
 111   }
 112
 113   /**
 114    * change listeners are notified of "services" property changes
 115    *
 116    * @param listener
 117    *          to be added that consumes new services Hashtable object.
 118    */
 119   public void addPropertyChangeListener(
 120           java.beans.PropertyChangeListener listener)
 121   {
 122     changeSupport.addPropertyChangeListener(listener);
 123   }
 124
 125   /**
 126    *
 127    *
 128    * @param listener
 129    *          to be removed
 130    */
 131   public void removePropertyChangeListener(
 132           java.beans.PropertyChangeListener listener)
 133   {
 134     changeSupport.removePropertyChangeListener(listener);
 135   }
 136
 137   /**
 138    * @return the aborted
 139    */
 140   public boolean isAborted()
 141   {
 142     return aborted;
 143   }
 144
 145   /**
 146    * @param aborted
 147    *          the aborted to set
 148    */
 149   public void setAborted(boolean aborted)
 150   {
 151     this.aborted = aborted;
 152   }
 153
 154   @Override
 155   public void run()
 156   {
 157
 158     if (running && oldthread != null && oldthread.isAlive())
 159     {
 160       if (!aborted)
 161       {
 162         return;
 163       }
 164       while (running)
 165       {
 166         try
 167         {
 168           Console.debug(
 169                   "Waiting around for old discovery thread to finish.");
 170           // wait around until old discoverer dies
 171           Thread.sleep(100);
 172         } catch (Exception e)
 173         {
 174         }
 175       }
 176       aborted = false;
 177       Console.debug("Old discovery thread has finished.");
 178     }
 179     running = true;
 180
 181     // first set up exclusion list if needed
 182     final Set<String> ignoredServices = new HashSet<>();
 183     for (String ignored : Cache
 184             .getDefault("IGNORED_JABAWS_SERVICETYPES", "").split("\\|"))
 185     {
 186       ignoredServices.add(ignored);
 187     }
 188
 189     changeSupport.firePropertyChange("services", services,
 190             new Vector<Jws2Instance>());
 191     oldthread = Thread.currentThread();
 192     try
 193     {
 194       Class foo = getClass().getClassLoader()
 195               .loadClass("compbio.ws.client.Jws2Client");
 196     } catch (ClassNotFoundException e)
 197     {
 198       jalview.bin.Console.errPrintln(
 199               "Not enabling JABA Webservices : client jar is not available."
 200                       + "\nPlease check that your webstart JNLP file is up to date!");
 201       running = false;
 202       return;
 203     }
 204     // reinitialise records of good and bad service URLs
 205     if (services != null)
 206     {
 207       services.removeAllElements();
 208     }
 209     if (urlsWithoutServices != null)
 210     {
 211       urlsWithoutServices.removeAllElements();
 212     }
 213     if (invalidServiceUrls != null)
 214     {
 215       invalidServiceUrls.removeAllElements();
 216     }
 217     if (validServiceUrls != null)
 218     {
 219       validServiceUrls.removeAllElements();
 220     }
 221     ArrayList<String> svctypes = new ArrayList<>();
 222
 223     List<JabaWsServerQuery> qrys = new ArrayList<>();
 224     for (final String jwsserver : getServiceUrls())
 225     {
 226       JabaWsServerQuery squery = new JabaWsServerQuery(this, jwsserver);
 227       if (svctypes.size() == 0)
 228       {
 229         // TODO: remove this ugly hack to get Canonical JABA service ordering
 230         // for all possible services
 231         for (Services sv : squery.JABAWS2SERVERS)
 232         {
 233           if (!ignoredServices.contains(sv.toString()))
 234           {
 235             svctypes.add(sv.toString());
 236           }
 237         }
 238
 239       }
 240       qrys.add(squery);
 241       new Thread(squery).start();
 242     }
 243     boolean finished = true;
 244     do
 245     {
 246       finished = true;
 247       try
 248       {
 249         Thread.sleep(100);
 250       } catch (Exception e)
 251       {
 252       }
 253       for (JabaWsServerQuery squery : qrys)
 254       {
 255         if (squery.isRunning())
 256         {
 257           finished = false;
 258         }
 259       }
 260       if (aborted)
 261       {
 262         Console.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.serviceType);
 286         }
 287         jalview.util.QuickSort.sort(spos, svcs);
 288         services = new Vector<>();
 289         for (Jws2Instance svc : svcs)
 290         {
 291           if (!ignoredServices.contains(svc.serviceType))
 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     jalview.bin.Console.outPrintln(
 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       if (!isRecalculable(service.action))
 373       {
 374         // add 'one shot' services to be displayed using the classic menu
 375         // structure
 376         enumerableServices.add(service);
 377       }
 378       else
 379       {
 380         if (!preferredHosts.containsKey(service.serviceType))
 381         {
 382           Jws2Instance preferredInstance = getPreferredServiceFor(
 383                   alignFrame, service.serviceType);
 384           if (preferredInstance != null)
 385           {
 386             preferredHosts.put(service.serviceType, preferredInstance);
 387           }
 388           else
 389           {
 390             preferredHosts.put(service.serviceType, service);
 391           }
 392         }
 393         List<Jws2Instance> ph = alternates.get(service.serviceType);
 394         if (preferredHosts.get(service.serviceType) != service)
 395         {
 396           if (ph == null)
 397           {
 398             ph = new ArrayList<>();
 399           }
 400           ph.add(service);
 401           alternates.put(service.serviceType, ph);
 402         }
 403       }
 404
 405     }
 406
 407     // create GUI element for classic services
 408     addEnumeratedServices(jws2al, alignFrame, enumerableServices);
 409     // and the instantaneous services
 410     for (final Jws2Instance service : preferredHosts.values())
 411     {
 412       atpoint = JvSwingUtils.findOrCreateMenu(jws2al, service.action);
 413       JMenuItem hitm;
 414       if (atpoint.getItemCount() > 1)
 415       {
 416         // previous service of this type already present
 417         atpoint.addSeparator();
 418       }
 419       atpoint.add(hitm = new JMenuItem(service.getHost()));
 420       hitm.setForeground(Color.blue);
 421       hitm.addActionListener(new ActionListener()
 422       {
 423
 424         @Override
 425         public void actionPerformed(ActionEvent e)
 426         {
 427           Desktop.showUrl(service.getHost());
 428         }
 429       });
 430       hitm.setToolTipText(JvSwingUtils.wrapTooltip(false,
 431               MessageManager.getString("label.open_jabaws_web_page")));
 432
 433       service.attachWSMenuEntry(atpoint, alignFrame);
 434       if (alternates.containsKey(service.serviceType))
 435       {
 436         atpoint.add(hitm = new JMenu(
 437                 MessageManager.getString("label.switch_server")));
 438         hitm.setToolTipText(JvSwingUtils.wrapTooltip(false,
 439                 MessageManager.getString("label.choose_jabaws_server")));
 440         for (final Jws2Instance sv : alternates.get(service.serviceType))
 441         {
 442           JMenuItem itm;
 443           hitm.add(itm = new JMenuItem(sv.getHost()));
 444           itm.setForeground(Color.blue);
 445           itm.addActionListener(new ActionListener()
 446           {
 447
 448             @Override
 449             public void actionPerformed(ActionEvent arg0)
 450             {
 451               new Thread(new Runnable()
 452               {
 453                 @Override
 454                 public void run()
 455                 {
 456                   setPreferredServiceFor(alignFrame, sv.serviceType,
 457                           sv.action, sv);
 458                   changeSupport.firePropertyChange("services",
 459                           new Vector<Jws2Instance>(), services);
 460                 }
 461               }).start();
 462
 463             }
 464           });
 465         }
 466       }
 467     }
 468   }
 469
 470   /**
 471    * add services using the Java 2.5/2.6/2.7 system which optionally creates
 472    * submenus to index by host and service program type
 473    */
 474   private void addEnumeratedServices(final JMenu jws2al,
 475           final AlignFrame alignFrame,
 476           List<Jws2Instance> enumerableServices)
 477   {
 478     boolean byhost = Cache.getDefault("WSMENU_BYHOST", false),
 479             bytype = Cache.getDefault("WSMENU_BYTYPE", false);
 480     /**
 481      * eventually, JWS2 services will appear under the same align/etc submenus.
 482      * for moment we keep them separate.
 483      */
 484     JMenu atpoint;
 485
 486     List<String> hostLabels = new ArrayList<>();
 487     Hashtable<String, String> lasthostFor = new Hashtable<>();
 488     Hashtable<String, ArrayList<Jws2Instance>> hosts = new Hashtable<>();
 489     ArrayList<String> hostlist = new ArrayList<>();
 490     for (Jws2Instance service : enumerableServices)
 491     {
 492       ArrayList<Jws2Instance> hostservices = hosts.get(service.getHost());
 493       if (hostservices == null)
 494       {
 495         hosts.put(service.getHost(), hostservices = new ArrayList<>());
 496         hostlist.add(service.getHost());
 497       }
 498       hostservices.add(service);
 499     }
 500     // now add hosts in order of the given array
 501     for (String host : hostlist)
 502     {
 503       Jws2Instance orderedsvcs[] = hosts.get(host)
 504               .toArray(new Jws2Instance[1]);
 505       String sortbytype[] = new String[orderedsvcs.length];
 506       for (int i = 0; i < sortbytype.length; i++)
 507       {
 508         sortbytype[i] = orderedsvcs[i].serviceType;
 509       }
 510       jalview.util.QuickSort.sort(sortbytype, orderedsvcs);
 511       for (final Jws2Instance service : orderedsvcs)
 512       {
 513         atpoint = JvSwingUtils.findOrCreateMenu(jws2al, service.action);
 514         String type = service.serviceType;
 515         if (byhost)
 516         {
 517           atpoint = JvSwingUtils.findOrCreateMenu(atpoint, host);
 518           if (atpoint.getToolTipText() == null)
 519           {
 520             atpoint.setToolTipText(MessageManager
 521                     .formatMessage("label.services_at", new String[]
 522                     { host }));
 523           }
 524         }
 525         if (bytype)
 526         {
 527           atpoint = JvSwingUtils.findOrCreateMenu(atpoint, type);
 528           if (atpoint.getToolTipText() == null)
 529           {
 530             atpoint.setToolTipText(service.getActionText());
 531           }
 532         }
 533         if (!byhost && !hostLabels.contains(
 534                 host + service.serviceType + service.getActionText()))
 535         // !hostLabels.contains(host + (bytype ?
 536         // service.serviceType+service.getActionText() : "")))
 537         {
 538           // add a marker indicating where this service is hosted
 539           // relies on services from the same host being listed in a
 540           // contiguous
 541           // group
 542           JMenuItem hitm;
 543           if (hostLabels.contains(host))
 544           {
 545             atpoint.addSeparator();
 546           }
 547           else
 548           {
 549             hostLabels.add(host);
 550           }
 551           if (lasthostFor.get(service.action) == null
 552                   || !lasthostFor.get(service.action).equals(host))
 553           {
 554             atpoint.add(hitm = new JMenuItem(host));
 555             hitm.setForeground(Color.blue);
 556             hitm.addActionListener(new ActionListener()
 557             {
 558
 559               @Override
 560               public void actionPerformed(ActionEvent e)
 561               {
 562                 Desktop.showUrl(service.getHost());
 563               }
 564             });
 565             hitm.setToolTipText(
 566                     JvSwingUtils.wrapTooltip(true, MessageManager
 567                             .getString("label.open_jabaws_web_page")));
 568             lasthostFor.put(service.action, host);
 569           }
 570           hostLabels.add(
 571                   host + service.serviceType + service.getActionText());
 572         }
 573
 574         service.attachWSMenuEntry(atpoint, alignFrame);
 575       }
 576     }
 577   }
 578
 579   /**
 580    *
 581    * @param args
 582    * @j2sIgnore
 583    */
 584   public static void main(String[] args)
 585   {
 586     if (args.length > 0)
 587     {
 588       testUrls = new ArrayList<>();
 589       for (String url : args)
 590       {
 591         testUrls.add(url);
 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                   jalview.bin.Console
 604                           .outPrintln("Changesupport: There are now "
 605                                   + getDiscoverer().services.size()
 606                                   + " services");
 607                   int i = 1;
 608                   for (Jws2Instance instance : getDiscoverer().services)
 609                   {
 610                     jalview.bin.Console.outPrintln("Service " + i++ + " "
 611                             + instance.getClass() + "@" + instance.getHost()
 612                             + ": " + instance.getActionText());
 613                   }
 614
 615                 }
 616               }
 617             });
 618     while (runner.isAlive())
 619     {
 620       try
 621       {
 622         Thread.sleep(50);
 623       } catch (InterruptedException e)
 624       {
 625       }
 626     }
 627     try
 628     {
 629       Thread.sleep(50);
 630     } catch (InterruptedException x)
 631     {
 632     }
 633   }
 634
 635   /**
 636    * Returns the singleton instance of this class.
 637    *
 638    * @return
 639    */
 640   public static Jws2Discoverer getDiscoverer()
 641   {
 642     if (discoverer == null)
 643     {
 644       discoverer = new Jws2Discoverer();
 645     }
 646     return discoverer;
 647   }
 648
 649   public boolean hasServices()
 650   {
 651     return !running && services != null && services.size() > 0;
 652   }
 653
 654   public boolean isRunning()
 655   {
 656     return running;
 657   }
 658
 659   public void setServiceUrls(List<String> wsUrls)
 660   {
 661     if (wsUrls != null && !wsUrls.isEmpty())
 662     {
 663       StringBuilder urls = new StringBuilder(128);
 664       String sep = "";
 665       for (String url : wsUrls)
 666       {
 667         urls.append(sep);
 668         urls.append(url);
 669         sep = ",";
 670       }
 671       Cache.setProperty(JWS2HOSTURLS, urls.toString());
 672     }
 673     else
 674     {
 675       Cache.removeProperty(JWS2HOSTURLS);
 676     }
 677   }
 678
 679   /**
 680    * Returns web service URLs, in the order in which they should be tried (or an
 681    * empty list).
 682    *
 683    * @return
 684    */
 685   public List<String> getServiceUrls()
 686   {
 687     if (testUrls != null)
 688     {
 689       // return test urls, if there are any, instead of touching cache
 690       return testUrls;
 691     }
 692     List<String> urls = new ArrayList<>();
 693
 694     if (this.preferredUrl != null)
 695     {
 696       urls.add(preferredUrl);
 697     }
 698
 699     String surls = Cache.getDefault(JWS2HOSTURLS, COMPBIO_JABAWS);
 700     try
 701     {
 702       StringTokenizer st = new StringTokenizer(surls, ",");
 703       while (st.hasMoreElements())
 704       {
 705         String url = null;
 706         try
 707         {
 708           url = st.nextToken();
 709           new URL(url);
 710           if (!urls.contains(url))
 711           {
 712             urls.add(url);
 713           }
 714           else
 715           {
 716             Console.warn("Ignoring duplicate url " + url + " in "
 717                     + JWS2HOSTURLS + " list");
 718           }
 719         } catch (MalformedURLException ex)
 720         {
 721           Console.warn("Problem whilst trying to make a URL from '"
 722                   + ((url != null) ? url : "<null>") + "'");
 723           Console.warn(
 724                   "This was probably due to a malformed comma separated list"
 725                           + " in the " + JWS2HOSTURLS
 726                           + " entry of $(HOME)/.jalview_properties)");
 727           Console.debug("Exception was ", ex);
 728         }
 729       }
 730     } catch (Exception ex)
 731     {
 732       Console.warn("Error parsing comma separated list of urls in "
 733               + JWS2HOSTURLS + " preference.", ex);
 734     }
 735     return urls;
 736   }
 737
 738   public Vector<Jws2Instance> getServices()
 739   {
 740     return (services == null) ? new Vector<>() : 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         if (urls.contains(svc.getServiceTypeURI()))
 961         {
 962           if (match == null)
 963           {
 964             // for moment we always pick service from server ordered first in
 965             // user's preferences
 966             match = svc;
 967           }
 968           if (urls.contains(svc.getUri()))
 969           {
 970             // stop and return - we've matched type URI and URI for service
 971             // endpoint
 972             return svc;
 973           }
 974         }
 975       }
 976     }
 977     return match;
 978   }
 979
 980   Map<String, Map<String, String>> preferredServiceMap = new HashMap<>();
 981
 982   /**
 983    * get current preferred service of the given type, or global default
 984    *
 985    * @param af
 986    *          null or a specific alignFrame
 987    * @param serviceType
 988    *          Jws2Instance.serviceType for service
 989    * @return null if no service of this type is available, the preferred service
 990    *         for the serviceType and af if specified and if defined.
 991    */
 992   public Jws2Instance getPreferredServiceFor(AlignFrame af,
 993           String serviceType)
 994   {
 995     String serviceurl = null;
 996     synchronized (preferredServiceMap)
 997     {
 998       String afid = (af == null) ? "" : af.getViewport().getSequenceSetId();
 999       Map<String, String> prefmap = preferredServiceMap.get(afid);
1000       if (afid.length() > 0 && prefmap == null)
1001       {
1002         // recover global setting, if any
1003         prefmap = preferredServiceMap.get("");
1004       }
1005       if (prefmap != null)
1006       {
1007         serviceurl = prefmap.get(serviceType);
1008       }
1009
1010     }
1011     Jws2Instance response = null;
1012     for (Jws2Instance svc : services)
1013     {
1014       if (svc.serviceType.equals(serviceType))
1015       {
1016         if (serviceurl == null || serviceurl.equals(svc.getHost()))
1017         {
1018           response = svc;
1019           break;
1020         }
1021       }
1022     }
1023     return response;
1024   }
1025
1026   public void setPreferredServiceFor(AlignFrame af, String serviceType,
1027           String serviceAction, Jws2Instance selectedServer)
1028   {
1029     String afid = (af == null) ? "" : af.getViewport().getSequenceSetId();
1030     if (preferredServiceMap == null)
1031     {
1032       preferredServiceMap = new HashMap<>();
1033     }
1034     Map<String, String> prefmap = preferredServiceMap.get(afid);
1035     if (prefmap == null)
1036     {
1037       prefmap = new HashMap<>();
1038       preferredServiceMap.put(afid, prefmap);
1039     }
1040     prefmap.put(serviceType, selectedServer.getHost());
1041     prefmap.put(serviceAction, selectedServer.getHost());
1042   }
1043
1044   public void setPreferredServiceFor(String serviceType,
1045           String serviceAction, Jws2Instance selectedServer)
1046   {
1047     setPreferredServiceFor(null, serviceType, serviceAction,
1048             selectedServer);
1049   }
1050
1051   /**
1052    * Set a URL to try before any others. For use with command-line parameter to
1053    * configure a local Jabaws installation without the need to add to property
1054    * files.
1055    *
1056    * @param value
1057    * @throws MalformedURLException
1058    */
1059   public void setPreferredUrl(String value) throws MalformedURLException
1060   {
1061     if (value != null && value.trim().length() > 0)
1062     {
1063       new URL(value);
1064       preferredUrl = value;
1065     }
1066   }
1067 }