com.haulmont.cuba.security.app.role

Class RolesHelper

java.lang.Object

com.haulmont.cuba.security.app.role.RolesHelper

@Component(value="cuba_RolesHelper")
public class RolesHelper
extends java.lang.Object

Class contains miscellaneous useful methods for working with predefined roles

Field Summary

Fields

Modifier and Type	Field and Description
protected DataManager	dataManager
protected Metadata	metadata
protected PredefinedRoleDefinitionRepository	predefinedRoleDefinitionRepository
protected ServerConfig	serverConfig

Constructor Summary

Constructors

Constructor and Description
RolesHelper()

Method Summary

Modifier and Type	Method and Description
protected void	fillWildcardPermissionsByRoleType(BasicRoleDefinition.BasicRoleDefinitionBuilder builder, RoleType roleType)
java.util.Collection<Role>	getDefaultRoles()
java.util.Collection<Role>	getDefaultRoles(EntityManager em)
Access	getPermissionUndefinedAccessPolicy() Defines a policy for resolving permission values that are not defined in roles.
java.util.Collection<RoleDefinition>	getRoleDefinitionsForUser(User user, boolean reloadUser) Returns a collection of RoleDefinition objects assigned to the User.
java.util.Collection<Permission>	transformToPermissionsCollection(PermissionsContainer permissionsContainer, PermissionType type, Role role)
Role	transformToRole(RoleDefinition roleDefinition, RoleTransformationOption... transformationOptions)
RoleDefinition	transformToRoleDefinition(Role role)

Methods inherited from class java.lang.Object

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

Field Detail

serverConfig

@Inject
protected ServerConfig serverConfig

predefinedRoleDefinitionRepository

@Inject
protected PredefinedRoleDefinitionRepository predefinedRoleDefinitionRepository

dataManager

@Inject
protected DataManager dataManager

metadata

@Inject
protected Metadata metadata

Constructor Detail

RolesHelper

public RolesHelper()

Method Detail

getDefaultRoles

public java.util.Collection<Role> getDefaultRoles()

getDefaultRoles

public java.util.Collection<Role> getDefaultRoles(@Nullable
                                                  EntityManager em)

getRoleDefinitionsForUser

public java.util.Collection<RoleDefinition> getRoleDefinitionsForUser(User user,
                                                                      boolean reloadUser)

Returns a collection of RoleDefinition objects assigned to the User. If the user role is associated with the database role, the database role will be converted to the RoleDefinition

Parameters:

user - the user

reloadUser - if set to true then the passed user will be reloaded with the proper view (contains roles with permissions). If the parameter value is false then this check won't be performed. Set the parameter to false when the method is invoked from within the opened transaction (i.e. from the UserSessionManager) - in this case all non-loaded fields will be fetched when they are accessed within the method.

Returns:

collection of RoleDefinition objects

transformToRole

public Role transformToRole(RoleDefinition roleDefinition,
                            RoleTransformationOption... transformationOptions)

transformToPermissionsCollection

public java.util.Collection<Permission> transformToPermissionsCollection(PermissionsContainer permissionsContainer,
                                                                         PermissionType type,
                                                                         Role role)

transformToRoleDefinition

public RoleDefinition transformToRoleDefinition(Role role)

getPermissionUndefinedAccessPolicy

public Access getPermissionUndefinedAccessPolicy()

Defines a policy for resolving permission values that are not defined in roles. For roles policy v1, if a role doesn't define any explicit permission then this target is allowed.

For new v2 security mechanism the undefined permission should be resolved as denied.

fillWildcardPermissionsByRoleType

protected void fillWildcardPermissionsByRoleType(BasicRoleDefinition.BasicRoleDefinitionBuilder builder,
                                                 @Nullable
                                                 RoleType roleType)