+/*
+ * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
+ * Copyright (C) $$Year-Rel$$ The Jalview Authors
+ *
+ * This file is part of Jalview.
+ *
+ * Jalview is free software: you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation, either version 3
+ * of the License, or (at your option) any later version.
+ *
+ * Jalview is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty
+ * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
+ * PURPOSE. See the GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with Jalview. If not, see <http://www.gnu.org/licenses/>.
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
+ */
package jalview.httpserver;
+import jalview.rest.RestHandler;
+
import java.net.BindException;
import java.net.URI;
import java.util.Collections;
import org.eclipse.jetty.server.Handler;
import org.eclipse.jetty.server.Server;
+import org.eclipse.jetty.server.ServerConnector;
import org.eclipse.jetty.server.handler.ContextHandler;
import org.eclipse.jetty.server.handler.HandlerCollection;
import org.eclipse.jetty.util.thread.QueuedThreadPool;
/**
- * An HttpServer built on Jetty
+ * An HttpServer built on Jetty. To use it
+ * <ul>
+ * <li>call getInstance() to create and start the server</li>
+ * <li>call registerHandler to add a handler for a path (below /jalview)</li>
+ * <li>when finished, call removedHandler</li>
+ * </ul>
*
* @author gmcarstairs
* @see http://eclipse.org/jetty/documentation/current/embedding-jetty.html
*/
public class HttpServer
{
- private static final String JALVIEW_PATH = "/jalview";
+ /*
+ * 'context root' - actually just prefixed to the path for each handler for
+ * now - see registerHandler
+ */
+ private static final String JALVIEW_PATH = "jalview";
/*
* Singleton instance of this server
{
synchronized (HttpServer.class)
{
- if (instance == null) {
+ if (instance == null)
+ {
instance = new HttpServer();
}
return instance;
private HttpServer() throws BindException
{
startServer();
+
+ /*
+ * Provides a REST server by default; add more programmatically as required
+ */
+ registerHandler(RestHandler.getInstance());
}
/**
- * Start the http server with a default thread pool size of 1
+ * Start the http server
*
* @throws BindException
*/
{
try
{
- // problem: how to both limit thread pool size and
- // pick a random free port - two alternative constructors
- QueuedThreadPool tp = new QueuedThreadPool(1, 1);
- // server = new Server(tp); // ? fails with URI null
- server = new Server(0); // pick a free port number
+ /*
+ * Create a server with a small number of threads; jetty will allocate a
+ * free port
+ */
+ QueuedThreadPool tp = new QueuedThreadPool(4, 1); // max, min
+ server = new Server(tp);
+ // 2 selector threads to handle incoming connections
+ ServerConnector connector = new ServerConnector(server, 0, 2);
+ // restrict to localhost
+ connector.setHost("localhost");
+ server.addConnector(connector);
/*
* HttpServer shuts down with Jalview process
/*
* Create a mutable set of handlers (can add handlers while the server is
- * running)
+ * running). Using vanilla handlers here rather than servlets
*/
- // TODO how to combine this with context root "/jalview"
+ // TODO how to properly configure context root "/jalview"
contextHandlers = new HandlerCollection(true);
server.setHandler(contextHandlers);
-
server.start();
+ // System.out.println(String.format(
+ // "HttpServer started with %d threads", server.getThreadPool()
+ // .getThreads()));
contextRoot = server.getURI();
- System.out.println("Jalview endpoint " + contextRoot);
} catch (Exception e)
{
System.err.println("Error trying to start HttpServer: "
}
/**
- * Register a handler for the given path and returns its URI
+ * Register a handler for the given path and set its URI
*
- * @param path
- * a path below the context root (without leading or trailing
- * separator)
* @param handler
* @return
+ * @throws IllegalStateException
+ * if handler path has not been set
*/
- public String registerHandler(String path, AbstractRequestHandler handler)
+ public void registerHandler(AbstractRequestHandler handler)
{
+ String path = handler.getPath();
+ if (path == null)
+ {
+ throw new IllegalStateException(
+ "Must set handler path before registering handler");
+ }
+
// http://stackoverflow.com/questions/20043097/jetty-9-embedded-adding-handlers-during-runtime
ContextHandler ch = new ContextHandler();
- ch.setContextPath("/" + path);
+ ch.setAllowNullPathInfo(true);
+ ch.setContextPath("/" + JALVIEW_PATH + "/" + path);
ch.setResourceBase(".");
- ch.setClassLoader(Thread.currentThread()
- .getContextClassLoader());
+ ch.setClassLoader(Thread.currentThread().getContextClassLoader());
ch.setHandler(handler);
/*
+ e.getMessage());
}
- return this.contextRoot + ch.getContextPath().substring(1);
+ handler.setUri(this.contextRoot + ch.getContextPath().substring(1));
+ System.out.println("Jalview " + handler.getName()
+ + " handler started on " + handler.getUri());
}
/**
*
* @param handler
*/
- public void removeHandler(Handler handler)
+ public void removeHandler(AbstractRequestHandler handler)
{
/*
* Have to use this cached lookup table since there is no method
{
contextHandlers.removeHandler(ch);
myHandlers.remove(handler);
+ System.out.println("Stopped Jalview " + handler.getName()
+ + " handler on " + handler.getUri());
}
}
}
git://source.jalview.org / jalview.git / blobdiff