Package io.jmix.security.model

Class RowLevelPolicy

java.lang.Object

io.jmix.security.model.RowLevelPolicy

All Implemented Interfaces:

Serializable

public class RowLevelPolicy
extends Object
implements Serializable

Defines a constraint that restricts data a user can read or modify. There are two row-level policy types: in-memory and JPQL.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
RowLevelPolicy(String entityName, RowLevelPolicyAction action, RowLevelBiPredicate<Object,org.springframework.context.ApplicationContext> biPredicate, Map<String,String> customProperties)
RowLevelPolicy(String entityName, RowLevelPolicyAction action, String script, RowLevelBiPredicate<Object,org.springframework.context.ApplicationContext> biPredicate, Map<String,String> customProperties)
RowLevelPolicy(String entityName, String whereClause, String joinClause)
RowLevelPolicy(String entityName, String whereClause, String joinClause, Map<String,String> customProperties)

Method Summary

Modifier and Type	Method	Description
RowLevelPolicyAction	getAction()	Returns entity CRUD operation
RowLevelBiPredicate<Object,org.springframework.context.ApplicationContext>	getBiPredicate()	Returns a predicate for in-memory row-level policy
Map<String,String>	getCustomProperties()
String	getEntityName()	Returns a name of the associated entity
String	getJoinClause()	Returns "join" clause for JPQL policy
String	getScript()	Returns a script for predicate for in-memory row-level policy
RowLevelPolicyType	getType()	Returns row-level policy type.
String	getWhereClause()	Returns "where" clause for JPQL policy

Methods inherited from class java.lang.Object

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

Constructor Details

RowLevelPolicy

public RowLevelPolicy(String entityName,
 String whereClause,
 @Nullable
 String joinClause)

RowLevelPolicy

public RowLevelPolicy(String entityName,
 String whereClause,
 @Nullable
 String joinClause,
 Map<String,String> customProperties)

RowLevelPolicy

public RowLevelPolicy(String entityName,
 RowLevelPolicyAction action,
 String script,
 RowLevelBiPredicate<Object,org.springframework.context.ApplicationContext> biPredicate,
 Map<String,String> customProperties)

RowLevelPolicy

public RowLevelPolicy(String entityName,
 RowLevelPolicyAction action,
 RowLevelBiPredicate<Object,org.springframework.context.ApplicationContext> biPredicate,
 Map<String,String> customProperties)

Method Details

getEntityName

public String getEntityName()

Returns a name of the associated entity

getAction

public RowLevelPolicyAction getAction()

Returns entity CRUD operation

Returns:

entity CRUD operation

getBiPredicate

@Nullable
public RowLevelBiPredicate<Object,org.springframework.context.ApplicationContext> getBiPredicate()

Returns a predicate for in-memory row-level policy

Returns:

a predicate

getScript

@Nullable
public String getScript()

Returns a script for predicate for in-memory row-level policy

Returns:

a script

getWhereClause

public String getWhereClause()

Returns "where" clause for JPQL policy

Returns:

JPQL "where" clause

getJoinClause

public String getJoinClause()

Returns "join" clause for JPQL policy

Returns:

JPQL "join" clause

getType

public RowLevelPolicyType getType()

Returns row-level policy type. It may be in-memory predicate or JPQL policy

Returns:

row-level policy type

getCustomProperties

public Map<String,String> getCustomProperties()