-
Notifications
You must be signed in to change notification settings - Fork 2.3k
/
User.java
164 lines (140 loc) · 4.7 KB
/
User.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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
/*
* 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 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package org.neo4j.server.security.auth;
import java.util.SortedSet;
import java.util.TreeSet;
/**
* Controls authorization and authentication for an individual user.
*/
public class User
{
/*
Design note: These instances are shared across threads doing disparate things with them, and there are no access
locks. Correctness depends on write-time assertions and this class remaining immutable. Please do not introduce
mutable fields here.
*/
/** User name */
private final String name;
/** Authentication credentials used by the built in username/password authentication scheme */
private final Credential credential;
/** Set of flags, eg. password_change_required */
private final SortedSet<String> flags;
public static final String PASSWORD_CHANGE_REQUIRED = "password_change_required";
private User( String name, Credential credential, SortedSet<String> flags )
{
this.name = name;
this.credential = credential;
this.flags = flags;
}
public String name()
{
return name;
}
public Credential credentials()
{
return credential;
}
public boolean hasFlag(String flag) { return flags.contains(flag); }
public Iterable<String> getFlags() { return flags; }
public boolean passwordChangeRequired() { return flags.contains( PASSWORD_CHANGE_REQUIRED ); }
/** Use this user as a base for a new user object */
public Builder augment() { return new Builder(this); }
@Override
public boolean equals( Object o )
{
if ( this == o )
{
return true;
}
if ( o == null || getClass() != o.getClass() )
{
return false;
}
User user = (User) o;
if ( !flags.equals( user.flags ) )
{
return false;
}
if ( credential != null ? !credential.equals( user.credential ) : user.credential != null )
{
return false;
}
if ( name != null ? !name.equals( user.name ) : user.name != null )
{
return false;
}
return true;
}
@Override
public int hashCode()
{
int result = name != null ? name.hashCode() : 0;
result = 31 * result + ( credential != null ? credential.hashCode() : 0);
result = 31 * result + ( flags.hashCode() );
return result;
}
@Override
public String toString()
{
return "User{" +
"name='" + name + '\'' +
", credentials=" + credential +
", flags=" + flags.toString() +
'}';
}
public static class Builder
{
private String name;
private Credential credential = Credential.INACCESSIBLE;
private TreeSet<String> flags = new TreeSet<>();
public Builder() { }
public Builder( String name, Credential credential )
{
this.name = name;
this.credential = credential;
}
public Builder( User base )
{
name = base.name;
credential = base.credential;
flags.addAll( base.flags );
}
public Builder withName( String name ) { this.name = name; return this; }
public Builder withCredentials( Credential creds ) { this.credential = creds; return this; }
public Builder withFlag( String flag ) { this.flags.add(flag); return this; }
public Builder withoutFlag( String flag ) { this.flags.remove(flag); return this; }
public Builder withRequiredPasswordChange( boolean change )
{
if ( change )
{
withFlag( PASSWORD_CHANGE_REQUIRED );
}
else
{
withoutFlag( PASSWORD_CHANGE_REQUIRED );
}
return this;
}
public User build()
{
return new User(name, credential, flags );
}
}
}