com.scaleout.client.caching (client 3.0.1 API)

Interface Summary
Interface	Description
CacheEntryEraseHandler<K,V>	Callback that removes the provided object from a backing store.
CacheEntryExpirationHandler<K,V>	Callback that is invoked when an object expires in the ScaleOut service.
CacheEntryForEachHandler<K,V,P>	Callback that is invoked on each eligible object for a `Cache.invoke(String, Duration)` call.
CacheEntryMethodInvocationHandler<K,V,P,R>	Callback event handler for all `Cache.singleInvoke(Object, String, Duration)` operations.
CacheEntryReduceHandler<K,V,P,R>	Callback that is invoked on each eligible object for a `Cache.invoke(String, Duration)` call.
CacheEntryStoreHandler<K,V>	Callback that writes the provided object to a backing store.
OperationContext<K,V,P>	Invoke operation context used during `Cache.invoke(String, Duration)` operations.
ParamHolder<P>	Retrieves a hydrated `P` parameter object for `Cache.invoke(String, byte[], Duration)` operations.
PostedEventHandler<K>	Callback event handler for `Cache.postEvent(Object, String, byte[], Duration)` operations.
ServiceEventHandler<K,V>	The service event handler handles events from the ScaleOut service.
ValueFactory<K,V>	Call back used to load objects into a `Cache`.

Class Summary
Class	Description
ByteArrayKeyEncoder	The `ByteArrayKeyEncoder` is an implementation of a `KeyEncoder` for `Byte[]` keys compatible with the SOSS-JNC API.
Cache<K,V>	The `Cache` class is used to make caching requests to a ScaleOut in-memory data grid.
CacheBuilder<K,V>	The `CacheBuilder` is used to instantiate a typed cache connected to a ScaleOut in-memory data grid.
CacheDeserializer<V>	The `CacheDeserializer` is used to deserialize a `V` value from a N-length byte array.
CachedObjectMetadata<K>	Metadata for an object stored in a `Cache`.
CacheResponse<K,V>	The `CacheResponse` provides details regarding the status of a caching request.
CacheSerializer<V>	The `CacheSerializer` is used to serialize a `V` value to a N-length byte array.
CacheValueDeserializer<V>	The `CacheValueDeserializer` is used as the default `V` value deserializer.
CacheValueSerializer<V>	The `CacheValueSerializer` is used as the default `V` value serializer.
ClientCache<K,V>	The `ClientCache` stores `ClientCacheEntry`'s to speed up read operations.
ClientCacheEntry<K,V>	The `ClientCacheEntry` is an element in a `ClientCache`.
ClientCacheEntryWeigher<K,V>	The `ClientCacheEntryWeigher` is used to evaluate a `ClientCacheEntry`'s weight in the weighted `ClientCache`.
Constants	Constants and reasonable defaults for configuring a cache from a properties file.
CreatePolicy	The `CreatePolicy` specifies per-object policy information when adding objects to a ScaleOut in-memory data grid.
CreatePolicyBuilder	The `CreatePolicyBuilder` class is used to create immutable `CreatePolicy` objects.
Event	Contains information about an event that was pushed from a ScaleOut client (via cache.postEvent).
EventDeliveryExceptionArgs<K,V>	The EventDeliveryExceptionHandlerArgs class is used to store the NamedCache, Id, and Exception that occurred during a BackingStore operation.
EventDeliveryExceptionHandler<K,V>	The EventDeliveryExceptionHandler is used to deliver exceptions that were unhandled in user code during backing store operations.
EventPayload	An event delived to `PostedEventHandler` handlers.
IntegerKeyEncoder	The `IntegerKeyEncoder` is an implementation of a `KeyEncoder` for `Integer` keys.
InvokeResponse	Details for the result of a `Cache.invoke(String, byte[], Duration)` operation.
KeyEncoder<K>	The `KeyEncoder` is used to transform a `K` key into an array of 32 bytes.
KeyEncodingResult	The `KeyEncodingResult` returned by an implementation of `KeyEncoder.encode(Object)`
LegacyStringKeyEncoder	The `LegacyStringKeyEncoder` is an implementation of a `KeyEncoder` for `String` keys compatible with the SOSS-JNC API.
LockToken	The `LockToken` is an identifier for a lock that is held on an object in the ScaleOut in-memory data grid.
ReadPolicy	The `ReadPolicy` specifies per-object policy information when reading objects from a ScaleOut in-memory data grid.
ReadPolicyBuilder	The `ReadPolicyBuilder` class is used to create immutable `ReadPolicy` objects.
StringKeyCache	Maintains an in-process cache of string keys.
StringKeyEncoder	The `StringKeyEncoder` is an implementation of a `KeyEncoder` for `String` keys that is not compatible with the SOSS-JNC API.
UndefinedParamHolder<P>	The `UndefinedParamHolder` is the default implementation of `ParamHolder` and returns NULL and logs an error.
UuidKeyEncoder	The `UuidKeyEncoder` is an implementation of a `KeyEncoder` for `UUID` keys compatible with the SOSS-JNC API.
ValueFactoryResult<V>	Created by a `ValueFactory` implementation.
VersionToken	The `VersionToken` is an identifier for the version of an object stored in the ScaleOut in-memory data grid.

Enum Summary
Enum	Description
BackingStoreMode	The `BackingStoreMode` indicates the type of asynchronous backing-store behavior that the server should invoke for an object.
CacheEntryDisposition	Cache entry disposition is used by the `CacheEntryExpirationHandler` to tell a `Cache` what to do with an object that has expired.
ClientCacheOptions	The `ClientCacheOptions` enum indicates in-memory client cache usage.
GeoServerCoherencyPolicy	The `GeoServerCoherencyPolicy` is used to indicate the type of coherency policy used for GeoServer "pull" replication.
GeoServerPullPolicy	The `GeoServerPullPolicy` enum is used to indicate whether objects added to the cache will be accessible to remote stores via GeoServer "pull" replication.
GeoServerPushPolicy	The `GeoServerPushPolicy` enum is used to indicate whether objects added to the cache will be subject to GeoServer "push" replication.
GeoServerReadMode	The `GeoServerReadMode` is an enum used to control GeoServer "pull" replication during Read operations.
InvokeType	Invoke types.
PreemptionPriority	The `PreemptionPriority` enum is used to indicate the priority of keeping a given object in the ScaleOut in-memory data grid under low-memory conditions.
RequestStatus	The `RequestStatus` provides details on the status of a caching request.
TimeoutType	The `TimeoutType` enum is used to indicate the type of timeout an object uses.

Exception Summary
Exception	Description
CacheException	The `CacheException` is thrown when all retries to connect to a ScaleOut in-memory data grid have been exhausted.
DeserializationException	The `DeserializationException` indicates that an error occurred while deserializing a value from the ScaleOut in-memory data grid.
SerializationException	The `SerializationException` indicates that an error occurred while serializing a value to the ScaleOut in-memory data grid.

Package com.scaleout.client.caching Description

API for caching to a ScaleOut in-memory data grid.