org.keycloak.authorization.model.Resource インタフェース

org.keycloak.authorization.model.Resource 連携図

公開メンバ関数
String	getId ()
String	getName ()
void	setName (String name)
String	getDisplayName ()
void	setDisplayName (String name)
Set< String >	getUris ()
void	updateUris (Set< String > uri)
String	getType ()
void	setType (String type)
List< Scope >	getScopes ()
String	getIconUri ()
void	setIconUri (String iconUri)
ResourceServer	getResourceServer ()
String	getOwner ()
boolean	isOwnerManagedAccess ()
void	setOwnerManagedAccess (boolean ownerManagedAccess)
void	updateScopes (Set< Scope > scopes)
Map< String, List< String > >	getAttributes ()
String	getSingleAttribute (String name)
List< String >	getAttribute (String name)
void	setAttribute (String name, List< String > values)
void	removeAttribute (String name)

詳解

Represents a resource, which is usually protected by a set of policies within a resource server.

著者

Pedro Igor

関数詳解

getAttribute()

List<String> org.keycloak.authorization.model.Resource.getAttribute

(

String

name

)

Returns the values of an attribute with the given name

戻り値

the values of an attribute

getAttributes()

Map<String, List<String> > org.keycloak.authorization.model.Resource.getAttributes

(

)

Returns the attributes associated with this resource.

戻り値

a map holding the attributes associated with this resource

getDisplayName()

String org.keycloak.authorization.model.Resource.getDisplayName

(

)

Returns the end user friendly name for this resource. If not defined, value for getName() is returned.

戻り値

the friendly name for this resource

getIconUri()

String org.keycloak.authorization.model.Resource.getIconUri

(

)

Returns an icon java.net.URI for this resource.

戻り値

a uri for an icon

getId()

String org.keycloak.authorization.model.Resource.getId

(

)

Returns the unique identifier for this instance.

戻り値

the unique identifier for this instance

getName()

String org.keycloak.authorization.model.Resource.getName

(

)

Returns the resource's name.

戻り値

the name of this resource

getOwner()

String org.keycloak.authorization.model.Resource.getOwner

(

)

Returns the resource's owner, which is usually an identifier that uniquely identifies the resource's owner.

戻り値

the owner of this resource

getResourceServer()

ResourceServer org.keycloak.authorization.model.Resource.getResourceServer

(

)

Returns the ResourceServer to where this resource belongs to.

戻り値

the resource server associated with this resource

getScopes()

List<Scope> org.keycloak.authorization.model.Resource.getScopes

(

)

Returns a List containing all the Scope associated with this resource.

戻り値

a list with all scopes associated with this resource

getSingleAttribute()

String org.keycloak.authorization.model.Resource.getSingleAttribute

(

String

name

)

Returns the first value of an attribute with the given name

戻り値

the first value of an attribute

getType()

String org.keycloak.authorization.model.Resource.getType

(

)

Returns a string representing the type of this resource.

戻り値

the type of this resource or null if not defined

getUris()

Set<String> org.keycloak.authorization.model.Resource.getUris

(

)

Returns a List containing all java.net.URI that uniquely identify this resource.

戻り値

a List if java.net.URI for this resource or empty list if not defined.

isOwnerManagedAccess()

boolean org.keycloak.authorization.model.Resource.isOwnerManagedAccess

(

)

Indicates if this resource can be managed by the resource owner.

戻り値

true 

if this resource can be managed by the resource owner. Otherwise,

false 

.

removeAttribute()

void org.keycloak.authorization.model.Resource.removeAttribute

(

String

name

)

setAttribute()

void org.keycloak.authorization.model.Resource.setAttribute	(	String	name,
		List< String >	values
	)

Sets an attribute with the given name and values.

引数

name	the attribute name
value	the attribute values

戻り値

a map holding the attributes associated with this resource

setDisplayName()

void org.keycloak.authorization.model.Resource.setDisplayName

(

String

name

)

Sets an end user friendly name for this resource.

引数

name	the name of this resource

setIconUri()

void org.keycloak.authorization.model.Resource.setIconUri

(

String

iconUri

)

Sets an icon java.net.URI for this resource.

戻り値

a uri for an icon

setName()

void org.keycloak.authorization.model.Resource.setName

(

String

name

)

Sets a name for this resource. The name must be unique.

引数

name	the name of this resource

setOwnerManagedAccess()

void org.keycloak.authorization.model.Resource.setOwnerManagedAccess

(

boolean

ownerManagedAccess

)

Sets if this resource can be managed by the resource owner.

引数

ownerManagedAccess

setType()

void org.keycloak.authorization.model.Resource.setType

(

String

type

)

Sets a string representing the type of this resource.

戻り値

the type of this resource or null if not defined

updateScopes()

void org.keycloak.authorization.model.Resource.updateScopes

(

Set< Scope >

scopes

)

Update the set of scopes associated with this resource.

引数

scopes

the list of scopes to update

updateUris()

void org.keycloak.authorization.model.Resource.updateUris

(

Set< String >

uri

)

Sets a list of java.net.URI that uniquely identify this resource.

引数

uri	an java.net.URI for this resource

---

このインタフェース詳解は次のファイルから抽出されました:

• D:/AppData/doxygen/keycloak/oidc-service/src/main/java/org/keycloak/authorization/model/Resource.java