Package io.jmix.security.model

Class ResourceRole

java.lang.Object

io.jmix.security.model.BaseRole

io.jmix.security.model.ResourceRole

All Implemented Interfaces:

Serializable

public class ResourceRole
extends BaseRole

Class is a container for security resource policies.

Resource policies define permissions for resources. A resource may be a screen, entity CRUD operation, entity attribute, etc.

Role objects may be created from different sources:

• from interfaces annotated with ResourceRole
• from database Role entities
• created explicitly by the application

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ResourceRole.ResourcePoliciesIndex	A data structure that stores role policies grouped by policy type and resource.

Constructor Summary

Constructors

Constructor	Description
ResourceRole()

Method Summary

Modifier and Type	Method	Description
Collection<ResourcePolicy>	getAllResourcePolicies()	Returns policies defined in the current role and in all its child roles.
ResourceRole.ResourcePoliciesIndex	getAllResourcePoliciesIndex()	Returns an index structure that stores policies of the current role and all child roles.
Collection<ResourcePolicy>	getResourcePolicies()	Returns a list of policies defined directly in the current role, excluding policies from child roles.
ResourceRole.ResourcePoliciesIndex	getResourcePoliciesIndex()	Returns an index structure that stores policies of the current role only.
Set<String>	getScopes()
void	setAllResourcePolicies(Collection<ResourcePolicy> allResourcePolicies)
void	setResourcePolicies(Collection<ResourcePolicy> resourcePolicies)
void	setScopes(Set<String> scopes)

Methods inherited from class io.jmix.security.model.BaseRole

getChildRoles, getCode, getCustomProperties, getDescription, getName, getSource, getTenantId, setChildRoles, setCode, setCustomProperties, setDescription, setName, setSource, setTenantId

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ResourceRole

public ResourceRole()

Method Details

getScopes

public Set<String> getScopes()

setScopes

public void setScopes(Set<String> scopes)

getResourcePolicies

public Collection<ResourcePolicy> getResourcePolicies()

Returns a list of policies defined directly in the current role, excluding policies from child roles.

setResourcePolicies

public void setResourcePolicies(Collection<ResourcePolicy> resourcePolicies)

getAllResourcePolicies

public Collection<ResourcePolicy> getAllResourcePolicies()

Returns policies defined in the current role and in all its child roles.

setAllResourcePolicies

public void setAllResourcePolicies(Collection<ResourcePolicy> allResourcePolicies)

getResourcePoliciesIndex

public ResourceRole.ResourcePoliciesIndex getResourcePoliciesIndex()

Returns an index structure that stores policies of the current role only.

getAllResourcePoliciesIndex

public ResourceRole.ResourcePoliciesIndex getAllResourcePoliciesIndex()

Returns an index structure that stores policies of the current role and all child roles.