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

Class CommonCrudController

java.lang.Object

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

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

Direct Known Subclasses:

PdxBasedCrudController

public abstract class CommonCrudController
extends AbstractBaseController

The CommonCrudController serves REST Requests related to listing regions, listing keys in region, delete keys or delete all data in region.

Since:

GemFire 8.0

Field Summary

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
CommonCrudController()

Method Summary

Modifier and Type	Method and Description
org.springframework.http.ResponseEntity<?>	delete(java.lang.String region) Delete all data in region
org.springframework.http.ResponseEntity<?>	delete(java.lang.String region, java.lang.String[] keys) Delete data for single key or specific keys in region
org.springframework.http.ResponseEntity<?>	keys(java.lang.String region) List all keys for the given region in the GemFire cluster
org.springframework.http.ResponseEntity<?>	ping() Ping is not secured so that it may not be used to determine a valid username/password
org.springframework.http.ResponseEntity<?>	regions() list all available resources (Regions) in the GemFire cluster
org.springframework.http.ResponseEntity<?>	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, getRestApiVersion, 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

Constructor Detail

CommonCrudController

public CommonCrudController()

Method Detail

regions

@RequestMapping(method=GET,
                produces={"application/json","application/json"})
public org.springframework.http.ResponseEntity<?> regions()

list all available resources (Regions) in the GemFire cluster

Returns:

JSON document containing result

keys

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

List all keys for the given region in the GemFire cluster

Parameters:

region - gemfire region

Returns:

JSON document containing result

delete

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

Delete data for single key or specific keys in region

Parameters:

region - gemfire region

keys - for which data is requested

Returns:

JSON document containing result

delete

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

Delete all data in region

Parameters:

region - gemfire region

Returns:

JSON document containing result

ping

@RequestMapping(method={GET,HEAD},
                value="/ping")
public org.springframework.http.ResponseEntity<?> ping()

Ping is not secured so that it may not be used to determine a valid username/password

Returns:

servers

@RequestMapping(method=GET,
                value="/servers")
public org.springframework.http.ResponseEntity<?> servers()