keycloak
公開メンバ関数 | 非公開変数類 | 全メンバ一覧
org.keycloak.authorization.permission.ResourcePermission クラス
org.keycloak.authorization.permission.ResourcePermission 連携図
Collaboration graph

公開メンバ関数

 ResourcePermission (Resource resource, List< Scope > scopes, ResourceServer resourceServer)
 
 ResourcePermission (Resource resource, ResourceServer resourceServer, Map< String, ? extends Collection< String >> claims)
 
 ResourcePermission (Resource resource, List< Scope > scopes, ResourceServer resourceServer, Map< String, ? extends Collection< String >> claims)
 
Resource getResource ()
 
List< ScopegetScopes ()
 
ResourceServer getResourceServer ()
 
Map< String, Set< String > > getClaims ()
 
boolean addClaim (String name, String value)
 
void removeClaim (String name)
 
void addScope (Scope scope)
 
void addClaims (Map< String, Set< String >> claims)
 

非公開変数類

final Resource resource
 
final List< Scopescopes
 
ResourceServer resourceServer
 
Map< String, Set< String > > claims
 

詳解

Represents a permission for a given resource.

著者
Pedro Igor

構築子と解体子

◆ ResourcePermission() [1/3]

org.keycloak.authorization.permission.ResourcePermission.ResourcePermission ( Resource  resource,
List< Scope scopes,
ResourceServer  resourceServer 
)
inline
48  {
49  this(resource, scopes, resourceServer, null);
50  }
final List< Scope > scopes
Definition: ResourcePermission.java:44
final Resource resource
Definition: ResourcePermission.java:43
ResourceServer resourceServer
Definition: ResourcePermission.java:45

◆ ResourcePermission() [2/3]

org.keycloak.authorization.permission.ResourcePermission.ResourcePermission ( Resource  resource,
ResourceServer  resourceServer,
Map< String, ? extends Collection< String >>  claims 
)
inline
52  {
53  this(resource, new ArrayList<>(resource.getScopes()), resourceServer, claims);
54  }
final Resource resource
Definition: ResourcePermission.java:43
Map< String, Set< String > > claims
Definition: ResourcePermission.java:46
ResourceServer resourceServer
Definition: ResourcePermission.java:45

◆ ResourcePermission() [3/3]

org.keycloak.authorization.permission.ResourcePermission.ResourcePermission ( Resource  resource,
List< Scope scopes,
ResourceServer  resourceServer,
Map< String, ? extends Collection< String >>  claims 
)
inline
56  {
57  this.resource = resource;
58  this.scopes = scopes;
60  if (claims != null) {
61  this.claims = new HashMap<>();
62  for (Entry<String, ? extends Collection<String>> entry : claims.entrySet()) {
63  this.claims.computeIfAbsent(entry.getKey(), key -> new LinkedHashSet<>()).addAll(entry.getValue());
64  }
65  }
66  }
final List< Scope > scopes
Definition: ResourcePermission.java:44
final Resource resource
Definition: ResourcePermission.java:43
Map< String, Set< String > > claims
Definition: ResourcePermission.java:46
ResourceServer resourceServer
Definition: ResourcePermission.java:45

関数詳解

◆ addClaim()

boolean org.keycloak.authorization.permission.ResourcePermission.addClaim ( String  name,
String  value 
)
inline

Adds a permission claim with the given name and a single value.

If a claim already exists, the value is added to list of values of the existing claim

引数
namethe name of the claim
valuethe value of the claim
115  {
116  if (claims == null) {
117  claims = new HashMap<>();
118  }
119  return claims.computeIfAbsent(name, key -> new HashSet<>()).add(value);
120  }
Map< String, Set< String > > claims
Definition: ResourcePermission.java:46

◆ addClaims()

void org.keycloak.authorization.permission.ResourcePermission.addClaims ( Map< String, Set< String >>  claims)
inline
146  {
147  if (this.claims == null) {
148  this.claims = new HashMap<>();
149  }
150  this.claims.putAll(claims);
151  }
Map< String, Set< String > > claims
Definition: ResourcePermission.java:46

◆ addScope()

void org.keycloak.authorization.permission.ResourcePermission.addScope ( Scope  scope)
inline
134  {
135  if (resource != null) {
136  if (!resource.getScopes().contains(scope)) {
137  return;
138  }
139  }
140 
141  if (!scopes.contains(scope)) {
142  scopes.add(scope);
143  }
144  }
final List< Scope > scopes
Definition: ResourcePermission.java:44
final Resource resource
Definition: ResourcePermission.java:43

◆ getClaims()

Map<String, Set<String> > org.keycloak.authorization.permission.ResourcePermission.getClaims ( )
inline

Returns all permission claims.

戻り値
100  {
101  if (claims == null) {
102  return Collections.emptyMap();
103  }
104  return Collections.unmodifiableMap(claims);
105  }
Map< String, Set< String > > claims
Definition: ResourcePermission.java:46

◆ getResource()

Resource org.keycloak.authorization.permission.ResourcePermission.getResource ( )
inline

Returns the resource to which this permission applies.

戻り値
the resource to which this permission applies
73  {
74  return this.resource;
75  }
final Resource resource
Definition: ResourcePermission.java:43

◆ getResourceServer()

ResourceServer org.keycloak.authorization.permission.ResourcePermission.getResourceServer ( )
inline

Returns the resource server associated with this permission.

戻り値
the resource server
91  {
92  return this.resourceServer;
93  }
ResourceServer resourceServer
Definition: ResourcePermission.java:45

◆ getScopes()

List<Scope> org.keycloak.authorization.permission.ResourcePermission.getScopes ( )
inline

Returns a list of permitted scopes associated with the resource

戻り値
a lit of permitted scopes
82  {
83  return this.scopes;
84  }
final List< Scope > scopes
Definition: ResourcePermission.java:44

◆ removeClaim()

void org.keycloak.authorization.permission.ResourcePermission.removeClaim ( String  name)
inline

Removes a permission claim.

引数
namethe name of the claim
128  {
129  if (claims != null) {
130  claims.remove(name);
131  }
132  }
Map< String, Set< String > > claims
Definition: ResourcePermission.java:46

メンバ詳解

◆ claims

Map<String, Set<String> > org.keycloak.authorization.permission.ResourcePermission.claims
private

◆ resource

final Resource org.keycloak.authorization.permission.ResourcePermission.resource
private

◆ resourceServer

ResourceServer org.keycloak.authorization.permission.ResourcePermission.resourceServer
private

◆ scopes

final List<Scope> org.keycloak.authorization.permission.ResourcePermission.scopes
private

このクラス詳解は次のファイルから抽出されました: