A B C D E F G H I L M N O P Q R S T U V W

A

acquireLock(CachedObjectId) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Locks the cached object in SOSS to prevent other clients from updating or removing it.
acquireLock(byte[]) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Locks the cached object in SOSS to prevent other clients from updating or removing it.
acquireLock(String) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Locks the cached object in SOSS to prevent other clients from updating or removing it.
acquireLock(UUID) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Locks the cached object in SOSS to prevent other clients from updating or removing it.
add(int, IndexValue) - Method in class com.scaleoutsoftware.soss.client.IndexCollection
Inserts the specified IndexValue at the specified position in this list.
add(IndexValue) - Method in class com.scaleoutsoftware.soss.client.IndexCollection
Adding to the end of an IndexCollection is not supported.
add(CachedObjectId<T>, T) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Deprecated. Use NamedCache.put(com.scaleoutsoftware.soss.client.CachedObjectId, T)
add(UUID, T) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Deprecated. Use NamedCache.put(com.scaleoutsoftware.soss.client.CachedObjectId, T)
add(byte[], T) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Deprecated. Use NamedCache.put(com.scaleoutsoftware.soss.client.CachedObjectId, T)
add(String, T) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Deprecated. Use NamedCache.put(com.scaleoutsoftware.soss.client.CachedObjectId, T)
addAll(Map<?, ? extends Serializable>) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Deprecated. Use NamedCache.putAll(java.util.Map)
addListener(NamedCacheObjectExpirationListener) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Adds a listener for "object expired" events.
addTags(String...) - Method in class com.scaleoutsoftware.soss.client.TaggableObject
Adds the tags specified in the tags to the object's tag list.
addTags(String...) - Method in class com.scaleoutsoftware.soss.client.TagHolder
Adds the tags specified in the tags to the current tag list.
allowClientCaching() - Method in class com.scaleoutsoftware.soss.client.NamedCache
Deprecated. Use NamedCache.getAllowClientCaching()
and(Filter, Filter) - Static method in class com.scaleoutsoftware.soss.client.FilterFactory
Creates a compound filter, matching objects must satisfy firstFilter AND secondFilter.

B

BackingStore - Interface in com.scaleoutsoftware.soss.client
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.
BackingStoreAsyncPolicy - Enum in com.scaleoutsoftware.soss.client
Indicates the type of asynchronous backing-store behavior that the server should invoke for an object.
BackingStorePolicy - Class in com.scaleoutsoftware.soss.client
Contains options to control how a NamedCache interacts with a backing store.
BackingStorePolicy() - Constructor for class com.scaleoutsoftware.soss.client.BackingStorePolicy
Creates a BackingStorePolicy object with all options set to false.
BackingStorePolicy(boolean, boolean, boolean) - Constructor for class com.scaleoutsoftware.soss.client.BackingStorePolicy
Creates a BackingStorePolicy object.
between(TimeSpan, TimeSpan) - Method in class com.scaleoutsoftware.soss.client.TimeSpan
 

C

CachedObjectId<T> - Class in com.scaleoutsoftware.soss.client
This class represents the object id in the Java SOSS NamedCache.
CachedObjectId(StateServerKey) - Constructor for class com.scaleoutsoftware.soss.client.CachedObjectId
Creates a CachedObjectId from StateServerKey.
CacheFactory - Class in com.scaleoutsoftware.soss.client
This class contains static methods for creating NamedCaches.
clear() - Method in class com.scaleoutsoftware.soss.client.IndexCollection
Clears all elements in the IndexCollection by setting the IndexValue in each index position to null.
clear() - Method in class com.scaleoutsoftware.soss.client.NamedCache
Clears the cache.
clearRange(int, int) - Method in class com.scaleoutsoftware.soss.client.IndexCollection
Clears a range of elements in the IndexCollection by setting the IndexValues in the corresponding index positions to null.
clearTags() - Method in class com.scaleoutsoftware.soss.client.TaggableObject
Clears all tags from the object's tag list.
clearTags() - Method in class com.scaleoutsoftware.soss.client.TagHolder
Clears all tags from the holder.
CoherencyPolicy - Interface in com.scaleoutsoftware.soss.client
This interface is implemented by the classes that represent various methods of keeping local proxy object coherent with its remote master.
com.scaleoutsoftware.soss.client - package com.scaleoutsoftware.soss.client
This API allows access to the ScaleOut StateServer store.
contains(CachedObjectId) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Checks if the cache contains an object with the given ID.
contains(byte[]) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Checks if the cache contains an object with the given ID.
contains(String) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Checks if the cache contains an object with the given ID.
contains(UUID) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Checks if the cache contains an object with the given ID.
CopyTo(byte[], int) - Method in class com.scaleoutsoftware.soss.client.IndexValue
Copies the contents of this IndexValue to the specified byte array beginning at the specified index.
createKey(byte[]) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Generates a CachedObjectId for an object identified by id.
createKey(String) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Generates a CachedObjectId for an object identified by id.
createKey(UUID) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Generates a CachedObjectId for an object identified by id.
createKey(StateServerKey) - Static method in class com.scaleoutsoftware.soss.client.NamedCache
Generates a CachedObjectId for an object identified by id.
CreatePolicy - Class in com.scaleoutsoftware.soss.client
The CreatePolicy class provides extended parameter information to the NamedCache.insert(com.scaleoutsoftware.soss.client.CachedObjectId, T, com.scaleoutsoftware.soss.client.CreatePolicy, boolean, boolean) and NamedCache.setDefaultCreatePolicy(com.scaleoutsoftware.soss.client.CreatePolicy).
CreatePolicy() - Constructor for class com.scaleoutsoftware.soss.client.CreatePolicy
Creates a CreatePolicy object with an infinite timeout and a sliding expiration policy.
CreatePolicy(TimeSpan) - Constructor for class com.scaleoutsoftware.soss.client.CreatePolicy
Creates a CreatePolicy object with a timeout of the specified duration and a sliding expiration policy.
CreatePolicy(TimeSpan, boolean) - Constructor for class com.scaleoutsoftware.soss.client.CreatePolicy
Creates a CreatePolicy object with a timeout of the specified duration that is either sliding or absolute.
CreatePolicy(TimeSpan, boolean, ObjectPreemptionPriority, Collection, boolean) - Constructor for class com.scaleoutsoftware.soss.client.CreatePolicy
Creates a CreatePolicy object.
CreatePolicy(int) - Constructor for class com.scaleoutsoftware.soss.client.CreatePolicy
Deprecated. use CreatePolicy.CreatePolicy(TimeSpan)
CreatePolicy(int, boolean) - Constructor for class com.scaleoutsoftware.soss.client.CreatePolicy
Deprecated. use CreatePolicy.CreatePolicy(TimeSpan, boolean)
CreatePolicy(int, boolean, ObjectPreemptionPriority, Object[], boolean) - Constructor for class com.scaleoutsoftware.soss.client.CreatePolicy
Deprecated. use CreatePolicy.CreatePolicy(TimeSpan, boolean, ObjectPreemptionPriority, java.util.Collection, boolean)
CustomSerializer - Interface in com.scaleoutsoftware.soss.client
Custom serializers should implement this interface.

D

deserialize(ByteArrayInputStream) - Method in interface com.scaleoutsoftware.soss.client.CustomSerializer
Deserializes an object from ByteArrayInputStream.
deserialize(ObjectInput) - Static method in class com.scaleoutsoftware.soss.client.IndexValue
Create a new IndexValue instance from the serialized stream given by in.
disableMethodInvocationEventHandling() - Method in class com.scaleoutsoftware.soss.client.NamedCache
Disables this NamedCache instance for receiving StateServer method invocation events.
disableObjectExpirationEventHandling() - Method in class com.scaleoutsoftware.soss.client.NamedCache
Deprecated. the event handling will be automatically disabled when the last listener is unregistered NamedCache.removeListener(NamedCacheObjectExpirationListener)

E

enableMethodInvocationEventHandling() - Method in class com.scaleoutsoftware.soss.client.NamedCache
Enables this NamedCache instance for receiving StateServer method invocation events.
enableObjectExpirationEventHandling() - Method in class com.scaleoutsoftware.soss.client.NamedCache
Deprecated. the event handling will be automatically enabled when the listener is registered NamedCache.addListener(NamedCacheObjectExpirationListener)
equal(String, Object) - Static method in class com.scaleoutsoftware.soss.client.FilterFactory
The value of the property with the name propertyName must be EQUAL to value.
equals(Object) - Method in class com.scaleoutsoftware.soss.client.CachedObjectId
 
equals(Object) - Method in class com.scaleoutsoftware.soss.client.IndexValue
 
equals(Object) - Method in class com.scaleoutsoftware.soss.client.TimeSpan
 
erase(CachedObjectId) - Method in interface com.scaleoutsoftware.soss.client.BackingStore
Removes an object from the backing store.
eval(O, P, EvalArgs<O>) - Method in interface com.scaleoutsoftware.soss.client.Invokable
Evaluates an object according the specified parameters
EvalArgs<O extends Serializable> - Interface in com.scaleoutsoftware.soss.client
A helper object provided to the Invokable.eval(java.io.Serializable, java.io.Serializable, EvalArgs)
EvalObjectDisposition - Enum in com.scaleoutsoftware.soss.client
Specifies the desired disposition of the target object following execution of an Invokable.eval(java.io.Serializable, java.io.Serializable, EvalArgs) method.
expressionsEqual(Filter, Filter) - Static method in class com.scaleoutsoftware.soss.client.FilterFactory
To pass through this filter objects must satisfy both firstFilter and secondFilter or neither of them.
ExtendedObjectMetadata - Class in com.scaleoutsoftware.soss.client
ExtendedObjectMetadata augments the user-specified ObjectMetadata values with additional read-only values maintained automatically by the StateServer.
ExtendedObjectMetadata() - Constructor for class com.scaleoutsoftware.soss.client.ExtendedObjectMetadata
 

F

Filter - Class in com.scaleoutsoftware.soss.client
An interface for filters that can be used in NamedCache.queryObjects(Class, Filter) and NamedCache.queryKeys(Class, Filter).
Filter() - Constructor for class com.scaleoutsoftware.soss.client.Filter
 
FilterFactory - Class in com.scaleoutsoftware.soss.client
This factory is used for constructing query expressions.
FilterFactory() - Constructor for class com.scaleoutsoftware.soss.client.FilterFactory
 
fromMilliseconds(long) - Static method in class com.scaleoutsoftware.soss.client.TimeSpan
Create TimeSpan from number of milliseconds
fromMinutes(long) - Static method in class com.scaleoutsoftware.soss.client.TimeSpan
Create TimeSpan from number of minutes
fromSeconds(long) - Static method in class com.scaleoutsoftware.soss.client.TimeSpan
Create TimeSpan from number of seconds

G

GeoServerReadMode - Enum in com.scaleoutsoftware.soss.client
Enum contains type of read used when accessing a local object with its master in remote store.
get(int) - Method in class com.scaleoutsoftware.soss.client.IndexCollection
Gets the element at the specified index.
get(CachedObjectId<T>) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Gets a cached item using default parameters.
get(byte[]) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Gets a cached item using default parameters.
get(String) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Gets a cached item using default parameters.
get(UUID) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Gets a cached item using default parameters.
getAbsoluteTimeout() - Method in class com.scaleoutsoftware.soss.client.CreatePolicy
Gets whether the timeout is an absolute expiration value or is a sliding expiration value that gets reset every time the object is accessed.
getAbsoluteTimeout() - Method in class com.scaleoutsoftware.soss.client.ExtendedObjectMetadata
Returns true if the StateServer object corresponding to this metadata instance will be removed from the store at a specific absolute time as opposed to a sliding expiration timeout due to a period of inactivity.
getAll(Collection) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Gets multiple objects from the cache based on a set of object identifiers.
getAllowClientCaching() - Method in class com.scaleoutsoftware.soss.client.NamedCache
Checks if client caching is enabled.
getAllowRemoteAccess() - Method in class com.scaleoutsoftware.soss.client.CreatePolicy
Gets whether an object can be accessed by remote stores.
getAllowRemoteAccess() - Method in class com.scaleoutsoftware.soss.client.ExtendedObjectMetadata
Returns true if the object can be accessed by the remote store, false otherwise.
getAllowReplication() - Method in class com.scaleoutsoftware.soss.client.CreatePolicy
Gets whether the object to be added to the cache will be subject to GeoServer cross-store replication.
getAllowReplication() - Method in class com.scaleoutsoftware.soss.client.ExtendedObjectMetadata
Returns true if the StateServer object corresponding to this metadata instance can be replicated to remote stores.
getBackingStoreAsyncPolicy() - Method in class com.scaleoutsoftware.soss.client.CreatePolicy
Returns the type of backing store operations (none, refresh-ahead or write-behind) performed on the StateServer object corresponding to this metadata instance.
getBackingStoreAsyncPolicy() - Method in class com.scaleoutsoftware.soss.client.ExtendedObjectMetadata
Returns the type of backing store operations (none, refresh-ahead or write-behind) performed on the StateServer object corresponding to this metadata instance.
getBackingStoreInterval() - Method in class com.scaleoutsoftware.soss.client.CreatePolicy
Gets the interval between asynchronous backing store events (refresh-ahead, write-behind).
getBackingStoreInterval() - Method in class com.scaleoutsoftware.soss.client.ExtendedObjectMetadata
Gets the interval between asynchronous backing store events (refresh-ahead, write-behind) for the StateServer object corresponding to this metadata instance.
getBackingStoreMode() - Method in class com.scaleoutsoftware.soss.client.CreatePolicy
Deprecated. use CreatePolicy.getBackingStoreAsyncPolicy()
getBytes() - Method in class com.scaleoutsoftware.soss.client.IndexValue
Returns a copy of the current value of this IndexValue as an array of bytes.
getCache() - Static method in class com.scaleoutsoftware.soss.client.CacheFactory
Creates a NamedCache using the default application id.
getCache(String) - Static method in class com.scaleoutsoftware.soss.client.CacheFactory
Creates a NamedCache using a specified name.
getCache(StateServerKey) - Static method in class com.scaleoutsoftware.soss.client.CacheFactory
Creates a NamedCache using the application id extracted from the StateServerKey.
getCache(String, boolean) - Static method in class com.scaleoutsoftware.soss.client.CacheFactory
Deprecated. the event handling will be automatically enabled when the listener is registered NamedCache.addListener(NamedCacheObjectExpirationListener); there is no need to explicitly enable them.
getCache(StateServerKey, boolean) - Static method in class com.scaleoutsoftware.soss.client.CacheFactory
Deprecated. the event handling will be automatically enabled when the listener is registered NamedCache.addListener(NamedCacheObjectExpirationListener); there is no need to explicitly enable them.
getCachedObjectId() - Method in class com.scaleoutsoftware.soss.client.NamedCacheObjectExpiredEventArgs
Returns the CachedObjectId of the expiring object.
getCreatePolicy(CachedObjectId) - Method in interface com.scaleoutsoftware.soss.client.BackingStore
Provides a policy object to be used when a load() operation inserts an object into the NamedCache.
getDefaultCoherencyPolicy() - Method in class com.scaleoutsoftware.soss.client.CreatePolicy
Gets the default coherency policy or null if no coherency policy is set.
getDefaultCoherencyPolicy() - Method in class com.scaleoutsoftware.soss.client.ExtendedObjectMetadata
Gets the default coherency policy or null if no coherency policy is set.
getDefaultCreatePolicy() - Method in class com.scaleoutsoftware.soss.client.NamedCache
Gets the CreatePolicy object used as parameters when adding objects to the cache using the add method.
getDefaultReadMode() - Method in class com.scaleoutsoftware.soss.client.NamedCache
Gets the default read mode (GeoServerReadMode) used by read operations.
getDependencies() - Method in class com.scaleoutsoftware.soss.client.CreatePolicy
Deprecated. use CreatePolicy.getParents()
getEnableAsyncOperations() - Method in class com.scaleoutsoftware.soss.client.BackingStorePolicy
If true, a client will handle asynchronous refresh-ahead/write-behind operations.
getEnableReadThrough() - Method in class com.scaleoutsoftware.soss.client.BackingStorePolicy
If true, a client will populate the StateServer automatically from a database (or other type of backing store) when a cache miss occurs by invoking the BackingStore.load method.
getEnableWriteThrough() - Method in class com.scaleoutsoftware.soss.client.BackingStorePolicy
If true, a client will synchronously write changes to a database (or other type of backing store) when a cached object is updated or created in the cache by invoking the BackingStore.store method.
getEncodedCredentials(String) - Method in interface com.scaleoutsoftware.soss.client.LoginModule
Gets a byte array representing credentials to be passed to server.
getErrors() - Method in class com.scaleoutsoftware.soss.client.InvokeResult
Returns the list of exceptions, that occured on workers and were dispatched back to the invocation origin point.
getGeoServerReadMode() - Method in class com.scaleoutsoftware.soss.client.ReadOptions
Gets the remote store's read mode.
getId() - Method in interface com.scaleoutsoftware.soss.client.EvalArgs
Provides the CachedObjectId corresponding to the target object being evaluated.
getId() - Method in exception com.scaleoutsoftware.soss.client.NamedCacheReadThroughTimeoutException
Gets the CachedObjectId of an object on which read-through was attempted.
getIndexCollection() - Method in class com.scaleoutsoftware.soss.client.ExtendedObjectMetadata
Gets the IndexCollection
getIndexCollection() - Method in class com.scaleoutsoftware.soss.client.NamedCacheFilter
Gets the IndexCollection
getIndexCollection() - Method in class com.scaleoutsoftware.soss.client.ObjectMetadata
Returns the IndexCollection of IndexValues specified for this object.
getInsertException() - Method in class com.scaleoutsoftware.soss.client.SossObjectDescriptor
Gets the exception encountered by a bulk add operation, or null if the object was added to the NamedCache successfully.
getInstance() - Static method in class com.scaleoutsoftware.soss.client.LoginManager
Gets an instance of the LoginManager (one per VM).
getJobCount() - Method in exception com.scaleoutsoftware.soss.client.NamedCacheBulkAddException
Total number of jobs in the bulk add call.
getJobFailed() - Method in exception com.scaleoutsoftware.soss.client.NamedCacheBulkAddException
Number of failed jobs in the bulk add call.
getKey() - Method in class com.scaleoutsoftware.soss.client.CachedObjectId
 
getKeyString() - Method in class com.scaleoutsoftware.soss.client.CachedObjectId
Retrieves the original (unhashed) string used as a key to a StateServer object.
getLockingMode() - Method in class com.scaleoutsoftware.soss.client.ReadOptions
Gets the locking mode (ReadLockingMode).
getLockingMode() - Method in class com.scaleoutsoftware.soss.client.UpdateOptions
Gets the locking behavior for the update.
getLockRetryInterval() - Method in class com.scaleoutsoftware.soss.client.NamedCache
Gets time between lock retries.
getMatchOptions() - Method in class com.scaleoutsoftware.soss.client.NamedCacheFilter
Gets matchAll boolean.
getMaxLockAttempts() - Method in class com.scaleoutsoftware.soss.client.NamedCache
Gets the number of lock attempts.
getMaxReadThroughPendingAttempts() - Method in class com.scaleoutsoftware.soss.client.NamedCache
Gets the number of read attempts made when another client has a backing store read-through operation pending.
getMetadata(CachedObjectId, ReadOptions) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Gets the index values for an object in the named cache.
getMetadata(byte[], ReadOptions) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Gets the index values for an object in the named cache.
getMetadata(String, ReadOptions) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Gets the index values for an object in the named cache.
getMetadata(UUID, ReadOptions) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Gets the index values for an object in the named cache.
getMetadata(CachedObjectId, boolean) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Gets the index values for an object in the named cache.
getMetadata(byte[], boolean) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Gets the index values for an object in the named cache.
getMetadata(String, boolean) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Gets the index values for an object in the named cache.
getMetadata(UUID, boolean) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Gets the index values for an object in the named cache.
getMetadata() - Method in class com.scaleoutsoftware.soss.client.SossObjectDescriptor
Gets metadata related to the object being inserted.
getNamedCache() - Method in interface com.scaleoutsoftware.soss.client.EvalArgs
Returns the NamedCache corresponding to the target object being evaluated.
getNamedCache() - Method in class com.scaleoutsoftware.soss.client.NamedCacheObjectExpiredEventArgs
Returns the NamedCache instance that can be used to manipulate the expiring cached object.
getNamedCacheEventCode() - Method in class com.scaleoutsoftware.soss.client.NamedCacheObjectExpiredEventArgs
Returns the reason why the event was fired in the form of event code NamedCacheObjectExpiredEventArgs.NamedCacheEventCode.
getNumFailed() - Method in class com.scaleoutsoftware.soss.client.InvokeResult
The number of objects which were not invoked on due to errors.
getNumSuccessful() - Method in class com.scaleoutsoftware.soss.client.InvokeResult
The number of successfully processed objects.
getObject() - Method in class com.scaleoutsoftware.soss.client.SossObjectDescriptor
Gets the serializable object to insert into the NamedCache.
getObjectIds() - Method in class com.scaleoutsoftware.soss.client.NamedCache
Returns IDs of all objects in cache.
getObjectSize() - Method in class com.scaleoutsoftware.soss.client.ExtendedObjectMetadata
Returns the size in bytes of the StateServer object corresponding to this metadata
getParents() - Method in class com.scaleoutsoftware.soss.client.CreatePolicy
Gets keys to objects on which the object being added depends.
getParents() - Method in class com.scaleoutsoftware.soss.client.ExtendedObjectMetadata
Return a read-only list containing the dependency parents specified for the StateServer object corresponding to this ObjectMetadata instance.
getPolicy() - Method in class com.scaleoutsoftware.soss.client.SossObjectDescriptor
Policy information for the object being inserted.
getPollingInterval() - Method in class com.scaleoutsoftware.soss.client.PollingCoherencyPolicy
Gets the polling interval for this coherency policy.
getPreemptionPriority() - Method in class com.scaleoutsoftware.soss.client.CreatePolicy
Gets the priority of keeping the object in the cache during low-memory situations.
getPreemptionPriority() - Method in class com.scaleoutsoftware.soss.client.ExtendedObjectMetadata
Returns the preemption priority of the StateServer object corresponding to this metadata instance.
getReadPendingRetryInterval() - Method in class com.scaleoutsoftware.soss.client.NamedCache
Gets milliseconds between read retries when backing store read-through operations are enabled.
getResult() - Method in class com.scaleoutsoftware.soss.client.InvokeResult
Returns the object generated by merging all of the result objects of the individual evaluations together.
getSeconds() - Method in class com.scaleoutsoftware.soss.client.TimeSpan
Gets the time span in seconds
getStaleObject() - Method in exception com.scaleoutsoftware.soss.client.NamedCacheStaleDataException
Returns a 'stale' object.
getStateServerKey(CachedObjectId) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Deprecated. CachedObjectId should be used instead of StateServerKey when performing cache operations. Use NamedCache.createKey(byte[]) to create CachedObjectIds
getStateServerKey(byte[]) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Deprecated. CachedObjectId should be used instead of StateServerKey when performing cache operations. Use NamedCache.createKey(byte[]) to create CachedObjectIds
getStateServerKey(String) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Deprecated. CachedObjectId should be used instead of StateServerKey when performing cache operations. Use NamedCache.createKey(byte[]) to create CachedObjectIds
getStoreName() - Method in class com.scaleoutsoftware.soss.client.RemoteStore
Gets remote store name.
getTags() - Method in interface com.scaleoutsoftware.soss.client.Taggable
Method used by NamedCache to store tags as SOSS attributes.
getTags() - Method in class com.scaleoutsoftware.soss.client.TaggableObject
 
getTags() - Method in class com.scaleoutsoftware.soss.client.TagHolder
 
getTimeout() - Method in class com.scaleoutsoftware.soss.client.CreatePolicy
Gets the time before the object expires.
getTimeout() - Method in class com.scaleoutsoftware.soss.client.ExtendedObjectMetadata
Returns the expiration timeout value for the StateServer object corresponding to this metadata.
getUseLocking() - Method in class com.scaleoutsoftware.soss.client.NamedCache
Gets useLocking property which determines the locking behavior when using the NamedCache's get or add.
getValue() - Method in enum com.scaleoutsoftware.soss.client.HashIndexPriority
 
greaterOrEqual(String, Object) - Static method in class com.scaleoutsoftware.soss.client.FilterFactory
The value of the property with the name propertyName must be GREATER than OR EQUAL to value.
greaterThan(String, Object) - Static method in class com.scaleoutsoftware.soss.client.FilterFactory
The value of the property with the name propertyName must be GREATER than value.

H

hasAllTags(String...) - Static method in class com.scaleoutsoftware.soss.client.FilterFactory
Matching objects must be tagged with ALL of the tags provided as parameters.
hasAllTags(String...) - Method in class com.scaleoutsoftware.soss.client.TaggableObject
Determines whether this object has all of the tags specified by tags.
hasAllTags(String...) - Method in class com.scaleoutsoftware.soss.client.TagHolder
Determines whether this holder has all of the tags specified by tags.
hasAnyTags(String...) - Static method in class com.scaleoutsoftware.soss.client.FilterFactory
Matching objects must be tagged with ANY of the tags provided as parameters.
hasAnyTags(String...) - Method in class com.scaleoutsoftware.soss.client.TaggableObject
Determines whether this object has any of the tags specified by tags.
hasAnyTags(String...) - Method in class com.scaleoutsoftware.soss.client.TagHolder
Determines whether this holder has any of the tags specified by tags.
hashCode() - Method in class com.scaleoutsoftware.soss.client.CachedObjectId
 
hashCode() - Method in class com.scaleoutsoftware.soss.client.IndexValue
 
HashIndexPriority - Enum in com.scaleoutsoftware.soss.client
This enum allows sorting of hashed attributes by priority.

I

IndexCollection - Class in com.scaleoutsoftware.soss.client
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.
IndexCollection() - Constructor for class com.scaleoutsoftware.soss.client.IndexCollection
 
IndexValue - Class in com.scaleoutsoftware.soss.client
An immutable value that may be assigned to an IndexCollection and used to query the StateServer for objects with metadata matching the IndexCollection.
IndexValue(boolean) - Constructor for class com.scaleoutsoftware.soss.client.IndexValue
Create a new IndexValue using the contents of value exported as a byte array.
IndexValue(Date) - Constructor for class com.scaleoutsoftware.soss.client.IndexValue
Create a new IndexValue using the contents of value exported as a byte array.
IndexValue(UUID) - Constructor for class com.scaleoutsoftware.soss.client.IndexValue
Create a new IndexValue using the contents of value exported as a byte array.
IndexValue(int) - Constructor for class com.scaleoutsoftware.soss.client.IndexValue
Create a new IndexValue using the contents of value exported as a byte array.
IndexValue(long) - Constructor for class com.scaleoutsoftware.soss.client.IndexValue
Create a new IndexValue using the contents of value exported as a byte array.
IndexValue(String) - Constructor for class com.scaleoutsoftware.soss.client.IndexValue
Create a new IndexValue using the 32-byte digest resulting from the SHA-256 MessageDigest of value.
IndexValue(byte[]) - Constructor for class com.scaleoutsoftware.soss.client.IndexValue
Create a new IndexValue with the value given in value.
IndexValue(byte[], int, int) - Constructor for class com.scaleoutsoftware.soss.client.IndexValue
Create a new IndexValue with the values given in positions position (inclusive) through position + length (exclusive) of the array value.
INFINITE_TIMEOUT - Static variable in class com.scaleoutsoftware.soss.client.TimeSpan
 
insert(CachedObjectId<T>, T, CreatePolicy, boolean, boolean) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Inserts a serializable object to a named cache.
insert(byte[], Serializable, CreatePolicy, boolean, boolean) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Inserts a serializable object to a named cache.
insert(String, Serializable, CreatePolicy, boolean, boolean) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Inserts a serializable object to a named cache.
insert(UUID, Serializable, CreatePolicy, boolean, boolean) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Inserts a serializable object to a named cache.
Invokable<O extends Serializable,P extends Serializable,R extends Serializable> - Interface in com.scaleoutsoftware.soss.client
The interface that must be implemented by all processing classes, and passed into the invoke call.
invoke(Class<? extends Invokable<O, P, R>>, NamedCacheFilter, P, TimeSpan) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Performs a parallel method invocation across the cache.
invoke(Class<? extends Invokable<O, P, R>>, Class<O>, Filter, P, TimeSpan) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Performs a parallel method invocation across the cache.The method invocations will occur on all hosts in parallel.
invoke(Invokable<O, P, R>, IndexCollection, P, TimeSpan) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Deprecated. Use NamedCache.invoke(Class, NamedCacheFilter, java.io.Serializable, TimeSpan)
invoke(Invokable<O, P, R>, IndexCollection, P, int) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Deprecated. Use NamedCache.invoke(Class, NamedCacheFilter, java.io.Serializable, TimeSpan)
invoke(Invokable<O, P, R>, NamedCacheFilter, P, int) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Deprecated. Use NamedCache.invoke(Class, NamedCacheFilter, java.io.Serializable, TimeSpan)
InvokeException - Exception in com.scaleoutsoftware.soss.client
An exception that occurred during an invoke call.
InvokeException(String, Throwable) - Constructor for exception com.scaleoutsoftware.soss.client.InvokeException
Constructs an InvokeException with a message and cause.
InvokeException(String) - Constructor for exception com.scaleoutsoftware.soss.client.InvokeException
Constructs an InvokeException with a message.
InvokeException(Throwable) - Constructor for exception com.scaleoutsoftware.soss.client.InvokeException
Constructs an InvokeException with a cause.
InvokeException() - Constructor for exception com.scaleoutsoftware.soss.client.InvokeException
Constructs an InvokeException.
InvokeResult<R> - Class in com.scaleoutsoftware.soss.client
Contains information about a completed invoke call.
InvokeResult(InvokeReply) - Constructor for class com.scaleoutsoftware.soss.client.InvokeResult
 
isAbsoluteTimeout() - Method in class com.scaleoutsoftware.soss.client.CreatePolicy
Deprecated. use CreatePolicy.getAbsoluteTimeout()
isAllowReplication() - Method in class com.scaleoutsoftware.soss.client.CreatePolicy
Deprecated. use CreatePolicy.getAllowReplication()
isEmpty() - Method in class com.scaleoutsoftware.soss.client.IndexCollection
Returns true if this IndexCollection contains no (non-null) IndexValues.
isProxy() - Method in class com.scaleoutsoftware.soss.client.ExtendedObjectMetadata
Checks if the object is a proxy object for "pull" replication.
isUseLocking() - Method in class com.scaleoutsoftware.soss.client.NamedCache
Deprecated. Use NamedCache.getUseLocking()

L

lessOrEqual(String, Object) - Static method in class com.scaleoutsoftware.soss.client.FilterFactory
The value of the property with the name propertyName must be LESS than OR EQUAL to value.
lessThan(String, Object) - Static method in class com.scaleoutsoftware.soss.client.FilterFactory
The value of the property with the name propertyName must be LESS than value.
load(CachedObjectId<T>) - Method in interface com.scaleoutsoftware.soss.client.BackingStore
Loads an object from the backing store.
login(String, LoginModule) - Method in class com.scaleoutsoftware.soss.client.LoginManager
Performs a log in for a cache specified by cacheName with a custom authorization method.
login(String) - Method in class com.scaleoutsoftware.soss.client.LoginManager
Performs a login for a cache specified by cacheName using the default authorization method.
LoginManager - Class in com.scaleoutsoftware.soss.client
Logs in to the ScaleOut StateServer service on a per-cache basis, passing supplied credentials to the server.
LoginModule - Interface in com.scaleoutsoftware.soss.client
This is an interface for user-defined login routines.
logout(String, LogoutScope) - Method in class com.scaleoutsoftware.soss.client.LoginManager
Performs a logout for a cache specified by cacheName.
LogoutScope - Enum in com.scaleoutsoftware.soss.client
Indicates the scope of a logout operation on NamedCache.

M

MaxDependencies - Static variable in class com.scaleoutsoftware.soss.client.CreatePolicy
 
MaxIndexValues - Static variable in class com.scaleoutsoftware.soss.client.IndexCollection
The fixed number of IndexValues an IndexCollection may hold.
MaxValueByteLength - Static variable in class com.scaleoutsoftware.soss.client.IndexValue
 
merge(R, R) - Method in interface com.scaleoutsoftware.soss.client.Invokable
Merges two result objects into one.

N

NamedCache - Class in com.scaleoutsoftware.soss.client
Provides access to a named collection of objects that can be shared globally across multiple clients.
NamedCacheBulkAddException - Exception in com.scaleoutsoftware.soss.client
This exception indicates an error while adding multiple objects with bulk add call.
NamedCacheException - Exception in com.scaleoutsoftware.soss.client
Most general Named Cache exception, a base class for all Named Cache exceptions.
NamedCacheException(String, Exception) - Constructor for exception com.scaleoutsoftware.soss.client.NamedCacheException
Construct new exception object.
NamedCacheFilter - Class in com.scaleoutsoftware.soss.client
This class represents a filter used in NamedCache.query()
NamedCacheFilter(IndexCollection, boolean) - Constructor for class com.scaleoutsoftware.soss.client.NamedCacheFilter
Creates a filter for queries.
NamedCacheFilter(IndexCollection) - Constructor for class com.scaleoutsoftware.soss.client.NamedCacheFilter
Creates a filter for queries.
NamedCacheFilter() - Constructor for class com.scaleoutsoftware.soss.client.NamedCacheFilter
Creates a filter that matches all objects.
NamedCacheIndexAttributeException - Exception in com.scaleoutsoftware.soss.client
This exception is used to indicate that there was an error while parsing object properties.
NamedCacheIndexAttributeException(String, Exception) - Constructor for exception com.scaleoutsoftware.soss.client.NamedCacheIndexAttributeException
Construct new exception object.
NamedCacheIndexAttributeException(String) - Constructor for exception com.scaleoutsoftware.soss.client.NamedCacheIndexAttributeException
Construct new exception object.
NamedCacheInvokeTimeoutException - Exception in com.scaleoutsoftware.soss.client
This exception indicates that an invoke operation timed out.
NamedCacheNotImplementedException - Exception in com.scaleoutsoftware.soss.client
This exception indicates that a request was made to perform an operation not implemented in the current release.
NamedCacheNotLicensedException - Exception in com.scaleoutsoftware.soss.client
This exception indicates that a client cannot access StateServer because the client is not licensed.
NamedCacheObjectAlreadyExistsException - Exception in com.scaleoutsoftware.soss.client
This exception indicates that an insert call failed because an object already exists in the StateServer with the given key.
NamedCacheObjectExpirationListener - Interface in com.scaleoutsoftware.soss.client
The interface clients use to receive callback notifications when an object is removed from StateServer.
NamedCacheObjectExpiredEventArgs - Class in com.scaleoutsoftware.soss.client
This is a helper class, objects of which are passed as an argument to the event handler's NamedCacheObjectExpirationListener.
NamedCacheObjectExpiredEventArgs.NamedCacheEventCode - Enum in com.scaleoutsoftware.soss.client
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 - Enum in com.scaleoutsoftware.soss.client
Enumeration used to indicate to StateServer the disposition of an expired object upon return from a StateServer event handler.
NamedCacheObjectLockedException - Exception in com.scaleoutsoftware.soss.client
This exception indicates that the requested StateServer object was locked and couldn't be accessed.
NamedCacheObjectNotFoundException - Exception in com.scaleoutsoftware.soss.client
This exception indicates that an error occurred because the key of an object on which StateServer was asked to operate was not found.
NamedCacheOptimisticLockException - Exception in com.scaleoutsoftware.soss.client
This exception indicates that the requested StateServer object was locked and couldn't be accessed.
NamedCacheReadThroughTimeoutException - Exception in com.scaleoutsoftware.soss.client
This exception indicates that a read-through operation to a backing store (such as a database) timed out.
NamedCacheRemoteStoreAccessException - Exception in com.scaleoutsoftware.soss.client
This exception is thrown when an access error to a remote store occurs.
NamedCacheRemoteStoreConfigurationException - Exception in com.scaleoutsoftware.soss.client
This exception is thrown by read calls when there is a misconfiguration in remote store settings.
NamedCacheSecurityException - Exception in com.scaleoutsoftware.soss.client
Exception in security routine.
NamedCacheSecurityException(String, Exception) - Constructor for exception com.scaleoutsoftware.soss.client.NamedCacheSecurityException
Construct new exception object.
NamedCacheSecurityException(String) - Constructor for exception com.scaleoutsoftware.soss.client.NamedCacheSecurityException
 
NamedCacheServerUnavailableException - Exception in com.scaleoutsoftware.soss.client
This exception indicates that the connection to the server was lost or an unexpected error occurred.
NamedCacheStaleDataException - Exception in com.scaleoutsoftware.soss.client
This exception is thrown by the NamedCache.retrieve(com.scaleoutsoftware.soss.client.CachedObjectId, 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.
not(Filter) - Static method in class com.scaleoutsoftware.soss.client.FilterFactory
Creates a compound filter, matching objects must NOT satisfy filter.
notEqual(String, Object) - Static method in class com.scaleoutsoftware.soss.client.FilterFactory
The value of the property with the name propertyName must NOT be EQUAL to value.
NotifyCoherencyPolicy - Class in com.scaleoutsoftware.soss.client
Indicates that proxy objects in remote stores should be notified every time the master object is updated.
NotifyCoherencyPolicy() - Constructor for class com.scaleoutsoftware.soss.client.NotifyCoherencyPolicy
Creates a new notify coherency policy.

O

ObjectDisposition - Enum in com.scaleoutsoftware.soss.client
An enumeration used to indicate to StateServer the disposition of an expired object upon return from a StateServer event handler.
objectExpired(NamedCacheObjectExpiredEventArgs) - Method in interface com.scaleoutsoftware.soss.client.NamedCacheObjectExpirationListener
Called when the object described via eventArgs is about to be removed from the cache.
ObjectMetadata - Class in com.scaleoutsoftware.soss.client
Metadata describing a StateServer object including the set of user-defined index values defined for the object.
ObjectMetadata() - Constructor for class com.scaleoutsoftware.soss.client.ObjectMetadata
Creates new empty instance.
ObjectNotSupportedException - Exception in com.scaleoutsoftware.soss.client
This exception is thrown by CustomSerializer methods when serialization/deserialization is not supported for an object.
ObjectNotSupportedException(String) - Constructor for exception com.scaleoutsoftware.soss.client.ObjectNotSupportedException
Creates exception with a message.
ObjectNotSupportedException() - Constructor for exception com.scaleoutsoftware.soss.client.ObjectNotSupportedException
Creates exception without a message.
ObjectPreemptionPriority - Enum in com.scaleoutsoftware.soss.client
Indicates the priority of keeping a given object in StateServer memory.
OptimisticConcurrencyVersionHolder - Interface in com.scaleoutsoftware.soss.client
Instances of Types that implement OptimisticConcurrencyVersionHolder are associated with StateServer object version information and are therefore suitable for optimistic concurrency.
or(Filter, Filter) - Static method in class com.scaleoutsoftware.soss.client.FilterFactory
Creates a compound filter, matching objects must satisfy firstFilter OR secondFilter.

P

PollingCoherencyPolicy - Class in com.scaleoutsoftware.soss.client

Indicates that proxy objects in remote stores should poll the master object for updates every time the specified coherency interval expires.

PollingCoherencyPolicy(TimeSpan) - Constructor for class com.scaleoutsoftware.soss.client.PollingCoherencyPolicy
Creates a polling coherency policy.
PollingCoherencyPolicy() - Constructor for class com.scaleoutsoftware.soss.client.PollingCoherencyPolicy
Creates a polling coherency policy with the default polling interval.
propertiesEqual(String, String) - Static method in class com.scaleoutsoftware.soss.client.FilterFactory
The two properties of matching objects must be EQUAL.
propertiesGreaterOrEqual(String, String) - Static method in class com.scaleoutsoftware.soss.client.FilterFactory
The value of the property of the matching objects with the name firstPropertyName should be GREATER than OR EQUAL to that of the property with the name secondPropertyName.
propertiesGreaterThan(String, String) - Static method in class com.scaleoutsoftware.soss.client.FilterFactory
The value of the property of the matching objects with the name firstPropertyName should be GREATER than that of the property with the name secondPropertyName.
propertiesLessOrEqual(String, String) - Static method in class com.scaleoutsoftware.soss.client.FilterFactory
The value of the property of the matching objects with the name firstPropertyName should be LESS than OR EQUAL to that of the property with the name secondPropertyName.
propertiesLessThan(String, String) - Static method in class com.scaleoutsoftware.soss.client.FilterFactory
The value of the property of the matching objects with the name firstPropertyName should be LESS than that of the property with the name secondPropertyName.
propertiesNotEqual(String, String) - Static method in class com.scaleoutsoftware.soss.client.FilterFactory
The two properties of matching objects must NOT be EQUAL.
put(CachedObjectId<T>, T) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Adds an item to the cache using default parameters.
put(byte[], Serializable) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Adds an item to the cache using default parameters.
put(String, Serializable) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Adds an item to the cache using default parameters.
put(UUID, Serializable) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Adds an item to the cache using default parameters.
putAll(Map<?, ? extends Serializable>) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Efficiently adds a large collection of objects to the cache.

Q

query(NamedCacheFilter) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Queries the cache for objects that match NamedCacheFilter.
query(IndexCollection) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Deprecated. Use NamedCache.query(NamedCacheFilter), NamedCache.queryKeys(Class, Filter), or NamedCache.queryObjects(Class, Filter)
queryKeys(Class<T>, Filter) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Queries objects in the StateServer within this NamedCache returning a set of typed, keys (Set<CachedObjectId<T>>) corresponding only to those objects that are instances of type T and its subtypes and satisfy the criteria specified by filter.
queryObjects(Class<T>, Filter) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Queries objects in the StateServer within this NamedCache returning a collection of objects (Collection<T>) containing only those objects that are instances of type T and its subtypes and satisfy the criteria specified by filter.

R

readExternal(ObjectInput) - Method in class com.scaleoutsoftware.soss.client.IndexCollection
 
readExternal(ObjectInput) - Method in class com.scaleoutsoftware.soss.client.IndexValue
 
readExternal(ObjectInput) - Method in class com.scaleoutsoftware.soss.client.TagHolder
 
ReadLockingMode - Enum in com.scaleoutsoftware.soss.client
An enumeration used to control locking behavior during Retrieve and GetMetadata operation
ReadOptions - Class in com.scaleoutsoftware.soss.client
Class containing options that can be used when retrieving an object or a metadata in ScaleOut StateServer.
ReadOptions(ReadLockingMode) - Constructor for class com.scaleoutsoftware.soss.client.ReadOptions
Creates a new instance of read options to be used in NamedCache.retrieve(com.scaleoutsoftware.soss.client.CachedObjectId, boolean) and NamedCache.getMetadata(com.scaleoutsoftware.soss.client.CachedObjectId, com.scaleoutsoftware.soss.client.ReadOptions) calls.
ReadOptions(ReadLockingMode, GeoServerReadMode) - Constructor for class com.scaleoutsoftware.soss.client.ReadOptions
Creates a new instance of read options to be used in NamedCache.retrieve(com.scaleoutsoftware.soss.client.CachedObjectId, boolean) and NamedCache.getMetadata(com.scaleoutsoftware.soss.client.CachedObjectId, com.scaleoutsoftware.soss.client.ReadOptions) calls.
releaseLock(CachedObjectId) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Releases the lock on a cached object.
releaseLock(byte[]) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Releases the lock on a cached object.
releaseLock(String) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Releases the lock on a cached object.
releaseLock(UUID) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Releases the lock on a cached object.
RemoteStore - Class in com.scaleoutsoftware.soss.client
A remote store which is used to look for objects that are not found.
RemoteStore(String) - Constructor for class com.scaleoutsoftware.soss.client.RemoteStore
Creates an object referencing remote store.
remove(int) - Method in class com.scaleoutsoftware.soss.client.IndexCollection
Removes the element at the specified index of the IndexCollection.
remove(CachedObjectId) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Removes the object from the cache.
remove(byte[]) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Removes the object from the cache.
remove(String) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Removes the object from the cache.
remove(UUID) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Removes the object from the cache.
removeListener(NamedCacheObjectExpirationListener) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Removes a listener for "object expired" events.
removeTags(String...) - Method in class com.scaleoutsoftware.soss.client.TaggableObject
Removes the tags specified in the tags from object's tag list.
removeTags(String...) - Method in class com.scaleoutsoftware.soss.client.TagHolder
Removes the tags specified in the tags from the current tag list.
retrieve(CachedObjectId<T>, boolean) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Retrieves an object from the named cache.
retrieve(byte[], boolean) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Retrieves an object from the named cache.
retrieve(String, boolean) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Retrieves an object from the named cache.
retrieve(UUID, boolean) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Retrieves an object from the named cache.
retrieve(CachedObjectId<T>, ReadOptions) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Retrieves an object from the named cache.
retrieve(String, ReadOptions) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Retrieves an object from the named cache.
retrieve(byte[], ReadOptions) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Retrieves an object from the named cache.
retrieve(UUID, ReadOptions) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Retrieves an object from the named cache.

S

serialize(ByteArrayOutputStream, Object) - Method in interface com.scaleoutsoftware.soss.client.CustomSerializer
Serializes an object to ByteArrayOutputStream.
set(int, IndexValue) - Method in class com.scaleoutsoftware.soss.client.IndexCollection
Replaces the element at the specified position in this list with the specified element (optional operation).
setAbsoluteTimeout(boolean) - Method in class com.scaleoutsoftware.soss.client.CreatePolicy
Sets whether the timeout is an absolute expiration value or is a sliding expiration value that gets reset every time the object is accessed.
setAllowClientCaching(boolean) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Sets an flag indicating whether (deserialized) objects accessed by this cache should be kept in a client-side cache when they are written to StateServer.
setAllowRemoteAccess(boolean) - Method in class com.scaleoutsoftware.soss.client.CreatePolicy
Sets if object can be accessed by remote stores.
setAllowReplication(boolean) - Method in class com.scaleoutsoftware.soss.client.CreatePolicy
Sets whether the object to be added to the cache will be subject to GeoServer cross-store replication.
setBackingStoreAdapter(BackingStore, BackingStorePolicy) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Specifies a class that can be used by the NamedCache to automatically interact with an external data source (a database, typically) for read-through, write-through, refresh-ahead, and write-behind operations.
setBackingStoreAsyncPolicy(BackingStoreAsyncPolicy) - Method in class com.scaleoutsoftware.soss.client.CreatePolicy
Sets the type of backing store operations (none, refresh-ahead or write-behind) performed on the StateServer object corresponding to this metadata instance.
setBackingStoreInterval(TimeSpan) - Method in class com.scaleoutsoftware.soss.client.CreatePolicy
Sets the interval between asynchronous backing store events (refresh-ahead, write-behind).
setBackingStoreMode(CreateInfo.BackingStoreMode) - Method in class com.scaleoutsoftware.soss.client.CreatePolicy
Deprecated. use CreatePolicy.setBackingStoreAsyncPolicy(BackingStoreAsyncPolicy)
setCustomSerialization(CustomSerializer) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Sets the custom serializer used to serialize objects when writing them to the SOSS cache and to deserialize objects when reading them from the SOSS cache.
setDefaultCoherencyPolicy(CoherencyPolicy) - Method in class com.scaleoutsoftware.soss.client.CreatePolicy
Sets the default coherency policy.
setDefaultCreatePolicy(CreatePolicy) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Sets a new CreatePolicy to be used as a default when creating objects.
setDefaultGeoServerReadMode(GeoServerReadMode) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Sets the default read mode (GeoServerReadMode) to be used by read operations.
setDependencies(Object[]) - Method in class com.scaleoutsoftware.soss.client.CreatePolicy
Deprecated. use CreatePolicy.setParents(java.util.Collection)
setDisposition(EvalObjectDisposition) - Method in interface com.scaleoutsoftware.soss.client.EvalArgs
Sets the target object's desired disposition, determining the post-evaluation activity.
setEnableAsyncOperations(boolean) - Method in class com.scaleoutsoftware.soss.client.BackingStorePolicy
If true, a client will handle asynchronous refresh-ahead/write-behind operations.
setEnableReadThrough(boolean) - Method in class com.scaleoutsoftware.soss.client.BackingStorePolicy
If true, a client will populate the StateServer automatically from a database (or other type of backing store) when a cache miss occurs by invoking the BackingStore.load method.
setEnableWriteThrough(boolean) - Method in class com.scaleoutsoftware.soss.client.BackingStorePolicy
If true, a client will synchronously write changes to a database (or other type of backing store) when a cached object is updated or created in the cache by invoking the BackingStore.store method.
setLockingMode(UpdateLockingMode) - Method in class com.scaleoutsoftware.soss.client.UpdateOptions
Sets the locking behavior for the update.
setLockRetryInterval(int) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Sets time between lock retries.
setMaxLockAttempts(int) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Sets the number of lock attempts.
setMaxReadThroughPendingAttempts(int) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Sets the number of read attempts made when performing a read-through operation from a backing store or a remote read from another store using GeoServer pull replication.
setMetadata(CachedObjectId, ObjectMetadata, boolean) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Creates and updates settable index values for a cached object and optionally unlocks the object.
setMetadata(byte[], ObjectMetadata, boolean) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Creates and updates settable index values for a cached object and optionally unlocks the object.
setMetadata(String, ObjectMetadata, boolean) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Creates and updates settable index values for a cached object and optionally unlocks the object.
setMetadata(UUID, ObjectMetadata, boolean) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Creates and updates settable index values for a cached object and optionally unlocks the object.
setMetadata(ObjectMetadata) - Method in class com.scaleoutsoftware.soss.client.SossObjectDescriptor
 
setObject(Serializable) - Method in class com.scaleoutsoftware.soss.client.SossObjectDescriptor
 
setObjectDisposition(NamedCacheObjectExpiredEventArgs.NamedCacheObjectDisposition) - Method in class com.scaleoutsoftware.soss.client.NamedCacheObjectExpiredEventArgs
Sets the object disposition( NamedCacheObjectExpiredEventArgs.NamedCacheObjectDisposition), determining the action to be performed.
setParents(Collection<?>) - Method in class com.scaleoutsoftware.soss.client.CreatePolicy
Sets keys to objects on which the object being added depends.
setPolicy(CreatePolicy) - Method in class com.scaleoutsoftware.soss.client.SossObjectDescriptor
 
setPreemptionPriority(ObjectPreemptionPriority) - Method in class com.scaleoutsoftware.soss.client.CreatePolicy
Sets the priority of keeping the object in the cache during low-memory situations.
setReadPendingRetryInterval(int) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Sets milliseconds between read retries when backing store read-through operations are enabled.
setRemoteStores(List<RemoteStore>) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Configures a list of remote stores that this NamedCache should use to look for objects that are not found in the local store.
setTimeout(TimeSpan) - Method in class com.scaleoutsoftware.soss.client.CreatePolicy
Sets the time before the object expires.
setupFilter(QueryContext) - Method in class com.scaleoutsoftware.soss.client.Filter
 
setUseLocking(boolean) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Determines the locking behavior when using the NamedCache's indexer to get or set cached items.
singleObjectInvoke(Class<? extends Invokable<O, P, R>>, CachedObjectId<O>, P, TimeSpan) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Performs a method invocation on a single object(SMI).
singleObjectInvoke(Class<? extends Invokable<O, P, R>>, byte[], P, TimeSpan) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Performs a method invocation on a single object(SMI).
singleObjectInvoke(Class<? extends Invokable<O, P, R>>, String, P, TimeSpan) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Performs a method invocation on a single object(SMI).
singleObjectInvoke(Class<? extends Invokable<O, P, R>>, UUID, P, TimeSpan) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Performs a method invocation on a single object(SMI).
size() - Method in class com.scaleoutsoftware.soss.client.IndexCollection
Gets the number of elements in the IndexCollection.
SossIndexAttribute - Annotation Type in com.scaleoutsoftware.soss.client
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.
SossObjectDescriptor - Class in com.scaleoutsoftware.soss.client
Contains information necessary to insert an object into a NamedCache via a bulk NamedCache.putAll(java.util.Map) operation.
SossObjectDescriptor(Serializable, CreatePolicy, ObjectMetadata) - Constructor for class com.scaleoutsoftware.soss.client.SossObjectDescriptor
Creates a SossObjDescriptor class with the metadata and CreatePolicy information needed to insert an object via a bulk put NamedCache.putAll(java.util.Map) operation.
store(CachedObjectId<T>, T) - Method in interface com.scaleoutsoftware.soss.client.BackingStore
Persists an object to the backing store.

T

Taggable - Interface in com.scaleoutsoftware.soss.client
Objects of classes implementing this interface can hold arbitrary tags scoped by the object's NamedCache.
TaggableObject - Class in com.scaleoutsoftware.soss.client
An object implementing Taggable.
TaggableObject() - Constructor for class com.scaleoutsoftware.soss.client.TaggableObject
 
TagHolder - Class in com.scaleoutsoftware.soss.client
This class is used as a holder for tags associated with an object.
TagHolder() - Constructor for class com.scaleoutsoftware.soss.client.TagHolder
Constructs an instance of TagHolder.
TimeSpan - Class in com.scaleoutsoftware.soss.client
An object of this class represents a time interval.
toString() - Method in class com.scaleoutsoftware.soss.client.CachedObjectId
 

U

update(CachedObjectId<T>, T, UpdateOptions) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Updates an object in the named cache.
update(byte[], Serializable, UpdateOptions) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Updates an object in the named cache.
update(String, Serializable, UpdateOptions) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Updates an object in the named cache.
update(UUID, Serializable, UpdateOptions) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Updates an object in the named cache.
update(CachedObjectId<T>, T, boolean) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Deprecated. Use NamedCache.update(CachedObjectId, java.io.Serializable, UpdateOptions).
update(byte[], Serializable, boolean) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Deprecated. Use NamedCache.update(byte[], java.io.Serializable, UpdateOptions).
update(String, Serializable, boolean) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Deprecated. Use NamedCache.update(String, java.io.Serializable, UpdateOptions).
update(UUID, Serializable, boolean) - Method in class com.scaleoutsoftware.soss.client.NamedCache
Deprecated. Use NamedCache.update(UUID, java.io.Serializable, UpdateOptions).
UpdateLockingMode - Enum in com.scaleoutsoftware.soss.client
Enumeration used to control locking behavior during update operations.
UpdateOptions - Class in com.scaleoutsoftware.soss.client
Class containing options that can be used when updating an object in ScaleOut StateServer.
UpdateOptions(UpdateLockingMode) - Constructor for class com.scaleoutsoftware.soss.client.UpdateOptions
Constructs an UpdateOptions structure with the desired locking mode.

V

value() - Method in enum com.scaleoutsoftware.soss.client.NamedCacheObjectExpiredEventArgs.NamedCacheObjectDisposition
 
value() - Method in enum com.scaleoutsoftware.soss.client.ObjectDisposition
 
valueOf(String) - Static method in enum com.scaleoutsoftware.soss.client.BackingStoreAsyncPolicy
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.scaleoutsoftware.soss.client.EvalObjectDisposition
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.scaleoutsoftware.soss.client.GeoServerReadMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.scaleoutsoftware.soss.client.HashIndexPriority
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.scaleoutsoftware.soss.client.LogoutScope
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.scaleoutsoftware.soss.client.NamedCacheObjectExpiredEventArgs.NamedCacheEventCode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.scaleoutsoftware.soss.client.NamedCacheObjectExpiredEventArgs.NamedCacheObjectDisposition
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.scaleoutsoftware.soss.client.ObjectDisposition
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.scaleoutsoftware.soss.client.ObjectPreemptionPriority
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.scaleoutsoftware.soss.client.ReadLockingMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.scaleoutsoftware.soss.client.UpdateLockingMode
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.scaleoutsoftware.soss.client.BackingStoreAsyncPolicy
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.scaleoutsoftware.soss.client.EvalObjectDisposition
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.scaleoutsoftware.soss.client.GeoServerReadMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.scaleoutsoftware.soss.client.HashIndexPriority
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.scaleoutsoftware.soss.client.LogoutScope
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.scaleoutsoftware.soss.client.NamedCacheObjectExpiredEventArgs.NamedCacheEventCode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.scaleoutsoftware.soss.client.NamedCacheObjectExpiredEventArgs.NamedCacheObjectDisposition
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.scaleoutsoftware.soss.client.ObjectDisposition
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.scaleoutsoftware.soss.client.ObjectPreemptionPriority
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.scaleoutsoftware.soss.client.ReadLockingMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.scaleoutsoftware.soss.client.UpdateLockingMode
Returns an array containing the constants of this enum type, in the order they are declared.

W

writeExternal(ObjectOutput) - Method in class com.scaleoutsoftware.soss.client.IndexCollection
 
writeExternal(ObjectOutput) - Method in class com.scaleoutsoftware.soss.client.IndexValue
 
writeExternal(ObjectOutput) - Method in class com.scaleoutsoftware.soss.client.TagHolder
 

A B C D E F G H I L M N O P Q R S T U V W

Copyright (C) 2007-2012 ScaleOut Software, Inc.