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 org.oransc.ric.portal.dashboard.DashboardApplication;
25 import org.oransc.ric.portal.dashboard.DashboardConstants;
26 import org.oransc.ric.portal.dashboard.model.DashboardUser;
27 import org.oransc.ric.portal.dashboard.model.SuccessTransport;
28 import org.slf4j.Logger;
29 import org.slf4j.LoggerFactory;
30 import org.springframework.http.MediaType;
31 import org.springframework.web.bind.annotation.RequestMapping;
32 import org.springframework.web.bind.annotation.RequestMethod;
33 import org.springframework.web.bind.annotation.RestController;
35 import io.swagger.annotations.ApiOperation;
38 * Answers REST requests for admin services like version, health etc.
41 @RequestMapping(value = DashboardConstants.ENDPOINT_PREFIX + "/admin", produces = MediaType.APPLICATION_JSON_VALUE)
42 public class AdminController {
44 private static final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
46 private final DashboardUser[] users;
48 public AdminController() {
50 users = new DashboardUser[] { //
51 new DashboardUser(1, "John", "Doe", "Active"), //
52 new DashboardUser(2, "Alice", "Nolan", "Active"), //
53 new DashboardUser(3, "Pierce", "King", "Inactive"), //
54 new DashboardUser(4, "Paul", "Smith", "Inactive"), //
55 new DashboardUser(5, "Jack", "Reacher", "Active") };
58 @ApiOperation(value = "Gets the Dashboard MANIFEST.MF property Implementation-Version.", response = SuccessTransport.class)
59 @RequestMapping(value = DashboardConstants.VERSION_PATH, method = RequestMethod.GET)
60 public SuccessTransport getVersion() {
61 logger.debug("getVersion");
62 return new SuccessTransport(200,
63 DashboardApplication.getImplementationVersion(MethodHandles.lookup().lookupClass()));
66 @ApiOperation(value = "Checks the health of the application.", response = SuccessTransport.class)
67 @RequestMapping(value = DashboardConstants.HEALTHCHECK_PATH, method = RequestMethod.GET)
68 public SuccessTransport getHealth() {
69 logger.debug("getHealth");
70 return new SuccessTransport(200, "Dashboard is healthy!");
73 @ApiOperation(value = "Gets the list of application users.", response = DashboardUser.class, responseContainer = "List")
74 @RequestMapping(value = DashboardConstants.USER_PATH, method = RequestMethod.GET)
75 public DashboardUser[] getUsers() {
76 logger.debug("getUsers");