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