dashboard/webapp-backend/src/main/java/org/oransc/ric/portal/dashboard/config/PortalApiConfiguration.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.config;
  21
  22 import java.lang.invoke.MethodHandles;
  23
  24 import org.onap.portalsdk.core.onboarding.crossapi.PortalRestAPIProxy;
  25 import org.onap.portalsdk.core.onboarding.util.PortalApiConstants;
  26 import org.slf4j.Logger;
  27 import org.slf4j.LoggerFactory;
  28 import org.springframework.boot.web.servlet.ServletRegistrationBean;
  29 import org.springframework.context.annotation.Bean;
  30 import org.springframework.context.annotation.Configuration;
  31
  32 @Configuration
  33 /**
  34  * This is not restricted to test or !test profile, it's always active, the same
  35  * servlet configuration is usable in production and test. This also means there
  36  * is no PortalApiMockConfiguration class in the test area.
  37  */
  38 public class PortalApiConfiguration {
  39
  40         private static final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
  41
  42         /**
  43          * Instantiates the EPSDK-FW servlet that implements the API called by Portal.
  44          * Needed because this app is not configured to scan the EPSDK-FW packages;
  45          * there's also a chance that Spring-Boot does not automatically
  46          * process @WebServlet annotations.
  47          *
  48          * @return Servlet registration bean for the Portal Rest API proxy servlet.
  49          */
  50         @Bean
  51         public ServletRegistrationBean<PortalRestAPIProxy> portalApiProxyServletBean() {
  52                 logger.debug("portalApiProxyServletBean");
  53                 PortalRestAPIProxy servlet = new PortalRestAPIProxy();
  54                 final ServletRegistrationBean<PortalRestAPIProxy> servletBean = new ServletRegistrationBean<>(servlet,
  55                                 PortalApiConstants.API_PREFIX + "/*");
  56                 servletBean.setName("PortalRestApiProxyServlet");
  57                 return servletBean;
  58         }
  59
  60 }