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

Class PdxBasedCrudController

java.lang.Object

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

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

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

@Controller(value="pdxCrudController")
 @RequestMapping(value="/v1")
public class PdxBasedCrudController
extends CommonCrudController

The PdxBasedCrudController class serving REST Requests related to the REST CRUD operation on region

Since:

GemFire 8.0

See Also:

Controller

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	DEFAULT_GETALL_RESULT_LIMIT
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
PdxBasedCrudController()

Method Summary

Modifier and Type	Method and Description
org.springframework.http.ResponseEntity<?>	create(java.lang.String region, java.lang.String key, java.lang.String json) Creating entry into the region
protected java.lang.String	getRestApiVersion()
org.springframework.http.ResponseEntity<?>	read(java.lang.String region, java.lang.String limit) Read all or fixed number of data in a given Region
org.springframework.http.ResponseEntity<?>	read(java.lang.String region, java.lang.String[] keys, java.lang.String ignoreMissingKey) Reading data for set of keys
org.springframework.http.ResponseEntity<?>	size(java.lang.String region)
org.springframework.http.ResponseEntity<?>	update(java.lang.String region, java.lang.String[] keys, java.lang.String opValue, java.lang.String json) Update data for a key or set of keys

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

delete, delete, keys, ping, regions, servers

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

REST_API_VERSION

protected static final java.lang.String REST_API_VERSION

See Also:

Constant Field Values

DEFAULT_GETALL_RESULT_LIMIT

protected static final java.lang.String DEFAULT_GETALL_RESULT_LIMIT

See Also:

Constant Field Values

Constructor Detail

PdxBasedCrudController

public PdxBasedCrudController()

Method Detail

getRestApiVersion

protected java.lang.String getRestApiVersion()

Specified by:

getRestApiVersion in class AbstractBaseController

create

@RequestMapping(method=POST,
                value="/{region}",
                consumes="application/json",
                produces="application/json")
public org.springframework.http.ResponseEntity<?> create(@PathVariable(value="region")
                                                                                                                                                                                                                   java.lang.String region,
                                                                                                                                                                                                                   @RequestParam(value="key",required=false)
                                                                                                                                                                                                                   java.lang.String key,
                                                                                                                                                                                                                   @RequestBody
                                                                                                                                                                                                                   java.lang.String json)

Creating entry into the region

Parameters:

region - region name where data will be created

key - gemfire region key

json - JSON document that is stored against the key

Returns:

JSON document

read

@RequestMapping(method=GET,
                value="/{region}",
                produces="application/json")
public org.springframework.http.ResponseEntity<?> read(@PathVariable(value="region")
                                                                                                                                                                   java.lang.String region,
                                                                                                                                                                   @RequestParam(value="limit",defaultValue="50")
                                                                                                                                                                   java.lang.String limit)

Read all or fixed number of data in a given Region

Parameters:

region - gemfire region name

limit - total number of entries requested

Returns:

JSON document

read

@RequestMapping(method=GET,
                value="/{region}/{keys}",
                produces="application/json")
public org.springframework.http.ResponseEntity<?> read(@PathVariable(value="region")
                                                                                                                                                                          java.lang.String region,
                                                                                                                                                                          @PathVariable(value="keys")
                                                                                                                                                                          java.lang.String[] keys,
                                                                                                                                                                          @RequestParam(value="ignoreMissingKey",required=false)
                                                                                                                                                                          java.lang.String ignoreMissingKey)

Reading data for set of keys

Parameters:

region - gemfire region name

keys - string containing comma seperated keys

Returns:

JSON document

update

@RequestMapping(method=PUT,
                value="/{region}/{keys}",
                consumes="application/json",
                produces="application/json")
public org.springframework.http.ResponseEntity<?> update(@PathVariable(value="region")
                                                                                                                                                                                                                         java.lang.String region,
                                                                                                                                                                                                                         @PathVariable(value="keys")
                                                                                                                                                                                                                         java.lang.String[] keys,
                                                                                                                                                                                                                         @RequestParam(value="op",defaultValue="PUT")
                                                                                                                                                                                                                         java.lang.String opValue,
                                                                                                                                                                                                                         @RequestBody
                                                                                                                                                                                                                         java.lang.String json)

Update data for a key or set of keys

Parameters:

region - gemfire data region

keys - keys for which update operation is requested

opValue - type of update (put, replace, cas etc)

json - new data for the key(s)

Returns:

JSON document

size

@RequestMapping(method=HEAD,
                value="/{region}",
                produces="application/json")
public org.springframework.http.ResponseEntity<?> size(@PathVariable(value="region")
                                                                                                                                                                    java.lang.String region)