com.haulmont.cuba.security.app.group.annotation

Annotation Type AccessGroup

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

Indicates that an annotated class is a access group. The access group will be available in the user interface if the application is running in the corresponding mode (the app property cuba.accessGroupsStorageMode equals SOURCE_CODE or MIXED).

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

 @AccessGroup(name = "MyFirstAccessGroup", parent = ParentAccessGroup.class)
 public class MyFirstAccessGroup extends AnnotatedAccessGroupDefinition {

     @JpqlConstraint(target = SomeEntity.class, where = "{E}.attr = true")
     @Override
     public ConstraintsContainer accessConstraints() {
         return super.accessConstraints();
     }

     @Constraint(operations = {EntityOp.READ, EntityOp.UPDATE})
     @JpqlConstraint(where = "{E}.active = true")
     public boolean userConstraints(User user) {
         return Boolean.TRUE.equals(user.getActive());
     }

     @SessionAttribute(name = "key1", value = "value1")
     @Override
     public Map<String, Serializable> sessionAttributes() {
         return super.sessionAttributes();
     }
 }
 

See Also:

SecurityStorageMode, JpqlConstraint, Constraint, CustomConstraint, SessionAttribute

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
java.lang.String	name Access group name

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.Class<? extends AccessGroupDefinition>	parent Access group parent name
java.lang.String	value

Element Detail

name

public abstract java.lang.String name

Access group name

parent

public abstract java.lang.Class<? extends AccessGroupDefinition> parent

Access group parent name

Default:

com.haulmont.cuba.security.group.AccessGroupDefinition.class

value

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

Default:

""