src/jalview/rest/RestHandler.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
   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
  10  * of the License, or (at your option) any later version.
  11  *
  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.
  16  *
  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.
  20  */
  21 package jalview.rest;
  22
  23 import jalview.bin.ApplicationSingletonProvider;
  24 import jalview.bin.ApplicationSingletonProvider.ApplicationSingletonI;
  25 import jalview.httpserver.AbstractRequestHandler;
  26
  27 import java.io.IOException;
  28 import java.io.PrintWriter;
  29 import java.net.BindException;
  30
  31 import javax.servlet.http.HttpServletRequest;
  32 import javax.servlet.http.HttpServletResponse;
  33
  34 /**
  35  * A simple handler to process (or delegate) HTTP requests on /jalview/rest.
  36  * Accessed only by HttpServer.
  37  */
  38 public class RestHandler extends AbstractRequestHandler
  39         implements ApplicationSingletonI
  40 {
  41   private static final String MY_PATH = "rest";
  42
  43   private static final String MY_NAME = "Rest";
  44
  45   /**
  46    * Returns the singleton instance of this class
  47    *
  48    * @return
  49    * @throws BindException
  50    */
  51   public static RestHandler getInstance() throws BindException
  52   {
  53     synchronized (RestHandler.class)
  54     {
  55       return (RestHandler) ApplicationSingletonProvider.getInstance(RestHandler.class);
  56     }
  57   }
  58
  59   /**
  60    * Private constructor enforces use of singleton
  61    *
  62    * @throws BindException
  63    */
  64   private RestHandler() throws BindException
  65   {
  66     setPath(MY_PATH);
  67
  68     /*
  69      * We don't register the handler here - this is done as a special case in
  70      * HttpServer initialisation; to do it here would invite an infinite loop of
  71      * RestHandler/HttpServer constructor
  72      */
  73   }
  74
  75   /**
  76    * Handle a jalview/rest request
  77    *
  78    * @throws IOException
  79    */
  80   @Override
  81   protected void processRequest(HttpServletRequest request,
  82           HttpServletResponse response) throws IOException
  83   {
  84     /*
  85      * Currently just echoes the request; add helper classes as required to
  86      * process requests
  87      */
  88     final String queryString = request.getQueryString();
  89     final String reply = "REST not yet implemented; received "
  90             + request.getMethod() + ": " + request.getRequestURL()
  91             + (queryString == null ? "" : "?" + queryString);
  92     System.out.println(reply);
  93
  94     response.setHeader("Cache-Control", "no-cache/no-store");
  95     response.setHeader("Content-type", "text/plain");
  96     final PrintWriter writer = response.getWriter();
  97     writer.write(reply);
  98     writer.close();
  99   }
 100
 101   /**
 102    * Returns a display name for this service
 103    */
 104   @Override
 105   public String getName()
 106   {
 107     return MY_NAME;
 108   }
 109
 110 }