Merge "Upgrade E2 to API spec 20190611"
[portal/ric-dashboard.git] / webapp-backend / src / main / java / org / oransc / ric / portal / dashboard / controller / AcXappController.java
index 87a783c..3782656 100644 (file)
@@ -44,7 +44,7 @@ import io.swagger.annotations.ApiParam;
 
 /**
  * Provides methods to manage policies of the Admission Control xApp, which
- * initially defines just one. All requests go via the A1 Mediatior.
+ * initially defines just one. All requests go via the A1 Mediator.
  */
 @RestController
 @RequestMapping(value = DashboardConstants.ENDPOINT_PREFIX + "/xapp/ac", produces = MediaType.APPLICATION_JSON_VALUE)
@@ -52,7 +52,8 @@ public class AcXappController {
 
        private static final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
 
-       private static final String POLICY_CONTROL_ADMISSION_TIME = "control_admission_time";
+       // A "control" is an element in the XApp descriptor
+       private static final String AC_CONTROL_NAME = "admission_control_policy";
 
        // Populated by the autowired constructor
        private final A1MediatorApi a1MediatorApi;
@@ -65,34 +66,31 @@ public class AcXappController {
 
        @ApiOperation(value = "Gets the A1 client library MANIFEST.MF property Implementation-Version.", response = SuccessTransport.class)
        @RequestMapping(value = DashboardConstants.VERSION_PATH, method = RequestMethod.GET)
-       public SuccessTransport getVersion() {
-               logger.debug("getVersion enter");
+       public SuccessTransport getA1MediatorClientVersion() {
                return new SuccessTransport(200, DashboardApplication.getImplementationVersion(A1MediatorApi.class));
        }
 
        /*
-        * GET policy is not supported at present by A1 Mediator. Keeping this hidden
-        * until that changes.
-        *
-        * @ApiOperation(value =
-        * "Gets the named policy for AC xApp via the A1 Mediator")
-        * 
-        * @RequestMapping(value = "policy/{" + POLICY_NAME + "}", method =
-        * RequestMethod.GET) public Object getPolicy(@PathVariable(POLICY_NAME) String
-        * policyName) { logger.debug("getPolicy: policy {}", policyName);
-        * a1MediatorApi.a1ControllerGetHandler(policyName); return null; }
+        * GET policy is not supported at present by A1 Mediator! Always returns 501.
         */
+       @ApiOperation(value = "Gets the admission control policy for AC xApp via the A1 Mediator")
+       @RequestMapping(value = "admctrl", method = RequestMethod.GET)
+       public Object getAdmissionControlPolicy(HttpServletResponse response) {
+               logger.debug("getAdmissionControlPolicy");
+               response.setStatus(HttpServletResponse.SC_NOT_IMPLEMENTED);
+               return null;
+       }
 
        /*
-        * This controller is deliberately kept ignorant of the
-        * ACAdmissionIntervalControl data structure.
+        * This controller is deliberately kept ignorant of the data expected by AC. The
+        * fields are defined in the ACAdmissionIntervalControl Typescript interface.
         */
-       @ApiOperation(value = "Sets the control admission time for AC xApp via the A1 Mediator")
+       @ApiOperation(value = "Sets the admission control policy for AC xApp via the A1 Mediator")
        @RequestMapping(value = "catime", method = RequestMethod.PUT)
-       public void setControlAdmissionTime(@ApiParam(value = "Control admission time") @RequestBody JsonNode caTime, //
+       public void setAdmissionControlPolicy(@ApiParam(value = "Admission control policy") @RequestBody JsonNode acPolicy, //
                        HttpServletResponse response) {
-               logger.debug("setControlAdmissionTime {}", caTime);
-               a1MediatorApi.a1ControllerPutHandler(POLICY_CONTROL_ADMISSION_TIME, caTime);
+               logger.debug("setAdmissionControlPolicy {}", acPolicy);
+               a1MediatorApi.a1ControllerPutHandler(AC_CONTROL_NAME, acPolicy);
                response.setStatus(a1MediatorApi.getApiClient().getStatusCode().value());
        }