com.haulmont.cuba.security.app.group

Class AccessConstraintsBuilder

java.lang.Object

com.haulmont.cuba.security.app.group.AccessConstraintsBuilder

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

Builder class that helps to create access constraints set.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,java.util.List<AccessConstraint>>	builderConstraints
protected ExtendedEntities	extendedEntities
protected java.util.List<ConstraintsContainer>	joinSets
protected Metadata	metadata
static java.lang.String	NAME

Constructor Summary

Constructors

Constructor and Description
AccessConstraintsBuilder()

Method Summary

Modifier and Type	Method and Description
protected void	addConstraint(MetaClass metaClass, AccessConstraint constraint)
ConstraintsContainer	build() Returns the built set of entity constraints
static AccessConstraintsBuilder	create()
AccessConstraintsBuilder	join(ConstraintsContainer constraints) Adds all existing entity constraints to the new constructed constraints set.
AccessConstraintsBuilder	withCustomGroovy(java.lang.Class<? extends Entity> target, java.lang.String constraintCode, java.lang.String groovyScript) Adds in-memory groovy custom constraint to the constraints set
AccessConstraintsBuilder	withCustomInMemory(java.lang.Class<? extends Entity> target, java.lang.String constraintCode, ConstraintPredicate<? extends Entity> predicate) Adds in-memory custom constraint to the constraints set
AccessConstraintsBuilder	withCustomJpql(java.lang.Class<? extends Entity> target, java.lang.String constraintCode, java.lang.String where, java.lang.String join) Adds JPQL custom constraint to the constraints set
AccessConstraintsBuilder	withGroovy(java.lang.Class<? extends Entity> target, EntityOp operation, java.lang.String groovyScript) Adds in-memory groovy constraint to the constraints set
AccessConstraintsBuilder	withGroovy(java.lang.Class<? extends Entity> target, java.util.EnumSet<EntityOp> operations, java.lang.String groovyScript) Adds in-memory groovy constraint to the constraints set
AccessConstraintsBuilder	withInMemory(java.lang.Class<? extends Entity> target, EntityOp operation, ConstraintPredicate<? extends Entity> predicate) Adds in-memory constraint to the constraints set
AccessConstraintsBuilder	withInMemory(java.lang.Class<? extends Entity> target, java.util.EnumSet<EntityOp> operations, ConstraintPredicate<? extends Entity> predicate) Adds in-memory constraint to the constraints set
AccessConstraintsBuilder	withJpql(java.lang.Class<? extends Entity> target, java.lang.String where) Adds JPQL READ constraint to the constraints set
AccessConstraintsBuilder	withJpql(java.lang.Class<? extends Entity> target, java.lang.String where, java.lang.String join) Adds JPQL READ constraint to the constraints set

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

metadata

@Inject
protected Metadata metadata

extendedEntities

@Inject
protected ExtendedEntities extendedEntities

joinSets

protected java.util.List<ConstraintsContainer> joinSets

builderConstraints

protected java.util.Map<java.lang.String,java.util.List<AccessConstraint>> builderConstraints

Constructor Detail

AccessConstraintsBuilder

public AccessConstraintsBuilder()

Method Detail

create

public static AccessConstraintsBuilder create()

Returns:

new constraints builder

join

public AccessConstraintsBuilder join(ConstraintsContainer constraints)

Adds all existing entity constraints to the new constructed constraints set.

Returns:

current instance of the builder

withJpql

public AccessConstraintsBuilder withJpql(java.lang.Class<? extends Entity> target,
                                         java.lang.String where,
                                         @Nullable
                                         java.lang.String join)

Adds JPQL READ constraint to the constraints set

Parameters:

target - entity class

where - JPQL where clause

join - JPQL join clause

Returns:

current instance of the builder

withJpql

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

Adds JPQL READ constraint to the constraints set

Parameters:

target - entity class

where - JPQL where clause

Returns:

current instance of the builder

withCustomJpql

public AccessConstraintsBuilder withCustomJpql(java.lang.Class<? extends Entity> target,
                                               java.lang.String constraintCode,
                                               java.lang.String where,
                                               @Nullable
                                               java.lang.String join)

Adds JPQL custom constraint to the constraints set

Parameters:

target - entity class

constraintCode - custom constraint code

where - JPQL where clause

join - JPQL join clause

Returns:

current instance of the builder

withInMemory

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

Adds in-memory constraint to the constraints set

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

withInMemory

public AccessConstraintsBuilder withInMemory(java.lang.Class<? extends Entity> target,
                                             java.util.EnumSet<EntityOp> operations,
                                             ConstraintPredicate<? extends Entity> predicate)

Adds in-memory constraint to the constraints set

Parameters:

target - entity class

operations - CRUD operations

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

Returns:

current instance of the builder

withCustomInMemory

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

Adds in-memory custom constraint to the constraints set

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

withGroovy

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

Adds in-memory groovy constraint to the constraints set

Parameters:

target - entity class

operation - CRUD operation

groovyScript - groovy script

Returns:

current instance of the builder

withGroovy

public AccessConstraintsBuilder withGroovy(java.lang.Class<? extends Entity> target,
                                           java.util.EnumSet<EntityOp> operations,
                                           java.lang.String groovyScript)

Adds in-memory groovy constraint to the constraints set

Parameters:

target - entity class

operations - CRUD operations

groovyScript - groovy script

Returns:

current instance of the builder

withCustomGroovy

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

Adds in-memory groovy custom constraint to the constraints set

Parameters:

target - entity class

constraintCode - custom constraint code

groovyScript - groovy script

Returns:

current instance of the builder

build

public ConstraintsContainer build()

Returns the built set of entity constraints

addConstraint

protected void addConstraint(MetaClass metaClass,
                             AccessConstraint constraint)