2 * ========================LICENSE_START=================================
5 * Copyright (C) 2019 AT&T Intellectual Property and Nokia
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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===================================
20 package org.oransc.ric.portal.dashboard.controller;
22 import java.lang.invoke.MethodHandles;
24 import javax.servlet.http.HttpServletResponse;
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;
40 import com.fasterxml.jackson.databind.JsonNode;
42 import io.swagger.annotations.ApiOperation;
43 import io.swagger.annotations.ApiParam;
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>
52 @RequestMapping(value = DashboardConstants.ENDPOINT_PREFIX + "/xapp/ac", produces = MediaType.APPLICATION_JSON_VALUE)
53 public class AcXappController {
55 private static final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
57 // A "control" is an element in the XApp descriptor
58 private static final String AC_CONTROL_NAME = "admission_control_policy";
60 // Populated by the autowired constructor
61 private final A1MediatorApi a1MediatorApi;
64 public AcXappController(final A1MediatorApi a1MediatorApi) {
65 Assert.notNull(a1MediatorApi, "API must not be null");
66 this.a1MediatorApi = a1MediatorApi;
67 if (logger.isDebugEnabled())
68 logger.debug("ctor: configured with client type {}", a1MediatorApi.getClass().getName());
71 @ApiOperation(value = "Gets the A1 client library MANIFEST.MF property Implementation-Version.", response = SuccessTransport.class)
72 @RequestMapping(value = DashboardConstants.VERSION_PATH, method = RequestMethod.GET)
73 public SuccessTransport getA1MediatorClientVersion() {
74 return new SuccessTransport(200, DashboardApplication.getImplementationVersion(A1MediatorApi.class));
78 * GET policy is not supported at present by A1 Mediator! Always returns 501.
80 @ApiOperation(value = "Gets the admission control policy for AC xApp via the A1 Mediator")
81 @RequestMapping(value = "admctrl", method = RequestMethod.GET)
82 public Object getAdmissionControlPolicy(HttpServletResponse response) {
83 logger.debug("getAdmissionControlPolicy");
84 response.setStatus(HttpServletResponse.SC_NOT_IMPLEMENTED);
89 * This controller is deliberately kept ignorant of the data expected by AC. The
90 * fields are defined in the ACAdmissionIntervalControl Typescript interface.
92 @ApiOperation(value = "Sets the admission control policy for AC xApp via the A1 Mediator")
93 @RequestMapping(value = "catime", method = RequestMethod.PUT)
94 public void setAdmissionControlPolicy(@ApiParam(value = "Admission control policy") @RequestBody JsonNode acPolicy, //
95 HttpServletResponse response) {
96 logger.debug("setAdmissionControlPolicy {}", acPolicy);
97 a1MediatorApi.a1ControllerPutHandler(AC_CONTROL_NAME, acPolicy);
98 response.setStatus(a1MediatorApi.getApiClient().getStatusCode().value());