X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=webapp-backend%2Fsrc%2Fmain%2Fjava%2Forg%2Foransc%2Fric%2Fportal%2Fdashboard%2Fcontroller%2FAnrXappController.java;h=9faeff72ce6721f96b81a3a4853d84af02841bf1;hb=81c5a43871449332f9a9560c7cf25d07cf714d8e;hp=aa7b443fe189a719beadf7d1dbac41d519fed8da;hpb=21f98d01948dabb1d6a89b60f5694969e42c9e63;p=portal%2Fric-dashboard.git diff --git a/webapp-backend/src/main/java/org/oransc/ric/portal/dashboard/controller/AnrXappController.java b/webapp-backend/src/main/java/org/oransc/ric/portal/dashboard/controller/AnrXappController.java index aa7b443f..9faeff72 100644 --- a/webapp-backend/src/main/java/org/oransc/ric/portal/dashboard/controller/AnrXappController.java +++ b/webapp-backend/src/main/java/org/oransc/ric/portal/dashboard/controller/AnrXappController.java @@ -25,8 +25,8 @@ import javax.servlet.http.HttpServletResponse; import org.oransc.ric.anrxapp.client.api.HealthApi; import org.oransc.ric.anrxapp.client.api.NcrtApi; -import org.oransc.ric.anrxapp.client.model.NeighborCellRelationDelTable; -import org.oransc.ric.anrxapp.client.model.NeighborCellRelationModTable; +import org.oransc.ric.anrxapp.client.model.GgNodeBTable; +import org.oransc.ric.anrxapp.client.model.NeighborCellRelationMod; import org.oransc.ric.anrxapp.client.model.NeighborCellRelationTable; import org.oransc.ric.portal.dashboard.DashboardApplication; import org.oransc.ric.portal.dashboard.DashboardConstants; @@ -36,6 +36,7 @@ import org.slf4j.LoggerFactory; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.context.annotation.Configuration; import org.springframework.http.MediaType; +import org.springframework.http.ResponseEntity; import org.springframework.util.Assert; import org.springframework.web.bind.annotation.PathVariable; import org.springframework.web.bind.annotation.RequestBody; @@ -43,6 +44,7 @@ import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RequestMethod; import org.springframework.web.bind.annotation.RequestParam; import org.springframework.web.bind.annotation.RestController; +import org.springframework.web.client.HttpStatusCodeException; import io.swagger.annotations.ApiOperation; @@ -57,91 +59,125 @@ public class AnrXappController { private static final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass()); - private static final String CELL_ID = "cellIdentifier"; - private static final String GGNBID = "ggnbId"; - private static final String START_INDEX = "startIndex"; - private static final String LIMIT = "limit"; - private static final String NRPCI = "neighborCellIdentifierNrpci"; - private static final String NRCGI = "neighborCellIdentifierNrcgi"; + // Query parameters + private static final String QP_NODEB = "ggnodeb"; + private static final String QP_SERVING = "servingCellNrcgi"; + private static final String QP_NEIGHBOR = "neighborCellNrpci"; + // Path parameters + private static final String PP_SERVING = "servingcells"; + private static final String PP_NEIGHBOR = "neighborcells"; // Populated by the autowired constructor private final HealthApi healthApi; private final NcrtApi ncrtApi; @Autowired - public AnrXappController(final HealthApi healthApi, final NcrtApi ncrtApi) { - Assert.notNull(healthApi, "API must not be null"); - Assert.notNull(ncrtApi, "API must not be null"); - this.healthApi = healthApi; - this.ncrtApi = ncrtApi; + public AnrXappController(final HealthApi anrHealthApi, final NcrtApi anrNcrtApi) { + Assert.notNull(anrHealthApi, "API must not be null"); + Assert.notNull(anrNcrtApi, "API must not be null"); + this.healthApi = anrHealthApi; + this.ncrtApi = anrNcrtApi; + if (logger.isDebugEnabled()) + logger.debug("ctor: configured with client types {} and {}", anrHealthApi.getClass().getName(), + anrNcrtApi.getClass().getName()); } @ApiOperation(value = "Gets the ANR 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 getAnrXappClientVersion() { return new SuccessTransport(200, DashboardApplication.getImplementationVersion(HealthApi.class)); } @ApiOperation(value = "Performs a liveness probe on the ANR xApp, result expressed as the response code.") @RequestMapping(value = "/health/alive", method = RequestMethod.GET) - public void getHealthAlive(HttpServletResponse response) { + public Object getHealthAlive(HttpServletResponse response) { logger.debug("getHealthAlive"); - healthApi.getHealthAlive(); - response.setStatus(healthApi.getApiClient().getStatusCode().value()); + try { + healthApi.getHealthAlive(); + response.setStatus(healthApi.getApiClient().getStatusCode().value()); + return null; + } catch (HttpStatusCodeException ex) { + logger.warn("getHealthAlive failed: {}", ex.toString()); + return ResponseEntity.status(HttpServletResponse.SC_BAD_GATEWAY).body(ex.getResponseBodyAsString()); + } } @ApiOperation(value = "Performs a readiness probe on the ANR xApp, result expressed as the response code.") @RequestMapping(value = "/health/ready", method = RequestMethod.GET) - public void getHealthReady(HttpServletResponse response) { + public Object getHealthReady(HttpServletResponse response) { logger.debug("getHealthReady"); - healthApi.getHealthReady(); - response.setStatus(healthApi.getApiClient().getStatusCode().value()); + try { + healthApi.getHealthReady(); + response.setStatus(healthApi.getApiClient().getStatusCode().value()); + return null; + } catch (HttpStatusCodeException ex) { + logger.warn("getHealthAlive failed: {}", ex.toString()); + return ResponseEntity.status(HttpServletResponse.SC_BAD_GATEWAY).body(ex.getResponseBodyAsString()); + } } - @ApiOperation(value = "Query NCRT of all cells, all or one gNB(s)", response = NeighborCellRelationTable.class) - @RequestMapping(value = "/cell", method = RequestMethod.GET) - public NeighborCellRelationTable getNcrtInfo( // - @RequestParam(name = GGNBID, required = false) String ggnbId, // - @RequestParam(name = START_INDEX, required = false) String startIndex, // - @RequestParam(name = LIMIT, required = false) Integer limit) { - logger.debug("queryNcrtAllCells: ggnbid {}, startIndex {} limit {}", ggnbId, startIndex, limit); - return ncrtApi.getNcrtInfo(ggnbId, startIndex, limit); + @ApiOperation(value = "Returns list of gNodeB IDs based on NCRT in ANR", response = GgNodeBTable.class) + @RequestMapping(value = "/gnodebs", method = RequestMethod.GET) + public Object getGnodebs() { + logger.debug("getGnodebs"); + try { + return ncrtApi.getgNodeB(); + } catch (HttpStatusCodeException ex) { + logger.warn("getGnodebs failed: {}", ex.toString()); + return ResponseEntity.status(HttpServletResponse.SC_BAD_GATEWAY).body(ex.getResponseBodyAsString()); + } } - @ApiOperation(value = "Query NCRT of a single serving cell", response = NeighborCellRelationTable.class) - @RequestMapping(value = "/cell/" + CELL_ID + "/{" + CELL_ID + "}", method = RequestMethod.GET) - public NeighborCellRelationTable getCellNcrtInfo(@PathVariable(CELL_ID) String cellIdentifier, // - @RequestParam(name = START_INDEX, required = false) String startIndex, // - @RequestParam(name = LIMIT, required = false) Integer limit, - @RequestParam(name = NRPCI, required = false) String nrpci, - @RequestParam(name = NRCGI, required = false) String nrcgi) { - logger.debug("queryNcrtAllCells: cellIdentifier {}, startIndex {} limit {} nrpci {} nrcgi {}", cellIdentifier, - startIndex, limit, nrpci, nrcgi); - return ncrtApi.getCellNcrtInfo(cellIdentifier, startIndex, limit, nrpci, nrcgi); + @ApiOperation(value = "Returns neighbor cell relation table for all gNodeBs or based on query parameters", response = NeighborCellRelationTable.class) + @RequestMapping(value = "/ncrt", method = RequestMethod.GET) + public Object getNcrt( // + @RequestParam(name = QP_NODEB, required = false) String ggnbId, // + @RequestParam(name = QP_SERVING, required = false) String servingCellNrcgi, // + @RequestParam(name = QP_NEIGHBOR, required = false) String neighborCellNrpci) { + logger.debug("getNcrt: ggnbid {}, servingCellNrpci {}, neighborCellNrcgi {}", ggnbId, servingCellNrcgi, + neighborCellNrpci); + try { + return ncrtApi.getNcrt(ggnbId, servingCellNrcgi, neighborCellNrpci); + } catch (HttpStatusCodeException ex) { + logger.warn("getNcrt failed: {}", ex.toString()); + return ResponseEntity.status(HttpServletResponse.SC_BAD_GATEWAY).body(ex.getResponseBodyAsString()); + } } - @ApiOperation(value = "Modify neighbor cell relation based on Source Cell NR CGI and Target Cell NR PCI / NR CGI") - @RequestMapping(value = "/cell/" + CELL_ID + "/{" + CELL_ID + "}", method = RequestMethod.PUT) - public void modifyNcrt(@PathVariable(CELL_ID) String cellIdentifier, // - @RequestBody NeighborCellRelationModTable ncrtModTable, // - HttpServletResponse response) { - logger.debug("modifyNcrt: cellIdentifier {} modTable {}", cellIdentifier, ncrtModTable); - ncrtApi.modifyNcrt(cellIdentifier, ncrtModTable); - response.setStatus(healthApi.getApiClient().getStatusCode().value()); + // /ncrt/servingcells/{servCellNrcgi}/neighborcells/{neighCellNrpci} : + @ApiOperation(value = "Modify neighbor cell relation based on Serving Cell NRCGI and Neighbor Cell NRPCI") + @RequestMapping(value = "/ncrt/" + PP_SERVING + "/{" + PP_SERVING + "}/" + PP_NEIGHBOR + "/{" + PP_NEIGHBOR + + "}", method = RequestMethod.PUT) + public Object modifyNcrt(@PathVariable(PP_SERVING) String servingCellNrcgi, // + @PathVariable(PP_NEIGHBOR) String neighborCellNrpci, // + @RequestBody NeighborCellRelationMod ncrMod, HttpServletResponse response) { + logger.debug("modifyNcrt: servingCellNrcgi {}, neighborCellNrpci {}, ncrMod {}", servingCellNrcgi, + neighborCellNrpci, ncrMod); + try { + ncrtApi.modifyNcrt(servingCellNrcgi, neighborCellNrpci, ncrMod); + response.setStatus(healthApi.getApiClient().getStatusCode().value()); + return null; + } catch (HttpStatusCodeException ex) { + logger.warn("modifyNcrt failed: {}", ex.toString()); + return ResponseEntity.status(HttpServletResponse.SC_BAD_GATEWAY).body(ex.getResponseBodyAsString()); + } } - /* - * TODO: DELETE should not have a body - the path should identify the resource to be deleted. - */ - @ApiOperation(value = "Delete neighbor cell relation based on Source Cell NR CGI and Target Cell NR PCI / NR CGI") - @RequestMapping(value = "/cell/" + CELL_ID + "/{" + CELL_ID + "}", method = RequestMethod.DELETE) - public void deleteNcrt(@PathVariable(CELL_ID) String cellIdentifier, // - @RequestBody NeighborCellRelationDelTable ncrtDelTable, // + @ApiOperation(value = "Delete neighbor cell relation based on Serving Cell NRCGI and Neighbor Cell NRPCI") + @RequestMapping(value = "/ncrt/" + PP_SERVING + "/{" + PP_SERVING + "}/" + PP_NEIGHBOR + "/{" + PP_NEIGHBOR + + "}", method = RequestMethod.DELETE) + public Object deleteNcrt(@PathVariable(PP_SERVING) String servingCellNrcgi, // + @PathVariable(PP_NEIGHBOR) String neighborCellNrpci, // HttpServletResponse response) { - logger.debug("modifyNcrt: cellIdentifier {} delTable {}", cellIdentifier, ncrtDelTable); - ncrtApi.deleteNcrt(cellIdentifier, ncrtDelTable); - response.setStatus(healthApi.getApiClient().getStatusCode().value()); + logger.debug("deleteNcrt: servingCellNrcgi {}, neighborCellNrpci {}", servingCellNrcgi, neighborCellNrpci); + try { + ncrtApi.deleteNcrt(servingCellNrcgi, neighborCellNrpci); + response.setStatus(healthApi.getApiClient().getStatusCode().value()); + return null; + } catch (HttpStatusCodeException ex) { + logger.warn("modifyNcrt failed: {}", ex.toString()); + return ResponseEntity.status(HttpServletResponse.SC_BAD_GATEWAY).body(ex.getResponseBodyAsString()); + } } }