com.haulmont.restapi.config

Class RestQueriesConfiguration

java.lang.Object

com.haulmont.restapi.config.RestQueriesConfiguration

@Component(value="cuba_RestQueriesConfiguration")
public class RestQueriesConfiguration
extends java.lang.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 cuba.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 and 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 and Description
static java.lang.String	ALL_ENTITIES_QUERY_NAME

Constructor Summary

Constructors

Constructor and Description
RestQueriesConfiguration()

Method Summary

Modifier and Type	Method and Description
java.util.List<RestQueriesConfiguration.QueryInfo>	getQueries()
java.util.List<RestQueriesConfiguration.QueryInfo>	getQueries(java.lang.String entityName)
RestQueriesConfiguration.QueryInfo	getQuery(java.lang.String entityName, java.lang.String queryName) Returns a query description with the given name for the given entity.

Methods inherited from class java.lang.Object

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

Field Detail

ALL_ENTITIES_QUERY_NAME

public static final java.lang.String ALL_ENTITIES_QUERY_NAME

See Also:

Constant Field Values

Constructor Detail

RestQueriesConfiguration

public RestQueriesConfiguration()

Method Detail

getQuery

@Nullable
public RestQueriesConfiguration.QueryInfo getQuery(java.lang.String entityName,
                                                             java.lang.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 java.util.List<RestQueriesConfiguration.QueryInfo> getQueries()

getQueries

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