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;
22 import com.fasterxml.jackson.core.type.TypeReference;
23 import com.fasterxml.jackson.databind.ObjectMapper;
26 import java.io.IOException;
27 import java.lang.invoke.MethodHandles;
28 import java.nio.file.Files;
29 import java.util.ArrayList;
30 import java.util.HashSet;
31 import java.util.List;
34 import org.onap.portalsdk.core.onboarding.exception.PortalAPIException;
35 import org.onap.portalsdk.core.restful.domain.EcompRole;
36 import org.onap.portalsdk.core.restful.domain.EcompUser;
37 import org.slf4j.Logger;
38 import org.slf4j.LoggerFactory;
41 * Provides simple user-management services.
43 * This first implementation serializes user details to a file.
45 public class DashboardUserManager {
47 private static final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
49 // This default value is only useful for development and testing.
50 public static final String USER_FILE_PATH = "dashboard-users.json";
52 private final File userFile;
53 private final List<EcompUser> users;
56 * Development/test-only constructor that uses default file path.
59 * If true, start empty and remove any existing file.
64 public DashboardUserManager(boolean clear) throws IOException {
67 logger.debug("ctor: removing file {}", userFile.getAbsolutePath());
68 File f = new File(DashboardUserManager.USER_FILE_PATH);
70 Files.delete(f.toPath());
76 * Constructur that accepts a file path
81 * If file cannot be read
83 public DashboardUserManager(final String userFilePath) throws IOException {
84 logger.debug("ctor: userfile {}", userFilePath);
85 if (userFilePath == null)
86 throw new IllegalArgumentException("Missing or empty user file property");
87 userFile = new File(userFilePath);
88 logger.debug("ctor: managing users in file {}", userFile.getAbsolutePath());
89 if (userFile.exists()) {
90 final ObjectMapper mapper = new ObjectMapper();
91 users = mapper.readValue(userFile, new TypeReference<List<EcompUser>>() {});
93 users = new ArrayList<>();
98 * Gets the current users.
100 * @return List of EcompUser objects, possibly empty
102 public List<EcompUser> getUsers() {
107 * Gets the user with the specified login Id
111 * @return User object; null if Id is not known
113 public EcompUser getUser(String loginId) {
114 for (EcompUser u : this.users) {
115 if (u.getLoginId().equals(loginId)) {
116 logger.debug("getUser: match on {}", loginId);
120 logger.debug("getUser: no match on {}", loginId);
124 private void saveUsers() throws IOException {
125 final ObjectMapper mapper = new ObjectMapper();
126 mapper.writeValue(userFile, users);
130 * Allow at most one thread to create a user at one time.
132 public synchronized void createUser(EcompUser user) throws PortalAPIException {
133 if (logger.isDebugEnabled()) {
134 logger.debug("createUser: loginId is {}", user.getLoginId());
136 if (users.contains(user))
137 throw new PortalAPIException("User exists: " + user.getLoginId());
141 } catch (Exception ex) {
142 throw new PortalAPIException("Save failed", ex);
147 * Allow at most one thread to modify a user at one time. We still have
148 * last-edit-wins of course.
150 public synchronized void updateUser(String loginId, EcompUser user) throws PortalAPIException {
151 logger.debug("editUser: loginId is {}", loginId);
152 int index = users.indexOf(user);
154 throw new PortalAPIException("User does not exist: " + user.getLoginId());
159 } catch (Exception ex) {
160 throw new PortalAPIException("Save failed", ex);
164 // Test infrastructure
165 public static void main(String[] args) throws Exception {
166 DashboardUserManager dum = new DashboardUserManager(false);
167 EcompUser user = new EcompUser();
168 user.setActive(true);
169 user.setLoginId("demo");
170 user.setFirstName("First");
171 user.setLastName("Last");
172 EcompRole role = new EcompRole();
174 role.setName(DashboardConstants.ROLE_NAME_ADMIN);
175 Set<EcompRole> roles = new HashSet<>();
177 user.setRoles(roles);
178 dum.createUser(user);
179 logger.debug("Created user {}", user);