2 * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
3 * Copyright (C) $$Year-Rel$$ The Jalview Authors
5 * This file is part of Jalview.
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.
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.
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.
21 package jalview.httpserver;
23 import jalview.bin.ApplicationSingletonProvider;
24 import jalview.bin.ApplicationSingletonProvider.ApplicationSingletonI;
25 import jalview.rest.RestHandler;
27 import java.net.BindException;
29 import java.util.Collections;
30 import java.util.HashMap;
33 import javax.servlet.http.HttpServletRequest;
34 import javax.servlet.http.HttpServletResponse;
36 import org.eclipse.jetty.server.Handler;
37 import org.eclipse.jetty.server.Server;
38 import org.eclipse.jetty.server.ServerConnector;
39 import org.eclipse.jetty.server.handler.ContextHandler;
40 import org.eclipse.jetty.server.handler.HandlerCollection;
41 import org.eclipse.jetty.util.thread.QueuedThreadPool;
44 * An HttpServer built on Jetty. To use it
46 * <li>call getInstance() to create and start the server</li>
47 * <li>call registerHandler to add a handler for a path (below /jalview)</li>
48 * <li>when finished, call removedHandler</li>
52 * @see http://eclipse.org/jetty/documentation/current/embedding-jetty.html
54 public class HttpServer implements ApplicationSingletonI
57 * Returns the singleton instance of this class.
60 * @throws BindException
62 public static HttpServer getInstance() throws BindException
64 synchronized (HttpServer.class)
66 return (HttpServer) ApplicationSingletonProvider
67 .getInstance(HttpServer.class);
71 * 'context root' - actually just prefixed to the path for each handler for
72 * now - see registerHandler
74 private static final String JALVIEW_PATH = "jalview";
79 private Server server;
82 * Registered handlers for context paths
84 private HandlerCollection contextHandlers;
87 * Lookup of ContextHandler by its wrapped handler
89 Map<Handler, ContextHandler> myHandlers = new HashMap<>();
92 * The context root for the server
94 private URI contextRoot;
98 * Private constructor to enforce use of singleton; use getInstance().
100 * @throws BindException
101 * if no free port can be assigned
103 private HttpServer() throws BindException
110 * Provides a REST server by default; add more programmatically as required
112 registerHandler(RestHandler.getInstance());
116 * Start the http server
118 * @throws BindException
120 private void startServer() throws BindException
125 * Create a server with a small number of threads; jetty will allocate a
128 QueuedThreadPool tp = new QueuedThreadPool(4, 1); // max, min
129 server = new Server(tp);
130 // 2 selector threads to handle incoming connections
131 ServerConnector connector = new ServerConnector(server, 0, 2);
132 // restrict to localhost
133 connector.setHost("localhost");
134 server.addConnector(connector);
137 * HttpServer shuts down with Jalview process
139 server.setStopAtShutdown(true);
142 * Create a mutable set of handlers (can add handlers while the server is
143 * running). Using vanilla handlers here rather than servlets
145 // TODO how to properly configure context root "/jalview"
146 contextHandlers = new HandlerCollection(true);
147 server.setHandler(contextHandlers);
149 // System.out.println(String.format(
150 // "HttpServer started with %d threads", server.getThreadPool()
152 contextRoot = server.getURI();
153 } catch (Exception e)
156 "Error trying to start HttpServer: " + e.getMessage());
160 } catch (Exception e1)
162 e1.printStackTrace();
167 throw new BindException("HttpServer failed to allocate a port");
172 * Returns the URI on which we are listening
178 return server == null ? null : server.getURI();
182 * For debug - write HTTP request details to stdout
187 protected void dumpRequest(HttpServletRequest request,
188 HttpServletResponse response)
190 for (String hdr : Collections.list(request.getHeaderNames()))
192 for (String val : Collections.list(request.getHeaders(hdr)))
194 System.out.println(hdr + ": " + val);
197 for (String param : Collections.list(request.getParameterNames()))
199 for (String val : request.getParameterValues(param))
201 System.out.println(param + "=" + val);
207 * Stop the Http server.
209 public void stopServer()
213 if (server.isStarted())
218 } catch (Exception e)
220 System.err.println("Error stopping Http Server on "
221 + server.getURI() + ": " + e.getMessage());
228 * Register a handler for the given path and set its URI
232 * @throws IllegalStateException
233 * if handler path has not been set
235 public void registerHandler(AbstractRequestHandler handler)
237 String path = handler.getPath();
240 throw new IllegalStateException(
241 "Must set handler path before registering handler");
244 // http://stackoverflow.com/questions/20043097/jetty-9-embedded-adding-handlers-during-runtime
245 ContextHandler ch = new ContextHandler();
246 ch.setAllowNullPathInfo(true);
247 ch.setContextPath("/" + JALVIEW_PATH + "/" + path);
248 ch.setResourceBase(".");
249 ch.setClassLoader(Thread.currentThread().getContextClassLoader());
250 ch.setHandler(handler);
253 * Remember the association so we can remove it later
255 this.myHandlers.put(handler, ch);
258 * A handler added to a running server must be started explicitly
260 contextHandlers.addHandler(ch);
264 } catch (Exception e)
267 "Error starting handler for " + path + ": " + e.getMessage());
270 handler.setUri(this.contextRoot + ch.getContextPath().substring(1));
271 System.out.println("Jalview " + handler.getName()
272 + " handler started on " + handler.getUri());
276 * Removes the handler from the server; more precisely, remove the
277 * ContextHandler wrapping the specified handler
281 public void removeHandler(AbstractRequestHandler handler)
284 * Have to use this cached lookup table since there is no method
285 * ContextHandler.getHandler()
287 ContextHandler ch = myHandlers.get(handler);
290 contextHandlers.removeHandler(ch);
291 myHandlers.remove(handler);
292 System.out.println("Stopped Jalview " + handler.getName()
293 + " handler on " + handler.getUri());