Jalview 2.6 source licence
[jalview.git] / src / jalview / ws / jws2 / Jws2Client.java
1 /*
2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.6)
3  * Copyright (C) 2010 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle
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 of the License, or (at your option) any later version.
10  * 
11  * Jalview is distributed in the hope that it will be useful, but 
12  * WITHOUT ANY WARRANTY; without even the implied warranty 
13  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
14  * PURPOSE.  See the GNU General Public License for more details.
15  * 
16  * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
17  */
18 package jalview.ws.jws2;
19
20 import javax.swing.JMenu;
21
22 import jalview.gui.AlignFrame;
23 import jalview.gui.WebserviceInfo;
24 import jalview.ws.jws2.Jws2Discoverer.Jws2Instance;
25
26 /**
27  * provides metadata for a jws2 service instance - resolves names, etc.
28  * 
29  * @author JimP
30  * 
31  */
32 public abstract class Jws2Client extends jalview.ws.WSClient
33 {
34   protected WebserviceInfo setWebService(Jws2Instance serv, boolean b)
35   {
36     // serviceHandle = serv;
37     String serviceInstance = serv.service.getClass().getName();
38     WebServiceName = serv.serviceType;
39     WebServiceJobTitle = serv.getActionText();
40     WsURL = serv.hosturl;
41     if (!b)
42     {
43       return new WebserviceInfo(WebServiceJobTitle, WebServiceJobTitle
44               + " using service hosted at " + serv.hosturl);
45     }
46     return null;
47   }
48   /*
49   Jws2Instance serviceHandle;
50    * (non-Javadoc)
51    * @see jalview.ws.WSMenuEntryProviderI#attachWSMenuEntry(javax.swing.JMenu, jalview.gui.AlignFrame)
52    *
53   @Override
54   public void attachWSMenuEntry(JMenu wsmenu, AlignFrame alignFrame)
55   {
56     if (serviceHandle==null)
57     {
58       throw new Error("Implementation error: No service handle for this Jws2 service.");
59     }
60     attachWSMenuEntry(wsmenu, serviceHandle, alignFrame);
61   }*/
62   /**
63    * add the menu item for a particular jws2 service instance
64    * @param wsmenu
65    * @param service
66    * @param alignFrame
67    */
68   abstract void attachWSMenuEntry(JMenu wsmenu,
69           final Jws2Instance service, final AlignFrame alignFrame);
70
71 }