com.gemstone.gemfire.cache.operations.package.html Maven / Gradle / Ivy
Show all versions of gemfire-core Show documentation
Contains the {@link com.gemstone.gemfire.cache.operations.OperationContext} interface that encapsulates an operation and the data associated with it for both the pre-operation and post-operation cases.
It also contains implementations of the {@link com.gemstone.gemfire.cache.operations.OperationContext} interface for various kinds of cache operations.
These include:
{@link com.gemstone.gemfire.cache.operations.KeyOperationContext}: Implementation for operations that require a key for the operation.
It provides a getKey method to obtain the key. Also provided are setCallbackArg and getCallbackArg methods that can be used to set/get an optional callback argument.
The operations returned as KeyOperationContext are {@link com.gemstone.gemfire.cache.operations.OperationContext.OperationCode#DESTROY}
and {@link com.gemstone.gemfire.cache.operations.OperationContext.OperationCode#CONTAINS_KEY}.
{@link com.gemstone.gemfire.cache.operations.KeyValueOperationContext}: Implementation for operations that require both key and value for the operation.
It extends the {@link com.gemstone.gemfire.cache.operations.KeyOperationContext} implementation providing getValue and setValue methods
in addition to those provided by the KeyOperationContext class.
The operations returned as KeyValueOperationContext are {@link com.gemstone.gemfire.cache.operations.OperationContext.OperationCode#GET} and {@link com.gemstone.gemfire.cache.operations.OperationContext.OperationCode#PUT}.
For the GET operation this is used to both the pre and post operation cases.
{@link com.gemstone.gemfire.cache.operations.InterestOperationContext}: Implementation for register and unregister of interest in a region.
It defines a sub-class {@link com.gemstone.gemfire.cache.operations.InterestType} that encapsulates different kinds of interest viz.
KEY, LIST, REGULAR_EXPRESSION, FILTER_CLASS and OQL_QUERY.
It provides getInterestType method to get the interest type,
getInterestResultPolicy method to get the {@link com.gemstone.gemfire.cache.InterestResultPolicy} of the request,
isUnregister method that returns true if this is an unregister operation, and getKey/setKey methods to get/set the key being registered.
The key may be a single key, a list of keys, a regular expression string or an OQL {@link com.gemstone.gemfire.cache.query.Query}.
{@link com.gemstone.gemfire.cache.operations.QueryOperationContext}: Implementation for a cache query operation for both the pre and post operation cases.
It provides getQuery to get the query string as well as a modifyQuery method to be able to modify it.
A utility getRegionNames method is also provided to obtain the list of regions as referenced by the query string.
For the results in the post operation phase, getQueryResult allows getting the result and setQueryResult allows modification of the result.
{@link com.gemstone.gemfire.cache.operations.RegionOperationContext}: Implementation for the region level operation for the pre operation case.
It provides getCallbackArg and setCallbackArg methods to get/set the optionally callback argument.
The operations returned as RegionOperationContext are {@link com.gemstone.gemfire.cache.operations.OperationContext.OperationCode#REGION_CLEAR}
and {@link com.gemstone.gemfire.cache.operations.OperationContext.OperationCode#REGION_DESTROY}.
{@link com.gemstone.gemfire.cache.operations.DestroyOperationContext}: Implementation for {@link com.gemstone.gemfire.cache.operations.OperationContext.OperationCode#DESTROY} operation
having the key object for both the pre-operation and post-operation updates.
{@link com.gemstone.gemfire.cache.operations.CloseCQOperationContext}: Implementation for {@link com.gemstone.gemfire.cache.operations.OperationContext.OperationCode#CLOSE_CQ} operation
for the pre-operation case.
{@link com.gemstone.gemfire.cache.operations.ExecuteCQOperationContext}: Implementation for {@link com.gemstone.gemfire.cache.operations.OperationContext.OperationCode#EXECUTE_CQ} operation
for both the pre-operation and post-operation case.
{@link com.gemstone.gemfire.cache.operations.ExecuteFunctionOperationContext}: Implementation for {@link com.gemstone.gemfire.cache.operations.OperationContext.OperationCode#EXECUTE_FUNCTION} operation
for the pre-operation case.
{@link com.gemstone.gemfire.cache.operations.GetOperationContext}: Implementation for {@link com.gemstone.gemfire.cache.operations.OperationContext.OperationCode#GET} operation
having the key object for the pre-operation case and both key-value objects for the post-operation case.
{@link com.gemstone.gemfire.cache.operations.InvalidateOperationContext}: Implementation for {@link com.gemstone.gemfire.cache.operations.OperationContext.OperationCode#INVALIDATE} region
operation having the key object for the pre-operation case and post-operation case.
{@link com.gemstone.gemfire.cache.operations.PutOperationContext}: Implementation for {@link com.gemstone.gemfire.cache.operations.OperationContext.OperationCode#PUT} operation
having the key and value objects for the pre-operation case and post-operation case.
{@link com.gemstone.gemfire.cache.operations.PutAllOperationContext}: Implementation for {@link com.gemstone.gemfire.cache.operations.OperationContext.OperationCode#KEY_SET} operation
having the key and value objects for the pre-operation case and post-operation case.
{@link com.gemstone.gemfire.cache.operations.RegionCreateOperationContext}: Implementation for {@link com.gemstone.gemfire.cache.operations.OperationContext.OperationCode#REGION_CREATE}
operation for the pre-operation case and post-operation case.
{@link com.gemstone.gemfire.cache.operations.StopCQOperationContext}: Implementation for {@link com.gemstone.gemfire.cache.operations.OperationContext.OperationCode#STOP_CQ} operation
for the pre-operation case.
{@link com.gemstone.gemfire.cache.operations.RegisterInterestOperationContext}: Implementation for {@link com.gemstone.gemfire.cache.operations.OperationContext.OperationCode#REGISTER_INTEREST} operation
for the pre-operation case, which derives from {@link com.gemstone.gemfire.cache.operations.InterestOperationContext}
{@link com.gemstone.gemfire.cache.operations.UnregisterInterestOperationContext}: Implementation for {@link com.gemstone.gemfire.cache.operations.OperationContext.OperationCode#UNREGISTER_INTEREST} operation
for the pre-operation case, which derives from {@link com.gemstone.gemfire.cache.operations.InterestOperationContext}