JAL-3851 merged to develop 2022-03-22

[jalview.git] / src / jalview / httpserver / HttpServer.java

diff --git a/src/jalview/httpserver/HttpServer.java b/src/jalview/httpserver/HttpServer.java
index fcfefaa..057c714 100644 (file)
--- a/src/jalview/httpserver/HttpServer.java
+++ b/src/jalview/httpserver/HttpServer.java
@@ -1,3 +1,23 @@
+/*
+ * 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 java.net.BindException;
@@ -9,6 +29,7 @@ import java.util.Map;
 import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpServletResponse;
 
+import org.eclipse.jetty.server.Connector;
 import org.eclipse.jetty.server.Handler;
 import org.eclipse.jetty.server.Server;
 import org.eclipse.jetty.server.ServerConnector;
@@ -62,6 +83,14 @@ public class HttpServer
    */
   private URI contextRoot;
 
+  /*
+   * The port of the server.  This can be set before starting the instance
+   * as a suggested port to use (it is not guaranteed).
+   * The value will be set to the actual port being used after the instance
+   * is started.
+   */
+  private static int PORT = 0;
+
   /**
    * Returns the singleton instance of this class.
    * 
@@ -72,7 +101,8 @@ public class HttpServer
   {
     synchronized (HttpServer.class)
     {
-      if (instance == null) {
+      if (instance == null)
+      {
         instance = new HttpServer();
       }
       return instance;
@@ -105,13 +135,20 @@ public class HttpServer
     try
     {
       /*
-       * Create a server with a small number of threads; jetty will allocate a
-       * free port
+       * Create a server with a small number of threads;
+       * If PORT has been set then jetty will try and use this, otherwise
+       * 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");
+      if (PORT > 0)
+      {
+        connector.setPort(PORT);
+      }
       server.addConnector(connector);
 
       /*
@@ -127,15 +164,23 @@ public class HttpServer
       contextHandlers = new HandlerCollection(true);
       server.setHandler(contextHandlers);
       server.start();
+      Connector[] cs = server.getConnectors();
+      if (cs.length > 0)
+      {
+        if (cs[0] instanceof ServerConnector)
+        {
+          ServerConnector c = (ServerConnector) cs[0];
+          PORT = c.getPort();
+        }
+      }
       // 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: "
-              + e.getMessage());
+      System.err.println(
+              "Error trying to start HttpServer: " + e.getMessage());
       try
       {
         server.stop();
@@ -228,8 +273,7 @@ public class HttpServer
     ch.setAllowNullPathInfo(true);
     ch.setContextPath("/" + JALVIEW_PATH + "/" + path);
     ch.setResourceBase(".");
-    ch.setClassLoader(Thread.currentThread()
-            .getContextClassLoader());
+    ch.setClassLoader(Thread.currentThread().getContextClassLoader());
     ch.setHandler(handler);
 
     /*
@@ -246,8 +290,8 @@ public class HttpServer
       ch.start();
     } catch (Exception e)
     {
-      System.err.println("Error starting handler for " + path + ": "
-              + e.getMessage());
+      System.err.println(
+              "Error starting handler for " + path + ": " + e.getMessage());
     }
 
     handler.setUri(this.contextRoot + ch.getContextPath().substring(1));
@@ -261,7 +305,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
@@ -272,6 +316,42 @@ public class HttpServer
     {
       contextHandlers.removeHandler(ch);
       myHandlers.remove(handler);
+      System.out.println("Stopped Jalview " + handler.getName()
+              + " handler on " + handler.getUri());
+    }
+  }
+
+  /**
+   * Gets the ContextHandler attached to this handler. Useful for obtaining the
+   * full path used to access a given handler.
+   * 
+   * @param handler
+   */
+  public ContextHandler getContextHandler(AbstractRequestHandler handler)
+  {
+    return myHandlers.get(handler);
+  }
+
+  /**
+   * This sets the "suggested" port to use. It can only be called once before
+   * starting the HttpServer instance. After the server has actually started the
+   * port is set to the actual port being used and cannot be changed.
+   * 
+   * @param port
+   * @return successful change
+   */
+  public static boolean setSuggestedPort(int port)
+  {
+    if (port < 1 || PORT > 0)
+    {
+      return false;
     }
+    PORT = port;
+    return true;
+  }
+
+  public static int getPort()
+  {
+    return PORT;
   }
 }