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.security.access.annotation.Secured;
  35 import org.springframework.util.Assert;
  36 import org.springframework.web.bind.annotation.GetMapping;
  37 import org.springframework.web.bind.annotation.PutMapping;
  38 import org.springframework.web.bind.annotation.RequestBody;
  39 import org.springframework.web.bind.annotation.RequestMapping;
  40 import org.springframework.web.bind.annotation.RestController;
  41
  42 import com.fasterxml.jackson.databind.JsonNode;
  43
  44 import io.swagger.annotations.ApiOperation;
  45 import io.swagger.annotations.ApiParam;
  46
  47 /**
  48  * Proxies calls from the front end to the AC xApp via the A1 Mediator API.
  49  *
  50  * If a method throws RestClientResponseException, it is handled by
  51  * {@link CustomResponseEntityExceptionHandler#handleProxyMethodException(Exception, org.springframework.web.context.request.WebRequest)}
  52  * which returns status 502. All other exceptions are handled by Spring which
  53  * returns status 500.
  54  */
  55 @RestController
  56 @RequestMapping(value = AcXappController.CONTROLLER_PATH, produces = MediaType.APPLICATION_JSON_VALUE)
  57 public class AcXappController {
  58
  59         private static final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
  60
  61         // Publish paths in constants so tests are easy to write
  62         public static final String CONTROLLER_PATH = DashboardConstants.ENDPOINT_PREFIX + "/xapp/admctrl";
  63         // Endpoints
  64         public static final String POLICY_METHOD = "policy";
  65         public static final String VERSION_METHOD = DashboardConstants.VERSION_METHOD;
  66
  67         // A "control" is an element in the XApp descriptor
  68         private static final String AC_CONTROL_NAME = "admission_control_policy";
  69
  70         // Populated by the autowired constructor
  71         private final A1MediatorApi a1MediatorApi;
  72
  73         @Autowired
  74         public AcXappController(final A1MediatorApi a1MediatorApi) {
  75                 Assert.notNull(a1MediatorApi, "API must not be null");
  76                 this.a1MediatorApi = a1MediatorApi;
  77                 if (logger.isDebugEnabled())
  78                         logger.debug("ctor: configured with client type {}", a1MediatorApi.getClass().getName());
  79         }
  80
  81         @ApiOperation(value = "Gets the A1 client library MANIFEST.MF property Implementation-Version.", response = SuccessTransport.class)
  82         @GetMapping(VERSION_METHOD)
  83         // No role required
  84         public SuccessTransport getA1MediatorClientVersion() {
  85                 return new SuccessTransport(200, DashboardApplication.getImplementationVersion(A1MediatorApi.class));
  86         }
  87
  88         /*
  89          * GET policy is not supported at present by A1 Mediator! Always returns 501.
  90          */
  91         @ApiOperation(value = "Gets the admission control policy for AC xApp via the A1 Mediator")
  92         @GetMapping(POLICY_METHOD)
  93         @Secured({ DashboardConstants.ROLE_ADMIN, DashboardConstants.ROLE_STANDARD })
  94         public Object getAdmissionControlPolicy(HttpServletResponse response) {
  95                 logger.debug("getAdmissionControlPolicy");
  96                 response.setStatus(HttpServletResponse.SC_NOT_IMPLEMENTED);
  97                 return null;
  98         }
  99
 100         /*
 101          * This controller is deliberately kept ignorant of the data expected by AC. The
 102          * fields are defined in the ACAdmissionIntervalControl Typescript interface.
 103          */
 104         @ApiOperation(value = "Sets the admission control policy for AC xApp via the A1 Mediator")
 105         @PutMapping(POLICY_METHOD)
 106         @Secured({ DashboardConstants.ROLE_ADMIN })
 107         public void putAdmissionControlPolicy(@ApiParam(value = "Admission control policy") @RequestBody JsonNode acPolicy, //
 108                         HttpServletResponse response) {
 109                 logger.debug("putAdmissionControlPolicy {}", acPolicy);
 110                 a1MediatorApi.a1ControllerPutHandler(AC_CONTROL_NAME, acPolicy);
 111                 response.setStatus(a1MediatorApi.getApiClient().getStatusCode().value());
 112         }
 113
 114 }