Package io.jmix.rest.impl.config

Class RestQueriesConfiguration

java.lang.Object

io.jmix.rest.impl.config.RestQueriesConfiguration

@Component("rest_RestQueriesConfiguration")
public class RestQueriesConfiguration
extends Object

Class is used for loading and storing of predefined JPQL queries that are used by the REST API. Queries are loaded from configuration files defined by the jmix.rest.queriesConfig application property.

Queries with the name defined by the ALL_ENTITIES_QUERY_NAME field should not be present in the queries config. If the query with this name is requested, the RestQueriesConfiguration.QueryInfo for the query that returns all entities will be returned.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RestQueriesConfiguration.QueryInfo	Class stores an information about the predefined JPQL query
static class	RestQueriesConfiguration.QueryParamInfo	Class stores an information about the predefined JPQL query parameter

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ALL_ENTITIES_QUERY_NAME
protected org.springframework.core.env.Environment	environment
protected boolean	initialized
protected static final String	JMIX_REST_QUERIES_CONFIG_PROP_NAME
protected ReadWriteLock	lock
protected List<RestQueriesConfiguration.QueryInfo>	queries
protected Resources	resources

Constructor Summary

Constructors

Constructor	Description
RestQueriesConfiguration()

Method Summary

Modifier and Type	Method	Description
protected void	checkInitialized()
protected RestQueriesConfiguration.QueryInfo	createAllEntitiesQuery(String entityName)
List<RestQueriesConfiguration.QueryInfo>	getQueries()
List<RestQueriesConfiguration.QueryInfo>	getQueries(String entityName)
RestQueriesConfiguration.QueryInfo	getQuery(String entityName, String queryName)	Returns a query description with the given name for the given entity.
protected void	init()
protected void	loadConfig(org.dom4j.Element rootElem)

Methods inherited from class java.lang.Object

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

Field Details

JMIX_REST_QUERIES_CONFIG_PROP_NAME

protected static final String JMIX_REST_QUERIES_CONFIG_PROP_NAME

See Also:

• Constant Field Values

initialized

protected volatile boolean initialized

lock

protected ReadWriteLock lock

resources

@Autowired
protected Resources resources

environment

@Autowired
protected org.springframework.core.env.Environment environment

queries

protected List<RestQueriesConfiguration.QueryInfo> queries

ALL_ENTITIES_QUERY_NAME

public static final String ALL_ENTITIES_QUERY_NAME

See Also:

• Constant Field Values

Constructor Details

RestQueriesConfiguration

public RestQueriesConfiguration()

Method Details

getQuery

@Nullable
public RestQueriesConfiguration.QueryInfo getQuery(String entityName,
 String queryName)

Returns a query description with the given name for the given entity.

Parameters:

entityName - entity name

queryName - query name

Returns:

query description

getQueries

public List<RestQueriesConfiguration.QueryInfo> getQueries()

getQueries

public List<RestQueriesConfiguration.QueryInfo> getQueries(String entityName)

checkInitialized

protected void checkInitialized()

init

protected void init()

loadConfig

protected void loadConfig(org.dom4j.Element rootElem)

createAllEntitiesQuery

protected RestQueriesConfiguration.QueryInfo createAllEntitiesQuery(String entityName)