public class TouchReplicatedRegionEntriesFunction extends java.lang.Object implements Function, Declarable
| Modifier and Type | Field and Description |
|---|---|
static java.lang.String |
ID |
| Constructor and Description |
|---|
TouchReplicatedRegionEntriesFunction() |
TouchReplicatedRegionEntriesFunction(Cache cache) |
| Modifier and Type | Method and Description |
|---|---|
void |
execute(FunctionContext context)
The method which contains the logic to be executed.
|
java.lang.String |
getId()
Return a unique function identifier, used to register the function with
FunctionService |
boolean |
hasResult()
Specifies whether the function sends results while executing.
|
void |
init(java.util.Properties properties)
Initializes a user-defined object using the given properties.
|
boolean |
isHA()
Specifies whether the function is eligible for re-execution (in case of failure).
|
boolean |
optimizeForWrite()
Return true to indicate to GemFire the method requires optimization for writing the targeted
FunctionService.onRegion(org.apache.geode.cache.Region) and any associated
routing objects. |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitgetRequiredPermissionspublic static final java.lang.String ID
public TouchReplicatedRegionEntriesFunction()
public TouchReplicatedRegionEntriesFunction(Cache cache)
public void execute(FunctionContext context)
FunctionExecution. The context
provided to this function is the one which was built using Execution. The contexts
can be data dependent or data-independent so user should check to see if the context provided
in parameter is instance of RegionFunctionContext.public java.lang.String getId()
FunctionFunctionServicegetId in interface FunctiongetId in interface Identifiablepublic boolean optimizeForWrite()
Function
Return true to indicate to GemFire the method requires optimization for writing the targeted
FunctionService.onRegion(org.apache.geode.cache.Region) and any associated
routing objects.
Returning false will optimize for read behavior on the targeted
FunctionService.onRegion(org.apache.geode.cache.Region) and any associated
routing objects.
This method is only consulted when Region passed to FunctionService#onRegion(org.apache.geode.cache.Region) is a partitioned region
optimizeForWrite in interface FunctionFunctionServicepublic boolean isHA()
FunctionisHA in interface FunctionFunctionContext.isPossibleDuplicate()public boolean hasResult()
Function
If Function.hasResult() returns false, ResultCollector.getResult() throws
FunctionException.
If Function.hasResult() returns true, ResultCollector.getResult() blocks and
waits for the result of function execution
public void init(java.util.Properties properties)
DeclarableCache initialization to fail.init in interface Declarableproperties - Contains the parameters declared in the declarative xml file.