Package io.jmix.data.accesscontext

Class ReadEntityQueryContext

java.lang.Object

io.jmix.data.accesscontext.ReadEntityQueryContext

All Implemented Interfaces:

AccessContext

public class ReadEntityQueryContext
extends Object
implements AccessContext

Defines an authorization point for modifying JPQL queries by adding JOIN and WHERE clauses.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	ReadEntityQueryContext.Condition

Field Summary

Fields

Modifier and Type	Field	Description
protected List<ReadEntityQueryContext.Condition>	conditions
protected final MetaClass	entityClass
protected final JmixQuery	originalQuery
protected final QueryTransformerFactory	queryTransformerFactory
protected final boolean	singleResult

Constructor Summary

Constructors

Constructor	Description
ReadEntityQueryContext(JmixQuery originalQuery, MetaClass entityClass, QueryTransformerFactory transformerFactory)
ReadEntityQueryContext(JmixQuery originalQuery, QueryTransformerFactory transformerFactory, Metadata metadata)

Method Summary

Modifier and Type	Method	Description
protected String	actualizePlaceholder(String queryPart, String actualEntityName, String actualEntityPath)	Replaces QueryTransformer.ALIAS_PLACEHOLDER with actual entity path if query returns nested entity instead of the one specified in from clause.
void	addJoinAndWhere(String join, String where)
protected void	buildQuery()
String	explainConstraints()	Returns a human-readable explanation of constraints applied to the current context instance for logging of authorization decisions.
MetaClass	getEntityClass()
JmixQuery	getResultQuery()
protected static String	printQuery(String query)

Methods inherited from class java.lang.Object

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

Field Details

queryTransformerFactory

protected final QueryTransformerFactory queryTransformerFactory

originalQuery

protected final JmixQuery originalQuery

entityClass

protected final MetaClass entityClass

singleResult

protected final boolean singleResult

conditions

protected List<ReadEntityQueryContext.Condition> conditions

Constructor Details

ReadEntityQueryContext

public ReadEntityQueryContext(JmixQuery originalQuery,
 MetaClass entityClass,
 QueryTransformerFactory transformerFactory)

ReadEntityQueryContext

public ReadEntityQueryContext(JmixQuery originalQuery,
 QueryTransformerFactory transformerFactory,
 Metadata metadata)

Method Details

getEntityClass

public MetaClass getEntityClass()

addJoinAndWhere

public void addJoinAndWhere(String join,
 String where)

getResultQuery

public JmixQuery getResultQuery()

buildQuery

protected void buildQuery()

actualizePlaceholder

protected String actualizePlaceholder(String queryPart,
 String actualEntityName,
 String actualEntityPath)

Replaces QueryTransformer.ALIAS_PLACEHOLDER with actual entity path if query returns nested entity instead of the one specified in from clause.

Example: select u.group from sec$User u
u.group should be used instead of {E}. Otherwise, constraint will be applied to the user instead of the group.

Parameters:

queryPart - to actualize

actualEntityName - nested entity or null if query return type is the same as type in from clause

actualEntityPath - query return entity path

Returns:

queryPart with replaced placeholder if needed

printQuery

protected static String printQuery(String query)

explainConstraints

@Nullable
public String explainConstraints()

Description copied from interface: AccessContext

Returns a human-readable explanation of constraints applied to the current context instance for logging of authorization decisions. Null if the current context does not impose any constraints.

Specified by:

explainConstraints in interface AccessContext