Allow browser refresh on known Angular routes
[portal/ric-dashboard.git] / 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 and Nokia
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.lang.invoke.MethodHandles;
23
24 import javax.servlet.http.HttpServletRequest;
25
26 import org.slf4j.Logger;
27 import org.slf4j.LoggerFactory;
28 import org.springframework.stereotype.Controller;
29 import org.springframework.web.bind.annotation.RequestMapping;
30 import org.springframework.web.bind.annotation.RequestMethod;
31
32 /**
33  * Listens for requests to known Angular routes.
34  */
35 @Controller
36 public class Html5PathsController {
37
38         private static final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
39
40         /**
41          * Forwards the browser to the index (main) page upon request of a known route.
42          * This unfortunately requires duplication of the Angular route strings in the
43          * path mappings on this method. Could switch to a regex pattern instead someday
44          * if the routes change too often.
45          * 
46          * https://stackoverflow.com/questions/44692781/configure-spring-boot-to-redirect-404-to-a-single-page-app
47          * 
48          * @param request
49          *                    HttpServletRequest
50          * @return Forward directive to index.html
51          */
52         @RequestMapping(method = { RequestMethod.OPTIONS, RequestMethod.GET }, //
53                         path = { "/catalog", "/control", "/stats", "/user" })
54         public String forwardAngularRoutes(HttpServletRequest request) {
55                 logger.debug("forwardAngularRoutes: {}", request.getRequestURI());
56                 return "forward:/index.html";
57         }
58
59 }