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

Class FunctionAccessController

java.lang.Object

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

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

@Controller(value="functionController")
 @RequestMapping(value="/v1/functions")
public class FunctionAccessController
extends AbstractBaseController

The FunctionsController class serving REST Requests related to the function execution

Since:

GemFire 8.0

See Also:

Controller

Field Summary

Fields

Modifier and Type	Field and Description
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
FunctionAccessController()

Method Summary

Modifier and Type	Method and Description
org.springframework.http.ResponseEntity<java.lang.String>	execute(java.lang.String functionId, java.lang.String region, java.lang.String[] members, java.lang.String[] groups, java.lang.String[] filter, java.lang.String argsInBody) Execute a function on Gemfire data node using REST API call.
protected java.lang.String	getRestApiVersion() Gets the version of the REST API implemented by this @Controller.
org.springframework.http.ResponseEntity<?>	list() list all registered functions in Gemfire data node

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

Constructor Detail

FunctionAccessController

public FunctionAccessController()

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 registered functions in Gemfire data node

Returns:

result as a JSON document.

execute

@RequestMapping(method=POST,
                value="/{functionId}",
                produces="application/json")
 @ResponseBody
 @ResponseStatus(value=OK)
public org.springframework.http.ResponseEntity<java.lang.String> execute(@PathVariable(value="functionId")
                                                                                                                                                                                                                                    java.lang.String functionId,
                                                                                                                                                                                                                                    @RequestParam(value="onRegion",required=false)
                                                                                                                                                                                                                                    java.lang.String region,
                                                                                                                                                                                                                                    @RequestParam(value="onMembers",required=false)
                                                                                                                                                                                                                                    java.lang.String[] members,
                                                                                                                                                                                                                                    @RequestParam(value="onGroups",required=false)
                                                                                                                                                                                                                                    java.lang.String[] groups,
                                                                                                                                                                                                                                    @RequestParam(value="filter",required=false)
                                                                                                                                                                                                                                    java.lang.String[] filter,
                                                                                                                                                                                                                                    @RequestBody(required=false)
                                                                                                                                                                                                                                    java.lang.String argsInBody)

Execute a function on Gemfire data node using REST API call. Arguments to the function are passed as JSON string in the request body.

Parameters:

functionId - represents function to be executed

region - list of regions on which function to be executed.

members - list of nodes on which function to be executed.

groups - list of groups on which function to be executed.

filter - list of keys which the function will use to determine on which node to execute the function.

argsInBody - function argument as a JSON document

Returns:

result as a JSON document