webapp-backend/src/main/java/org/oransc/ric/portal/dashboard/controller/AcXappController.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.HttpServletResponse;
  25
  26 import org.oransc.ric.a1med.client.api.A1MediatorApi;
  27 import org.oransc.ric.portal.dashboard.DashboardApplication;
  28 import org.oransc.ric.portal.dashboard.DashboardConstants;
  29 import org.oransc.ric.portal.dashboard.model.SuccessTransport;
  30 import org.slf4j.Logger;
  31 import org.slf4j.LoggerFactory;
  32 import org.springframework.beans.factory.annotation.Autowired;
  33 import org.springframework.http.MediaType;
  34 import org.springframework.util.Assert;
  35 import org.springframework.web.bind.annotation.RequestBody;
  36 import org.springframework.web.bind.annotation.RequestMapping;
  37 import org.springframework.web.bind.annotation.RequestMethod;
  38 import org.springframework.web.bind.annotation.RestController;
  39
  40 import com.fasterxml.jackson.databind.JsonNode;
  41
  42 import io.swagger.annotations.ApiOperation;
  43 import io.swagger.annotations.ApiParam;
  44
  45 /**
  46  * * Proxies calls from the front end to the AC xApp via the A1 Mediator API.
  47  * All methods answer 502 on failure: <blockquote>HTTP server received an
  48  * invalid response from a server it consulted when acting as a proxy or
  49  * gateway.</blockquote>
  50  */
  51 @RestController
  52 @RequestMapping(value = AcXappController.CONTROLLER_PATH, produces = MediaType.APPLICATION_JSON_VALUE)
  53 public class AcXappController {
  54
  55         private static final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
  56
  57         // Publish paths in constants so tests are easy to write
  58         public static final String CONTROLLER_PATH = DashboardConstants.ENDPOINT_PREFIX + "/xapp/ac";
  59         // Endpoints
  60         public static final String ADMCTRL_METHOD = "/admctrl";
  61
  62         // A "control" is an element in the XApp descriptor
  63         private static final String AC_CONTROL_NAME = "admission_control_policy";
  64
  65         // Populated by the autowired constructor
  66         private final A1MediatorApi a1MediatorApi;
  67
  68         @Autowired
  69         public AcXappController(final A1MediatorApi a1MediatorApi) {
  70                 Assert.notNull(a1MediatorApi, "API must not be null");
  71                 this.a1MediatorApi = a1MediatorApi;
  72                 if (logger.isDebugEnabled())
  73                         logger.debug("ctor: configured with client type {}", a1MediatorApi.getClass().getName());
  74         }
  75
  76         @ApiOperation(value = "Gets the A1 client library MANIFEST.MF property Implementation-Version.", response = SuccessTransport.class)
  77         @RequestMapping(value = DashboardConstants.VERSION_METHOD, method = RequestMethod.GET)
  78         public SuccessTransport getA1MediatorClientVersion() {
  79                 return new SuccessTransport(200, DashboardApplication.getImplementationVersion(A1MediatorApi.class));
  80         }
  81
  82         /*
  83          * GET policy is not supported at present by A1 Mediator! Always returns 501.
  84          */
  85         @ApiOperation(value = "Gets the admission control policy for AC xApp via the A1 Mediator")
  86         @RequestMapping(value = ADMCTRL_METHOD, method = RequestMethod.GET)
  87         public Object getAdmissionControlPolicy(HttpServletResponse response) {
  88                 logger.debug("getAdmissionControlPolicy");
  89                 response.setStatus(HttpServletResponse.SC_NOT_IMPLEMENTED);
  90                 return null;
  91         }
  92
  93         /*
  94          * This controller is deliberately kept ignorant of the data expected by AC. The
  95          * fields are defined in the ACAdmissionIntervalControl Typescript interface.
  96          */
  97         @ApiOperation(value = "Sets the admission control policy for AC xApp via the A1 Mediator")
  98         @RequestMapping(value = ADMCTRL_METHOD, method = RequestMethod.PUT)
  99         public void setAdmissionControlPolicy(@ApiParam(value = "Admission control policy") @RequestBody JsonNode acPolicy, //
 100                         HttpServletResponse response) {
 101                 logger.debug("setAdmissionControlPolicy {}", acPolicy);
 102                 a1MediatorApi.a1ControllerPutHandler(AC_CONTROL_NAME, acPolicy);
 103                 response.setStatus(a1MediatorApi.getApiClient().getStatusCode().value());
 104         }
 105
 106 }