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

公開メンバ関数
String	getId ()

String	getType ()

DecisionStrategy	getDecisionStrategy ()

void	setDecisionStrategy (DecisionStrategy decisionStrategy)

Logic	getLogic ()

void	setLogic (Logic logic)

Map< String, String >	getConfig ()

void	setConfig (Map< String, String > config)

void	removeConfig (String name)

void	putConfig (String name, String value)

String	getName ()

void	setName (String name)

String	getDescription ()

void	setDescription (String description)

ResourceServer	getResourceServer ()

Set< Policy >	getAssociatedPolicies ()

Set< Resource >	getResources ()

Set< Scope >	getScopes ()

String	getOwner ()

void	setOwner (String owner)

void	addScope (Scope scope)

void	removeScope (Scope scope)

void	addAssociatedPolicy (Policy associatedPolicy)

void	removeAssociatedPolicy (Policy associatedPolicy)

void	addResource (Resource resource)

void	removeResource (Resource resource)

詳解

Represents an authorization policy and all the configuration associated with it.

著者: Pedro Igor

関数詳解

◆ addAssociatedPolicy()

void org.keycloak.authorization.model.Policy.addAssociatedPolicy ( Policy associatedPolicy )

◆ addResource()

void org.keycloak.authorization.model.Policy.addResource ( Resource resource )

◆ addScope()

void org.keycloak.authorization.model.Policy.addScope ( Scope scope )

◆ getAssociatedPolicies()

Set<Policy> org.keycloak.authorization.model.Policy.getAssociatedPolicies ( )

Returns the Policy instances associated with this policy and used to evaluate authorization decisions when this policy applies.

戻り値: the associated policies or an empty set if no policy is associated with this policy

◆ getConfig()

Map<String, String> org.keycloak.authorization.model.Policy.getConfig ( )

Returns a Map holding string-based key/value pairs representing any additional configuration for this policy.

戻り値: a unmodifiable map with any additional configuration defined for this policy.

◆ getDecisionStrategy()

DecisionStrategy org.keycloak.authorization.model.Policy.getDecisionStrategy ( )

Returns the DecisionStrategy for this policy.

戻り値: the decision strategy defined for this policy

◆ getDescription()

String org.keycloak.authorization.model.Policy.getDescription ( )

Returns the description of this policy.

戻り値: a description or null of there is no description

◆ getId()

String org.keycloak.authorization.model.Policy.getId ( )

Returns the unique identifier for this instance.

戻り値: the unique identifier for this instance

◆ getLogic()

Logic org.keycloak.authorization.model.Policy.getLogic ( )

Returns the Logic for this policy.

戻り値: the decision strategy defined for this policy

◆ getName()

String org.keycloak.authorization.model.Policy.getName ( )

Returns the name of this policy.

戻り値: the name of this policy

◆ getOwner()

String org.keycloak.authorization.model.Policy.getOwner ( )

◆ getResources()

Set<Resource> org.keycloak.authorization.model.Policy.getResources ( )

Returns the Resource instances where this policy applies.

戻り値: a set with all resource instances where this policy applies. Or an empty set if there is no resource associated with this policy

◆ getResourceServer()

ResourceServer org.keycloak.authorization.model.Policy.getResourceServer ( )

Returns the ResourceServer where this policy belongs to.

戻り値: a resource server

◆ getScopes()

Set<Scope> org.keycloak.authorization.model.Policy.getScopes ( )

Returns the Scope instances where this policy applies.

戻り値: a set with all scope instances where this policy applies. Or an empty set if there is no scope associated with this policy

◆ getType()

String org.keycloak.authorization.model.Policy.getType ( )

Returns the type of this policy.

戻り値: the type of this policy

◆ putConfig()

void org.keycloak.authorization.model.Policy.putConfig	(	String	name,
		String	value
	)

◆ removeAssociatedPolicy()

void org.keycloak.authorization.model.Policy.removeAssociatedPolicy ( Policy associatedPolicy )

◆ removeConfig()

void org.keycloak.authorization.model.Policy.removeConfig ( String name )

◆ removeResource()

void org.keycloak.authorization.model.Policy.removeResource ( Resource resource )

◆ removeScope()

void org.keycloak.authorization.model.Policy.removeScope ( Scope scope )

◆ setConfig()

void org.keycloak.authorization.model.Policy.setConfig ( Map< String, String > config )

Sets a Map with string-based key/value pairs representing any additional configuration for this policy.

戻り値: a map with any additional configuration for this policy.

◆ setDecisionStrategy()

void org.keycloak.authorization.model.Policy.setDecisionStrategy ( DecisionStrategy decisionStrategy )

Sets the {DecisionStrategy} for this policy.

戻り値: the decision strategy for this policy

◆ setDescription()

void org.keycloak.authorization.model.Policy.setDescription ( String description )

Sets the description for this policy.

引数

description a description

◆ setLogic()

void org.keycloak.authorization.model.Policy.setLogic ( Logic logic )

Sets the {Logic} for this policy.

戻り値: the decision strategy for this policy

◆ setName()

void org.keycloak.authorization.model.Policy.setName ( String name )

Sets an unique name to this policy.