org.apache.geode.rest.internal.web.controllers

Class QueryAccessController

java.lang.Object

org.apache.geode.rest.internal.web.controllers.AbstractBaseController

org.apache.geode.rest.internal.web.controllers.QueryAccessController

@Controller(value="queryController")
 @RequestMapping(value="/v1/queries")
public class QueryAccessController
extends AbstractBaseController

The QueryingController class serves all HTTP REST requests related to the gemfire querying

Since:

GemFire 8.0

See Also:

Controller

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	PARAMETERIZED_QUERIES_REGION
protected static java.lang.String	REST_API_VERSION

Fields inherited from class org.apache.geode.rest.internal.web.controllers.AbstractBaseController

DEFAULT_ENCODING, NEW_META_DATA_PROPERTY, OLD_META_DATA_PROPERTY, securityService, TYPE_META_DATA_PROPERTY, UTF_8

Constructor Summary

Constructors

Constructor and Description
QueryAccessController()

Method Summary

Modifier and Type	Method and Description
org.springframework.http.ResponseEntity<?>	create(java.lang.String queryId, java.lang.String oqlInUrl, java.lang.String oqlInBody) Create a named, parametrized Query
org.springframework.http.ResponseEntity<?>	delete(java.lang.String queryId) Delete named, parametrized Query
protected java.lang.String	getRestApiVersion() Gets the version of the REST API implemented by this @Controller.
org.springframework.http.ResponseEntity<?>	list() list all parametrized Queries created in a Gemfire data node
org.springframework.http.ResponseEntity<java.lang.String>	runAdhocQuery(java.lang.String oql) Run an adhoc Query specified in a query string
org.springframework.http.ResponseEntity<java.lang.String>	runNamedQuery(java.lang.String queryId, java.lang.String arguments) Run named parametrized Query with ID
org.springframework.http.ResponseEntity<?>	update(java.lang.String queryId, java.lang.String oqlInUrl, java.lang.String oqlInBody) Update named, parametrized Query

Methods inherited from class org.apache.geode.rest.internal.web.controllers.AbstractBaseController

casValue, casValue, checkForKeyExist, checkForMultipleKeysExist, checkForQueryIdExist, convert, convert, convert, convertErrorAsJson, convertErrorAsJson, convertJsonArrayIntoPdxCollection, convertJsonToMap, createNamedQuery, decode, decode, deleteNamedQuery, deleteQueryId, deleteValue, deleteValues, deleteValues, generateKey, generateKey, getActualTypeValue, getAllMembersInDS, getCache, getKeys, getMembers, getPdxValues, getQueryIdValue, getQueryService, getQueryStore, getRegion, getValue, getValues, getValues, introspectAndConvert, jsonToObject, jsonToObjectArray, postValue, processQueryResponse, putPdxValues, putValue, putValues, putValues, replaceValue, replaceValue, toUri, updateMultipleKeys, updateNamedQuery, updateSingleKey, validateJsonAndFindType, validateQuery

Methods inherited from class java.lang.Object

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

Field Detail

PARAMETERIZED_QUERIES_REGION

protected static final java.lang.String PARAMETERIZED_QUERIES_REGION

See Also:

Constant Field Values

REST_API_VERSION

protected static final java.lang.String REST_API_VERSION

See Also:

Constant Field Values

Constructor Detail

QueryAccessController

public QueryAccessController()

Method Detail

getRestApiVersion

protected java.lang.String getRestApiVersion()

Gets the version of the REST API implemented by this @Controller.

Specified by:

getRestApiVersion in class AbstractBaseController

Returns:

a String indicating the REST API version.

list

@RequestMapping(method=GET,
                produces="application/json")
 @ResponseBody
 @ResponseStatus(value=OK)
public org.springframework.http.ResponseEntity<?> list()

list all parametrized Queries created in a Gemfire data node

Returns:

result as a JSON document.

create

@RequestMapping(method=POST)
public org.springframework.http.ResponseEntity<?> create(@RequestParam(value="id")
                                                                                      java.lang.String queryId,
                                                                                      @RequestParam(value="q",required=false)
                                                                                      java.lang.String oqlInUrl,
                                                                                      @RequestBody(required=false)
                                                                                      java.lang.String oqlInBody)

Create a named, parametrized Query

Parameters:

queryId - uniquely identify the query

oqlInUrl - OQL query string specified in a request URL

oqlInBody - OQL query string specified in a request body

Returns:

result as a JSON document.

runAdhocQuery

@RequestMapping(method=GET,
                value="/adhoc",
                produces="application/json")
 @ResponseBody
 @ResponseStatus(value=OK)
public org.springframework.http.ResponseEntity<java.lang.String> runAdhocQuery(@RequestParam(value="q")
                                                                                                                                                                                                                                  java.lang.String oql)

Run an adhoc Query specified in a query string

Parameters:

oql - OQL query string to be executed

Returns:

query result as a JSON document

runNamedQuery

@RequestMapping(method=POST,
                value="/{query}",
                produces="application/json")
 @ResponseBody
 @ResponseStatus(value=OK)
public org.springframework.http.ResponseEntity<java.lang.String> runNamedQuery(@PathVariable(value="query")
                                                                                                                                                                                                                                     java.lang.String queryId,
                                                                                                                                                                                                                                     @RequestBody
                                                                                                                                                                                                                                     java.lang.String arguments)

Run named parametrized Query with ID

Parameters:

queryId - id of the OQL string

arguments - query bind params required while executing query

Returns:

query result as a JSON document

update

@RequestMapping(method=PUT,
                value="/{query}")
public org.springframework.http.ResponseEntity<?> update(@PathVariable(value="query")
                                                                                                                       java.lang.String queryId,
                                                                                                                       @RequestParam(value="q",required=false)
                                                                                                                       java.lang.String oqlInUrl,
                                                                                                                       @RequestBody(required=false)
                                                                                                                       java.lang.String oqlInBody)

Update named, parametrized Query

Parameters:

queryId - uniquely identify the query

oqlInUrl - OQL query string specified in a request URL

oqlInBody - OQL query string specified in a request body

delete

@RequestMapping(method=DELETE,
                value="/{query}")
public org.springframework.http.ResponseEntity<?> delete(@PathVariable(value="query")
                                                                                                                          java.lang.String queryId)

Delete named, parametrized Query

Parameters:

queryId - uniquely identify the query to be deleted