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, "JabaQuery").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.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     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       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               }, "LoadPreferredService").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(),
 496                 hostservices = new ArrayList<>());
 497         hostlist.add(service.getHost());
 498       }
 499       hostservices.add(service);
 500     }
 501     // now add hosts in order of the given array
 502     for (String host : hostlist)
 503     {
 504       Jws2Instance orderedsvcs[] = hosts.get(host)
 505               .toArray(new Jws2Instance[1]);
 506       String sortbytype[] = new String[orderedsvcs.length];
 507       for (int i = 0; i < sortbytype.length; i++)
 508       {
 509         sortbytype[i] = orderedsvcs[i].serviceType;
 510       }
 511       jalview.util.QuickSort.sort(sortbytype, orderedsvcs);
 512       for (final Jws2Instance service : orderedsvcs)
 513       {
 514         atpoint = JvSwingUtils.findOrCreateMenu(jws2al, service.action);
 515         String type = service.serviceType;
 516         if (byhost)
 517         {
 518           atpoint = JvSwingUtils.findOrCreateMenu(atpoint, host);
 519           if (atpoint.getToolTipText() == null)
 520           {
 521             atpoint.setToolTipText(MessageManager
 522                     .formatMessage("label.services_at", new String[]
 523                     { host }));
 524           }
 525         }
 526         if (bytype)
 527         {
 528           atpoint = JvSwingUtils.findOrCreateMenu(atpoint, type);
 529           if (atpoint.getToolTipText() == null)
 530           {
 531             atpoint.setToolTipText(service.getActionText());
 532           }
 533         }
 534         if (!byhost && !hostLabels.contains(
 535                 host + service.serviceType + service.getActionText()))
 536         // !hostLabels.contains(host + (bytype ?
 537         // service.serviceType+service.getActionText() : "")))
 538         {
 539           // add a marker indicating where this service is hosted
 540           // relies on services from the same host being listed in a
 541           // contiguous
 542           // group
 543           JMenuItem hitm;
 544           if (hostLabels.contains(host))
 545           {
 546             atpoint.addSeparator();
 547           }
 548           else
 549           {
 550             hostLabels.add(host);
 551           }
 552           if (lasthostFor.get(service.action) == null
 553                   || !lasthostFor.get(service.action).equals(host))
 554           {
 555             atpoint.add(hitm = new JMenuItem(host));
 556             hitm.setForeground(Color.blue);
 557             hitm.addActionListener(new ActionListener()
 558             {
 559
 560               @Override
 561               public void actionPerformed(ActionEvent e)
 562               {
 563                 Desktop.showUrl(service.getHost());
 564               }
 565             });
 566             hitm.setToolTipText(
 567                     JvSwingUtils.wrapTooltip(true, MessageManager
 568                             .getString("label.open_jabaws_web_page")));
 569             lasthostFor.put(service.action, host);
 570           }
 571           hostLabels.add(
 572                   host + service.serviceType + service.getActionText());
 573         }
 574
 575         service.attachWSMenuEntry(atpoint, alignFrame);
 576       }
 577     }
 578   }
 579
 580   public static void main(String[] args)
 581   {
 582     if (args.length > 0)
 583     {
 584       testUrls = new ArrayList<>();
 585       for (String url : args)
 586       {
 587         testUrls.add(url);
 588       }
 589       ;
 590     }
 591     Thread runner = getDiscoverer()
 592             .startDiscoverer(new PropertyChangeListener()
 593             {
 594
 595               @Override
 596               public void propertyChange(PropertyChangeEvent evt)
 597               {
 598                 if (getDiscoverer().services != null)
 599                 {
 600                   System.out.println("Changesupport: There are now "
 601                           + getDiscoverer().services.size() + " services");
 602                   int i = 1;
 603                   for (Jws2Instance instance : getDiscoverer().services)
 604                   {
 605                     System.out.println("Service " + i++ + " "
 606                             + instance.getClass() + "@" + instance.getHost()
 607                             + ": " + instance.getActionText());
 608                   }
 609
 610                 }
 611               }
 612             });
 613     while (runner.isAlive())
 614     {
 615       try
 616       {
 617         Thread.sleep(50);
 618       } catch (InterruptedException e)
 619       {
 620       }
 621       ;
 622     }
 623     try
 624     {
 625       Thread.sleep(50);
 626     } catch (InterruptedException x)
 627     {
 628     }
 629   }
 630
 631   /**
 632    * Returns the singleton instance of this class.
 633    *
 634    * @return
 635    */
 636   public static Jws2Discoverer getDiscoverer()
 637   {
 638     if (discoverer == null)
 639     {
 640       discoverer = new Jws2Discoverer();
 641     }
 642     return discoverer;
 643   }
 644
 645   public boolean hasServices()
 646   {
 647     return !running && services != null && services.size() > 0;
 648   }
 649
 650   public boolean isRunning()
 651   {
 652     return running;
 653   }
 654
 655   public void setServiceUrls(List<String> wsUrls)
 656   {
 657     if (wsUrls != null && !wsUrls.isEmpty())
 658     {
 659       StringBuilder urls = new StringBuilder(128);
 660       String sep = "";
 661       for (String url : wsUrls)
 662       {
 663         urls.append(sep);
 664         urls.append(url);
 665         sep = ",";
 666       }
 667       Cache.setProperty(JWS2HOSTURLS, urls.toString());
 668     }
 669     else
 670     {
 671       Cache.removeProperty(JWS2HOSTURLS);
 672     }
 673   }
 674
 675   /**
 676    * Returns web service URLs, in the order in which they should be tried (or an
 677    * empty list).
 678    *
 679    * @return
 680    */
 681   public List<String> getServiceUrls()
 682   {
 683     if (testUrls != null)
 684     {
 685       // return test urls, if there are any, instead of touching cache
 686       return testUrls;
 687     }
 688     List<String> urls = new ArrayList<>();
 689
 690     if (this.preferredUrl != null)
 691     {
 692       urls.add(preferredUrl);
 693     }
 694
 695     String surls = Cache.getDefault(JWS2HOSTURLS, COMPBIO_JABAWS);
 696     try
 697     {
 698       StringTokenizer st = new StringTokenizer(surls, ",");
 699       while (st.hasMoreElements())
 700       {
 701         String url = null;
 702         try
 703         {
 704           url = st.nextToken();
 705           new URL(url);
 706           if (!urls.contains(url))
 707           {
 708             urls.add(url);
 709           }
 710           else
 711           {
 712             Cache.log.warn("Ignoring duplicate url " + url + " in "
 713                     + JWS2HOSTURLS + " list");
 714           }
 715         } catch (MalformedURLException ex)
 716         {
 717           Cache.log.warn("Problem whilst trying to make a URL from '"
 718                   + ((url != null) ? url : "<null>") + "'");
 719           Cache.log.warn(
 720                   "This was probably due to a malformed comma separated list"
 721                           + " in the " + JWS2HOSTURLS
 722                           + " entry of $(HOME)/.jalview_properties)");
 723           Cache.log.debug("Exception was ", ex);
 724         }
 725       }
 726     } catch (Exception ex)
 727     {
 728       Cache.log.warn("Error parsing comma separated list of urls in "
 729               + JWS2HOSTURLS + " preference.", ex);
 730     }
 731     return urls;
 732   }
 733
 734   public Vector<Jws2Instance> getServices()
 735   {
 736     return (services == null) ? new Vector<Jws2Instance>()
 737             : new Vector<>(services);
 738   }
 739
 740   /**
 741    * test the given URL with the JabaWS test code
 742    *
 743    * @param foo
 744    * @return
 745    */
 746   public static boolean testServiceUrl(URL foo)
 747   {
 748     try
 749     {
 750       compbio.ws.client.WSTester
 751               .main(new String[]
 752               { "-h=" + foo.toString() });
 753     } catch (Exception e)
 754     {
 755       e.printStackTrace();
 756       return false;
 757     } catch (OutOfMemoryError e)
 758     {
 759       e.printStackTrace();
 760       return false;
 761     } catch (Error e)
 762     {
 763       e.printStackTrace();
 764       return false;
 765     }
 766
 767     return true;
 768   }
 769
 770   public boolean restart()
 771   {
 772     synchronized (this)
 773     {
 774       if (running)
 775       {
 776         aborted = true;
 777       }
 778       else
 779       {
 780         running = true;
 781       }
 782       return aborted;
 783     }
 784   }
 785
 786   /**
 787    * Start a fresh discovery thread and notify the given object when we're
 788    * finished. Any known existing threads will be killed before this one is
 789    * started.
 790    *
 791    * @param changeSupport2
 792    * @return new thread
 793    */
 794   public Thread startDiscoverer(PropertyChangeListener changeSupport2)
 795   {
 796     /*    if (restart())
 797         {
 798           return;
 799         }
 800         else
 801         {
 802           Thread thr = new Thread(this);
 803           thr.start();
 804         }
 805        */
 806     if (isRunning())
 807     {
 808       setAborted(true);
 809     }
 810     addPropertyChangeListener(changeSupport2);
 811     Thread thr = new Thread(this);
 812     thr.start();
 813     return thr;
 814   }
 815
 816   /**
 817    * @return the invalidServiceUrls
 818    */
 819   public Vector<String> getInvalidServiceUrls()
 820   {
 821     return invalidServiceUrls;
 822   }
 823
 824   /**
 825    * @return the urlsWithoutServices
 826    */
 827   public Vector<String> getUrlsWithoutServices()
 828   {
 829     return urlsWithoutServices;
 830   }
 831
 832   /**
 833    * add an 'empty' JABA server to the list. Only servers not already in the
 834    * 'bad URL' list will be added to this list.
 835    *
 836    * @param jwsservers
 837    */
 838   public synchronized void addUrlwithnoservices(String jwsservers)
 839   {
 840     if (urlsWithoutServices == null)
 841     {
 842       urlsWithoutServices = new Vector<>();
 843     }
 844
 845     if ((invalidServiceUrls == null
 846             || !invalidServiceUrls.contains(jwsservers))
 847             && !urlsWithoutServices.contains(jwsservers))
 848     {
 849       urlsWithoutServices.add(jwsservers);
 850     }
 851   }
 852
 853   /**
 854    * add a bad URL to the list
 855    *
 856    * @param jwsservers
 857    */
 858   public synchronized void addInvalidServiceUrl(String jwsservers)
 859   {
 860     if (invalidServiceUrls == null)
 861     {
 862       invalidServiceUrls = new Vector<>();
 863     }
 864     if (!invalidServiceUrls.contains(jwsservers))
 865     {
 866       invalidServiceUrls.add(jwsservers);
 867     }
 868   }
 869
 870   /**
 871    *
 872    * @return a human readable report of any problems with the service URLs used
 873    *         for discovery
 874    */
 875   public String getErrorMessages()
 876   {
 877     if (!isRunning() && !isAborted())
 878     {
 879       StringBuffer ermsg = new StringBuffer();
 880       boolean list = false;
 881       if (getInvalidServiceUrls() != null
 882               && getInvalidServiceUrls().size() > 0)
 883       {
 884         ermsg.append(MessageManager.getString("warn.urls_not_contacted")
 885                 + ": \n");
 886         for (String svcurl : getInvalidServiceUrls())
 887         {
 888           if (list)
 889           {
 890             ermsg.append(", ");
 891           }
 892           list = true;
 893           ermsg.append(svcurl);
 894         }
 895         ermsg.append("\n\n");
 896       }
 897       list = false;
 898       if (getUrlsWithoutServices() != null
 899               && getUrlsWithoutServices().size() > 0)
 900       {
 901         ermsg.append(
 902                 MessageManager.getString("warn.urls_no_jaba") + ": \n");
 903         for (String svcurl : getUrlsWithoutServices())
 904         {
 905           if (list)
 906           {
 907             ermsg.append(", ");
 908           }
 909           list = true;
 910           ermsg.append(svcurl);
 911         }
 912         ermsg.append("\n");
 913       }
 914       if (ermsg.length() > 1)
 915       {
 916         return ermsg.toString();
 917       }
 918
 919     }
 920     return null;
 921   }
 922
 923   public int getServerStatusFor(String url)
 924   {
 925     if (validServiceUrls != null && validServiceUrls.contains(url))
 926     {
 927       return 1;
 928     }
 929     if (urlsWithoutServices != null && urlsWithoutServices.contains(url))
 930     {
 931       return 0;
 932     }
 933     if (invalidServiceUrls != null && invalidServiceUrls.contains(url))
 934     {
 935       return -1;
 936     }
 937     return -2;
 938   }
 939
 940   /**
 941    * pick the user's preferred service based on a set of URLs (jaba server
 942    * locations) and service URIs (specifying version and service interface
 943    * class)
 944    *
 945    * @param serviceURL
 946    * @return null or best match for given uri/ls.
 947    */
 948   public Jws2Instance getPreferredServiceFor(String[] serviceURLs)
 949   {
 950     HashSet<String> urls = new HashSet<>();
 951     urls.addAll(Arrays.asList(serviceURLs));
 952     Jws2Instance match = null;
 953     if (services != null)
 954     {
 955       for (Jws2Instance svc : services)
 956       {
 957         if (urls.contains(svc.getServiceTypeURI()))
 958         {
 959           if (match == null)
 960           {
 961             // for moment we always pick service from server ordered first in
 962             // user's preferences
 963             match = svc;
 964           }
 965           if (urls.contains(svc.getUri()))
 966           {
 967             // stop and return - we've matched type URI and URI for service
 968             // endpoint
 969             return svc;
 970           }
 971         }
 972       }
 973     }
 974     return match;
 975   }
 976
 977   Map<String, Map<String, String>> preferredServiceMap = new HashMap<>();;
 978
 979   /**
 980    * get current preferred service of the given type, or global default
 981    *
 982    * @param af
 983    *          null or a specific alignFrame
 984    * @param serviceType
 985    *          Jws2Instance.serviceType for service
 986    * @return null if no service of this type is available, the preferred service
 987    *         for the serviceType and af if specified and if defined.
 988    */
 989   public Jws2Instance getPreferredServiceFor(AlignFrame af,
 990           String serviceType)
 991   {
 992     String serviceurl = null;
 993     synchronized (preferredServiceMap)
 994     {
 995       String afid = (af == null) ? "" : af.getViewport().getSequenceSetId();
 996       Map<String, String> prefmap = preferredServiceMap.get(afid);
 997       if (afid.length() > 0 && prefmap == null)
 998       {
 999         // recover global setting, if any
1000         prefmap = preferredServiceMap.get("");
1001       }
1002       if (prefmap != null)
1003       {
1004         serviceurl = prefmap.get(serviceType);
1005       }
1006
1007     }
1008     Jws2Instance response = null;
1009     for (Jws2Instance svc : services)
1010     {
1011       if (svc.serviceType.equals(serviceType))
1012       {
1013         if (serviceurl == null || serviceurl.equals(svc.getHost()))
1014         {
1015           response = svc;
1016           break;
1017         }
1018       }
1019     }
1020     return response;
1021   }
1022
1023   public void setPreferredServiceFor(AlignFrame af, String serviceType,
1024           String serviceAction, Jws2Instance selectedServer)
1025   {
1026     String afid = (af == null) ? "" : af.getViewport().getSequenceSetId();
1027     if (preferredServiceMap == null)
1028     {
1029       preferredServiceMap = new HashMap<>();
1030     }
1031     Map<String, String> prefmap = preferredServiceMap.get(afid);
1032     if (prefmap == null)
1033     {
1034       prefmap = new HashMap<>();
1035       preferredServiceMap.put(afid, prefmap);
1036     }
1037     prefmap.put(serviceType, selectedServer.getHost());
1038     prefmap.put(serviceAction, selectedServer.getHost());
1039   }
1040
1041   public void setPreferredServiceFor(String serviceType,
1042           String serviceAction, Jws2Instance selectedServer)
1043   {
1044     setPreferredServiceFor(null, serviceType, serviceAction,
1045             selectedServer);
1046   }
1047
1048   /**
1049    * Set a URL to try before any others. For use with command-line parameter to
1050    * configure a local Jabaws installation without the need to add to property
1051    * files.
1052    *
1053    * @param value
1054    * @throws MalformedURLException
1055    */
1056   public void setPreferredUrl(String value) throws MalformedURLException
1057   {
1058     if (value != null && value.trim().length() > 0)
1059     {
1060       new URL(value);
1061       preferredUrl = value;
1062     }
1063   }
1064 }