import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.MediaType;
import org.springframework.util.Assert;
+import org.springframework.web.bind.annotation.GetMapping;
+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.RequestMethod;
import org.springframework.web.bind.annotation.RestController;
import com.fasterxml.jackson.databind.JsonNode;
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.
+ * * Proxies calls from the front end to the AC xApp via the A1 Mediator API.
+ * All methods answer 502 on failure: <blockquote>HTTP server received an
+ * invalid response from a server it consulted when acting as a proxy or
+ * gateway.</blockquote>
*/
@RestController
-@RequestMapping(value = DashboardConstants.ENDPOINT_PREFIX + "/xapp/ac", produces = MediaType.APPLICATION_JSON_VALUE)
+@RequestMapping(value = AcXappController.CONTROLLER_PATH, produces = MediaType.APPLICATION_JSON_VALUE)
public class AcXappController {
private static final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
- private static final String POLICY_CONTROL_ADMISSION_TIME = "control_admission_time";
+ // Publish paths in constants so tests are easy to write
+ public static final String CONTROLLER_PATH = DashboardConstants.ENDPOINT_PREFIX + "/xapp/ac";
+ // Endpoints
+ public static final String ADMCTRL_METHOD = "/admctrl";
+ public static final String VERSION_METHOD = DashboardConstants.VERSION_METHOD;
+
+ // 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;
public AcXappController(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)
- @RequestMapping(value = DashboardConstants.VERSION_PATH, method = RequestMethod.GET)
- public SuccessTransport getVersion() {
- logger.debug("getVersion enter");
+ @GetMapping(VERSION_METHOD)
+ 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")
+ @GetMapping(ADMCTRL_METHOD)
+ 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")
- @RequestMapping(value = "catime", method = RequestMethod.PUT)
- public void setControlAdmissionTime(@ApiParam(value = "Control admission time") @RequestBody JsonNode caTime, //
+ @ApiOperation(value = "Sets the admission control policy for AC xApp via the A1 Mediator")
+ @PutMapping(ADMCTRL_METHOD)
+ 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());
}