git.basschouten.com Git - openhab-addons.git/blob

   1 /**
   2  * Copyright (c) 2010-2023 Contributors to the openHAB project
   3  *
   4  * See the NOTICE file(s) distributed with this work for additional
   5  * information.
   6  *
   7  * This program and the accompanying materials are made available under the
   8  * terms of the Eclipse Public License 2.0 which is available at
   9  * http://www.eclipse.org/legal/epl-2.0
  10  *
  11  * SPDX-License-Identifier: EPL-2.0
  12  */
  13 package org.openhab.binding.mielecloud.internal.config.servlet;
  14
  15 import java.io.IOException;
  16
  17 import javax.servlet.ServletException;
  18 import javax.servlet.http.HttpServlet;
  19 import javax.servlet.http.HttpServletRequest;
  20 import javax.servlet.http.HttpServletResponse;
  21
  22 import org.eclipse.jdt.annotation.NonNullByDefault;
  23 import org.eclipse.jdt.annotation.Nullable;
  24 import org.slf4j.Logger;
  25 import org.slf4j.LoggerFactory;
  26
  27 /**
  28  * Base class for servlets that show a visible frontend in the browser.
  29  *
  30  * @author Björn Lange - Initial Contribution
  31  */
  32 @NonNullByDefault
  33 public abstract class AbstractShowPageServlet extends HttpServlet {
  34     private static final long serialVersionUID = 3820684716753275768L;
  35
  36     private static final String CONTENT_TYPE = "text/html;charset=UTF-8";
  37
  38     private final Logger logger = LoggerFactory.getLogger(AbstractShowPageServlet.class);
  39
  40     private final ResourceLoader resourceLoader;
  41
  42     protected ResourceLoader getResourceLoader() {
  43         return resourceLoader;
  44     }
  45
  46     /**
  47      * Creates a new {@link AbstractShowPageServlet}.
  48      *
  49      * @param resourceLoader Loader for resource files.
  50      */
  51     public AbstractShowPageServlet(ResourceLoader resourceLoader) {
  52         this.resourceLoader = resourceLoader;
  53     }
  54
  55     @Override
  56     protected void doGet(@Nullable HttpServletRequest request, @Nullable HttpServletResponse response)
  57             throws ServletException, IOException {
  58         if (response == null) {
  59             logger.warn("Ignoring received request without response.");
  60             return;
  61         }
  62         if (request == null) {
  63             logger.warn("Ignoring illegal request.");
  64             response.sendError(HttpServletResponse.SC_BAD_REQUEST);
  65             return;
  66         }
  67
  68         try {
  69             String html = handleGetRequest(request, response);
  70             response.setContentType(CONTENT_TYPE);
  71             response.getWriter().write(html);
  72             response.getWriter().close();
  73         } catch (MieleHttpException e) {
  74             response.sendError(e.getHttpErrorCode());
  75         } catch (IOException e) {
  76             logger.warn("Failed to load resources.", e);
  77             response.sendError(HttpServletResponse.SC_INTERNAL_SERVER_ERROR);
  78         }
  79     }
  80
  81     /**
  82      * Handles a GET request.
  83      *
  84      * @param request The request.
  85      * @param response The response.
  86      * @return A rendered HTML body to be displayed in the browser. The body will be framed by the binding's frontend
  87      *         layout.
  88      * @throws MieleHttpException if an error occurs that should be handled by sending a default error response.
  89      * @throws IOException if an error occurs while loading resources.
  90      */
  91     protected abstract String handleGetRequest(HttpServletRequest request, HttpServletResponse response)
  92             throws MieleHttpException, IOException;
  93 }