-
Notifications
You must be signed in to change notification settings - Fork 2.3k
/
AuthInfo.java
72 lines (66 loc) · 2.3 KB
/
AuthInfo.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
/*
* 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.plugin.spi;
import java.io.Serializable;
import java.util.Collection;
import org.neo4j.server.security.enterprise.auth.plugin.api.AuthToken;
/**
* An object that can be returned as the result of successful authentication by an <tt>AuthPlugin</tt>.
*
* <p>This result type combines authentication and authorization information.
*
* <p>NOTE: If authentication caching is enabled the result type <tt>CacheableAuthInfo</tt> should be used instead.
*
* @see AuthPlugin#authenticateAndAuthorize(AuthToken)
* @see CacheableAuthInfo
*/
public interface AuthInfo extends Serializable
{
/**
* Should return a principal that uniquely identifies the authenticated subject within this realm.
*
* <p>Typically this is the same as the principal within the auth token map.
*
* @return a principal that uniquely identifies the authenticated subject within this realm.
*/
Object getPrincipal();
/**
* Should return the roles assigned to this principal.
*
* @return the roles assigned to this principal
*/
Collection<String> getRoles();
static AuthInfo of( Object principal, Collection<String> roles )
{
return new AuthInfo()
{
@Override
public Object getPrincipal()
{
return principal;
}
@Override
public Collection<String> getRoles()
{
return roles;
}
};
}
}