2 * ========================LICENSE_START=================================
5 * Copyright (C) 2019 AT&T Intellectual Property
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.io.IOException;
23 import java.lang.invoke.MethodHandles;
24 import java.util.List;
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.http.MediaType;
43 import org.springframework.http.ResponseEntity;
44 import org.springframework.security.access.annotation.Secured;
45 import org.springframework.validation.annotation.Validated;
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;
55 import io.swagger.annotations.ApiOperation;
58 * Answers REST requests for admin services like version, health etc.
61 @RequestMapping(value = AdminController.CONTROLLER_PATH, produces = MediaType.APPLICATION_JSON_VALUE)
62 public class AdminController {
64 private static final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
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";
76 private DashboardUserManager dashboardUserManager;
79 private AppStatsManager appStatsManager;
82 private RicRegionList instanceConfig;
84 @ApiOperation(value = "Gets the Dashboard MANIFEST.MF property Implementation-Version.", response = SuccessTransport.class)
85 @GetMapping(VERSION_METHOD)
87 public SuccessTransport getVersion() {
88 // These endpoints are invoked repeatedly by K8S
89 logger.trace("getVersion");
90 return new SuccessTransport(200,
91 DashboardApplication.getImplementationVersion(MethodHandles.lookup().lookupClass()));
94 @ApiOperation(value = "Checks the health of the application.", response = SuccessTransport.class)
95 @GetMapping(HEALTH_METHOD)
97 public SuccessTransport getHealth() {
98 // These endpoints are invoked repeatedly by K8S
99 logger.trace("getHealth");
100 return new SuccessTransport(200, "Dashboard is healthy!");
103 @ApiOperation(value = "Gets the list of application users.", response = EcompUser.class, responseContainer = "List")
104 @GetMapping(USER_METHOD)
105 @Secured({ DashboardConstants.ROLE_ADMIN }) // regular users should not see this
106 public List<EcompUser> getUsers() {
107 logger.debug("getUsers");
108 return dashboardUserManager.getUsers();
111 @ApiOperation(value = "Gets the RIC regions and instances.", response = RicRegion.class, responseContainer = "List")
112 @GetMapping(INSTANCE_METHOD)
113 @Secured({ DashboardConstants.ROLE_ADMIN, DashboardConstants.ROLE_STANDARD })
114 public List<RicRegionTransport> getRegionsInstances() {
115 logger.debug("getRegionsInstances");
116 return instanceConfig.getSimpleInstances();
119 @ApiOperation(value = "Gets all xApp statistics reporting details.", response = StatsDetailsTransport.class, responseContainer = "List")
120 @GetMapping(DashboardConstants.RIC_INSTANCE_KEY + "/{" + DashboardConstants.RIC_INSTANCE_KEY + "}/"
121 + STATAPPMETRIC_METHOD)
122 @Secured({ DashboardConstants.ROLE_ADMIN, DashboardConstants.ROLE_STANDARD })
123 public List<AppStats> getStats(@PathVariable(DashboardConstants.RIC_INSTANCE_KEY) String instanceKey) {
124 logger.debug("getStats for instance {}", instanceKey);
125 return appStatsManager.getStatsByInstance(instanceKey);
128 @ApiOperation(value = "Gets a xApp's metrics status by Id.", response = StatsDetailsTransport.class, responseContainer = "List")
129 @GetMapping(DashboardConstants.RIC_INSTANCE_KEY + "/{" + DashboardConstants.RIC_INSTANCE_KEY + "}/"
130 + STATAPPMETRIC_METHOD + "/" + DashboardConstants.APP_ID + "/{" + DashboardConstants.APP_ID + "}")
131 @Secured({ DashboardConstants.ROLE_ADMIN, DashboardConstants.ROLE_STANDARD })
132 public AppStats getStatsById(@PathVariable(DashboardConstants.RIC_INSTANCE_KEY) String instanceKey,
133 @PathVariable(DashboardConstants.APP_ID) int appId) {
134 logger.debug("getStatsById for instance {} by app id {}", instanceKey, appId);
135 return appStatsManager.getStatsById(instanceKey, appId);
138 @ApiOperation(value = "Creates xApp metrics status.")
139 @PostMapping(DashboardConstants.RIC_INSTANCE_KEY + "/{" + DashboardConstants.RIC_INSTANCE_KEY + "}/"
140 + STATAPPMETRIC_METHOD)
141 @Secured({ DashboardConstants.ROLE_ADMIN })
142 public IDashboardResponse createStats(@PathVariable(DashboardConstants.RIC_INSTANCE_KEY) String instanceKey,
143 @Validated @RequestBody StatsDetailsTransport statsSetupRequest) throws StatsManagerException, IOException {
144 logger.debug("createStats with instance {} request {}", instanceKey, statsSetupRequest);
145 return appStatsManager.createStats(instanceKey, statsSetupRequest);
148 @ApiOperation(value = "Updates xApp metrics status.")
149 @PutMapping(DashboardConstants.RIC_INSTANCE_KEY + "/{" + DashboardConstants.RIC_INSTANCE_KEY + "}/"
150 + STATAPPMETRIC_METHOD)
151 @Secured({ DashboardConstants.ROLE_ADMIN })
152 public void updateStats(@PathVariable(DashboardConstants.RIC_INSTANCE_KEY) String instanceKey,
153 @Validated @RequestBody StatsDetailsTransport statsSetupRequest) throws StatsManagerException, IOException {
154 logger.debug("updateStats for instance {} request {}", instanceKey, statsSetupRequest);
155 appStatsManager.updateStats(instanceKey, statsSetupRequest);
158 @ApiOperation(value = "Deletes xApp metric status.")
159 @DeleteMapping(DashboardConstants.RIC_INSTANCE_KEY + "/{" + DashboardConstants.RIC_INSTANCE_KEY + "}/"
160 + STATAPPMETRIC_METHOD + "/" + DashboardConstants.APP_ID + "/{" + DashboardConstants.APP_ID + "}")
161 @Secured({ DashboardConstants.ROLE_ADMIN })
162 public ResponseEntity<String> deleteStats(@PathVariable(DashboardConstants.RIC_INSTANCE_KEY) String instanceKey,
163 @PathVariable(DashboardConstants.APP_ID) int appId) throws StatsManagerException, IOException {
164 logger.debug("deleteStats instance {} request {}", instanceKey, appId);
165 appStatsManager.deleteStats(instanceKey, appId);
166 return ResponseEntity.ok(null);