public class CreateRegionFunction extends Object implements Function, Declarable, DataSerializable
DataSerializable.Replaceable
Constructor and Description |
---|
CreateRegionFunction() |
Modifier and Type | Method and Description |
---|---|
void |
execute(FunctionContext context)
The method which contains the logic to be executed.
|
void |
fromData(DataInput in)
Reads the state of this object as primitive data from the given
DataInput . |
String |
getId()
Return a unique function identifier, used to register the function with
FunctionService |
Collection<ResourcePermission> |
getRequiredPermissions(String regionName)
Returns the list of ResourcePermission this function requires.
|
boolean |
hasResult()
Specifies whether the function sends results while executing.
|
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. |
void |
toData(DataOutput out)
Writes the state of this object as primitive data to the given
DataOutput . |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getRequiredPermissions
exists, find, remove
init, initialize
public static final String ID
public void execute(FunctionContext context)
Function
Execution
. 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 Collection<ResourcePermission> getRequiredPermissions(String regionName)
Function
By default, functions require DATA:WRITE permission. If your function requires other permissions, you will need to override this method.
Please be as specific as possible when you set the required permissions for your function e.g. if your function reads from a region, it would be good to include the region name in your permission. It's better to return "DATA:READ:regionName" as the required permission other than "DATA:READ", because the latter means only users with read permission on ALL regions can execute your function.
All the permissions returned from this method will be ANDed together.
getRequiredPermissions
in interface Function
regionName
- the region this function will be executed on. The regionName is optional and
will only be present when the function is executed by an onRegion() executor. In other
cases,
it will be null. This method returns permissions appropriate to the context, independent
of the
presence of the regionName parameter.ResourcePermission
s indicating the permissions required to
execute the function.public String getId()
Function
FunctionService
getId
in interface Function
getId
in interface Identifiable
public 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 Function
FunctionService
public boolean isHA()
Function
isHA
in interface Function
FunctionContext.isPossibleDuplicate()
public boolean hasResult()
Function
If this method returns false, ResultCollector.getResult()
throws
FunctionException
.
If this method returns true, ResultCollector.getResult()
blocks and
waits for the result of function execution
public void toData(DataOutput out)
DataSerializable
DataOutput
.
Since 5.7 it is possible for any method call to the specified DataOutput
to throw
GemFireRethrowable
. It should not be caught by user code. If it is it
must be rethrown.
toData
in interface DataSerializable
out
- the DataOutput
to write topublic void fromData(DataInput in)
DataSerializable
DataInput
.fromData
in interface DataSerializable
in
- the DataInput
to read from