/*- * ========================LICENSE_START================================= * O-RAN-SC * %% * Copyright (C) 2019 AT&T Intellectual Property and Nokia * %% * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. * ========================LICENSE_END=================================== */ package org.oransc.ric.portal.dashboard.controller; import java.lang.invoke.MethodHandles; import javax.servlet.http.HttpServletResponse; import org.oransc.ric.portal.dashboard.DashboardApplication; import org.oransc.ric.portal.dashboard.DashboardConstants; import org.oransc.ric.portal.dashboard.model.SuccessTransport; import org.oransc.ric.xappmgr.client.api.HealthApi; import org.oransc.ric.xappmgr.client.api.XappApi; import org.oransc.ric.xappmgr.client.model.AllXapps; import org.oransc.ric.xappmgr.client.model.XAppInfo; import org.oransc.ric.xappmgr.client.model.Xapp; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.context.annotation.Configuration; import org.springframework.http.MediaType; import org.springframework.http.ResponseEntity; import org.springframework.util.Assert; import org.springframework.web.bind.annotation.PathVariable; import org.springframework.web.bind.annotation.RequestBody; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RequestMethod; import org.springframework.web.bind.annotation.RestController; import org.springframework.web.client.HttpStatusCodeException; import io.swagger.annotations.ApiOperation; /** * Proxies calls from the front end to the xApp Manager API. All methods answer * 502 on failure:
HTTP server received an invalid response from a * server it consulted when acting as a proxy or gateway.
*/ @Configuration @RestController @RequestMapping(value = DashboardConstants.ENDPOINT_PREFIX + "/xappmgr", produces = MediaType.APPLICATION_JSON_VALUE) public class XappManagerController { private static final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass()); // Populated by the autowired constructor private final HealthApi healthApi; private final XappApi xappApi; @Autowired public XappManagerController(final HealthApi healthApi, final XappApi xappApi) { Assert.notNull(healthApi, "health API must not be null"); Assert.notNull(xappApi, "xapp API must not be null"); this.healthApi = healthApi; this.xappApi = xappApi; if (logger.isDebugEnabled()) logger.debug("ctor: configured with client types {} and {}", healthApi.getClass().getName(), xappApi.getClass().getName()); } @ApiOperation(value = "Gets the XApp manager client library MANIFEST.MF property Implementation-Version.", response = SuccessTransport.class) @RequestMapping(value = DashboardConstants.VERSION_PATH, method = RequestMethod.GET) public SuccessTransport getXappManagerClientVersion() { return new SuccessTransport(200, DashboardApplication.getImplementationVersion(HealthApi.class)); } @ApiOperation(value = "Calls the xApp Manager liveness health check.") @RequestMapping(value = "/health/alive", method = RequestMethod.GET) public Object getHealth(HttpServletResponse response) { logger.debug("getHealthAlive"); try { healthApi.getHealthAlive(); response.setStatus(healthApi.getApiClient().getStatusCode().value()); return null; } catch (HttpStatusCodeException ex) { logger.warn("getHealthAlive failed: {}", ex.toString()); return ResponseEntity.status(HttpServletResponse.SC_BAD_GATEWAY).body(ex.getResponseBodyAsString()); } } @ApiOperation(value = "Calls the xApp Manager readiness health check.") @RequestMapping(value = "/health/ready", method = RequestMethod.GET) public Object getHealthReady(HttpServletResponse response) { logger.debug("getHealthReady"); try { healthApi.getHealthReady(); response.setStatus(healthApi.getApiClient().getStatusCode().value()); return null; } catch (HttpStatusCodeException ex) { logger.warn("getHealthReady failed: {}", ex.toString()); return ResponseEntity.status(HttpServletResponse.SC_BAD_GATEWAY).body(ex.getResponseBodyAsString()); } } @ApiOperation(value = "Calls the xApp Manager to get the list of xApps.", response = AllXapps.class) @RequestMapping(value = "/xapps", method = RequestMethod.GET) public Object getAllXapps() { logger.debug("getAllXapps"); try { return xappApi.getAllXapps(); } catch (HttpStatusCodeException ex) { logger.warn("getAllXapps failed: {}", ex.toString()); return ResponseEntity.status(HttpServletResponse.SC_BAD_GATEWAY).body(ex.getResponseBodyAsString()); } } @ApiOperation(value = "Calls the xApp Manager to get the named xApp.", response = Xapp.class) @RequestMapping(value = "/xapps/{xAppName}", method = RequestMethod.GET) public Object getXapp(@PathVariable("xAppName") String xAppName) { logger.debug("getXapp {}", xAppName); try { return xappApi.getXappByName(xAppName); } catch (HttpStatusCodeException ex) { logger.warn("getXapp failed: {}", ex.toString()); return ResponseEntity.status(HttpServletResponse.SC_BAD_GATEWAY).body(ex.getResponseBodyAsString()); } } @ApiOperation(value = "Calls the xApp Manager to deploy the specified Xapp.", response = Xapp.class) @RequestMapping(value = "/xapps", method = RequestMethod.POST) public Object deployXapp(@RequestBody XAppInfo xAppInfo) { logger.debug("deployXapp {}", xAppInfo); try { return xappApi.deployXapp(xAppInfo); } catch (HttpStatusCodeException ex) { logger.warn("deployXapp failed: {}", ex.toString()); return ResponseEntity.status(HttpServletResponse.SC_BAD_GATEWAY).body(ex.getResponseBodyAsString()); } } @ApiOperation(value = "Calls the xApp Manager to undeploy the named Xapp.") @RequestMapping(value = "/xapps/{xAppName}", method = RequestMethod.DELETE) public Object undeployXapp(@PathVariable("xAppName") String xAppName, HttpServletResponse response) { logger.debug("undeployXapp {}", xAppName); try { xappApi.undeployXapp(xAppName); response.setStatus(healthApi.getApiClient().getStatusCode().value()); return null; } catch (HttpStatusCodeException ex) { logger.warn("undeployXapp failed: {}", ex.toString()); return ResponseEntity.status(HttpServletResponse.SC_BAD_GATEWAY).body(ex.getResponseBodyAsString()); } } }