org.apache.geode.cache.execute

Interface Execution

public interface Execution

Provides methods to build the context for the execution of a Function . A Context describes the environment in which the Execution will take place.

This interface is implemented by GemFire. To obtain an instance of it use FunctionService.

Since:

GemFire 6.0

See Also:

FunctionService, Function

Method Summary

Modifier and Type	Method and Description
ResultCollector<?,?>	execute(Function function) Executes the function instance provided.
ResultCollector<?,?>	execute(java.lang.String functionId) Executes the function using its id
ResultCollector<?,?>	execute(java.lang.String functionId, boolean hasResult) Deprecated. as of 6.6, use execute(String) instead
ResultCollector<?,?>	execute(java.lang.String functionId, boolean hasResult, boolean isHA) Deprecated. as of 6.6, use execute(String) instead
ResultCollector<?,?>	execute(java.lang.String functionId, boolean hasResult, boolean isHA, boolean optimizeForWrite) Deprecated. as of 6.6, use execute(String) instead
Execution	withArgs(java.lang.Object args) Specifies the user data passed to the function when it is executed.
Execution	withCollector(ResultCollector<?,?> rc) Specifies the ResultCollector that will receive the results after the function has been executed.
Execution	withFilter(java.util.Set<?> filter) Specifies a data filter of routing objects for selecting the GemFire members to execute the function on.

Method Detail

withFilter

Execution withFilter(java.util.Set<?> filter)

Specifies a data filter of routing objects for selecting the GemFire members to execute the function on.

Applicable only for regions with DataPolicy.PARTITION DataPolicy. If the filter is null, it will execute on all data of the region.

Parameters:

filter - Set defining the data filter to be used for executing the function

Returns:

an Execution with the filter

Throws:

java.lang.IllegalArgumentException - if filter passed is null.

java.lang.UnsupportedOperationException - if not called after FunctionService.onRegion(org.apache.geode.cache.Region)

Since:

GemFire 6.0

withArgs

Execution withArgs(java.lang.Object args)

Specifies the user data passed to the function when it is executed. The function can retrieve these arguments using FunctionContext.getArguments()

Parameters:

args - user data passed to the function execution

Returns:

an Execution with args

Throws:

java.lang.IllegalArgumentException - if the input parameter is null

Since:

GemFire 6.0

withCollector

Execution withCollector(ResultCollector<?,?> rc)

Specifies the ResultCollector that will receive the results after the function has been executed. Collector will receive results as they are sent from the Function.execute(FunctionContext) using ResultSender.

Returns:

an Execution with a collector

Throws:

java.lang.IllegalArgumentException - if ResultCollector is null

Since:

GemFire 6.0

See Also:

ResultCollector

execute

ResultCollector<?,?> execute(java.lang.String functionId)
                      throws FunctionException

Executes the function using its id

Function.execute(FunctionContext) is called on the instance retrieved using FunctionService.getFunction(String) on the executing member.

Parameters:

functionId - the Function.getId() of the function

Returns:

ResultCollector to retrieve the results received. This is different object than the ResultCollector provided in withCollector(ResultCollector). User has to use this reference to retrieve results.

Throws:

LowMemoryException - if the Function.optimizeForWrite() returns true and there is a low memory condition

FunctionException

Since:

GemFire 6.0

execute

ResultCollector<?,?> execute(Function function)
                      throws FunctionException

Executes the function instance provided.

Function.execute(FunctionContext) is called on the de-serialized instance on the executing member.

Parameters:

function - instance to execute

Returns:

ResultCollector to retrieve the results received. This is different object than the ResultCollector provided in withCollector(ResultCollector). User has to use this reference to retrieve results.

Throws:

LowMemoryException - if the Function.optimizeForWrite() returns true and there is a low memory condition

FunctionException

Since:

GemFire 6.0

execute

@Deprecated
ResultCollector<?,?> execute(java.lang.String functionId,
                                         boolean hasResult)
                                  throws FunctionException

Deprecated. as of 6.6, use execute(String) instead

Executes the function using its id

Function.execute(FunctionContext) is called on the de-serialized instance on the executing member. Function should be registered on the executing member using FunctionService.registerFunction(Function) method before calling this method. As of 6.6, this is deprecated, since users can pass different value for the hasResult parameter that than the boolean value returned from Function.hasResult().

Parameters:

functionId - the Function.getId() of the function

hasResult - Whether the function returns any result

Returns:

ResultCollector to retrieve the results received. This is different object than the ResultCollector provided in withCollector(ResultCollector). User has to use this reference to retrieve results.

Throws:

LowMemoryException - if the Function.optimizeForWrite() returns true and there is a low memory condition

FunctionException

Since:

GemFire 6.5

execute

@Deprecated
ResultCollector<?,?> execute(java.lang.String functionId,
                                         boolean hasResult,
                                         boolean isHA)
                                  throws FunctionException

Deprecated. as of 6.6, use execute(String) instead

Executes the function using its id

Function.execute(FunctionContext) is called on the de-serialized instance on the executing member.Function should be registered on the executing member using FunctionService.registerFunction(Function) method before calling this method. As of 6.6, this is deprecated, since users can pass different value for the hasResult, isHA parameter that than the boolean values returned from Function.hasResult(), Function.isHA().

Parameters:

functionId - the Function.getId() of the function

hasResult - Whether the function returns any result

isHA - Whether the given function is HA

Returns:

ResultCollector to retrieve the results received. This is different object than the ResultCollector provided in withCollector(ResultCollector). User has to use this reference to retrieve results.

Throws:

LowMemoryException - if the Function.optimizeForWrite() returns true and there is a low memory condition

FunctionException

Since:

GemFire 6.5

execute

@Deprecated
ResultCollector<?,?> execute(java.lang.String functionId,
                                         boolean hasResult,
                                         boolean isHA,
                                         boolean optimizeForWrite)
                                  throws FunctionException

Deprecated. as of 6.6, use execute(String) instead

Executes the function using its id

Function.execute(FunctionContext) is called on the de-serialized instance on the executing member.Function should be registered on the executing member using FunctionService.registerFunction(Function) method before calling this method. As of 6.6, this is deprecated, since users can pass different value for the hasResult, isHA, optimizeForWrite parameters that than the boolean values returned from Function.hasResult(), Function.isHA(), Function.optimizeForWrite().

Parameters:

functionId - the Function.getId() of the function

hasResult - Whether the function returns any result

isHA - Whether the given function is HA

optimizeForWrite - Whether the function should be optmized for write operations

Returns:

ResultCollector to retrieve the results received. This is different object than the ResultCollector provided in withCollector(ResultCollector). User has to use this reference to retrieve results.

Throws:

LowMemoryException - if the Function.optimizeForWrite() returns true and there is a low memory condition

FunctionException

Since:

GemFire 6.5