Package com.axelor.meta.query

Class MetaQueryService

java.lang.Object

com.axelor.meta.query.MetaQueryService

@Singleton
public class MetaQueryService
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	MetaQueryService.SavedQuery	A saved query and its parsed definition, for a caller that inspects the definition before running it.

Constructor Summary

Constructors

Constructor	Description
MetaQueryService()

Method Summary

Modifier and Type	Method	Description
MetaQuery	checkAccess(MetaQuery metaQuery)	Validate that the current user may run the given query, and return the query to run.
MetaQueryService.SavedQuery	definition(String name)	The named query and its definition, once the user is allowed to run it.
Map<String,Object>	describe(String name)
QueryResult	execute(MetaQuery metaQuery, Map<String,Object> params)
QueryResult	execute(MetaQuery metaQuery, Map<String,Object> params, Integer limit, Integer offset)
QueryResult	execute(Long id, Map<String,Object> params)
QueryResult	execute(Long id, Map<String,Object> params, Integer limit, Integer offset)
QueryResult	execute(String name, Map<String,Object> params)
QueryResult	execute(String name, Map<String,Object> params, Integer limit, Integer offset)
DatasetEnvelope	resolve(MetaQueryService.SavedQuery saved, Map<String,Object> params, Integer limit, Integer offset, Integer maxRows)	Runs a saved query already loaded with definition(String).
DatasetEnvelope	resolve(MetaQueryService.SavedQuery saved, Map<String,Object> params, Integer limit, Integer offset, Integer maxRows, QueryAccess access)	Runs a saved query held to access rather than to the current user's permissions alone, as QueryEngine.execute(Query, Map, Integer, Integer, Integer, QueryAccess) does.
DatasetEnvelope	resolve(Query query, Map<String,Object> params, Integer maxRows)	Runs a query that is not stored and wraps its result in the same envelope, with no source.
DatasetEnvelope	resolve(Query query, Map<String,Object> params, Integer maxRows, QueryAccess access)	Runs a query that is not stored, held to access.
DatasetEnvelope	resolve(String name, Map<String,Object> params, Integer limit, Integer offset)	Runs a named query and wraps the result in the envelope presentation depends on.
DatasetEnvelope	resolve(String name, Map<String,Object> params, Integer limit, Integer offset, Integer maxRows)	Runs a named query with the row cap tightened to maxRows, as QueryEngine.execute(Query, Map, Integer, Integer, Integer) does.

Methods inherited from class java.lang.Object

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

Constructor Details

MetaQueryService

public MetaQueryService()

Method Details

execute

public QueryResult execute(Long id,
 Map<String,Object> params)

execute

public QueryResult execute(Long id,
 Map<String,Object> params,
 Integer limit,
 Integer offset)

execute

public QueryResult execute(String name,
 Map<String,Object> params)

execute

public QueryResult execute(String name,
 Map<String,Object> params,
 Integer limit,
 Integer offset)

execute

public QueryResult execute(MetaQuery metaQuery,
 Map<String,Object> params)

execute

public QueryResult execute(MetaQuery metaQuery,
 Map<String,Object> params,
 Integer limit,
 Integer offset)

resolve

public DatasetEnvelope resolve(String name,
 Map<String,Object> params,
 Integer limit,
 Integer offset)

Runs a named query and wraps the result in the envelope presentation depends on.

Built here because only this layer holds the query's metadata and its stored definition alongside the executor's window and applied parameters.

resolve

public DatasetEnvelope resolve(String name,
 Map<String,Object> params,
 Integer limit,
 Integer offset,
 Integer maxRows)

Runs a named query with the row cap tightened to maxRows, as QueryEngine.execute(Query, Map, Integer, Integer, Integer) does.

resolve

public DatasetEnvelope resolve(MetaQueryService.SavedQuery saved,
 Map<String,Object> params,
 Integer limit,
 Integer offset,
 Integer maxRows)

Runs a saved query already loaded with definition(String).

resolve

public DatasetEnvelope resolve(MetaQueryService.SavedQuery saved,
 Map<String,Object> params,
 Integer limit,
 Integer offset,
 Integer maxRows,
 QueryAccess access)

Runs a saved query held to access rather than to the current user's permissions alone, as QueryEngine.execute(Query, Map, Integer, Integer, Integer, QueryAccess) does.

resolve

public DatasetEnvelope resolve(Query query,
 Map<String,Object> params,
 Integer maxRows)

Runs a query that is not stored and wraps its result in the same envelope, with no source.

There is no MetaQuery whose roles could apply, so access is the engine's own: the user must be able to read every model the query touches, and their row-level filters apply.

resolve

public DatasetEnvelope resolve(Query query,
 Map<String,Object> params,
 Integer maxRows,
 QueryAccess access)

Runs a query that is not stored, held to access.

definition

public MetaQueryService.SavedQuery definition(String name)

The named query and its definition, once the user is allowed to run it.

describe

public Map<String,Object> describe(String name)

checkAccess

public MetaQuery checkAccess(MetaQuery metaQuery)

Validate that the current user may run the given query, and return the query to run.

The metaQuery may originate from an action context, whose roles and definition are both attacker-controlled. So the roles are checked on the persisted record, and the definition must be the persisted one: running the context's would let anyone allowed one saved query run any XML, and running the persisted one in its place would answer a question nobody asked.

An administrator or technical staff member may run any definition, saved or not, so a query's roles do not restrict them either.

Returns:

metaQuery for such a user; otherwise the persisted query it names