X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fhttpserver%2FHttpServer.java;h=134123b4f22eaaee83082144382a58debbab8fc1;hb=37de9310bec3501cbc6381e0c3dcb282fcaad812;hp=d39ada12fdb57a998bb195e605d6b2554b919a44;hpb=f2f654875a6eb5f4e90b2c5c545bfed3a70f2b5f;p=jalview.git

diff --git a/src/jalview/httpserver/HttpServer.java b/src/jalview/httpserver/HttpServer.java
index d39ada1..134123b 100644
--- a/src/jalview/httpserver/HttpServer.java
+++ b/src/jalview/httpserver/HttpServer.java
@@ -1,5 +1,27 @@
+/*
+ * 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;
@@ -11,19 +33,29 @@ import javax.servlet.http.HttpServletResponse;
 
 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
@@ -60,7 +92,8 @@ public class HttpServer
   {
     synchronized (HttpServer.class)
     {
-      if (instance == null) {
+      if (instance == null)
+      {
         instance = new HttpServer();
       }
       return instance;
@@ -76,10 +109,15 @@ public class HttpServer
   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
    */
@@ -87,11 +125,17 @@ public class HttpServer
   {
     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
@@ -100,15 +144,16 @@ public class HttpServer
 
       /*
        * 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: "
@@ -184,22 +229,28 @@ public class 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);
 
     /*
@@ -220,7 +271,9 @@ public class HttpServer
               + 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());
   }
 
   /**
@@ -229,7 +282,7 @@ public class HttpServer
    * 
    * @param handler
    */
-  public void removeHandler(Handler handler)
+  public void removeHandler(AbstractRequestHandler handler)
   {
     /*
      * Have to use this cached lookup table since there is no method
@@ -240,6 +293,8 @@ public class HttpServer
     {
       contextHandlers.removeHandler(ch);
       myHandlers.remove(handler);
+      System.out.println("Stopped Jalview " + handler.getName()
+              + " handler on " + handler.getUri());
     }
   }
 }