Adding interfaces in documentation
[aai/sparky-be.git] / sparkybe-onap-service / src / main / java / org / onap / aai / sparky / editattributes / UserAuthorizationReader.java
1 /**
2  * ============LICENSE_START===================================================
3  * SPARKY (AAI UI service)
4  * ============================================================================
5  * Copyright © 2017 AT&T Intellectual Property.
6  * Copyright © 2017 Amdocs
7  * All rights reserved.
8  * ============================================================================
9  * Licensed under the Apache License, Version 2.0 (the "License");
10  * you may not use this file except in compliance with the License.
11  * You may obtain a copy of the License at
12  *
13  *      http://www.apache.org/licenses/LICENSE-2.0
14  *
15  * Unless required by applicable law or agreed to in writing, software
16  * distributed under the License is distributed on an "AS IS" BASIS,
17  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
18  * See the License for the specific language governing permissions and
19  * limitations under the License.
20  * ============LICENSE_END=====================================================
21  *
22  * ECOMP and OpenECOMP are trademarks
23  * and service marks of AT&T Intellectual Property.
24  */
25 package org.onap.aai.sparky.editattributes;
26
27 import java.io.File;
28 import java.io.IOException;
29 import java.nio.file.Files;
30 import java.util.ArrayList;
31 import java.util.List;
32 import java.util.stream.Collectors;
33 import java.util.stream.Stream;
34
35 /**
36  * Reads user IDs from a file. Each line in the user authorization file should contain a single user
37  * ID. For example,
38  *
39  * <pre>
40  * user1
41  * user2
42  * </pre>
43  */
44 public class UserAuthorizationReader {
45
46   private File userAuthorizationFile;
47
48   /**
49    * Set the user authorization file.
50    *
51    * @param file a user authorization file
52    */
53   public UserAuthorizationReader(File file) {
54     this.userAuthorizationFile = file;
55   }
56
57   /**
58    * Gets user IDs from a file.
59    *
60    * @return a list of user IDs
61    * @throws IOException if there is a problem reading the user configuration file
62    */
63   public List<String> getUsers() throws IOException {
64     List<String> userList = new ArrayList<>();
65     try (Stream<String> stream = Files.lines(getUserAuthorizationFile().toPath())) {
66       userList.addAll(stream.map(String::trim).collect(Collectors.toList()));
67     }
68     return userList;
69   }
70
71   // Getters and setters
72   public File getUserAuthorizationFile() {
73     return userAuthorizationFile;
74   }
75
76   public void setUserAuthorizationFile(File file) {
77     this.userAuthorizationFile = file;
78   }
79 }