webapp-backend/src/main/java/org/oransc/ric/portal/dashboard/controller/AnrXappController.java

   1 /*-
   2  * ========================LICENSE_START=================================
   3  * O-RAN-SC
   4  * %%
   5  * Copyright (C) 2019 AT&T Intellectual Property and Nokia
   6  * %%
   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
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  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===================================
  19  */
  20 package org.oransc.ric.portal.dashboard.controller;
  21
  22 import java.lang.invoke.MethodHandles;
  23
  24 import javax.servlet.http.HttpServletResponse;
  25
  26 import org.oransc.ric.anrxapp.client.api.HealthApi;
  27 import org.oransc.ric.anrxapp.client.api.NcrtApi;
  28 import org.oransc.ric.anrxapp.client.model.GgNodeBTable;
  29 import org.oransc.ric.anrxapp.client.model.NeighborCellRelationMod;
  30 import org.oransc.ric.anrxapp.client.model.NeighborCellRelationTable;
  31 import org.oransc.ric.portal.dashboard.DashboardApplication;
  32 import org.oransc.ric.portal.dashboard.DashboardConstants;
  33 import org.oransc.ric.portal.dashboard.model.SuccessTransport;
  34 import org.slf4j.Logger;
  35 import org.slf4j.LoggerFactory;
  36 import org.springframework.beans.factory.annotation.Autowired;
  37 import org.springframework.context.annotation.Configuration;
  38 import org.springframework.http.MediaType;
  39 import org.springframework.util.Assert;
  40 import org.springframework.web.bind.annotation.PathVariable;
  41 import org.springframework.web.bind.annotation.RequestBody;
  42 import org.springframework.web.bind.annotation.RequestMapping;
  43 import org.springframework.web.bind.annotation.RequestMethod;
  44 import org.springframework.web.bind.annotation.RequestParam;
  45 import org.springframework.web.bind.annotation.RestController;
  46
  47 import io.swagger.annotations.ApiOperation;
  48
  49 /**
  50  * Provides methods to contact the ANR xApp which manages a Neighbor Cell
  51  * Relation Table (NCRT).
  52  */
  53 @Configuration
  54 @RestController
  55 @RequestMapping(value = AnrXappController.CONTROLLER_PATH, produces = MediaType.APPLICATION_JSON_VALUE)
  56 public class AnrXappController {
  57
  58         private static final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
  59
  60         // Publish paths in constants so tests are easy to write
  61         public static final String CONTROLLER_PATH = DashboardConstants.ENDPOINT_PREFIX + "/xapp/anr";
  62         // Endpoints
  63         public static final String HEALTH_ALIVE_METHOD = "/health/alive";
  64         public static final String HEALTH_READY_METHOD = "/health/ready";
  65         public static final String GNODEBS_METHOD = "/gnodebs";
  66         public static final String NCRT_METHOD = "/ncrt";
  67         public static final String VERSION_METHOD = DashboardConstants.VERSION_METHOD;
  68
  69         // Path parameters
  70         public static final String PP_SERVING = "servingcells";
  71         public static final String PP_NEIGHBOR = "neighborcells";
  72         // Query parameters
  73         public static final String QP_NODEB = "ggnodeb";
  74         public static final String QP_SERVING = "servingCellNrcgi";
  75         public static final String QP_NEIGHBOR = "neighborCellNrpci";
  76
  77         // Populated by the autowired constructor
  78         private final HealthApi healthApi;
  79         private final NcrtApi ncrtApi;
  80
  81         @Autowired
  82         public AnrXappController(final HealthApi anrHealthApi, final NcrtApi anrNcrtApi) {
  83                 Assert.notNull(anrHealthApi, "API must not be null");
  84                 Assert.notNull(anrNcrtApi, "API must not be null");
  85                 this.healthApi = anrHealthApi;
  86                 this.ncrtApi = anrNcrtApi;
  87                 if (logger.isDebugEnabled())
  88                         logger.debug("ctor: configured with client types {} and {}", anrHealthApi.getClass().getName(),
  89                                         anrNcrtApi.getClass().getName());
  90         }
  91
  92         @ApiOperation(value = "Gets the ANR client library MANIFEST.MF property Implementation-Version.", response = SuccessTransport.class)
  93         @RequestMapping(value = VERSION_METHOD, method = RequestMethod.GET)
  94         public SuccessTransport getClientVersion() {
  95                 return new SuccessTransport(200, DashboardApplication.getImplementationVersion(HealthApi.class));
  96         }
  97
  98         @ApiOperation(value = "Performs a liveness probe on the ANR xApp, result expressed as the response code.")
  99         @RequestMapping(value = HEALTH_ALIVE_METHOD, method = RequestMethod.GET)
 100         public void getHealthAlive(HttpServletResponse response) {
 101                 logger.debug("getHealthAlive");
 102                 healthApi.getHealthAlive();
 103                 response.setStatus(healthApi.getApiClient().getStatusCode().value());
 104         }
 105
 106         @ApiOperation(value = "Performs a readiness probe on the ANR xApp, result expressed as the response code.")
 107         @RequestMapping(value = HEALTH_READY_METHOD, method = RequestMethod.GET)
 108         public void getHealthReady(HttpServletResponse response) {
 109                 logger.debug("getHealthReady");
 110                 healthApi.getHealthReady();
 111                 response.setStatus(healthApi.getApiClient().getStatusCode().value());
 112         }
 113
 114         @ApiOperation(value = "Returns list of gNodeB IDs based on NCRT in ANR", response = GgNodeBTable.class)
 115         @RequestMapping(value = GNODEBS_METHOD, method = RequestMethod.GET)
 116         public GgNodeBTable getGnodebs() {
 117                 logger.debug("getGnodebs");
 118                 return ncrtApi.getgNodeB();
 119         }
 120
 121         @ApiOperation(value = "Returns neighbor cell relation table for all gNodeBs or based on query parameters", response = NeighborCellRelationTable.class)
 122         @RequestMapping(value = NCRT_METHOD, method = RequestMethod.GET)
 123         public NeighborCellRelationTable getNcrt( //
 124                         @RequestParam(name = QP_NODEB, required = false) String ggnbId, //
 125                         @RequestParam(name = QP_SERVING, required = false) String servingCellNrcgi, //
 126                         @RequestParam(name = QP_NEIGHBOR, required = false) String neighborCellNrpci) {
 127                 logger.debug("getNcrt: ggnbid {}, servingCellNrpci {}, neighborCellNrcgi {}", ggnbId, servingCellNrcgi,
 128                                 neighborCellNrpci);
 129                 return ncrtApi.getNcrt(ggnbId, servingCellNrcgi, neighborCellNrpci);
 130         }
 131
 132         // /ncrt/servingcells/{servCellNrcgi}/neighborcells/{neighCellNrpci} :
 133         @ApiOperation(value = "Modify neighbor cell relation based on Serving Cell NRCGI and Neighbor Cell NRPCI")
 134         @RequestMapping(value = NCRT_METHOD + "/" + PP_SERVING + "/{" + PP_SERVING + "}/" + PP_NEIGHBOR + "/{" + PP_NEIGHBOR
 135                         + "}", method = RequestMethod.PUT)
 136         public void modifyNcrt(@PathVariable(PP_SERVING) String servingCellNrcgi, //
 137                         @PathVariable(PP_NEIGHBOR) String neighborCellNrpci, //
 138                         @RequestBody NeighborCellRelationMod ncrMod, HttpServletResponse response) {
 139                 logger.debug("modifyNcrt: servingCellNrcgi {}, neighborCellNrpci {}, ncrMod {}", servingCellNrcgi,
 140                                 neighborCellNrpci, ncrMod);
 141                 ncrtApi.modifyNcrt(servingCellNrcgi, neighborCellNrpci, ncrMod);
 142                 response.setStatus(healthApi.getApiClient().getStatusCode().value());
 143         }
 144
 145         @ApiOperation(value = "Delete neighbor cell relation based on Serving Cell NRCGI and Neighbor Cell NRPCI")
 146         @RequestMapping(value = NCRT_METHOD + "/" + PP_SERVING + "/{" + PP_SERVING + "}/" + PP_NEIGHBOR + "/{" + PP_NEIGHBOR
 147                         + "}", method = RequestMethod.DELETE)
 148         public void deleteNcrt(@PathVariable(PP_SERVING) String servingCellNrcgi, //
 149                         @PathVariable(PP_NEIGHBOR) String neighborCellNrpci, //
 150                         HttpServletResponse response) {
 151                 logger.debug("deleteNcrt: servingCellNrcgi {}, neighborCellNrpci {}", servingCellNrcgi, neighborCellNrpci);
 152                 ncrtApi.deleteNcrt(servingCellNrcgi, neighborCellNrpci);
 153                 response.setStatus(healthApi.getApiClient().getStatusCode().value());
 154         }
 155
 156 }