senselogic.sitevision.api.security

Interface RoleUtil

@Requireable(value="RoleUtil")
public interface RoleUtil

Role utility interface.

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

Since:

Sitevision 5.1

Author:

Magnus Lövgren

See Also:

PermissionUtil

Method Summary

Modifier and Type	Method and Description
boolean	containsPermission(Node aRole, PermissionUtil.Permission aPermission) Checks if a role contains a specific permission.
RoleAssignmentBuilder	getRoleAssignmentBuilder() Creates a RoleAssignmentBuilder instance.
Node	getRoleByName(String aRoleName) Gets a role by name.
RoleMatcherBuilder	getRoleMatcherBuilder() Creates a RoleMatcherBuilder instance.

Method Detail

getRoleAssignmentBuilder

RoleAssignmentBuilder getRoleAssignmentBuilder()

Creates a RoleAssignmentBuilder instance.

Returns:

a RoleAssignmentBuilder

getRoleMatcherBuilder

RoleMatcherBuilder getRoleMatcherBuilder()

Creates a RoleMatcherBuilder instance.

Returns:

a RoleMatcherBuilder

Since:

Sitevision 6.1

getRoleByName

Node getRoleByName(String aRoleName)

Gets a role by name.

Parameters:

aRoleName - the name of the role

Returns:

the role (sv:role) with name aRoleName, or null if no such role could be found

containsPermission

boolean containsPermission(Node aRole,
                           PermissionUtil.Permission aPermission)

Checks if a role contains a specific permission.

Parameters:

aRole - the role (sv:role)

aPermission - the permission

Returns:

true if aRole is a sv:role and contains aPermission, false otherwise