keycloak
公開メンバ関数 | 非公開メンバ関数 | 非公開変数類 | 全メンバ一覧
org.keycloak.representations.idm.authorization.ResourceRepresentation クラス
org.keycloak.representations.idm.authorization.ResourceRepresentation の継承関係図
Inheritance graph
org.keycloak.representations.idm.authorization.ResourceRepresentation 連携図
Collaboration graph

公開メンバ関数

 ResourceRepresentation (String name, Set< ScopeRepresentation > scopes, Set< String > uris, String type, String iconUri)
 
 ResourceRepresentation (String name, Set< ScopeRepresentation > scopes, String uri, String type, String iconUri)
 
 ResourceRepresentation (String name, Set< ScopeRepresentation > scopes, Set< String > uris, String type)
 
 ResourceRepresentation (String name, Set< ScopeRepresentation > scopes, String uri, String type)
 
 ResourceRepresentation (String name, Set< ScopeRepresentation > scopes)
 
 ResourceRepresentation (String name, String... scopes)
 
 ResourceRepresentation ()
 
void setId (String id)
 
String getId ()
 
String getName ()
 
String getDisplayName ()
 
String getUri ()
 
Set< String > getUris ()
 
String getType ()
 
Set< ScopeRepresentationgetScopes ()
 
String getIconUri ()
 
void setName (String name)
 
void setDisplayName (String displayName)
 
void setUri (String uri)
 
void setUris (Set< String > uris)
 
void setType (String type)
 
void setScopes (Set< ScopeRepresentation > scopes)
 
void setIconUri (String iconUri)
 
ResourceOwnerRepresentation getOwner ()
 
void setOwner (ResourceOwnerRepresentation owner)
 
void setOwner (String ownerId)
 
Boolean getOwnerManagedAccess ()
 
void setOwnerManagedAccess (Boolean ownerManagedAccess)
 
void addScope (String... scopeNames)
 
Map< String, List< String > > getAttributes ()
 
void setAttributes (Map< String, List< String >> attributes)
 
boolean equals (Object o)
 
int hashCode ()
 

非公開メンバ関数

void setScopesUma (Set< ScopeRepresentation > scopes)
 

非公開変数類

String id
 
String name
 
Set< String > uris
 
String type
 
Set< ScopeRepresentationscopes
 
String iconUri
 
ResourceOwnerRepresentation owner
 
Boolean ownerManagedAccess
 
String displayName
 
Map< String, List< String > > attributes
 

詳解

One or more resources that the resource server manages as a set of protected resources.

For more details, OAuth-resource-reg.

著者
Pedro Igor

構築子と解体子

◆ ResourceRepresentation() [1/7]

org.keycloak.representations.idm.authorization.ResourceRepresentation.ResourceRepresentation ( String  name,
Set< ScopeRepresentation scopes,
Set< String >  uris,
String  type,
String  iconUri 
)
inline

Creates a new instance.

引数
namea human-readable string describing a set of one or more resources
urisa List of URI that provides network locations for the resource set being registered
typea string uniquely identifying the semantics of the resource set
scopesthe available scopes for this resource set
iconUria URI for a graphic icon representing the resource set
74  {
75  this.name = name;
76  this.scopes = scopes;
77  this.uris = uris;
78  this.type = type;
79  this.iconUri = iconUri;
80  }
Set< ScopeRepresentation > scopes
Definition: ResourceRepresentation.java:53
String name
Definition: ResourceRepresentation.java:46
String iconUri
Definition: ResourceRepresentation.java:56
Set< String > uris
Definition: ResourceRepresentation.java:49
String type
Definition: ResourceRepresentation.java:50

◆ ResourceRepresentation() [2/7]

org.keycloak.representations.idm.authorization.ResourceRepresentation.ResourceRepresentation ( String  name,
Set< ScopeRepresentation scopes,
String  uri,
String  type,
String  iconUri 
)
inline
82  {
83  this(name, scopes, Collections.singleton(uri), type, iconUri);
84  }
Set< ScopeRepresentation > scopes
Definition: ResourceRepresentation.java:53
String name
Definition: ResourceRepresentation.java:46
String iconUri
Definition: ResourceRepresentation.java:56
String type
Definition: ResourceRepresentation.java:50

◆ ResourceRepresentation() [3/7]

org.keycloak.representations.idm.authorization.ResourceRepresentation.ResourceRepresentation ( String  name,
Set< ScopeRepresentation scopes,
Set< String >  uris,
String  type 
)
inline

Creates a new instance.

引数
namea human-readable string describing a set of one or more resources
urisa List of URI that provides the network location for the resource set being registered
typea string uniquely identifying the semantics of the resource set
scopesthe available scopes for this resource set
94  {
95  this(name, scopes, uris, type, null);
96  }
Set< ScopeRepresentation > scopes
Definition: ResourceRepresentation.java:53
String name
Definition: ResourceRepresentation.java:46
Set< String > uris
Definition: ResourceRepresentation.java:49
String type
Definition: ResourceRepresentation.java:50

◆ ResourceRepresentation() [4/7]

org.keycloak.representations.idm.authorization.ResourceRepresentation.ResourceRepresentation ( String  name,
Set< ScopeRepresentation scopes,
String  uri,
String  type 
)
inline
98  {
99  this(name, scopes, Collections.singleton(uri), type, null);
100  }
Set< ScopeRepresentation > scopes
Definition: ResourceRepresentation.java:53
String name
Definition: ResourceRepresentation.java:46
String type
Definition: ResourceRepresentation.java:50

◆ ResourceRepresentation() [5/7]

org.keycloak.representations.idm.authorization.ResourceRepresentation.ResourceRepresentation ( String  name,
Set< ScopeRepresentation scopes 
)
inline

Creates a new instance.

引数
namea human-readable string describing a set of one or more resources
serverUria URI that identifies this resource server
scopesthe available scopes for this resource set
109  {
110  this(name, scopes, (Set<String>) null, null, null);
111  }
Set< ScopeRepresentation > scopes
Definition: ResourceRepresentation.java:53
String name
Definition: ResourceRepresentation.java:46

◆ ResourceRepresentation() [6/7]

org.keycloak.representations.idm.authorization.ResourceRepresentation.ResourceRepresentation ( String  name,
String...  scopes 
)
inline
113  {
114  this.name = name;
115  this.scopes = new HashSet<>();
116  for (String s : scopes) {
117  ScopeRepresentation rep = new ScopeRepresentation(s);
118  this.scopes.add(rep);
119  }
120  }
Set< ScopeRepresentation > scopes
Definition: ResourceRepresentation.java:53
String name
Definition: ResourceRepresentation.java:46

◆ ResourceRepresentation() [7/7]

org.keycloak.representations.idm.authorization.ResourceRepresentation.ResourceRepresentation ( )
inline

Creates a new instance.

126  {
127  this(null, null, (Set<String>) null, null, null);
128  }

関数詳解

◆ addScope()

void org.keycloak.representations.idm.authorization.ResourceRepresentation.addScope ( String...  scopeNames)
inline
260  {
261  if (scopes == null) {
262  scopes = new HashSet<>();
263  }
264  for (String scopeName : scopeNames) {
265  scopes.add(new ScopeRepresentation(scopeName));
266  }
267  }
Set< ScopeRepresentation > scopes
Definition: ResourceRepresentation.java:53

◆ equals()

boolean org.keycloak.representations.idm.authorization.ResourceRepresentation.equals ( Object  o)
inline
277  {
278  if (this == o) return true;
279  if (o == null || getClass() != o.getClass()) return false;
281  return Objects.equals(getName(), scope.getName());
282  }
ResourceRepresentation()
Definition: ResourceRepresentation.java:126
String getName()
Definition: ResourceRepresentation.java:138

◆ getAttributes()

Map<String, List<String> > org.keycloak.representations.idm.authorization.ResourceRepresentation.getAttributes ( )
inline
269  {
270  return attributes;
271  }
Map< String, List< String > > attributes
Definition: ResourceRepresentation.java:63

◆ getDisplayName()

String org.keycloak.representations.idm.authorization.ResourceRepresentation.getDisplayName ( )
inline
142  {
143  return displayName;
144  }
String displayName
Definition: ResourceRepresentation.java:60

◆ getIconUri()

String org.keycloak.representations.idm.authorization.ResourceRepresentation.getIconUri ( )
inline
172  {
173  return this.iconUri;
174  }
String iconUri
Definition: ResourceRepresentation.java:56

◆ getId()

String org.keycloak.representations.idm.authorization.ResourceRepresentation.getId ( )
inline
134  {
135  return this.id;
136  }
String id
Definition: ResourceRepresentation.java:44

◆ getName()

String org.keycloak.representations.idm.authorization.ResourceRepresentation.getName ( )
inline
138  {
139  return this.name;
140  }
String name
Definition: ResourceRepresentation.java:46

◆ getOwner()

ResourceOwnerRepresentation org.keycloak.representations.idm.authorization.ResourceRepresentation.getOwner ( )
inline
229  {
230  return this.owner;
231  }
ResourceOwnerRepresentation owner
Definition: ResourceRepresentation.java:57

◆ getOwnerManagedAccess()

Boolean org.keycloak.representations.idm.authorization.ResourceRepresentation.getOwnerManagedAccess ( )
inline
252  {
253  return ownerManagedAccess;
254  }
Boolean ownerManagedAccess
Definition: ResourceRepresentation.java:58

◆ getScopes()

Set<ScopeRepresentation> org.keycloak.representations.idm.authorization.ResourceRepresentation.getScopes ( )
inline
164  {
165  if (this.scopes == null) {
166  return Collections.emptySet();
167  }
168 
169  return Collections.unmodifiableSet(this.scopes);
170  }
Set< ScopeRepresentation > scopes
Definition: ResourceRepresentation.java:53

◆ getType()

String org.keycloak.representations.idm.authorization.ResourceRepresentation.getType ( )
inline
160  {
161  return this.type;
162  }
String type
Definition: ResourceRepresentation.java:50

◆ getUri()

String org.keycloak.representations.idm.authorization.ResourceRepresentation.getUri ( )
inline
148  {
149  if (this.uris == null || this.uris.isEmpty()) {
150  return null;
151  }
152 
153  return this.uris.iterator().next();
154  }
Set< String > uris
Definition: ResourceRepresentation.java:49

◆ getUris()

Set<String> org.keycloak.representations.idm.authorization.ResourceRepresentation.getUris ( )
inline
156  {
157  return this.uris;
158  }
Set< String > uris
Definition: ResourceRepresentation.java:49

◆ hashCode()

int org.keycloak.representations.idm.authorization.ResourceRepresentation.hashCode ( )
inline
284  {
285  return Objects.hash(getName());
286  }
String getName()
Definition: ResourceRepresentation.java:138

◆ setAttributes()

void org.keycloak.representations.idm.authorization.ResourceRepresentation.setAttributes ( Map< String, List< String >>  attributes)
inline
273  {
274  this.attributes = attributes;
275  }
Map< String, List< String > > attributes
Definition: ResourceRepresentation.java:63

◆ setDisplayName()

void org.keycloak.representations.idm.authorization.ResourceRepresentation.setDisplayName ( String  displayName)
inline
180  {
181  this.displayName = displayName;
182  }
String displayName
Definition: ResourceRepresentation.java:60

◆ setIconUri()

void org.keycloak.representations.idm.authorization.ResourceRepresentation.setIconUri ( String  iconUri)
inline
225  {
226  this.iconUri = iconUri;
227  }
String iconUri
Definition: ResourceRepresentation.java:56

◆ setId()

void org.keycloak.representations.idm.authorization.ResourceRepresentation.setId ( String  id)
inline
130  {
131  this.id = id;
132  }
String id
Definition: ResourceRepresentation.java:44

◆ setName()

void org.keycloak.representations.idm.authorization.ResourceRepresentation.setName ( String  name)
inline
176  {
177  this.name = name;
178  }
String name
Definition: ResourceRepresentation.java:46

◆ setOwner() [1/2]

void org.keycloak.representations.idm.authorization.ResourceRepresentation.setOwner ( ResourceOwnerRepresentation  owner)
inline
234  {
235  this.owner = owner;
236  }
ResourceOwnerRepresentation owner
Definition: ResourceRepresentation.java:57

◆ setOwner() [2/2]

void org.keycloak.representations.idm.authorization.ResourceRepresentation.setOwner ( String  ownerId)
inline
239  {
240  if (ownerId == null) {
241  owner = null;
242  return;
243  }
244 
245  if (owner == null) {
246  owner = new ResourceOwnerRepresentation();
247  }
248 
249  owner.setId(ownerId);
250  }
void setId(String id)
Definition: ResourceOwnerRepresentation.java:39
ResourceOwnerRepresentation owner
Definition: ResourceRepresentation.java:57

◆ setOwnerManagedAccess()

void org.keycloak.representations.idm.authorization.ResourceRepresentation.setOwnerManagedAccess ( Boolean  ownerManagedAccess)
inline
256  {
258  }
Boolean ownerManagedAccess
Definition: ResourceRepresentation.java:58

◆ setScopes()

void org.keycloak.representations.idm.authorization.ResourceRepresentation.setScopes ( Set< ScopeRepresentation scopes)
inline
211  {
212  this.scopes = scopes;
213  }
Set< ScopeRepresentation > scopes
Definition: ResourceRepresentation.java:53

◆ setScopesUma()

void org.keycloak.representations.idm.authorization.ResourceRepresentation.setScopesUma ( Set< ScopeRepresentation scopes)
inlineprivate

TODO: This is a workaround to allow deserialization of UMA resource representation. Jackson 2.19+ support aliases, once we upgrade, change this.

引数
scopes
221  {
222  this.scopes = scopes;
223  }
Set< ScopeRepresentation > scopes
Definition: ResourceRepresentation.java:53

◆ setType()

void org.keycloak.representations.idm.authorization.ResourceRepresentation.setType ( String  type)
inline
205  {
206  if (type != null && !"".equalsIgnoreCase(type.trim())) {
207  this.type = type;
208  }
209  }
String type
Definition: ResourceRepresentation.java:50

◆ setUri()

void org.keycloak.representations.idm.authorization.ResourceRepresentation.setUri ( String  uri)
inline
186  {
187  if (uri != null && !"".equalsIgnoreCase(uri.trim())) {
188  this.uris = Collections.singleton(uri);
189  }
190  }
Set< String > uris
Definition: ResourceRepresentation.java:49

◆ setUris()

void org.keycloak.representations.idm.authorization.ResourceRepresentation.setUris ( Set< String >  uris)
inline
192  {
193  if (uris != null) {
194  Set<String> resultSet = new HashSet<>();
195  for (String uri : uris) {
196  if (uri != null && !"".equalsIgnoreCase(uri.trim())) {
197  resultSet.add(uri);
198  }
199  }
200 
201  this.uris = resultSet;
202  }
203  }
Set< String > uris
Definition: ResourceRepresentation.java:49

メンバ詳解

◆ attributes

Map<String, List<String> > org.keycloak.representations.idm.authorization.ResourceRepresentation.attributes
private

◆ displayName

String org.keycloak.representations.idm.authorization.ResourceRepresentation.displayName
private

◆ iconUri

String org.keycloak.representations.idm.authorization.ResourceRepresentation.iconUri
private

◆ id

String org.keycloak.representations.idm.authorization.ResourceRepresentation.id
private

◆ name

String org.keycloak.representations.idm.authorization.ResourceRepresentation.name
private

◆ owner

ResourceOwnerRepresentation org.keycloak.representations.idm.authorization.ResourceRepresentation.owner
private

◆ ownerManagedAccess

Boolean org.keycloak.representations.idm.authorization.ResourceRepresentation.ownerManagedAccess
private

◆ scopes

Set<ScopeRepresentation> org.keycloak.representations.idm.authorization.ResourceRepresentation.scopes
private

◆ type

String org.keycloak.representations.idm.authorization.ResourceRepresentation.type
private

◆ uris

Set<String> org.keycloak.representations.idm.authorization.ResourceRepresentation.uris
private

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