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;
23 import java.io.IOException;
24 import java.lang.invoke.MethodHandles;
25 import java.nio.file.Files;
26 import java.util.ArrayList;
27 import java.util.List;
29 import org.onap.portalsdk.core.onboarding.exception.PortalAPIException;
30 import org.onap.portalsdk.core.restful.domain.EcompUser;
31 import org.slf4j.Logger;
32 import org.slf4j.LoggerFactory;
33 import org.springframework.context.annotation.Profile;
35 import com.fasterxml.jackson.core.type.TypeReference;
36 import com.fasterxml.jackson.databind.ObjectMapper;
39 * Provides simple user-management services.
41 * This first implementation serializes user details to a file.
43 * Migrate to a database someday?
46 public class DashboardUserManager {
48 private static final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
50 // This default value is only useful for development and testing.
51 public static final String USER_FILE_PATH = "dashboard-users.json";
53 private final File userFile;
54 private final List<EcompUser> users;
57 * Development/test-only constructor that uses default file path.
60 * If true, start empty and remove any existing file.
65 public DashboardUserManager(boolean clear) throws IOException {
68 logger.debug("ctor: removing file {}", userFile.getAbsolutePath());
69 File f = new File(DashboardUserManager.USER_FILE_PATH);
71 Files.delete(f.toPath());
77 * Constructor that accepts a file path
82 * If file cannot be read
84 public DashboardUserManager(final String userFilePath) throws IOException {
85 logger.debug("ctor: userfile {}", userFilePath);
86 if (userFilePath == null)
87 throw new IllegalArgumentException("Missing or empty user file property");
88 userFile = new File(userFilePath);
89 logger.debug("ctor: managing users in file {}", userFile.getAbsolutePath());
90 if (userFile.exists()) {
91 final ObjectMapper mapper = new ObjectMapper();
92 users = mapper.readValue(userFile, new TypeReference<List<EcompUser>>() {
95 users = new ArrayList<>();
100 * Gets the current users.
102 * @return List of EcompUser objects, possibly empty
104 public List<EcompUser> getUsers() {
109 * Gets the user with the specified login Id
113 * @return User object; null if Id is not known
115 public EcompUser getUser(String loginId) {
116 for (EcompUser u : this.users) {
117 if (u.getLoginId().equals(loginId)) {
118 logger.debug("getUser: match on {}", loginId);
122 logger.debug("getUser: no match on {}", loginId);
126 private void saveUsers() throws IOException {
127 final ObjectMapper mapper = new ObjectMapper();
128 mapper.writeValue(userFile, users);
132 * Allow at most one thread to create a user at one time.
134 public synchronized void createUser(EcompUser user) throws PortalAPIException {
135 logger.debug("createUser: loginId {}", 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 {}", 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);