Integrate EPSDK-FW library for auth and users
[portal/ric-dashboard.git] / 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 and Nokia
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.lang.invoke.MethodHandles;
23
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.security.access.annotation.Secured;
32 import org.springframework.web.bind.annotation.GetMapping;
33 import org.springframework.web.bind.annotation.RequestMapping;
34 import org.springframework.web.bind.annotation.RestController;
35
36 import io.swagger.annotations.ApiOperation;
37
38 /**
39  * Answers REST requests for admin services like version, health etc.
40  */
41 @RestController
42 @RequestMapping(value = AdminController.CONTROLLER_PATH, produces = MediaType.APPLICATION_JSON_VALUE)
43 public class AdminController {
44
45         private static final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
46
47         // Publish paths in constants so tests are easy to write
48         public static final String CONTROLLER_PATH = DashboardConstants.ENDPOINT_PREFIX + "/admin";
49         public static final String USER_METHOD = "user";
50         public static final String HEALTH_METHOD = "health";
51         public static final String VERSION_METHOD = DashboardConstants.VERSION_METHOD;
52
53         private final DashboardUser[] users;
54
55         private static final String ACTIVE = "Active";
56         private static final String INACTIVE = "Inactive";
57
58         public AdminController() {
59                 // Mock data
60                 users = new DashboardUser[] { //
61                                 new DashboardUser(1, "John", "Doe", ACTIVE), //
62                                 new DashboardUser(2, "Alice", "Nolan", ACTIVE), //
63                                 new DashboardUser(3, "Pierce", "King", INACTIVE), //
64                                 new DashboardUser(4, "Paul", "Smith", INACTIVE), //
65                                 new DashboardUser(5, "Jack", "Reacher", ACTIVE) };
66         }
67
68         @ApiOperation(value = "Gets the Dashboard MANIFEST.MF property Implementation-Version.", response = SuccessTransport.class)
69         @GetMapping(VERSION_METHOD)
70         // No role required
71         public SuccessTransport getVersion() {
72                 logger.debug("getVersion");
73                 return new SuccessTransport(200,
74                                 DashboardApplication.getImplementationVersion(MethodHandles.lookup().lookupClass()));
75         }
76
77         @ApiOperation(value = "Checks the health of the application.", response = SuccessTransport.class)
78         @GetMapping(HEALTH_METHOD)
79         // No role required
80         public SuccessTransport getHealth() {
81                 logger.debug("getHealth");
82                 return new SuccessTransport(200, "Dashboard is healthy!");
83         }
84
85         @ApiOperation(value = "Gets the list of application users.", response = DashboardUser.class, responseContainer = "List")
86         @GetMapping(USER_METHOD)
87         @Secured({ DashboardConstants.ROLE_ADMIN })
88         public DashboardUser[] getUsers() {
89                 logger.debug("getUsers");
90                 return users;
91         }
92
93 }