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

   1 /*-
   2  * ========================LICENSE_START=================================
   3  * O-RAN-SC
   4  * %%
   5  * Copyright (C) 2019 AT&T Intellectual Property
   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.io.IOException;
  23 import java.lang.invoke.MethodHandles;
  24 import java.util.List;
  25
  26 import org.onap.portalsdk.core.restful.domain.EcompUser;
  27 import org.oransc.ric.portal.dashboard.AppStatsManager;
  28 import org.oransc.ric.portal.dashboard.DashboardApplication;
  29 import org.oransc.ric.portal.dashboard.DashboardConstants;
  30 import org.oransc.ric.portal.dashboard.DashboardUserManager;
  31 import org.oransc.ric.portal.dashboard.exception.StatsManagerException;
  32 import org.oransc.ric.portal.dashboard.model.AppStats;
  33 import org.oransc.ric.portal.dashboard.model.IDashboardResponse;
  34 import org.oransc.ric.portal.dashboard.model.RicRegion;
  35 import org.oransc.ric.portal.dashboard.model.RicRegionList;
  36 import org.oransc.ric.portal.dashboard.model.RicRegionTransport;
  37 import org.oransc.ric.portal.dashboard.model.StatsDetailsTransport;
  38 import org.oransc.ric.portal.dashboard.model.SuccessTransport;
  39 import org.slf4j.Logger;
  40 import org.slf4j.LoggerFactory;
  41 import org.springframework.beans.factory.annotation.Autowired;
  42 import org.springframework.beans.factory.annotation.Value;
  43 import org.springframework.http.MediaType;
  44 import org.springframework.http.ResponseEntity;
  45 import org.springframework.security.access.annotation.Secured;
  46 import org.springframework.web.bind.annotation.DeleteMapping;
  47 import org.springframework.web.bind.annotation.GetMapping;
  48 import org.springframework.web.bind.annotation.PathVariable;
  49 import org.springframework.web.bind.annotation.PostMapping;
  50 import org.springframework.web.bind.annotation.PutMapping;
  51 import org.springframework.web.bind.annotation.RequestBody;
  52 import org.springframework.web.bind.annotation.RequestMapping;
  53 import org.springframework.web.bind.annotation.RestController;
  54
  55 import io.swagger.annotations.ApiOperation;
  56
  57 /**
  58  * Answers REST requests for admin services like version, health etc.
  59  */
  60 @RestController
  61 @RequestMapping(value = AdminController.CONTROLLER_PATH, produces = MediaType.APPLICATION_JSON_VALUE)
  62 public class AdminController {
  63
  64         private static final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
  65
  66         // Publish paths in constants so tests are easy to write
  67         public static final String CONTROLLER_PATH = DashboardConstants.ENDPOINT_PREFIX + "/admin";
  68         public static final String HEALTH_METHOD = "health";
  69         public static final String INSTANCE_METHOD = "instance";
  70         public static final String USER_METHOD = "user";
  71         public static final String VERSION_METHOD = DashboardConstants.VERSION_METHOD;
  72         public static final String XAPPMETRICS_METHOD = "metrics";
  73         public static final String STATAPPMETRIC_METHOD = "appmetric";
  74
  75         @Value("${metrics.url.ml}")
  76         private String mlAppMetricsUrl;
  77
  78         @Autowired
  79         private DashboardUserManager dashboardUserManager;
  80
  81         @Autowired
  82         private AppStatsManager appStatsManager;
  83
  84         @Autowired
  85         private RicRegionList instanceConfig;
  86
  87         @ApiOperation(value = "Gets the Dashboard MANIFEST.MF property Implementation-Version.", response = SuccessTransport.class)
  88         @GetMapping(VERSION_METHOD)
  89         // No role required
  90         public SuccessTransport getVersion() {
  91                 // These endpoints are invoked repeatedly by K8S
  92                 logger.trace("getVersion");
  93                 return new SuccessTransport(200,
  94                                 DashboardApplication.getImplementationVersion(MethodHandles.lookup().lookupClass()));
  95         }
  96
  97         @ApiOperation(value = "Checks the health of the application.", response = SuccessTransport.class)
  98         @GetMapping(HEALTH_METHOD)
  99         // No role required
 100         public SuccessTransport getHealth() {
 101                 // These endpoints are invoked repeatedly by K8S
 102                 logger.trace("getHealth");
 103                 return new SuccessTransport(200, "Dashboard is healthy!");
 104         }
 105
 106         @ApiOperation(value = "Gets the list of application users.", response = EcompUser.class, responseContainer = "List")
 107         @GetMapping(USER_METHOD)
 108         @Secured({ DashboardConstants.ROLE_ADMIN }) // regular users should not see this
 109         public List<EcompUser> getUsers() {
 110                 logger.debug("getUsers");
 111                 return dashboardUserManager.getUsers();
 112         }
 113
 114         @ApiOperation(value = "Gets the RIC regions and instances.", response = RicRegion.class, responseContainer = "List")
 115         @GetMapping(INSTANCE_METHOD)
 116         @Secured({ DashboardConstants.ROLE_ADMIN, DashboardConstants.ROLE_STANDARD })
 117         public List<RicRegionTransport> getRegionsInstances() {
 118                 logger.debug("getRegionsInstances");
 119                 return instanceConfig.getSimpleInstances();
 120         }
 121
 122         @ApiOperation(value = "Gets all xApp statistics reporting details.", response = StatsDetailsTransport.class, responseContainer = "List")
 123         @GetMapping(DashboardConstants.RIC_INSTANCE_KEY + "/{" + DashboardConstants.RIC_INSTANCE_KEY + "}/"
 124                         + STATAPPMETRIC_METHOD)
 125         @Secured({ DashboardConstants.ROLE_ADMIN, DashboardConstants.ROLE_STANDARD })
 126         public List<AppStats> getStats(@PathVariable(DashboardConstants.RIC_INSTANCE_KEY) String instanceKey) {
 127                 logger.debug("getStats for instance {}", instanceKey);
 128                 return appStatsManager.getStatsByInstance(instanceKey);
 129         }
 130
 131         @ApiOperation(value = "Gets a xApp's metrics status by Id.", response = StatsDetailsTransport.class, responseContainer = "List")
 132         @GetMapping(DashboardConstants.RIC_INSTANCE_KEY + "/{" + DashboardConstants.RIC_INSTANCE_KEY + "}/"
 133                         + STATAPPMETRIC_METHOD + "/" + DashboardConstants.APP_ID + "/{" + DashboardConstants.APP_ID + "}")
 134         @Secured({ DashboardConstants.ROLE_ADMIN, DashboardConstants.ROLE_STANDARD })
 135         public AppStats getStatsById(@PathVariable(DashboardConstants.RIC_INSTANCE_KEY) String instanceKey,
 136                         @PathVariable(DashboardConstants.APP_ID) int appId) {
 137                 logger.debug("getStatsById for instance {} by app id {}", instanceKey, appId);
 138                 return appStatsManager.getStatsById(instanceKey, appId);
 139         }
 140
 141         @ApiOperation(value = "Creates xApp metrics status.")
 142         @PostMapping(DashboardConstants.RIC_INSTANCE_KEY + "/{" + DashboardConstants.RIC_INSTANCE_KEY + "}/"
 143                         + STATAPPMETRIC_METHOD)
 144         @Secured({ DashboardConstants.ROLE_ADMIN })
 145         public IDashboardResponse createStats(@PathVariable(DashboardConstants.RIC_INSTANCE_KEY) String instanceKey,
 146                         @RequestBody StatsDetailsTransport statsSetupRequest) throws StatsManagerException, IOException {
 147                 logger.debug("createStats with instance {} request {}", instanceKey, statsSetupRequest);
 148                 return appStatsManager.createStats(instanceKey, statsSetupRequest);
 149         }
 150
 151         @ApiOperation(value = "Updates xApp metrics status.")
 152         @PutMapping(DashboardConstants.RIC_INSTANCE_KEY + "/{" + DashboardConstants.RIC_INSTANCE_KEY + "}/"
 153                         + STATAPPMETRIC_METHOD)
 154         @Secured({ DashboardConstants.ROLE_ADMIN })
 155         public ResponseEntity<String> updateStats(@PathVariable(DashboardConstants.RIC_INSTANCE_KEY) String instanceKey,
 156                         @RequestBody StatsDetailsTransport statsSetupRequest) throws StatsManagerException, IOException {
 157                 logger.debug("updateStats for instance {} request {}", instanceKey, statsSetupRequest);
 158                 appStatsManager.updateStats(instanceKey, statsSetupRequest);
 159                 return ResponseEntity.ok(null);
 160         }
 161
 162         @ApiOperation(value = "Deletes xApp metric status.")
 163         @DeleteMapping(DashboardConstants.RIC_INSTANCE_KEY + "/{" + DashboardConstants.RIC_INSTANCE_KEY + "}/"
 164                         + STATAPPMETRIC_METHOD + "/" + DashboardConstants.APP_ID + "/{" + DashboardConstants.APP_ID + "}")
 165         @Secured({ DashboardConstants.ROLE_ADMIN })
 166         public ResponseEntity<String> deleteStats(@PathVariable(DashboardConstants.RIC_INSTANCE_KEY) String instanceKey,
 167                         @PathVariable(DashboardConstants.APP_ID) int appId) throws StatsManagerException, IOException {
 168                 logger.debug("deleteStats instance {} request {}", instanceKey, appId);
 169                 appStatsManager.deleteStats(instanceKey, appId);
 170                 return ResponseEntity.ok(null);
 171         }
 172 }