dashboard/webapp-backend/src/main/java/org/oransc/ric/portal/dashboard/controller/Html5PathsController.java

   1 /*-
   2  * ========================LICENSE_START=================================
   3  * O-RAN-SC
   4  * %%
   5  * Copyright (C) 2019 AT&T Intellectual Property
   6  * %%
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  * ========================LICENSE_END===================================
  19  */
  20 package org.oransc.ric.portal.dashboard.controller;
  21
  22 import java.io.IOException;
  23 import java.lang.invoke.MethodHandles;
  24 import java.net.URL;
  25
  26 import javax.servlet.http.HttpServletRequest;
  27 import javax.servlet.http.HttpServletResponse;
  28
  29 import org.slf4j.Logger;
  30 import org.slf4j.LoggerFactory;
  31 import org.springframework.stereotype.Controller;
  32 import org.springframework.web.bind.annotation.RequestMapping;
  33 import org.springframework.web.bind.annotation.RequestMethod;
  34
  35 /**
  36  * Listens for requests to known Angular routes.
  37  */
  38 @Controller
  39 public class Html5PathsController {
  40
  41         private static final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
  42
  43         /**
  44          * Forwards the browser to the index (main) page upon request of a known route.
  45          * This unfortunately requires duplication of the Angular route strings in the
  46          * path mappings on this method. Could switch to a regex pattern instead someday
  47          * if the routes change too often.
  48          *
  49          * https://stackoverflow.com/questions/44692781/configure-spring-boot-to-redirect-404-to-a-single-page-app
  50          *
  51          * @param request
  52          *                     HttpServletRequest
  53          * @param response
  54          *                     HttpServletResponse
  55          * @throws IOException
  56          *                         On error
  57          */
  58         @RequestMapping(method = { RequestMethod.OPTIONS, RequestMethod.GET }, //
  59                         path = { "/catalog", "/control", "/stats", "/user" })
  60         public void forwardAngularRoutes(HttpServletRequest request, HttpServletResponse response) throws IOException {
  61                 URL url = new URL(request.getScheme(), request.getServerName(), request.getServerPort(), "/index.html");
  62                 if (logger.isDebugEnabled())
  63                         logger.debug("forwardAngularRoutes: {} redirected to {}", request.getRequestURI(), url);
  64                 response.sendRedirect(url.toString());
  65         }
  66
  67 }