com.haulmont.cuba.security.app.role.annotation

Annotation Type Role

@Target(value=TYPE)
 @Retention(value=RUNTIME)
 @Component
public @interface Role

Indicates that an annotated class is a "Role". Such a role will be available in the user interface if the application is running in the corresponding mode (the app property cuba.rolesStorageMode equals SOURCE_CODE or MIXED).

The easiest way to determine the role in the application source code is to extend your class from AnnotatedRoleDefinition and mark it with this annotation. Usage example:

     @Role(name = "My first role", isDefault = true)
 public class MyFirstRole extends AnnotatedRoleDefinition {

     @EntityAccess(entityClass = SomeEntity.class,
             operations = {EntityOp.DELETE, EntityOp.UPDATE})
     @Override
     public EntityPermissionsContainer entityPermissions() {
         return super.entityPermissions();
     }

     @EntityAttributeAccess(entityClass = SomeEntity.class, view = {"someAttribute", "attr2"},
             modify = {"attr3", "attr4"})
     @Override
     public EntityAttributePermissionsContainer entityAttributePermissions() {
         return super.entityAttributePermissions();
     }

     @SpecificAccess(permissions = {"my.specific.permission1", "my.specific.permission2"})
     @Override
     public SpecificPermissionsContainer specificPermissions() {
         return super.specificPermissions();
     }

     @ScreenAccess(screenIds = {"myapp_SomeEntity.edit", "myapp_OtherEntity.browse"})
     @Override
     public ScreenPermissionsContainer screenPermissions() {
         return super.screenPermissions();
     }

     @ScreenComponentAccess(screenId = "myapp_SomeEntity.browse", deny = {"someGroupBox"})
     @Override
     public ScreenComponentPermissionsContainer screenComponentPermissions() {
         return super.screenComponentPermissions();
     }
 }
 

See Also:

SecurityStorageMode, EntityAccess, EntityAttributeAccess, ScreenAccess, ScreenComponentAccess, SpecificAccess

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
java.lang.String	name Role name.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.String	description Description of the role.
boolean	isDefault Determines if the role is default.
boolean	isSuper Determines if the role is super.
java.lang.String	securityScope Determines security scope for the role.
java.lang.String	value

Element Detail

name

public abstract java.lang.String name

Role name.

description

public abstract java.lang.String description

Description of the role.

Default:

""

value

@AliasFor(annotation=org.springframework.stereotype.Component.class)
public abstract java.lang.String value

Default:

""

isDefault

public abstract boolean isDefault

Determines if the role is default.

Default:

false

isSuper

public abstract boolean isSuper

Determines if the role is super.

Default:

false

securityScope

public abstract java.lang.String securityScope

Determines security scope for the role.

Default:

"GENERIC_UI"