-
Notifications
You must be signed in to change notification settings - Fork 2.3k
/
RoleRepository.java
112 lines (96 loc) · 4.07 KB
/
RoleRepository.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
/*
* Copyright (c) 2002-2016 "Neo Technology,"
* Network Engine for Objects in Lund AB [http://neotechnology.com]
*
* This file is part of Neo4j.
*
* Neo4j is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package org.neo4j.server.security.enterprise.auth;
import java.util.List;
import java.io.IOException;
import java.util.Set;
import java.util.stream.Collectors;
import org.neo4j.kernel.api.security.exception.InvalidArgumentsException;
import org.neo4j.kernel.lifecycle.Lifecycle;
import org.neo4j.server.security.auth.ListSnapshot;
import org.neo4j.server.security.auth.User;
import org.neo4j.server.security.auth.exception.ConcurrentModificationException;
/**
* A component that can store and retrieve roles. Implementations must be thread safe.
*/
public interface RoleRepository extends Lifecycle
{
RoleRecord getRoleByName( String roleName );
Set<String> getRoleNamesByUsername( String username );
/**
* Clears all cached role data.
*/
void clear();
/**
* Create a role, given that the roles token is unique.
*
* @param role the new role object
* @throws InvalidArgumentsException if the role name is not valid or the role name already exists
*/
void create( RoleRecord role ) throws InvalidArgumentsException, IOException;
/**
* Replaces the roles in the repository with the given roles.
* @param roles the new roles
* @throws InvalidArgumentsException if any role name is not valid
* @throws IOException if the underlying storage for roles fails
*/
void setRoles( ListSnapshot<RoleRecord> roles ) throws InvalidArgumentsException, IOException;
/**
* Update a role, given that the role token is unique.
*
* @param existingRole the existing role object, which must match the current state in this repository
* @param updatedRole the updated role object
* @throws ConcurrentModificationException if the existingRole does not match the current state in the repository
*/
void update( RoleRecord existingRole, RoleRecord updatedRole )
throws ConcurrentModificationException, IOException;
/**
* Deletes a role.
*
* @param role the role to delete
* @return true if the role was found and deleted
*/
boolean delete( RoleRecord role ) throws IOException;
int numberOfRoles();
/**
* Asserts whether the given role name is valid or not. A valid role name is non-null, non-empty, and contains
* only simple ascii characters.
* @param roleName the role name to be tested.
* @throws InvalidArgumentsException if the role name was invalid.
*/
void assertValidRoleName( String roleName ) throws InvalidArgumentsException;
void removeUserFromAllRoles( String username )
throws ConcurrentModificationException, IOException;
Set<String> getAllRoleNames();
/**
* Returns a snapshot of the current persisted role repository
* @return a snapshot of the current persisted role repository
* @throws IOException
*/
ListSnapshot<RoleRecord> getPersistedSnapshot() throws IOException;
static boolean validate( List<User> users, List<RoleRecord> roles )
{
Set<String> usernamesInRoles = roles.stream()
.flatMap( rr -> rr.users().stream() )
.collect( Collectors.toSet() );
Set<String> usernameInUsers = users.stream().map( User::name ).collect( Collectors.toSet() );
return usernameInUsers.containsAll( usernamesInRoles );
}
}