senselogic.sitevision.api.security

Interface RoleAssignment

public interface RoleAssignment

Role assignment representation that can be applied on a node to update its roles setup.

A role assignment instance is a representation of a sv:role and a principal (sv:user, sv:simpleUser, sv:userGroup or sv:virtualGroup) that can be applied to various nodes using the apply(Node) method.

An instance of the Sitevision class implementing this interface can be obtained via RoleAssignmentBuilder.build(). See RoleAssignmentBuilder for how to obtain an instance of the RoleAssignmentBuilder interface.

Since:

Sitevision 5.1

Author:

Magnus Lövgren

Method Summary

Modifier and Type	Method and Description
void	apply(Node aNode) Applies this role assignment on a given node.
boolean	isApplicable(Node aNode) Whether or not current user is allowed to apply(Node) or revoke(Node) this role assignment for a given node.
boolean	isApplied(Node aNode) Whether or not a given node already has this role assignment applied.
void	revoke(Node aNode) Revokes this role assignment on a given node.

Method Detail

apply

void apply(Node aNode)
    throws ConstraintViolationException,
           RepositoryException

Applies this role assignment on a given node.

Parameters:

aNode - the node of the role assignment operation, typically a sv:page

Throws:

ConstraintViolationException - if current user doesn't have permission to do the role assignment on aNode

RepositoryException - if something else goes wrong (e.g. mutation might fail if no lock can be acquired for aNode)

See Also:

isApplicable(Node)

isApplicable

boolean isApplicable(Node aNode)

Whether or not current user is allowed to apply(Node) or revoke(Node) this role assignment for a given node.

Permission note! Current user must have PermissionUtil.Permission.MANAGE_RIGHTS on aNode and current user must also have the role (that this role assignment contains) on aNode.

Parameters:

aNode - the node of the role assignment operation, typically a sv:page

Returns:

true if current user is allowed to apply/revoke this role assignment on aNode, false otherwise

isApplied

boolean isApplied(Node aNode)

Whether or not a given node already has this role assignment applied.

Note! If this method returns true, there is no need to execute apply(Node).

Parameters:

aNode - the node of the role assignment operation, typically a sv:page

Returns:

true if aNode already has this role assignment, false otherwise

revoke

void revoke(Node aNode)
     throws ConstraintViolationException,
            RepositoryException

Revokes this role assignment on a given node.

Parameters:

aNode - the node of the revoke operation, typically a sv:page

Throws:

ConstraintViolationException - if current user doesn't have permission to revoke the role assignment on aNode

RepositoryException - if something else goes wrong (e.g. mutation might fail if no lock can be acquired for aNode)

Since:

Sitevision 6.0.1

See Also:

isApplicable(Node)