Use new get method from A1 API for AC policy

[portal/ric-dashboard.git] / webapp-backend / src / main / java / org / oransc / ric / portal / dashboard / controller / A1MediatorController.java

diff --git a/webapp-backend/src/main/java/org/oransc/ric/portal/dashboard/controller/A1MediatorController.java b/webapp-backend/src/main/java/org/oransc/ric/portal/dashboard/controller/A1MediatorController.java
new file mode 100644 (file)
index 0000000..a1180f6
--- /dev/null
+++ b/webapp-backend/src/main/java/org/oransc/ric/portal/dashboard/controller/A1MediatorController.java
@@ -0,0 +1,111 @@
+/*-
+ * ========================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.a1med.client.api.A1MediatorApi;
+import org.oransc.ric.portal.dashboard.DashboardApplication;
+import org.oransc.ric.portal.dashboard.DashboardConstants;
+import org.oransc.ric.portal.dashboard.model.SuccessTransport;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.http.MediaType;
+import org.springframework.security.access.annotation.Secured;
+import org.springframework.util.Assert;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.PathVariable;
+import org.springframework.web.bind.annotation.PutMapping;
+import org.springframework.web.bind.annotation.RequestBody;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+import io.swagger.annotations.ApiOperation;
+import io.swagger.annotations.ApiParam;
+
+/**
+ * Proxies calls from the front end to the A1 Mediator API to get and put
+ * policies. The first application managed via this path is Admission Control.
+ * 
+ * If a method throws RestClientResponseException, it is handled by
+ * {@link CustomResponseEntityExceptionHandler#handleProxyMethodException(Exception, org.springframework.web.context.request.WebRequest)}
+ * which returns status 502. All other exceptions are handled by Spring which
+ * returns status 500.
+ */
+@RestController
+@RequestMapping(value = A1MediatorController.CONTROLLER_PATH, produces = MediaType.APPLICATION_JSON_VALUE)
+public class A1MediatorController {
+
+       private static final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
+
+       // Publish paths in constants so tests are easy to write
+       public static final String CONTROLLER_PATH = DashboardConstants.ENDPOINT_PREFIX + "/a1-p";
+       // Endpoints
+       public static final String VERSION_METHOD = DashboardConstants.VERSION_METHOD;
+       // Path parameters
+       public static final String PP_POLICIES = "policies";
+
+       // Populated by the autowired constructor
+       private final A1MediatorApi a1MediatorApi;
+
+       @Autowired
+       public A1MediatorController(final A1MediatorApi a1MediatorApi) {
+               Assert.notNull(a1MediatorApi, "API must not be null");
+               this.a1MediatorApi = a1MediatorApi;
+               if (logger.isDebugEnabled())
+                       logger.debug("ctor: configured with client type {}", a1MediatorApi.getClass().getName());
+       }
+
+       @ApiOperation(value = "Gets the A1 client library MANIFEST.MF property Implementation-Version.", response = SuccessTransport.class)
+       @GetMapping(VERSION_METHOD)
+       // No role required
+       public SuccessTransport getA1MediatorClientVersion() {
+               return new SuccessTransport(200, DashboardApplication.getImplementationVersion(A1MediatorApi.class));
+       }
+
+       /*
+        * This method is deliberately kept ignorant of the data passing thru.
+        */
+       @ApiOperation(value = "Gets the specified policy from the A1 Mediator")
+       @GetMapping(PP_POLICIES + "/{" + PP_POLICIES + "}")
+       @Secured({ DashboardConstants.ROLE_ADMIN, DashboardConstants.ROLE_STANDARD })
+       public Object getPolicy(@PathVariable(PP_POLICIES) String policyName) {
+               logger.debug("getPolicy {}", policyName);
+               return a1MediatorApi.a1ControllerGetHandler(policyName);
+       }
+
+       /*
+        * This method is deliberately kept ignorant of the data passing thru.
+        */
+       @ApiOperation(value = "Puts the specified policy to the A1 Mediator")
+       @PutMapping(PP_POLICIES + "/{" + PP_POLICIES + "}")
+       @Secured({ DashboardConstants.ROLE_ADMIN })
+       public void putPolicy(@PathVariable(PP_POLICIES) String policyName,
+                       @ApiParam(value = "Policy body") @RequestBody String policy, //
+                       HttpServletResponse response) {
+               logger.debug("putPolicy name {} value {}", policyName, policy);
+               a1MediatorApi.a1ControllerPutHandler(policyName, policy);
+               response.setStatus(a1MediatorApi.getApiClient().getStatusCode().value());
+       }
+
+}