import org.oransc.ric.e2mgr.client.model.SetupRequest;
import org.oransc.ric.portal.dashboard.DashboardApplication;
import org.oransc.ric.portal.dashboard.DashboardConstants;
-import org.oransc.ric.portal.dashboard.model.ErrorTransport;
import org.oransc.ric.portal.dashboard.model.RanDetailsTransport;
import org.oransc.ric.portal.dashboard.model.SuccessTransport;
import org.slf4j.Logger;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Configuration;
-import org.springframework.http.HttpStatus;
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;
*/
@Configuration
@RestController
-@RequestMapping(value = DashboardConstants.ENDPOINT_PREFIX + "/e2mgr", produces = MediaType.APPLICATION_JSON_VALUE)
+@RequestMapping(value = E2ManagerController.CONTROLLER_PATH, produces = MediaType.APPLICATION_JSON_VALUE)
public class E2ManagerController {
private static final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
- private final List<NodebIdentity> mockNodebIdList;
-
+ // Publish paths in constants so tests are easy to write
+ public static final String CONTROLLER_PATH = DashboardConstants.ENDPOINT_PREFIX + "/e2mgr";
+ // Endpoints
+ public static final String HEALTH_METHOD = "health";
+ public static final String NODEB_METHOD = "/nodeb";
+ public static final String NODEB_LIST_METHOD = "/nodeb-ids";
+ public static final String RAN_METHOD = "/ran";
+ public static final String ENDC_SETUP_METHOD = "/endcSetup";
+ public static final String X2_SETUP_METHOD = "/x2Setup";
+ public static final String VERSION_METHOD = DashboardConstants.VERSION_METHOD;
// Path parameters
private static final String PP_RANNAME = "ranName";
private final HealthCheckApi e2HealthCheckApi;
private final NodebApi e2NodebApi;
+ // TODO: remove this when E2 delivers the feature
+ private final List<NodebIdentity> mockNodebIdList;
+
@Autowired
public E2ManagerController(final HealthCheckApi e2HealthCheckApi, final NodebApi e2NodebApi,
@Value("${e2mgr.mock.rannames:#{null}}") final String mockRanNames) {
}
@ApiOperation(value = "Gets the E2 manager client library MANIFEST.MF property Implementation-Version.", response = SuccessTransport.class)
- @RequestMapping(value = DashboardConstants.VERSION_PATH, method = RequestMethod.GET)
- public SuccessTransport getE2ManagerClientVersion() {
+ @RequestMapping(value = VERSION_METHOD, method = RequestMethod.GET)
+ public SuccessTransport getClientVersion() {
return new SuccessTransport(200, DashboardApplication.getImplementationVersion(HealthCheckApi.class));
}
@ApiOperation(value = "Gets the health from the E2 manager, expressed as the response code.")
- @RequestMapping(value = "/health", method = RequestMethod.GET)
- public Object healthGet(HttpServletResponse response) {
+ @RequestMapping(value = HEALTH_METHOD, method = RequestMethod.GET)
+ public void healthGet(HttpServletResponse response) {
logger.debug("healthGet");
- try {
- e2HealthCheckApi.healthGet();
- response.setStatus(e2HealthCheckApi.getApiClient().getStatusCode().value());
- return null;
- } catch (HttpStatusCodeException ex) {
- logger.warn("healthGet failed: {}", ex.toString());
- return new ResponseEntity<ErrorTransport>(new ErrorTransport(ex.getRawStatusCode(), ex.toString()),
- HttpStatus.BAD_GATEWAY);
- }
+ e2HealthCheckApi.healthGet();
+ response.setStatus(e2HealthCheckApi.getApiClient().getStatusCode().value());
}
// This calls other methods to simplify the task of the front-end.
@ApiOperation(value = "Gets all RAN identities and statuses from the E2 manager.", response = RanDetailsTransport.class, responseContainer = "List")
- @RequestMapping(value = "/ran", method = RequestMethod.GET)
- public Object getRanDetails() {
+ @RequestMapping(value = RAN_METHOD, method = RequestMethod.GET)
+ public List<RanDetailsTransport> getRanDetails() {
logger.debug("getRanDetails");
- List<NodebIdentity> nodebIdList = null;
- try {
- // TODO: remove mock when e2mgr delivers the getNodebIdList() method
- nodebIdList = mockNodebIdList.isEmpty() ? e2NodebApi.getNodebIdList() : mockNodebIdList;
- } catch (HttpStatusCodeException ex) {
- logger.warn("getRanDetails: getNodebIdList failed: {}", ex.toString());
- return new ResponseEntity<ErrorTransport>(new ErrorTransport(ex.getRawStatusCode(), ex.toString()),
- HttpStatus.BAD_GATEWAY);
- }
+ // TODO: remove mock when e2mgr delivers the getNodebIdList() method
+ List<NodebIdentity> nodebIdList = mockNodebIdList.isEmpty() ? e2NodebApi.getNodebIdList() : mockNodebIdList;
List<RanDetailsTransport> details = new ArrayList<>();
for (NodebIdentity nbid : nodebIdList) {
GetNodebResponse nbResp = null;
try {
- // Keep looping despite failures
+ // Catch exceptions to keep looping despite failures
nbResp = e2NodebApi.getNb(nbid.getInventoryName());
} catch (HttpStatusCodeException ex) {
- logger.warn("getRanDetails failed for name {}: {}", nbid.getInventoryName(), ex.toString());
+ logger.warn("E2 getNb failed for name {}: {}", nbid.getInventoryName(), ex.toString());
nbResp = new GetNodebResponse().connectionStatus("UNKNOWN").ip("UNKNOWN").port(-1)
.ranName(nbid.getInventoryName());
}
}
@ApiOperation(value = "Get RAN identities list.", response = NodebIdentity.class, responseContainer = "List")
- @RequestMapping(value = "/nodeb/id", method = RequestMethod.GET)
- public Object getNodebIdList() {
+ @RequestMapping(value = NODEB_LIST_METHOD, method = RequestMethod.GET)
+ public List<NodebIdentity> getNodebIdList() {
logger.debug("getNodebIdList");
- try {
- return e2NodebApi.getNodebIdList();
- } catch (HttpStatusCodeException ex) {
- logger.warn("getNodebIdList failed: {}", ex.toString());
- return new ResponseEntity<ErrorTransport>(new ErrorTransport(ex.getRawStatusCode(), ex.toString()),
- HttpStatus.BAD_GATEWAY);
- }
+ return e2NodebApi.getNodebIdList();
}
@ApiOperation(value = "Get RAN by name.", response = GetNodebResponse.class)
- @RequestMapping(value = "/nodeb/{" + PP_RANNAME + "}", method = RequestMethod.GET)
- public Object getNb(@PathVariable(PP_RANNAME) String ranName) {
+ @RequestMapping(value = NODEB_METHOD + "/{" + PP_RANNAME + "}", method = RequestMethod.GET)
+ public GetNodebResponse getNb(@PathVariable(PP_RANNAME) String ranName) {
logger.debug("getNb {}", ranName);
- try {
- return e2NodebApi.getNb(ranName);
- } catch (HttpStatusCodeException ex) {
- logger.warn("getNb failed: {}", ex.toString());
- return new ResponseEntity<ErrorTransport>(new ErrorTransport(ex.getRawStatusCode(), ex.toString()),
- HttpStatus.BAD_GATEWAY);
- }
+ return e2NodebApi.getNb(ranName);
}
@ApiOperation(value = "Close all connections to the RANs and delete the data from the nodeb-rnib DB.")
- @RequestMapping(value = "/nodeb", method = RequestMethod.DELETE)
- public Object nodebDelete(HttpServletResponse response) {
+ @RequestMapping(value = NODEB_METHOD, method = RequestMethod.DELETE)
+ public void nodebDelete(HttpServletResponse response) {
logger.debug("nodebDelete");
- try {
- e2NodebApi.nodebDelete();
- response.setStatus(e2NodebApi.getApiClient().getStatusCode().value());
- return null;
- } catch (HttpStatusCodeException ex) {
- logger.warn("nodebDelete failed: {}", ex.toString());
- return new ResponseEntity<ErrorTransport>(new ErrorTransport(ex.getRawStatusCode(), ex.toString()),
- HttpStatus.BAD_GATEWAY);
- }
+ e2NodebApi.nodebDelete();
+ response.setStatus(e2NodebApi.getApiClient().getStatusCode().value());
}
@ApiOperation(value = "Sets up an EN-DC RAN connection via the E2 manager.")
- @RequestMapping(value = "/endcSetup", method = RequestMethod.POST)
- public Object endcSetup(@RequestBody SetupRequest setupRequest, HttpServletResponse response) {
+ @RequestMapping(value = ENDC_SETUP_METHOD, method = RequestMethod.POST)
+ public void endcSetup(@RequestBody SetupRequest setupRequest, HttpServletResponse response) {
logger.debug("endcSetup {}", setupRequest);
- try {
- e2NodebApi.endcSetup(setupRequest);
- response.setStatus(e2NodebApi.getApiClient().getStatusCode().value());
- return null;
- } catch (HttpStatusCodeException ex) {
- logger.warn("endcSetup failed: {}", ex.toString());
- return new ResponseEntity<ErrorTransport>(new ErrorTransport(ex.getRawStatusCode(), ex.toString()),
- HttpStatus.BAD_GATEWAY);
- }
+ e2NodebApi.endcSetup(setupRequest);
+ response.setStatus(e2NodebApi.getApiClient().getStatusCode().value());
}
@ApiOperation(value = "Sets up an X2 RAN connection via the E2 manager.")
- @RequestMapping(value = "/x2Setup", method = RequestMethod.POST)
- public Object x2Setup(@RequestBody SetupRequest setupRequest, HttpServletResponse response) {
+ @RequestMapping(value = X2_SETUP_METHOD, method = RequestMethod.POST)
+ public void x2Setup(@RequestBody SetupRequest setupRequest, HttpServletResponse response) {
logger.debug("x2Setup {}", setupRequest);
- try {
- e2NodebApi.x2Setup(setupRequest);
- response.setStatus(e2NodebApi.getApiClient().getStatusCode().value());
- return null;
- } catch (HttpStatusCodeException ex) {
- logger.warn("x2Setup failed: {}", ex.toString());
- return new ResponseEntity<ErrorTransport>(new ErrorTransport(ex.getRawStatusCode(), ex.toString()),
- HttpStatus.BAD_GATEWAY);
- }
+ e2NodebApi.x2Setup(setupRequest);
+ response.setStatus(e2NodebApi.getApiClient().getStatusCode().value());
}
}