com.haulmont.cuba.security.app.group

Class AccessGroupDefinitionBuilder

java.lang.Object

com.haulmont.cuba.security.app.group.AccessGroupDefinitionBuilder

@Component(value="cuba_AccessGroupDefinitionBuilder")
 @Scope(value="prototype")
public class AccessGroupDefinitionBuilder
extends java.lang.Object

Builder class that helps to create access group definition.

Field Summary

Fields

Modifier and Type	Field and Description
protected AccessConstraintsBuilder	accessConstraintsBuilder
protected java.lang.String	name
static java.lang.String	NAME
protected java.util.Map<java.lang.String,java.io.Serializable>	sessionAttributes

Constructor Summary

Constructors

Constructor and Description
AccessGroupDefinitionBuilder()

Method Summary

Modifier and Type	Method and Description
AccessGroupDefinition	build() Returns the built access group definition
static AccessGroupDefinitionBuilder	create()
protected void	init()
AccessGroupDefinitionBuilder	withConstraints(java.util.function.Consumer<AccessConstraintsBuilder> constraintsConsumer) Adds access constraints to the group definition using AccessConstraintsBuilder
AccessGroupDefinitionBuilder	withCustomGroovyConstraint(java.lang.Class<? extends Entity> target, java.lang.String constraintCode, java.lang.String groovyScript) Adds in-memory groovy custom constraint to the group definition
AccessGroupDefinitionBuilder	withCustomInMemoryConstraint(java.lang.Class<? extends Entity> target, java.lang.String constraintCode, ConstraintPredicate<? extends Entity> predicate) Adds in-memory custom constraint to the group definition
AccessGroupDefinitionBuilder	withCustomJpqlConstraint(java.lang.Class<? extends Entity> target, java.lang.String constraintCode, java.lang.String where, java.lang.String join) Adds JPQL custom constraint to the group definition
AccessGroupDefinitionBuilder	withGroovyConstraint(java.lang.Class<? extends Entity> target, EntityOp operation, java.lang.String groovyScript) Adds in-memory groovy constraint to the group definition
AccessGroupDefinitionBuilder	withInMemoryConstraint(java.lang.Class<? extends Entity> target, EntityOp operation, ConstraintPredicate<? extends Entity> predicate) Adds in-memory constraint to the group definition
AccessGroupDefinitionBuilder	withJpqlConstraint(java.lang.Class<? extends Entity> target, java.lang.String where) Adds JPQL READ constraint to the group definition
AccessGroupDefinitionBuilder	withJpqlConstraint(java.lang.Class<? extends Entity> target, java.lang.String where, java.lang.String join) Adds JPQL READ constraint to the group definition
AccessGroupDefinitionBuilder	withName(java.lang.String name) Specifies the group name type.
AccessGroupDefinitionBuilder	withSessionAttribute(java.lang.String key, java.io.Serializable value) Adds new session attribute to the group definition
AccessGroupDefinitionBuilder	withSessionAttributes(java.util.Map<java.lang.String,java.io.Serializable> attributes) Adds new session attributes to the group definition

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

accessConstraintsBuilder

protected AccessConstraintsBuilder accessConstraintsBuilder

name

protected java.lang.String name

sessionAttributes

protected java.util.Map<java.lang.String,java.io.Serializable> sessionAttributes

Constructor Detail

AccessGroupDefinitionBuilder

public AccessGroupDefinitionBuilder()

Method Detail

create

public static AccessGroupDefinitionBuilder create()

init

@PostConstruct
protected void init()

withName

public AccessGroupDefinitionBuilder withName(java.lang.String name)

Specifies the group name type.

Returns:

current instance of the builder

withJpqlConstraint

public AccessGroupDefinitionBuilder withJpqlConstraint(java.lang.Class<? extends Entity> target,
                                                       java.lang.String where,
                                                       java.lang.String join)

Adds JPQL READ constraint to the group definition

Parameters:

target - entity class

where - JPQL where clause

join - JPQL join clause

Returns:

current instance of the builder

withJpqlConstraint

public AccessGroupDefinitionBuilder withJpqlConstraint(java.lang.Class<? extends Entity> target,
                                                       java.lang.String where)

Adds JPQL READ constraint to the group definition

Parameters:

target - entity class

where - JPQL where clause

Returns:

current instance of the builder

withCustomJpqlConstraint

public AccessGroupDefinitionBuilder withCustomJpqlConstraint(java.lang.Class<? extends Entity> target,
                                                             java.lang.String constraintCode,
                                                             java.lang.String where,
                                                             java.lang.String join)

Adds JPQL custom constraint to the group definition

Parameters:

target - entity class

constraintCode - custom constraint code

where - JPQL where clause

join - JPQL join clause

Returns:

current instance of the builder

withInMemoryConstraint

public AccessGroupDefinitionBuilder withInMemoryConstraint(java.lang.Class<? extends Entity> target,
                                                           EntityOp operation,
                                                           ConstraintPredicate<? extends Entity> predicate)

Adds in-memory constraint to the group definition

Parameters:

target - entity class

operation - CRUD operation

predicate - in-memory predicate, returns true if entity is allowed by access constraint

Returns:

current instance of the builder

withCustomInMemoryConstraint

public AccessGroupDefinitionBuilder withCustomInMemoryConstraint(java.lang.Class<? extends Entity> target,
                                                                 java.lang.String constraintCode,
                                                                 ConstraintPredicate<? extends Entity> predicate)

Adds in-memory custom constraint to the group definition

Parameters:

target - entity class

constraintCode - custom constraint code

predicate - in-memory predicate, returns true if entity is allowed by access constraint

Returns:

current instance of the builder

withGroovyConstraint

public AccessGroupDefinitionBuilder withGroovyConstraint(java.lang.Class<? extends Entity> target,
                                                         EntityOp operation,
                                                         java.lang.String groovyScript)

Adds in-memory groovy constraint to the group definition

Parameters:

target - entity class

operation - CRUD operation

groovyScript - groovy script

Returns:

current instance of the builder

withCustomGroovyConstraint

public AccessGroupDefinitionBuilder withCustomGroovyConstraint(java.lang.Class<? extends Entity> target,
                                                               java.lang.String constraintCode,
                                                               java.lang.String groovyScript)

Adds in-memory groovy custom constraint to the group definition

Parameters:

target - entity class

constraintCode - custom constraint code

groovyScript - groovy script

Returns:

current instance of the builder

withConstraints

public AccessGroupDefinitionBuilder withConstraints(java.util.function.Consumer<AccessConstraintsBuilder> constraintsConsumer)

Adds access constraints to the group definition using AccessConstraintsBuilder

Returns:

current instance of the builder

withSessionAttribute

public AccessGroupDefinitionBuilder withSessionAttribute(java.lang.String key,
                                                         java.io.Serializable value)

Adds new session attribute to the group definition

Parameters:

key - session attribute key

value - session attribute value

Returns:

current instance of the builder

withSessionAttributes

public AccessGroupDefinitionBuilder withSessionAttributes(java.util.Map<java.lang.String,java.io.Serializable> attributes)

Adds new session attributes to the group definition

Parameters:

attributes - map of session attributes

Returns:

current instance of the builder

build

public AccessGroupDefinition build()

Returns the built access group definition