2 * ========================LICENSE_START=================================
5 * Copyright (C) 2019 AT&T Intellectual Property and Nokia
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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===================================
20 package org.oransc.ric.portal.dashboard.controller;
22 import java.lang.invoke.MethodHandles;
24 import javax.servlet.http.HttpServletResponse;
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.security.access.annotation.Secured;
40 import org.springframework.util.Assert;
41 import org.springframework.web.bind.annotation.DeleteMapping;
42 import org.springframework.web.bind.annotation.GetMapping;
43 import org.springframework.web.bind.annotation.PathVariable;
44 import org.springframework.web.bind.annotation.PutMapping;
45 import org.springframework.web.bind.annotation.RequestBody;
46 import org.springframework.web.bind.annotation.RequestMapping;
47 import org.springframework.web.bind.annotation.RequestParam;
48 import org.springframework.web.bind.annotation.RestController;
50 import io.swagger.annotations.ApiOperation;
53 * Provides methods to contact the ANR xApp which manages a Neighbor Cell
54 * Relation Table (NCRT).
58 @RequestMapping(value = AnrXappController.CONTROLLER_PATH, produces = MediaType.APPLICATION_JSON_VALUE)
59 public class AnrXappController {
61 private static final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
63 // Publish paths in constants so tests are easy to write
64 public static final String CONTROLLER_PATH = DashboardConstants.ENDPOINT_PREFIX + "/xapp/anr";
66 public static final String HEALTH_ALIVE_METHOD = "/health/alive";
67 public static final String HEALTH_READY_METHOD = "/health/ready";
68 public static final String GNODEBS_METHOD = "/gnodebs";
69 public static final String NCRT_METHOD = "/ncrt";
70 public static final String VERSION_METHOD = DashboardConstants.VERSION_METHOD;
73 public static final String PP_SERVING = "servingcells";
74 public static final String PP_NEIGHBOR = "neighborcells";
76 // Populated by the autowired constructor
77 private final HealthApi healthApi;
78 private final NcrtApi ncrtApi;
81 public AnrXappController(final HealthApi anrHealthApi, final NcrtApi anrNcrtApi) {
82 Assert.notNull(anrHealthApi, "API must not be null");
83 Assert.notNull(anrNcrtApi, "API must not be null");
84 this.healthApi = anrHealthApi;
85 this.ncrtApi = anrNcrtApi;
86 if (logger.isDebugEnabled())
87 logger.debug("ctor: configured with client types {} and {}", anrHealthApi.getClass().getName(),
88 anrNcrtApi.getClass().getName());
91 @ApiOperation(value = "Gets the ANR client library MANIFEST.MF property Implementation-Version.", response = SuccessTransport.class)
92 @GetMapping(VERSION_METHOD)
94 public SuccessTransport getClientVersion() {
95 return new SuccessTransport(200, DashboardApplication.getImplementationVersion(HealthApi.class));
98 @ApiOperation(value = "Performs a liveness probe on the ANR xApp, result expressed as the response code.")
99 @GetMapping(HEALTH_ALIVE_METHOD)
101 public void getHealthAlive(HttpServletResponse response) {
102 logger.debug("getHealthAlive");
103 healthApi.getHealthAlive();
104 response.setStatus(healthApi.getApiClient().getStatusCode().value());
107 @ApiOperation(value = "Performs a readiness probe on the ANR xApp, result expressed as the response code.")
108 @GetMapping(HEALTH_READY_METHOD)
110 public void getHealthReady(HttpServletResponse response) {
111 logger.debug("getHealthReady");
112 healthApi.getHealthReady();
113 response.setStatus(healthApi.getApiClient().getStatusCode().value());
116 @ApiOperation(value = "Returns list of gNodeB IDs based on NCRT in ANR", response = GgNodeBTable.class)
117 @GetMapping(GNODEBS_METHOD)
118 @Secured({ DashboardConstants.ROLE_ADMIN, DashboardConstants.ROLE_STANDARD })
119 public GgNodeBTable getGnodebs() {
120 logger.debug("getGnodebs");
121 return ncrtApi.getgNodeB();
124 @ApiOperation(value = "Returns neighbor cell relation table for all gNodeBs or based on query parameters", response = NeighborCellRelationTable.class)
125 @GetMapping(NCRT_METHOD)
126 @Secured({ DashboardConstants.ROLE_ADMIN, DashboardConstants.ROLE_STANDARD })
127 public NeighborCellRelationTable getNcrt( //
128 @RequestParam(required = false) String ggnodeb, //
129 @RequestParam(required = false) String servingCellNrcgi, //
130 @RequestParam(required = false) String neighborCellNrpci) {
131 logger.debug("getNcrt: ggnbid {}, servingCellNrpci {}, neighborCellNrcgi {}", ggnodeb, servingCellNrcgi,
133 return ncrtApi.getNcrt(ggnodeb, servingCellNrcgi, neighborCellNrpci);
136 // /ncrt/servingcells/{servCellNrcgi}/neighborcells/{neighCellNrpci} :
137 @ApiOperation(value = "Modify neighbor cell relation based on Serving Cell NRCGI and Neighbor Cell NRPCI")
138 @PutMapping(NCRT_METHOD + "/" + PP_SERVING + "/{" + PP_SERVING + "}/" + PP_NEIGHBOR + "/{" + PP_NEIGHBOR + "}")
139 @Secured({ DashboardConstants.ROLE_ADMIN })
140 public void modifyNcrt(@PathVariable(PP_SERVING) String servingCellNrcgi, //
141 @PathVariable(PP_NEIGHBOR) String neighborCellNrpci, //
142 @RequestBody NeighborCellRelationMod ncrMod, HttpServletResponse response) {
143 logger.debug("modifyNcrt: servingCellNrcgi {}, neighborCellNrpci {}, ncrMod {}", servingCellNrcgi,
144 neighborCellNrpci, ncrMod);
145 ncrtApi.modifyNcrt(servingCellNrcgi, neighborCellNrpci, ncrMod);
146 response.setStatus(healthApi.getApiClient().getStatusCode().value());
149 @ApiOperation(value = "Delete neighbor cell relation based on Serving Cell NRCGI and Neighbor Cell NRPCI")
150 @DeleteMapping(NCRT_METHOD + "/" + PP_SERVING + "/{" + PP_SERVING + "}/" + PP_NEIGHBOR + "/{" + PP_NEIGHBOR + "}")
151 @Secured({ DashboardConstants.ROLE_ADMIN })
152 public void deleteNcrt(@PathVariable(PP_SERVING) String servingCellNrcgi, //
153 @PathVariable(PP_NEIGHBOR) String neighborCellNrpci, //
154 HttpServletResponse response) {
155 logger.debug("deleteNcrt: servingCellNrcgi {}, neighborCellNrpci {}", servingCellNrcgi, neighborCellNrpci);
156 ncrtApi.deleteNcrt(servingCellNrcgi, neighborCellNrpci);
157 response.setStatus(healthApi.getApiClient().getStatusCode().value());