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.GetMapping;
32 import org.springframework.web.bind.annotation.RequestMapping;
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 = AdminController.CONTROLLER_PATH, produces = MediaType.APPLICATION_JSON_VALUE)
42 public class AdminController {
44 private static final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
46 // Publish paths in constants so tests are easy to write
47 public static final String CONTROLLER_PATH = DashboardConstants.ENDPOINT_PREFIX + "/admin";
48 public static final String USER_METHOD = "user";
49 public static final String HEALTH_METHOD = "health";
50 public static final String VERSION_METHOD = DashboardConstants.VERSION_METHOD;
52 private final DashboardUser[] users;
54 private static final String ACTIVE = "Active";
55 private static final String INACTIVE = "Inactive";
57 public AdminController() {
59 users = new DashboardUser[] { //
60 new DashboardUser(1, "John", "Doe", ACTIVE), //
61 new DashboardUser(2, "Alice", "Nolan", ACTIVE), //
62 new DashboardUser(3, "Pierce", "King", INACTIVE), //
63 new DashboardUser(4, "Paul", "Smith", INACTIVE), //
64 new DashboardUser(5, "Jack", "Reacher", ACTIVE) };
67 @ApiOperation(value = "Gets the Dashboard MANIFEST.MF property Implementation-Version.", response = SuccessTransport.class)
68 @GetMapping(VERSION_METHOD)
69 public SuccessTransport getVersion() {
70 logger.debug("getVersion");
71 return new SuccessTransport(200,
72 DashboardApplication.getImplementationVersion(MethodHandles.lookup().lookupClass()));
75 @ApiOperation(value = "Checks the health of the application.", response = SuccessTransport.class)
76 @GetMapping(HEALTH_METHOD)
77 public SuccessTransport getHealth() {
78 logger.debug("getHealth");
79 return new SuccessTransport(200, "Dashboard is healthy!");
82 @ApiOperation(value = "Gets the list of application users.", response = DashboardUser.class, responseContainer = "List")
83 @GetMapping(USER_METHOD)
84 public DashboardUser[] getUsers() {
85 logger.debug("getUsers");