See: Description
| Interface | Description |
|---|---|
| BackingStore |
Provides a means for a
NamedCache to interact with a backing store (such as a database) to perform read-through, write-though, refresh-ahead,
and write-behind operations. |
| CoherencyPolicy |
This interface is implemented by the classes that represent various methods of keeping local proxy object
coherent with its remote master.
|
| CreateHandler |
By implementing this interface the read through behaviour can be specified on object-by-object basis.
|
| EvalArgs<O> |
A helper object provided to the
Invokable.eval(Object, java.io.Serializable, EvalArgs) |
| Invokable<O,P extends java.io.Serializable,R> |
The interface that must be implemented by all processing classes, and passed into the
invoke call. |
| InvokeFilter<T,P> |
The interface that must be implemented and passed into the
invokeFilter call. |
| LoginModule |
This is an interface for user-defined login routines.
|
| NamedCacheObjectExpirationListener |
The interface clients use to receive callback notifications when an object is removed from
StateServer.
|
| OptimisticConcurrencyVersionHolder |
Instances of Types that implement OptimisticConcurrencyVersionHolder are associated with StateServer object version
information and are therefore suitable for optimistic concurrency.
|
| Taggable |
Objects of classes implementing this interface can hold arbitrary tags scoped by the object's
NamedCache. |
| Class | Description |
|---|---|
| BackingStorePolicy |
Contains options to control how a
NamedCache interacts with a backing store. |
| CachedObjectId<T> |
This class represents the object id in the Java SOSS NamedCache.
|
| CacheFactory |
This class contains static methods for creating
NamedCaches. |
| CreatePolicy |
The
CreatePolicy class provides extended parameter information to the NamedCache.insert(com.scaleoutsoftware.soss.client.CachedObjectId<T>, T, com.scaleoutsoftware.soss.client.CreatePolicy, boolean, boolean) and
NamedCache.setDefaultCreatePolicy(com.scaleoutsoftware.soss.client.CreatePolicy). |
| CustomSerializer<O> |
Custom serializers should extend this class.
|
| Dependency |
Invocation grid dependency.
|
| Event |
Contains information about an event that was pushed from a ScaleOut client (via Pipeline.postEvent).
|
| EventDeliveryExceptionHandler |
The EventDeliveryExceptionHandler is used to deliver exceptions that were unhandled in user code during
backing store operations.
|
| EventDeliveryExceptionHandlerArgs |
The EventDeliveryExceptionHandlerArgs class is used to store the NamedCache, Id, and Exception that occurred during
a BackingStore operation.
|
| EventWrapper | |
| ExtendedObjectMetadata |
ExtendedObjectMetadata augments the user-specified ObjectMetadata values with additional read-only
values maintained automatically by the StateServer. |
| Filter |
An interface for filters that can be used in
NamedCache.queryObjects(Class, Filter) and
NamedCache.queryKeys(Class, Filter). |
| FilterFactory |
This factory is used for constructing query expressions.
|
| IgDaemonInvokable | |
| IndexCollection |
A
List of IndexValues which may be used to query the StateServer object
store for the set of objects with metadata matching the (positional) values specified in the
IndexCollection. |
| IndexValue |
An immutable value that may be assigned to an
IndexCollection and used to query the
StateServer for objects with metadata matching the IndexCollection. |
| InvocationGrid |
This is a handle object for the available invocation grid.
|
| InvocationGridBuilder |
An invocation grid (IG) represents a custom configuration of the set of JVMs attached to the hosts in the store.
|
| InvokeResult<R> |
Contains information about a completed
invoke call. |
| LoginManager |
Logs in to the ScaleOut StateServer service on a per-cache basis, passing supplied credentials to the server.
|
| NamedCache |
Provides access to a named collection of objects that can be shared globally across multiple clients.
|
| NamedCacheFilter |
This class represents a filter used in
NamedCache.query() |
| NamedCacheObjectExpiredEventArgs |
This is a helper class, objects of which are passed as an argument to the event handler's
NamedCacheObjectExpirationListener. |
| NotifyCoherencyPolicy |
Indicates that objects in remote stores should be notified every time a master object is created, or updated.
|
| ObjectMetadata |
Metadata describing a StateServer object including the set of user-defined index values
defined for the object.
|
| PollingCoherencyPolicy |
Indicates that proxy objects in remote stores should poll the master object for updates every time the specified coherency
interval expires.
|
| ReadOptions |
Class containing options that can be used when retrieving an object or a metadata in ScaleOut StateServer.
|
| RemoteStore |
A remote store which is used to look for objects that are not found.
|
| SossObjectDescriptor |
Contains information necessary to insert an object into a NamedCache via a
bulk
NamedCache.putAll(java.util.Map) operation. |
| TaggableObject |
An object implementing
Taggable. |
| TagHolder |
This class is used as a holder for tags associated with an object.
|
| TimeSpan |
An object of this class represents a time interval.
|
| UpdateOptions |
Class containing options that can be used when updating an object in ScaleOut StateServer.
|
| Enum | Description |
|---|---|
| BackingStoreAsyncPolicy |
Indicates the type of asynchronous backing-store behavior that the server should invoke for an object.
|
| Dependency.DependencyType |
Dependency type
|
| EvalObjectDisposition |
Specifies the desired disposition of the target object following
execution of an
Invokable.eval(Object, java.io.Serializable, EvalArgs) method. |
| GeoServerReadMode |
Enum contains type of read used when accessing a local object with its master in remote store.
|
| HashIndexPriority |
This enum allows sorting of hashed attributes by priority.
|
| LogoutScope |
Indicates the scope of a logout operation on
NamedCache. |
| NamedCacheObjectExpiredEventArgs.NamedCacheEventCode |
Enumeration containing the event codes, which can be used to determine the reason why the object was expired
and the event was fired.
|
| NamedCacheObjectExpiredEventArgs.NamedCacheObjectDisposition |
Enumeration used to indicate to StateServer the disposition of an expired object upon return from a StateServer event handler.
|
| ObjectDisposition |
An enumeration used to indicate to StateServer the disposition of an expired object upon
return from a StateServer event handler.
|
| ObjectPreemptionPriority |
Indicates the priority of keeping a given object in StateServer memory.
|
| ReadLockingMode |
An enumeration used to control locking behavior during Retrieve and GetMetadata operation
|
| ReadMode | |
| UpdateLockingMode |
Enumeration used to control locking behavior during update operations.
|
| Exception | Description |
|---|---|
| InvokeException |
An exception that occurred during an
invoke call. |
| NamedCacheBulkAddException |
This exception indicates an error while adding multiple objects with bulk add call.
|
| NamedCacheException |
Most general Named Cache exception, a base class for all Named Cache exceptions.
|
| NamedCacheIndexAttributeException |
This exception is used to indicate that there was an error while parsing object properties.
|
| NamedCacheInvokeTimeoutException |
This exception indicates that an invoke operation timed out.
|
| NamedCacheNotImplementedException |
This exception indicates that a request was made to perform an operation not implemented in the current release.
|
| NamedCacheNotLicensedException |
This exception indicates that a client cannot access StateServer because the client is not licensed.
|
| NamedCacheObjectAlreadyExistsException |
This exception indicates that an insert call failed because an object already exists in the StateServer with the given key.
|
| NamedCacheObjectLockedException |
This exception indicates that the requested StateServer object was locked and couldn't be accessed.
|
| NamedCacheObjectNotFoundException |
This exception indicates that an error occurred because the key of an object on which StateServer
was asked to operate was not found.
|
| NamedCacheOptimisticLockException |
This exception indicates that the requested StateServer object was locked and couldn't be accessed.
|
| NamedCacheReadThroughTimeoutException |
This exception indicates that a read-through operation to a backing store (such as a database) timed out.
|
| NamedCacheRemoteStoreAccessException |
This exception is thrown when an access error to a remote store occurs.
|
| NamedCacheRemoteStoreConfigurationException |
This exception is thrown by read calls when there is a misconfiguration in remote store settings.
|
| NamedCacheSecurityException |
Exception in security routine.
|
| NamedCacheServerUnavailableException |
This exception indicates that the connection to the server was lost or an unexpected error occurred.
|
| NamedCacheStaleDataException |
This exception is thrown by the
NamedCache.retrieve(com.scaleoutsoftware.soss.client.CachedObjectId<T>, boolean) method if the object that is being read is a local
copy of the remote master object (proxy) and the previous polling operation failed PollingCoherencyPolicy. |
| ObjectNotSupportedException |
This exception is thrown by
CustomSerializer methods when serialization/deserialization is not
supported for an object. |
| Annotation Type | Description |
|---|---|
| SossIndexAttribute |
A marker that indicates that the property or class to which it
applies should be saved in the StateServer property index when instances of the class
are created or updated.
|
This API allows access to the ScaleOut StateServer store.
The SOSS store can contain multiple named caches. Objects in a named cache can be accessed by methods of the
NamedCache class. To create an instance of a NamedCache, use the CacheFactory.
Cached objects can be identified by CachedObjectId, String,
byte, or UUID.
The key features of a named cache are:
NamedCache.setUseLocking(boolean)),
queryKeys, queryObjects, query) cached objects by attribute values (SossIndexAttribute), tags (Taggable),
or index values (NamedCacheFilter),
BackingStore) to perform
read-through, write-though, refresh-ahead, and write-behind operations,
OptimisticConcurrencyVersionHolder),
invoke) on multiple clients,
putAll),
NamedCacheObjectExpirationListener),
LoginManager),
RemoteStore).