Index

A

Absolute - Enum constant in enum class com.scaleout.client.caching.TimeoutType

The object uses an absolute timeout.

add(K, V) - Method in class com.scaleout.client.caching.Cache

Add an object to the ScaleOut cache.

add(K, V, CreatePolicy) - Method in class com.scaleout.client.caching.Cache

Add an object to the ScaleOut cache with a parameter CreatePolicy.

add(K, V, CreatePolicy, List<K>) - Method in class com.scaleout.client.caching.Cache

Add an object to the ScaleOut cache with a parameter CreatePolicy.

add(K, V, List<K>) - Method in class com.scaleout.client.caching.Cache

Add an object to the ScaleOut cache.

addAndLock(K, V) - Method in class com.scaleout.client.caching.Cache

Add an object to the ScaleOut cache with an exclusive lock.

addAndLock(K, V, CreatePolicy) - Method in class com.scaleout.client.caching.Cache

Add an object to the ScaleOut cache with an exclusive lock and a parameter CreatePolicy.

addAndLockAsync(K, V) - Method in class com.scaleout.client.caching.Cache

Asynchronously add an object to the ScaleOut cache with an exclusive lock.

addAndLockAsync(K, V, CreatePolicy) - Method in class com.scaleout.client.caching.Cache

Asynchronously add an object to the ScaleOut cache with an exclusive lock and a parameter CreatePolicy.

addAsync(K, V) - Method in class com.scaleout.client.caching.Cache

Asynchronously add an object to the ScaleOut cache.

addAsync(K, V, CreatePolicy) - Method in class com.scaleout.client.caching.Cache

Asynchronously add an object to the ScaleOut cache with a parameter CreatePolicy.

addOrUpdate(K, V) - Method in class com.scaleout.client.caching.Cache

Add or update an object to/in the ScaleOut cache.

addOrUpdate(K, V, CreatePolicy) - Method in class com.scaleout.client.caching.Cache

Add or update an object to/in the ScaleOut cache with a custom CreatePolicy.

addOrUpdateAsync(K, V) - Method in class com.scaleout.client.caching.Cache

Asynchronously add or update an object to or in the ScaleOut cache.

addOrUpdateAsync(K, V, CreatePolicy) - Method in class com.scaleout.client.caching.Cache

Asynchronously add or update an object to/in the ScaleOut cache with a custom CreatePolicy.

addRemoteStoreName(String) - Method in class com.scaleout.client.caching.CacheBuilder

Set the remote store name for GeoServerPull.

addRemoteStoreNames(List<String>) - Method in class com.scaleout.client.caching.CacheBuilder

Set remote store names to use for GeoServerPull.

addTags(String...) - Method in class com.scaleout.client.caching.query.TaggableObject

Adds the tags specified in the tags to the object's tag list.

AllowRemoteAccess - Enum constant in enum class com.scaleout.client.caching.GeoServerPullPolicy

Remote access will be allowed.

AllowReplication - Enum constant in enum class com.scaleout.client.caching.GeoServerPushPolicy

The object will be replicated to a remote GeoServer store.

and(Filter, Filter) - Static method in class com.scaleout.client.caching.query.FilterFactory

Creates a compound filter, matching objects must satisfy firstFilter AND secondFilter.

AuthNotNeeded - Enum constant in enum class com.scaleout.client.caching.RequestStatus

The client requested authorization for a request which does not require authorization.

B

backingStoreEventInterval(Duration) - Method in class com.scaleout.client.caching.CacheBuilder

The interval the BackingStoreMode will use.

backingStoreMode(BackingStoreMode) - Method in class com.scaleout.client.caching.CacheBuilder

The BackingStoreMode the Cache will use.

BackingStoreMode - Enum Class in com.scaleout.client.caching

The BackingStoreMode indicates the type of asynchronous backing-store behavior that the server should invoke for an object.

build() - Method in class com.scaleout.client.caching.CacheBuilder

Instantiates a Cache connected to ScaleOut via the GridConnection.

build() - Method in class com.scaleout.client.caching.CreatePolicyBuilder

Instantiates a CreatePolicy with all configured options.

build() - Method in class com.scaleout.client.caching.ReadPolicyBuilder

Instantiates a new, immutable ReadPolicy.

ByteArrayKeyEncoder - Class in com.scaleout.client.caching

The ByteArrayKeyEncoder is an implementation of a KeyEncoder for Byte keys compatible with the SOSS-JNC API.

ByteArrayKeyEncoder() - Constructor for class com.scaleout.client.caching.ByteArrayKeyEncoder

Constructs a KeyEncoder implementation for byte[] keys.

C

Cache<K,V> - Class in com.scaleout.client.caching

The Cache class is used to make caching requests to a ScaleOut in-memory data grid.

CacheBuilder<K,V> - Class in com.scaleout.client.caching

The CacheBuilder is used to instantiate a typed cache connected to a ScaleOut in-memory data grid.

CacheBuilder(GridConnection, String, KeyEncoder<K>, Class<K>) - Constructor for class com.scaleout.client.caching.CacheBuilder

Instantiates a new CacheBuilder instance.

CacheBuilder(GridConnection, String, KeyEncoder<K>, Class<K>, Properties) - Constructor for class com.scaleout.client.caching.CacheBuilder

Instantiates a new CacheBuilder instance.

CacheBuilder(GridConnection, String, Class<K>) - Constructor for class com.scaleout.client.caching.CacheBuilder

Instantiates a new CacheBuilder instance.

CacheBuilder(GridConnection, String, Class<K>, Properties) - Constructor for class com.scaleout.client.caching.CacheBuilder

Instantiates a new CacheBuilder instance.

CacheCleared - Enum constant in enum class com.scaleout.client.caching.RequestStatus

The ScaleOut cache was cleared of all objects.

CacheDeserializer<V> - Class in com.scaleout.client.caching

The CacheDeserializer is used to deserialize a V value from a N-length byte array.

CacheDeserializer() - Constructor for class com.scaleout.client.caching.CacheDeserializer

Default constructor.

CachedObjectMetadata<K> - Class in com.scaleout.client.caching

Metadata for an object stored in a Cache.

CachedObjectMetadata() - Constructor for class com.scaleout.client.caching.CachedObjectMetadata

Default constructor.

CacheEntryDisposition - Enum Class in com.scaleout.client.caching

Cache entry disposition is used by the CacheEntryExpirationHandler to tell a Cache what to do with an object that has expired.

CacheEntryEraseHandler<K,V> - Interface in com.scaleout.client.caching

Callback that removes the provided object from a backing store.

CacheEntryExpirationHandler<K,V> - Interface in com.scaleout.client.caching

Callback that is invoked when an object expires in the ScaleOut service.

CacheEntryStoreHandler<K,V> - Interface in com.scaleout.client.caching

Callback that writes the provided object to a backing store.

CacheException - Exception Class in com.scaleout.client.caching

The CacheException is thrown when all retries to connect to a ScaleOut in-memory data grid have been exhausted.

CacheException(Exception) - Constructor for exception class com.scaleout.client.caching.CacheException

Instantiates a CacheException with a Exception cause.

CacheException(String) - Constructor for exception class com.scaleout.client.caching.CacheException

Instantiates a CacheException with a message.

CacheException(String, Exception) - Constructor for exception class com.scaleout.client.caching.CacheException

Instantiates a CacheException with a message and an Exception cause.

CacheObjectAttribute - Annotation Interface in com.scaleout.client.caching.query

An attribute that indicates that the property or class to which it applies are available for queries.

CacheObjectAttributeException - Exception Class in com.scaleout.client.caching.query

Thrown if there is an error parsing a method annotated with CacheObjectAttribute.

CacheObjectAttributeException(Exception) - Constructor for exception class com.scaleout.client.caching.query.CacheObjectAttributeException

Construct a CacheObjectAttributeException with an underlying cause.

CacheObjectAttributeException(String) - Constructor for exception class com.scaleout.client.caching.query.CacheObjectAttributeException

Construct a CacheObjectAttributeException with a custom message.

CacheObjectAttributeException(String, Exception) - Constructor for exception class com.scaleout.client.caching.query.CacheObjectAttributeException

Construct a CacheObjectAttributeException with an underlying cause and custom message.

CacheResponse<K,V> - Class in com.scaleout.client.caching

The CacheResponse provides details regarding the status of a caching request.

CacheResponse() - Constructor for class com.scaleout.client.caching.CacheResponse

Default constructor.

CacheSerializer<V> - Class in com.scaleout.client.caching

The CacheSerializer is used to serialize a V value to a N-length byte array.

CacheSerializer() - Constructor for class com.scaleout.client.caching.CacheSerializer

Default constructor.

CacheValueDeserializer<V> - Class in com.scaleout.client.caching

The CacheValueDeserializer is used as the default V value deserializer.

CacheValueDeserializer() - Constructor for class com.scaleout.client.caching.CacheValueDeserializer

Default Cache value deserializer.

CacheValueSerializer<V> - Class in com.scaleout.client.caching

The CacheValueSerializer is used as the default V value serializer.

CacheValueSerializer() - Constructor for class com.scaleout.client.caching.CacheValueSerializer

Default Cache serializer.

ClassStructureParsingException - Exception Class in com.scaleout.client.caching.query

Thrown if there is an error parsing a class annotated with CacheObjectAttribute.

ClassStructureParsingException(String, Class) - Constructor for exception class com.scaleout.client.caching.query.ClassStructureParsingException

Construct an exception with a custom message and the class where the exception was thrown.

ClassStructureParsingException(String, Method) - Constructor for exception class com.scaleout.client.caching.query.ClassStructureParsingException

Construct an exception with a custom message and the method where the exception was thrown.

clear() - Method in class com.scaleout.client.caching.Cache

Clear all objects from the ScaleOut cache.

clearAsync() - Method in class com.scaleout.client.caching.Cache

Asynchronously clear all objects from the ScaleOut cache.

clearTags() - Method in class com.scaleout.client.caching.query.TaggableObject

Clears all tags from the object's tag list.

clientCache(ClientCache<K, V>) - Method in class com.scaleout.client.caching.CacheBuilder

Assign a custom client cache implementation to this Cache.

ClientCache<K,V> - Class in com.scaleout.client.caching

The ClientCache stores ClientCacheEntry's to speed up read operations.

ClientCache() - Constructor for class com.scaleout.client.caching.ClientCache

Default constructor.

clientCacheCoherencyIntervalMs(long) - Method in class com.scaleout.client.caching.CacheBuilder

The client cache will return the object if the coherency interval has not elapsed.

ClientCacheEntry<K,V> - Class in com.scaleout.client.caching

The ClientCacheEntry is an element in a ClientCache.

ClientCacheEntry() - Constructor for class com.scaleout.client.caching.ClientCacheEntry

Default constructor.

clientCacheEntryWeigher(ClientCacheEntryWeigher<K, V>) - Method in class com.scaleout.client.caching.CacheBuilder

The ClientCacheEntryWeigher the ClientCache will use.

ClientCacheEntryWeigher<K,V> - Class in com.scaleout.client.caching

The ClientCacheEntryWeigher is used to evaluate a ClientCacheEntry's weight in the weighted ClientCache.

ClientCacheEntryWeigher() - Constructor for class com.scaleout.client.caching.ClientCacheEntryWeigher

Default constructor.

clientCacheOptions(ClientCacheOptions) - Method in class com.scaleout.client.caching.CacheBuilder

The ClientCacheOptions the ClientCache will use.

ClientCacheOptions - Enum Class in com.scaleout.client.caching

The ClientCacheOptions enum indicates in-memory client cache usage.

clientCacheSize(int) - Method in class com.scaleout.client.caching.CacheBuilder

The size of the ClientCache.

com.scaleout.client - package com.scaleout.client

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

com.scaleout.client.caching - package com.scaleout.client.caching

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

com.scaleout.client.caching.query - package com.scaleout.client.caching.query

API for querying cached objects in a ScaleOut in-memory data grid.

connect(String) - Static method in class com.scaleout.client.GridConnection

Connects to a ScaleOut in-memory data grid, returning a GridConnection instance that can be used with a CacheBuilder to create a Cache and access objects in the ScaleOut in-memory data grid.

Constants - Class in com.scaleout.client.caching

Constants and reasonable defaults for configuring a cache from a properties file.

contains(String, String) - Static method in class com.scaleout.client.caching.query.FilterFactory

The string property with the name propertyName must CONTAIN the string str.

create(K) - Method in interface com.scaleout.client.caching.ValueFactory

Creates a ValueFactoryResult based on the key.

createPolicy() - Method in class com.scaleout.client.caching.Cache

Retrieve the default CreatePolicy used by this Cache.

CreatePolicy - Class in com.scaleout.client.caching

The CreatePolicy specifies per-object policy information when adding objects to a ScaleOut in-memory data grid.

CreatePolicy(CreatePolicyBuilder) - Constructor for class com.scaleout.client.caching.CreatePolicy

Construct a CreatePolicy based on the CreatePolicyBuilder.

CreatePolicyBuilder - Class in com.scaleout.client.caching

The CreatePolicyBuilder class is used to create immutable CreatePolicy objects.

CreatePolicyBuilder() - Constructor for class com.scaleout.client.caching.CreatePolicyBuilder

Instantiates the CreatePolicyBuilder

CreatePolicyBuilder(CreatePolicy) - Constructor for class com.scaleout.client.caching.CreatePolicyBuilder

Instantiates the CreatePolicyBuilder

customSerialization(CacheSerializer<V>, CacheDeserializer<V>) - Method in class com.scaleout.client.caching.CacheBuilder

Set the value CacheSerializer and CacheDeserializer the Cache will use.

D

DeepCopy - Enum constant in enum class com.scaleout.client.caching.ClientCacheOptions

Returns a "deep copy" of the object.

defaultPolicy() - Static method in class com.scaleout.client.caching.ReadPolicyBuilder

Retrieves the default ReadPolicy.

DeserializationException - Exception Class in com.scaleout.client.caching

The DeserializationException indicates that an error occurred while deserializing a value from the ScaleOut in-memory data grid.

DeserializationException(String) - Constructor for exception class com.scaleout.client.caching.DeserializationException

Instantiates a DeserializationException with a message.

DeserializationException(String, Exception) - Constructor for exception class com.scaleout.client.caching.DeserializationException

Instantiates a DeserializationException with a message and an Exception cause.

deserialize(byte[]) - Method in class com.scaleout.client.caching.CacheDeserializer

Deserialize a byte[] into a V object.

deserialize(byte[]) - Method in class com.scaleout.client.caching.CacheValueDeserializer

Deserialize an object using ObjectInputStream.

Disable - Enum constant in enum class com.scaleout.client.caching.ClientCacheOptions

Disables the client cache.

Disabled - Enum constant in enum class com.scaleout.client.caching.GeoServerPullPolicy

Remote access will be disabled.

Disabled - Enum constant in enum class com.scaleout.client.caching.GeoServerPushPolicy

GeoServer replication will not be performed.

disableLocalStringKeyCaching() - Method in class com.scaleout.client.caching.CacheBuilder

Disables the in-memory string key cache.

E

emptyLockToken() - Static method in class com.scaleout.client.caching.LockToken

Retrieve an empty lock token.

emptyVersionToken() - Static method in class com.scaleout.client.caching.VersionToken

Retrieve an empty version token.

enableAsyncReadThrough(boolean) - Method in class com.scaleout.client.caching.Cache

Enable async read through on this service event handler.

enableAsyncWriteThrough(boolean) - Method in class com.scaleout.client.caching.Cache

Enable async write through on this service event handler.

enableReadThrough(boolean) - Method in class com.scaleout.client.caching.Cache

Enable read through on this service event handler.

encode(byte[]) - Method in class com.scaleout.client.caching.ByteArrayKeyEncoder

Encodes the byte[] key.

encode(Integer) - Method in class com.scaleout.client.caching.IntegerKeyEncoder

Encodes the Integer key into a KeyEncodingResult

encode(String) - Method in class com.scaleout.client.caching.LegacyStringKeyEncoder

Encodes the String key into a KeyEncodingResult with a unicode encoded key string.

encode(String) - Method in class com.scaleout.client.caching.StringKeyEncoder

Encodes the String key into a KeyEncodingResult with a UTF-8 encoded key string.

encode(UUID) - Method in class com.scaleout.client.caching.UuidKeyEncoder

Encodes the UUID key.

encode(K) - Method in class com.scaleout.client.caching.KeyEncoder

Encodes a K key into an array of 32-bytes.

encodedKeyString() - Method in class com.scaleout.client.caching.KeyEncodingResult

Retrieve the encoded key string (if it exists).

equal(String, Object) - Static method in class com.scaleout.client.caching.query.FilterFactory

The value of the property with the name propertyName must be EQUAL to value.

erase(K) - Method in interface com.scaleout.client.caching.CacheEntryEraseHandler

Remove the provided object based on the key from a backing store.

evaluateEntryWeight(ClientCacheEntry<K, V>) - Method in class com.scaleout.client.caching.ClientCacheEntryWeigher

Evaluates the weight of the entry.

EventDeliveryExceptionArgs<K,V> - Class in com.scaleout.client.caching

The EventDeliveryExceptionHandlerArgs class is used to store the NamedCache, Id, and Exception that occurred during a BackingStore operation.

EventDeliveryExceptionArgs() - Constructor for class com.scaleout.client.caching.EventDeliveryExceptionArgs

Default constructor.

EventDeliveryExceptionHandler<K,V> - Class in com.scaleout.client.caching

The EventDeliveryExceptionHandler is used to deliver exceptions that were unhandled in user code during backing store operations.

EventDeliveryExceptionHandler() - Constructor for class com.scaleout.client.caching.EventDeliveryExceptionHandler

Default constructor.

expressionsEqual(Filter, Filter) - Static method in class com.scaleout.client.caching.query.FilterFactory

To pass through this filter objects must satisfy both firstFilter and secondFilter or neither of them.

F

Filter - Class in com.scaleout.client.caching.query

An interface for filters that can be used in Cache.queryObjects(Filter, Class), or Cache.queryKeys(Filter, Class).

FilterFactory - Class in com.scaleout.client.caching.query

This factory is used for constructing query expressions.

fromBytes(byte[]) - Method in class com.scaleout.client.caching.ByteArrayKeyEncoder

Returns the original byte[] key.

fromBytes(byte[]) - Method in class com.scaleout.client.caching.IntegerKeyEncoder

Retrieves the Integer key.

fromBytes(byte[]) - Method in class com.scaleout.client.caching.KeyEncoder

Retrieves a encoded key.

fromBytes(byte[]) - Method in class com.scaleout.client.caching.LegacyStringKeyEncoder

Retrieves a Unicode string from the 32-byte encoded key string.

fromBytes(byte[]) - Method in class com.scaleout.client.caching.StringKeyEncoder

Retrieves a UTF-8 string from the 32-byte encoded key string.

fromBytes(byte[]) - Method in class com.scaleout.client.caching.UuidKeyEncoder

Returns the original byte[] key.

fromString(String) - Static method in enum class com.scaleout.client.caching.BackingStoreMode

Retrieve a backing store mode from a string value.

fromString(String) - Static method in enum class com.scaleout.client.caching.ClientCacheOptions

Retrieve a ClientCacheOptions enum from a string.

fromString(String) - Static method in enum class com.scaleout.client.caching.GeoServerCoherencyPolicy

Retrieve a GeoServerCoherencyPolicy enum from a string.

fromString(String) - Static method in enum class com.scaleout.client.caching.GeoServerPullPolicy

Retrieve a GeoServerPullPolicy enum from a string.

fromString(String) - Static method in enum class com.scaleout.client.caching.GeoServerPushPolicy

Retrieve a GeoServerPushPolicy enum from a string.

fromString(String) - Static method in enum class com.scaleout.client.caching.GeoServerReadMode

Retrieve a GeoServerReadMode enum from a string.

fromString(String) - Static method in enum class com.scaleout.client.caching.PreemptionPriority

Retrieve a PreemptionPriority from a string.

fromString(String) - Static method in enum class com.scaleout.client.caching.TimeoutType

Retrieve a TimeoutType enum from a string.

G

GEOS_MAX_REGISTER_REMOTE_STORE_RETRY_ATTEMPTS - Static variable in class com.scaleout.client.caching.Constants

GeoServer max register remote store attempt configuration key

GEOS_MAX_REGISTER_REMOTE_STORE_RETRY_ATTEMPTS_DEFAULT - Static variable in class com.scaleout.client.caching.Constants

GeoServer max register remote store attempt configuration default value

GEOS_REGISTER_REMOTE_STORE_RETRY_INTERVAL - Static variable in class com.scaleout.client.caching.Constants

GeoServer max register remote store retry interval configuration key

GEOS_REGISTER_REMOTE_STORE_RETRY_INTERVAL_DEFAULT - Static variable in class com.scaleout.client.caching.Constants

GeoServer max register remote store retry interval configuration default value

GEOS_REMOTE_STORE_NAMES - Static variable in class com.scaleout.client.caching.Constants

GeoServer remote store configuration key

GEOS_REMOTE_STORE_NAMES_DEFAULT - Static variable in class com.scaleout.client.caching.Constants

GeoServer remote store configuration default value

GEOSERVER_COHERENCY_POLICY - Static variable in class com.scaleout.client.caching.Constants

GeoServer coherency policy configuration key.

GEOSERVER_COHERENCY_POLICY_INTERVAL - Static variable in class com.scaleout.client.caching.Constants

GeoServer coherency interval configuration key

GEOSERVER_COHERENCY_POLICY_INTERVAL_DEFAULT - Static variable in class com.scaleout.client.caching.Constants

GeoServer default coherency interval value

GEOSERVER_COHERENCY_POLICY_NO - Static variable in class com.scaleout.client.caching.Constants

GeoServer coherency policy no auto refresh value

GEOSERVER_COHERENCY_POLICY_NOTIFY - Static variable in class com.scaleout.client.caching.Constants

GeoServer coherency policy notify value

GEOSERVER_COHERENCY_POLICY_POLL - Static variable in class com.scaleout.client.caching.Constants

GeoServer coherency policy poll value

GEOSERVER_PULL_POLICY - Static variable in class com.scaleout.client.caching.Constants

GeoServer pull policy configuration key

GEOSERVER_PULL_POLICY_ALLOW - Static variable in class com.scaleout.client.caching.Constants

GeoServer pull policy allow value

GEOSERVER_PULL_POLICY_DISABLED - Static variable in class com.scaleout.client.caching.Constants

GeoServer pull policy disable value

GEOSERVER_PUSH_POLICY - Static variable in class com.scaleout.client.caching.Constants

GeoServer push policy configuration key

GEOSERVER_PUSH_POLICY_ALLOW - Static variable in class com.scaleout.client.caching.Constants

GeoServer push policy configuration allow value

GEOSERVER_PUSH_POLICY_DISABLED - Static variable in class com.scaleout.client.caching.Constants

GeoServer push policy configuration disable value

GEOSERVER_READ_MODE - Static variable in class com.scaleout.client.caching.Constants

GeoServer read mode configuration key

GEOSERVER_READ_MODE_LOCAL_ALLOW_STALE - Static variable in class com.scaleout.client.caching.Constants

GeoServer read mode configuration allow stale value

GEOSERVER_READ_MODE_LOCAL_THROW_STALE - Static variable in class com.scaleout.client.caching.Constants

GeoServer read mode configuration throw on stale value

GEOSERVER_READ_MODE_NONE - Static variable in class com.scaleout.client.caching.Constants

GeoServer read mode configuration none value

GEOSERVER_READ_MODE_REMOTE - Static variable in class com.scaleout.client.caching.Constants

GeoServer read mode configuration remote value

geoServerCoherencyInterval(Duration) - Method in class com.scaleout.client.caching.CacheBuilder

Note, requires GeoServer Pro enabled license.

geoServerCoherencyPolicy(GeoServerCoherencyPolicy) - Method in class com.scaleout.client.caching.CacheBuilder

Note, GeoServerCoherencyPolicy.Poll and GeoServerCoherencyPolicy.Notify requires GeoServer Pro enabled license.

GeoServerCoherencyPolicy - Enum Class in com.scaleout.client.caching

The GeoServerCoherencyPolicy is used to indicate the type of coherency policy used for GeoServer "pull" replication.

GeoServerLocalNameNotSet - Enum constant in enum class com.scaleout.client.caching.RequestStatus

Note, requires GeoServer Pro.

GeoServerNoActiveRemoteStore - Enum constant in enum class com.scaleout.client.caching.RequestStatus

Note, requires GeoServer Pro.

geoServerPullPolicy(GeoServerPullPolicy) - Method in class com.scaleout.client.caching.CacheBuilder

Note, requires GeoServer Pro enabled license.

GeoServerPullPolicy - Enum Class in com.scaleout.client.caching

The GeoServerPullPolicy enum is used to indicate whether objects added to the cache will be accessible to remote stores via GeoServer "pull" replication.

geoServerPushPolicy(GeoServerPushPolicy) - Method in class com.scaleout.client.caching.CacheBuilder

The GeoServerPushPolicy the Cache will use.

GeoServerPushPolicy - Enum Class in com.scaleout.client.caching

The GeoServerPushPolicy enum is used to indicate whether objects added to the cache will be subject to GeoServer "push" replication.

geoServerReadMode(GeoServerReadMode) - Method in class com.scaleout.client.caching.CacheBuilder

The GeoServerReadMode the Cache will use.

GeoServerReadMode - Enum Class in com.scaleout.client.caching

The GeoServerReadMode is an enum used to control GeoServer "pull" replication during Read operations.

GeoServerRemoteAccessError - Enum constant in enum class com.scaleout.client.caching.RequestStatus

Note, requires GeoServer Pro.

GeoServerStaleRead - Enum constant in enum class com.scaleout.client.caching.RequestStatus

Note, requires GeoServer Pro.

GeoServerSuccessfulObjectTakeover - Enum constant in enum class com.scaleout.client.caching.RequestStatus

Note, requires GeoServer Pro.

get(byte[]) - Method in class com.scaleout.client.caching.StringKeyCache

Retrieve the string key for this hashed string key.

get(K) - Method in class com.scaleout.client.caching.ClientCache

Retrieve an entry from the client cache.

getAllowRemoteAccess() - Method in class com.scaleout.client.caching.CachedObjectMetadata

Return true/false if this object has remote access allowed.

getAllowReplication() - Method in class com.scaleout.client.caching.CachedObjectMetadata

Return true/false if this object is allowed to be replicated.

getAppId() - Method in class com.scaleout.client.caching.Cache

The application ID of this service event handler.

getBackingStoreEventInterval() - Method in class com.scaleout.client.caching.CachedObjectMetadata

Retrieve the backing store event interval duration.

getBackingStoreEventInterval() - Method in class com.scaleout.client.caching.CreatePolicy

Retrieves the configured backing store event interval.

getBackingStoreMode() - Method in class com.scaleout.client.caching.CachedObjectMetadata

Retrieve the backing store mode.

getBackingStoreMode() - Method in class com.scaleout.client.caching.CreatePolicy

Retrieves the configured BackingStoreMode.

getCache() - Method in class com.scaleout.client.caching.EventDeliveryExceptionArgs

The Cache where a ValueFactory, CacheEntryEraseHandler, CacheEntryStoreHandler, or CacheEntryExpirationHandler threw an exception.

getClientCache() - Method in class com.scaleout.client.caching.CacheBuilder

Retrieve the ClientCache.

getClientCacheCoherencyIntervalMs() - Method in class com.scaleout.client.caching.CacheBuilder

Retrieve the client cache coherency interval in Ms

getClientCacheOptions() - Method in class com.scaleout.client.caching.CacheBuilder

Retrieve the ClientCacheOptions the ClientCache will use.

getClientCacheSize() - Method in class com.scaleout.client.caching.CacheBuilder

Retrieve the size of the ClientCache.

getClientCacheWeigher() - Method in class com.scaleout.client.caching.CacheBuilder

Retrieve the ClientCacheEntryWeigher the ClientCache will use.

getConnection() - Method in class com.scaleout.client.caching.CacheBuilder

Retrieve the GridConnection the Cache will use.

getCreatePolicy() - Method in class com.scaleout.client.caching.CacheBuilder

Retrieve the CreatePolicy the Cache will use.

getCreatePolicy() - Method in class com.scaleout.client.caching.ValueFactoryResult

Retrieves the creation policy.

getCreateTime() - Method in class com.scaleout.client.caching.CachedObjectMetadata

Retrieve the time this object was created.

getDeserializer() - Method in class com.scaleout.client.caching.CacheBuilder

Retrieve the CacheDeserializer the Cache will use

getException() - Method in class com.scaleout.client.caching.EventDeliveryExceptionArgs

The exception that was unhandled by the ValueFactory, CacheEntryEraseHandler, CacheEntryStoreHandler, or CacheEntryExpirationHandler implementation.

getGeoServerCoherencyInterval() - Method in class com.scaleout.client.caching.CreatePolicy

Retrieves the configured coherency interval for GeoServer polling operations.

getGeoServerCoherencyInterval() - Method in class com.scaleout.client.caching.ReadPolicy

Retrieves the configured coherency interval for GeoServer polling operations.

getGeoServerCoherencyPolicy() - Method in class com.scaleout.client.caching.CachedObjectMetadata

Retrieve the GeoServer coherency policy.

getGeoServerCoherencyPolicy() - Method in class com.scaleout.client.caching.CreatePolicy

Retrieves the configured GeoServerCoherencyPolicy.

getGeoServerCoherencyPolicy() - Method in class com.scaleout.client.caching.ReadPolicy

Retrieves the configured GeoServerCoherencyPolicy.

getGeoServerPullPolicy() - Method in class com.scaleout.client.caching.CreatePolicy

Retrieves the configured GeoServerPullPolicy.

getGeoServerPullPolicy() - Method in class com.scaleout.client.caching.ReadPolicy

Retrieves the configured GeoServerPullPolicy.

getGeoServerPushPolicy() - Method in class com.scaleout.client.caching.CreatePolicy

Retrieves the configured GeoServerPushPolicy.

getGeoServerPushPolicy() - Method in class com.scaleout.client.caching.ReadPolicy

Retrieves the configured GeoServerPushPolicy.

getGeoServerReadMode() - Method in class com.scaleout.client.caching.CacheBuilder

Retrieve the GeoServerReadMode the Cache will use.

getGeoServerReadMode() - Method in class com.scaleout.client.caching.ReadPolicy

Retrieves the configured GeoServerReadMode.

getGridConnection() - Method in class com.scaleout.client.caching.Cache

Retrieve the GridConnection associated with this service event handler.

getKey() - Method in class com.scaleout.client.caching.CacheResponse

Returns the key for the request or null if no key is used.

getKey() - Method in class com.scaleout.client.caching.ClientCacheEntry

Retrieve the entries key.

getKey() - Method in class com.scaleout.client.caching.EventDeliveryExceptionArgs

The key of the object for the operation that was in progress.

getKeyClass() - Method in class com.scaleout.client.caching.CacheBuilder

Retrieve the key class.

getKeyEncoder() - Method in class com.scaleout.client.caching.CacheBuilder

Retrieve the KeyEncoder the Cache will use to encode keys.

getKeyEncoder() - Method in class com.scaleout.client.caching.Cache

The KeyEncoder used by this service event handler.

getLockToken() - Method in class com.scaleout.client.caching.CacheResponse

If the caching request successfully completed and performed a locking operation then a lock token will be returned.

getLockToken() - Method in class com.scaleout.client.caching.ClientCacheEntry

Retrieve the version token.

getMaxReadThroughAttempts() - Method in class com.scaleout.client.caching.CacheBuilder

Retrieve the max read through attempts.

getMaxRegisterRemoteStoreAttempts() - Method in class com.scaleout.client.caching.CacheBuilder

Retrieve the max register remote store attempts.

getMetadata(K) - Method in class com.scaleout.client.caching.Cache

Retrieves CachedObjectMetadata for an object stored in the cache.

getMetadataAsync(K) - Method in class com.scaleout.client.caching.Cache

Retrieves CachedObjectMetadata for an object stored in the cache.

getName() - Method in class com.scaleout.client.caching.CacheBuilder

Retrieve the name of the Cache this CacheBuilder will create.

getObjectSize() - Method in class com.scaleout.client.caching.CachedObjectMetadata

Retrieve the object size (in bytes).

getObjectTimeout() - Method in class com.scaleout.client.caching.CreatePolicy

Retrieves the configured object timeout.

getParentKeys() - Method in class com.scaleout.client.caching.CachedObjectMetadata

Retrieve the parent keys.

getPreemptionPriority() - Method in class com.scaleout.client.caching.CachedObjectMetadata

Retrieve the preemption priority.

getPreemptionPriority() - Method in class com.scaleout.client.caching.CreatePolicy

Retrieves the configured PreemptionPriority

getReadPolicy() - Method in class com.scaleout.client.caching.CacheBuilder

Retrieve the ReadPolicy the Cache will use.

getReadThroughRetryInterval() - Method in class com.scaleout.client.caching.CacheBuilder

Retrieve the read through retry interval.

getRegisterRemoteStoreRetryInterval() - Method in class com.scaleout.client.caching.CacheBuilder

Retrieve the register remote store interval.

getRemoteStoreNames() - Method in class com.scaleout.client.caching.CacheBuilder

Retrieve the remote store names.

getSerializer() - Method in class com.scaleout.client.caching.CacheBuilder

Retrieve the CacheSerializer the Cache will use

getStatus() - Method in class com.scaleout.client.caching.CacheResponse

Returns the status of a caching request.

getTagHolder() - Method in class com.scaleout.client.caching.ValueFactoryResult

Retrieves the tag holder.

getTags() - Method in interface com.scaleout.client.caching.query.Taggable

Method used by Cache to store tags as SOSS attributes.

getTags() - Method in class com.scaleout.client.caching.query.TaggableObject

 

getTimeout() - Method in class com.scaleout.client.caching.CachedObjectMetadata

Retrieve the timeout duration.

getTimeoutType() - Method in class com.scaleout.client.caching.CachedObjectMetadata

Retrieve the timeout type for this object.

getTimeoutType() - Method in class com.scaleout.client.caching.CreatePolicy

Retrieves the configured object TimeoutType.

getTimestamp() - Method in class com.scaleout.client.caching.ClientCacheEntry

Retrieve the timestamp of this entry.

getUpdateTime() - Method in class com.scaleout.client.caching.CachedObjectMetadata

Retrieve the time this object was last updated.

getValue() - Method in class com.scaleout.client.caching.CacheResponse

Returns the value for the request or null if no value is available.

getValue() - Method in class com.scaleout.client.caching.ClientCacheEntry

Retrieve the entries value.

getValue() - Method in class com.scaleout.client.caching.ValueFactoryResult

Retrieves the value.

getVersionToken() - Method in class com.scaleout.client.caching.CacheResponse

If the caching request successfully completed a key/value operation and the object has a version then a version token will be returned.

getVersionToken() - Method in class com.scaleout.client.caching.ClientCacheEntry

Retrieve the lock token

greaterOrEqual(String, Object) - Static method in class com.scaleout.client.caching.query.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.scaleout.client.caching.query.FilterFactory

The value of the property with the name propertyName must be GREATER than value.

GridConnectException - Exception Class in com.scaleout.client

Indicates that an error occurred while connecting to the ScaleOut in-memory data grid.

GridConnectException(String) - Constructor for exception class com.scaleout.client.GridConnectException

Constructs a new GridConnectException with the specified detail message.

GridConnectException(String, Exception) - Constructor for exception class com.scaleout.client.GridConnectException

Constructs a new GridConnectException with the specified detail message and cause.

GridConnection - Class in com.scaleout.client

Represents connection(s) to one or more servers in a ScaleOut in-memory data grid.

H

handleExpirationEvent(Cache<K, V>, K) - Method in interface com.scaleout.client.caching.CacheEntryExpirationHandler

Callback that is invoked when an object expires in the ScaleOut service.

hasAllTags(String...) - Static method in class com.scaleout.client.caching.query.FilterFactory

Matching objects must be tagged with ALL of the tags provided as parameters.

hasAllTags(String...) - Method in class com.scaleout.client.caching.query.TaggableObject

Determines whether this object has all the tags specified by tags.

hasAnyTags(String...) - Static method in class com.scaleout.client.caching.query.FilterFactory

Matching objects must be tagged with ANY of the tags provided as parameters.

hasAnyTags(String...) - Method in class com.scaleout.client.caching.query.TaggableObject

Determines whether this object has any of the tags specified by tags.

Hashable - Enum constant in enum class com.scaleout.client.caching.query.HashIndexPriority

The item the CacheObjectAttribute refers to will be entered into the in-memory datagrid hashtable if there's room after attempting to hash all higher priority items.

HashIndexPriority - Enum Class in com.scaleout.client.caching.query

This enum allows sorting of hashed attributes by priority.

hasValue() - Method in class com.scaleout.client.caching.LockToken

Check to see if this LockToken has a value.

hasValue() - Method in class com.scaleout.client.caching.VersionToken

Check to see if this VersionToken has a value.

HighPriorityHashable - Enum constant in enum class com.scaleout.client.caching.query.HashIndexPriority

The item the CacheObjectAttribute refers to will be entered into the StateServer Hashtable if there's room.

I

IntegerKeyEncoder - Class in com.scaleout.client.caching

The IntegerKeyEncoder is an implementation of a KeyEncoder for Integer keys.

IntegerKeyEncoder() - Constructor for class com.scaleout.client.caching.IntegerKeyEncoder

Construct a KeyEncoder for Integer keys.

isContained(String, String) - Static method in class com.scaleout.client.caching.query.FilterFactory

The string property with the name propertyName must be CONTAINED IN the string str.

isProxy() - Method in class com.scaleout.client.caching.CachedObjectMetadata

Return true/false if this object is a "proxy" object.

K

keyBytes() - Method in class com.scaleout.client.caching.KeyEncodingResult

Retrieve the encoded key bytes.

KeyEncoder<K> - Class in com.scaleout.client.caching

The KeyEncoder is used to transform a K key into an array of 32 bytes.

KeyEncoder() - Constructor for class com.scaleout.client.caching.KeyEncoder

Construct a KeyEncoder.

KeyEncodingResult - Class in com.scaleout.client.caching

The KeyEncodingResult returned by an implementation of KeyEncoder.encode(Object)

KeyEncodingResult(byte[]) - Constructor for class com.scaleout.client.caching.KeyEncodingResult

Creates a KeyEncodingResult with the encoded key

KeyEncodingResult(byte[], byte[]) - Constructor for class com.scaleout.client.caching.KeyEncodingResult

Create a KeyEncodingResult with the key bytes and an encoded key string.

L

LegacyStringKeyEncoder - Class in com.scaleout.client.caching

The LegacyStringKeyEncoder is an implementation of a KeyEncoder for String keys compatible with the SOSS-JNC API.

LegacyStringKeyEncoder(StringKeyCache) - Constructor for class com.scaleout.client.caching.LegacyStringKeyEncoder

Construct a KeyEncoder for String keys compatible with the SOSS-JNC API.

lessOrEqual(String, Object) - Static method in class com.scaleout.client.caching.query.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.scaleout.client.caching.query.FilterFactory

The value of the property with the name propertyName must be LESS than value.

LocalAllowStaleData - Enum constant in enum class com.scaleout.client.caching.GeoServerReadMode

Indicates that the read operation can return the object value from the proxy held in the local ScaleOut store.

LocalThrowOnStaleData - Enum constant in enum class com.scaleout.client.caching.GeoServerReadMode

Indicates that the read operation can return the object value from the proxy held in the local ScaleOut store.

lock(K) - Method in class com.scaleout.client.caching.Cache

Lock an object within the ScaleOut cache for exclusive access.

lockAsync(K) - Method in class com.scaleout.client.caching.Cache

Asynchronously lock an object within the ScaleOut cache for exclusive access.

LockLostError - Enum constant in enum class com.scaleout.client.caching.RequestStatus

An exclusive lock timed out and then locked by another client.

LockToken - Class in com.scaleout.client.caching

The LockToken is an identifier for a lock that is held on an object in the ScaleOut in-memory data grid.

LockToken() - Constructor for class com.scaleout.client.caching.LockToken

Default constructor.

M

MEMORY_PREEMPTION_PRIORITY - Static variable in class com.scaleout.client.caching.Constants

Object preemption priority configuration key

MEMORY_PREEMPTION_PRIORITY_NORMAL - Static variable in class com.scaleout.client.caching.Constants

Object preemption priority configuration normal value

MEMORY_PREEMPTION_PRIORITY_NOTREMOVABLE - Static variable in class com.scaleout.client.caching.Constants

Object preemption priority configuration not removable value

N

NoAutoRefresh - Enum constant in enum class com.scaleout.client.caching.GeoServerCoherencyPolicy

Proxy objects in other stores should not be refreshed automatically.

NoMemory - Enum constant in enum class com.scaleout.client.caching.RequestStatus

The ScaleOut store ran out of memory.

None - Enum constant in enum class com.scaleout.client.caching.BackingStoreMode

The server should not perform asynchronous backing store operations for this object.

None - Enum constant in enum class com.scaleout.client.caching.GeoServerReadMode

Default.

Normal - Enum constant in enum class com.scaleout.client.caching.PreemptionPriority

The object is a candidate for removal from StateServer memory if memory pressure warrants

not(Filter) - Static method in class com.scaleout.client.caching.query.FilterFactory

Creates a compound filter, matching objects must NOT satisfy filter.

NotAuthorized - Enum constant in enum class com.scaleout.client.caching.RequestStatus

The client is not authorized to perform an operation.

notEqual(String, Object) - Static method in class com.scaleout.client.caching.query.FilterFactory

The value of the property with the name propertyName must NOT be EQUAL to value.

NotHandled - Enum constant in enum class com.scaleout.client.caching.CacheEntryDisposition

The client has not handled the event; the object will be removed.

NotHashable - Enum constant in enum class com.scaleout.client.caching.query.HashIndexPriority

The item in the CacheObjectAttribute refers to is never entered into the StateServer Hashtable.

Notify - Enum constant in enum class com.scaleout.client.caching.GeoServerCoherencyPolicy

Remote stores should be notified of changes to the object, so they can refresh their proxy object.

NotImplemented - Enum constant in enum class com.scaleout.client.caching.RequestStatus

The request is not implemented.

NotLicensed - Enum constant in enum class com.scaleout.client.caching.RequestStatus

The client is not licensed to perform an operation.

NotReady - Enum constant in enum class com.scaleout.client.caching.RequestStatus

The ScaleOut store is not ready to perform the operation.

NotRemovable - Enum constant in enum class com.scaleout.client.caching.PreemptionPriority

The associated object must remain in memory until its expiration is reached or the object is explicitly removed.

O

OBJECT_BACKING_STORE_EVENT_INTERVAL - Static variable in class com.scaleout.client.caching.Constants

Object backing store event interval configuration key

OBJECT_BACKING_STORE_EVENT_INTERVAL_DEFAULT - Static variable in class com.scaleout.client.caching.Constants

Object backing store event interval configuration default value

OBJECT_BACKING_STORE_MODE - Static variable in class com.scaleout.client.caching.Constants

Object backing store mode configuration key

OBJECT_BACKING_STORE_MODE_NONE - Static variable in class com.scaleout.client.caching.Constants

Object backing store mode configuration none value

OBJECT_BACKING_STORE_MODE_REFRESHAHEAD - Static variable in class com.scaleout.client.caching.Constants

Object backing store mode configuration refresh ahead value

OBJECT_BACKING_STORE_MODE_WRITEBEHIND - Static variable in class com.scaleout.client.caching.Constants

Object backing store mode configuration write behind value

OBJECT_BACKING_STORE_OPTION - Static variable in class com.scaleout.client.caching.Constants

Object backing store configuration key

OBJECT_BACKING_STORE_OPTION_DEFAULT - Static variable in class com.scaleout.client.caching.Constants

Object backing store configuration value

OBJECT_CLIENT_CACHE_CLASS - Static variable in class com.scaleout.client.caching.Constants

Object client cache class configuration key

OBJECT_CLIENT_CACHE_CLASS_DEFAULT - Static variable in class com.scaleout.client.caching.Constants

Object client cache class configuration default value

OBJECT_CLIENT_CACHE_COHERENCY_INTERVAL - Static variable in class com.scaleout.client.caching.Constants

Client cache coherency interval configuration key

OBJECT_CLIENT_CACHE_COHERENCY_INTERVAL_DEFAULT - Static variable in class com.scaleout.client.caching.Constants

Client cache coherency interval configuration default value

OBJECT_CLIENT_CACHE_OPTION - Static variable in class com.scaleout.client.caching.Constants

Client cache option configuration key

OBJECT_CLIENT_CACHE_OPTION_DEEPCOPY - Static variable in class com.scaleout.client.caching.Constants

Client cache option configuration deepcopy value

OBJECT_CLIENT_CACHE_OPTION_DISABLED - Static variable in class com.scaleout.client.caching.Constants

Client cache option configuration disable value

OBJECT_CLIENT_CACHE_OPTION_REFERENCE - Static variable in class com.scaleout.client.caching.Constants

Client cache option configuration reference value

OBJECT_CLIENT_CACHE_SIZE - Static variable in class com.scaleout.client.caching.Constants

Client cache size configuration key

OBJECT_CLIENT_CACHE_SIZE_DEFAULT - Static variable in class com.scaleout.client.caching.Constants

Client cache size configuration default value

OBJECT_CLIENT_CACHE_WEIGHER_CLASS - Static variable in class com.scaleout.client.caching.Constants

Object client cache class configuration key

OBJECT_DESERIALIZER_CLASS - Static variable in class com.scaleout.client.caching.Constants

Object deserializer class configuration key

OBJECT_MAX_READ_THROUGH_ATTEMPTS - Static variable in class com.scaleout.client.caching.Constants

Object max read through attempts configuration key

OBJECT_MAX_READ_THROUGH_ATTEMPTS_DEFAULT - Static variable in class com.scaleout.client.caching.Constants

Object max read through attempts configuration default value

OBJECT_READ_THROUGH_RETRY_INTERVAL - Static variable in class com.scaleout.client.caching.Constants

Object read through retry interval configuration key

OBJECT_READ_THROUGH_RETRY_INTERVAL_DEFAULT - Static variable in class com.scaleout.client.caching.Constants

Object read through retry interval configuration default value

OBJECT_SERIALIZER_CLASS - Static variable in class com.scaleout.client.caching.Constants

Object serializer class configuration key

OBJECT_TIMEOUT - Static variable in class com.scaleout.client.caching.Constants

Object timeout configuration key

OBJECT_TIMEOUT_DEFAULT - Static variable in class com.scaleout.client.caching.Constants

Object timeout configuration default value

OBJECT_TIMEOUT_TYPE - Static variable in class com.scaleout.client.caching.Constants

Object timeout type configuration key

OBJECT_TIMEOUT_TYPE_ABSOLUTE - Static variable in class com.scaleout.client.caching.Constants

Object timeout type configuration absolute value

OBJECT_TIMEOUT_TYPE_RESET - Static variable in class com.scaleout.client.caching.Constants

Object timeout type configuration reset on update value

OBJECT_TIMEOUT_TYPE_SLIDING - Static variable in class com.scaleout.client.caching.Constants

Object timeout type configuration sliding value

ObjectAdded - Enum constant in enum class com.scaleout.client.caching.RequestStatus

An object was added to the ScaleOut cache.

ObjectAddedAndLocked - Enum constant in enum class com.scaleout.client.caching.RequestStatus

An object was added with an exclusive lock to the ScaleOut cache.

ObjectAlreadyLocked - Enum constant in enum class com.scaleout.client.caching.RequestStatus

An object was already locked by another client.

ObjectError - Enum constant in enum class com.scaleout.client.caching.RequestStatus

A general error occurred within the request.

ObjectExists - Enum constant in enum class com.scaleout.client.caching.RequestStatus

The object already exists in the cache.

ObjectLocked - Enum constant in enum class com.scaleout.client.caching.RequestStatus

An object in the ScaleOut cache was locked for exclusive access.

ObjectNotFound - Enum constant in enum class com.scaleout.client.caching.RequestStatus

The ScaleOut cache did not contain the request object.

ObjectRemoved - Enum constant in enum class com.scaleout.client.caching.RequestStatus

A cached object was removed from a ScaleOut cache.

ObjectRetrieved - Enum constant in enum class com.scaleout.client.caching.RequestStatus

An object was retrieved from the ScaleOut cache.

ObjectRetrievedAndLocked - Enum constant in enum class com.scaleout.client.caching.RequestStatus

An object was retrieved from the ScaleOut cache and locked for exclusive access.

objectTimeout(Duration) - Method in class com.scaleout.client.caching.CacheBuilder

The timeout for objects stored in the ScaleOut Cache.

objectTimeoutType(TimeoutType) - Method in class com.scaleout.client.caching.CacheBuilder

The TimeoutType the Cache will use.

ObjectUnlocked - Enum constant in enum class com.scaleout.client.caching.RequestStatus

An object in the ScaleOut cache was unlocked.

ObjectUpdated - Enum constant in enum class com.scaleout.client.caching.RequestStatus

An object was updated in the ScaleOut cache.

ObjectUpdatedAndLockRetained - Enum constant in enum class com.scaleout.client.caching.RequestStatus

An object was updated and an exclusive lock was retained by the requester.

ObjectUpdatedAndUnlocked - Enum constant in enum class com.scaleout.client.caching.RequestStatus

An object was updated and an exclusive lock was released.

ObjectVersionMismatch - Enum constant in enum class com.scaleout.client.caching.RequestStatus

The version supplied didn't match the version in the store.

onException(EventDeliveryExceptionArgs<K, V>) - Method in class com.scaleout.client.caching.EventDeliveryExceptionHandler

This method is called when an unhandled exception occurs during any backing store operation.

OperationFailed - Enum constant in enum class com.scaleout.client.caching.RequestStatus

The caching operation failed.

or(Filter, Filter) - Static method in class com.scaleout.client.caching.query.FilterFactory

Creates a compound filter, matching objects must satisfy firstFilter OR secondFilter.

P

Poll - Enum constant in enum class com.scaleout.client.caching.GeoServerCoherencyPolicy

Proxy objects will be periodically refreshed in remote stores.

preemptionPriority(PreemptionPriority) - Method in class com.scaleout.client.caching.CacheBuilder

The PreemptionPriority the Cache will use.

PreemptionPriority - Enum Class in com.scaleout.client.caching

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.

propertiesContains(String, String) - Static method in class com.scaleout.client.caching.query.FilterFactory

The string property with the name propertyName must CONTAIN the string property with the name secondPropertyName.

propertiesEqual(String, String) - Static method in class com.scaleout.client.caching.query.FilterFactory

The two properties of matching objects must be EQUAL.

propertiesGreaterOrEqual(String, String) - Static method in class com.scaleout.client.caching.query.FilterFactory

The value of the property of the matching objects with the name firstPropertyName must be GREATER than OR EQUAL to that of the property with the name secondPropertyName.

propertiesGreaterThan(String, String) - Static method in class com.scaleout.client.caching.query.FilterFactory

The value of the property of the matching objects with the name firstPropertyName must be GREATER than that of the property with the name secondPropertyName.

propertiesLessOrEqual(String, String) - Static method in class com.scaleout.client.caching.query.FilterFactory

The value of the property of the matching objects with the name firstPropertyName must be LESS than OR EQUAL to that of the property with the name secondPropertyName.

propertiesLessThan(String, String) - Static method in class com.scaleout.client.caching.query.FilterFactory

The value of the property of the matching objects with the name firstPropertyName must be LESS than that of the property with the name secondPropertyName.

propertiesNotEqual(String, String) - Static method in class com.scaleout.client.caching.query.FilterFactory

The two properties of matching objects must NOT be EQUAL.

PropertyInvocationException - Exception Class in com.scaleout.client.caching.query

Thrown if an error occurs while parsing a class annotated with CacheObjectAttribute.

PropertyInvocationException(String, Throwable) - Constructor for exception class com.scaleout.client.caching.query.PropertyInvocationException

Construct the exception.

ProxyFound - Enum constant in enum class com.scaleout.client.caching.RequestStatus

Note, requires GeoServer Pro.

put(byte[], String) - Method in class com.scaleout.client.caching.StringKeyCache

Add an item to this in-process string key cache

put(ClientCacheEntry<K, V>) - Method in class com.scaleout.client.caching.ClientCache

Add an element to the client cache.

Q

queryKeys(Filter, Class<C>) - Method in class com.scaleout.client.caching.Cache

Query the objects in this Cache with the parameter filter returning an iterable of Cache keys.

queryObjects(Filter, Class<C>) - Method in class com.scaleout.client.caching.Cache

Query the objects in this Cache with the parameter filter.

R

raiseServiceEventForReadThrough() - Method in class com.scaleout.client.caching.CacheBuilder

Tell the ScaleOut StateServer service to raise events for read through.

read(K) - Method in class com.scaleout.client.caching.Cache

Read an object from the ScaleOut cache.

read(K, ReadPolicy) - Method in class com.scaleout.client.caching.Cache

Read a locked object from the ScaleOut cache.

readAndLock(K) - Method in class com.scaleout.client.caching.Cache

Read an object from the ScaleOut cache and acquire an exclusive lock for that object.

readAndLock(K, ReadPolicy) - Method in class com.scaleout.client.caching.Cache

Read an object from the ScaleOut cache and acquire an exclusive lock for that object using a custom read policy.

readAndLockAsync(K) - Method in class com.scaleout.client.caching.Cache

Asynchronously read an object from the ScaleOut cache and acquire an exclusive lock for that object.

readAndLockAsync(K, ReadPolicy) - Method in class com.scaleout.client.caching.Cache

Asynchronously read an object from the ScaleOut cache and acquire an exclusive lock for that object using a custom read policy.

readAsync(K) - Method in class com.scaleout.client.caching.Cache

Asynchronously read an object from the ScaleOut cache.

readAsync(K, ReadPolicy) - Method in class com.scaleout.client.caching.Cache

Asynchronously read a locked object from the ScaleOut cache.

readLocked(K, LockToken) - Method in class com.scaleout.client.caching.Cache

Read a locked object from the ScaleOut cache.

readLocked(K, LockToken, ReadPolicy) - Method in class com.scaleout.client.caching.Cache

Read a locked object from the ScaleOut cache with a custom read policy.

readLockedAsync(K, LockToken) - Method in class com.scaleout.client.caching.Cache

Asynchronously read a locked object from the ScaleOut cache.

readLockedAsync(K, LockToken, ReadPolicy) - Method in class com.scaleout.client.caching.Cache

Asynchronously read a locked object from the ScaleOut cache with a custom read policy.

readOrAdd(K, ValueFactory<K, V>, ReadPolicy) - Method in class com.scaleout.client.caching.Cache

Read an object from the ScaleOut cache.

readOrAddAsync(K, ValueFactory<K, V>, ReadPolicy) - Method in class com.scaleout.client.caching.Cache

Read an object from the ScaleOut cache.

ReadPending - Enum constant in enum class com.scaleout.client.caching.RequestStatus

The read request is pending.

ReadPolicy - Class in com.scaleout.client.caching

The ReadPolicy specifies per-object policy information when reading objects from a ScaleOut in-memory data grid.

ReadPolicyBuilder - Class in com.scaleout.client.caching

The ReadPolicyBuilder class is used to create immutable ReadPolicy objects.

ReadPolicyBuilder() - Constructor for class com.scaleout.client.caching.ReadPolicyBuilder

Construct a builder.

Reference - Enum constant in enum class com.scaleout.client.caching.ClientCacheOptions

Returns a reference to the object.

RefreshAhead - Enum constant in enum class com.scaleout.client.caching.BackingStoreMode

The server should periodically notify client code that the object needs to be refreshed in the cache.

refreshLock(K, LockToken) - Method in class com.scaleout.client.caching.Cache

Refresh a lock on an object within the ScaleOut cache.

refreshLockAsync(K, LockToken) - Method in class com.scaleout.client.caching.Cache

Asynchronously refresh a lock on an object within the ScaleOut cache.

Remote - Enum constant in enum class com.scaleout.client.caching.GeoServerReadMode

Indicates that the caller has configured GeoServer for "pull" replication and wants to force the local store to read the object from the remote store (rather than reading from a local proxy of the object).

remove(K) - Method in class com.scaleout.client.caching.Cache

Remove an object from the ScaleOut cache.

remove(K) - Method in class com.scaleout.client.caching.ClientCache

Remove an entry from the client cache.

Remove - Enum constant in enum class com.scaleout.client.caching.CacheEntryDisposition

The client would like the object removed from the store.

removeAsync(K) - Method in class com.scaleout.client.caching.Cache

Asynchronously remove an object from the ScaleOut cache.

removeLocked(K, LockToken) - Method in class com.scaleout.client.caching.Cache

Remove a locked object from the ScaleOut cache.

removeLockedAsync(K, LockToken) - Method in class com.scaleout.client.caching.Cache

Asynchronously remove a locked object from the ScaleOut cache.

removeOptimistic(K, VersionToken) - Method in class com.scaleout.client.caching.Cache

Remove an optimistically locked object from the ScaleOut cache.

removeTags(String...) - Method in class com.scaleout.client.caching.query.TaggableObject

Removes the tags specified in the tags from object's tag list.

RequestStatus - Enum Class in com.scaleout.client.caching

The RequestStatus provides details on the status of a caching request.

ResetOnUpdate - Enum constant in enum class com.scaleout.client.caching.TimeoutType

The object's timeout is reset when the object is updated, but it is not reset if the object is read.

S

Save - Enum constant in enum class com.scaleout.client.caching.CacheEntryDisposition

The client would like to keep the object in the store.

SerializationException - Exception Class in com.scaleout.client.caching

The SerializationException indicates that an error occurred while serializing a value to the ScaleOut in-memory data grid.

SerializationException(String) - Constructor for exception class com.scaleout.client.caching.SerializationException

Instantiates a SerializationException with a message.

SerializationException(String, Exception) - Constructor for exception class com.scaleout.client.caching.SerializationException

Instantiates a SerializationException with a message and an Exception cause.

serialize(V) - Method in class com.scaleout.client.caching.CacheSerializer

Serialize a V object into a byte[].

serialize(V) - Method in class com.scaleout.client.caching.CacheValueSerializer

Serializes an object using an ObjectOutputStream.

ServiceEvents - Class in com.scaleout.client

Manages event callback registration for Cache instances.

ServiceEventsException - Exception Class in com.scaleout.client

Indicates that an error occurred while connecting to the ScaleOut in-memory data grid.

ServiceEventsException(String) - Constructor for exception class com.scaleout.client.ServiceEventsException

Constructs a new ServiceEventsException with the specified detail message.

ServiceEventsException(String, Exception) - Constructor for exception class com.scaleout.client.ServiceEventsException

Constructs a new GridConnectException with the specified detail message and cause.

setBackingStoreEventInterval(Duration) - Method in class com.scaleout.client.caching.CreatePolicyBuilder

Configuration option for the backing store event interval.

setBackingStoreMode(BackingStoreMode) - Method in class com.scaleout.client.caching.CreatePolicyBuilder

Configuration option for the BackingStoreMode.

setEraseObjectHandler(Cache<K, V>, CacheEntryEraseHandler<K, V>) - Static method in class com.scaleout.client.ServiceEvents

Sets a CacheEntryEraseHandler for the target cache.

setExpirationHandler(Cache<K, V>, CacheEntryExpirationHandler<K, V>) - Static method in class com.scaleout.client.ServiceEvents

Sets a CacheEntryExpirationHandler for the target Cache.

setGeoServerCoherencyInterval(Duration) - Method in class com.scaleout.client.caching.CreatePolicyBuilder

Configuration option for the GeoServer coherency interval for polling operations.

setGeoServerCoherencyInterval(Duration) - Method in class com.scaleout.client.caching.ReadPolicyBuilder

Configuration option for the GeoServer coherency interval for polling operations.

setGeoServerCoherencyPolicy(GeoServerCoherencyPolicy) - Method in class com.scaleout.client.caching.CreatePolicyBuilder

Configuration option for GeoServerCoherencyPolicy.

setGeoServerCoherencyPolicy(GeoServerCoherencyPolicy) - Method in class com.scaleout.client.caching.ReadPolicyBuilder

Configuration option for GeoServerCoherencyPolicy.

setGeoserverPullPolicy(GeoServerPullPolicy) - Method in class com.scaleout.client.caching.ReadPolicyBuilder

Configuration option for the GeoServerPullPolicy.

setGeoServerPullPolicy(GeoServerPullPolicy) - Method in class com.scaleout.client.caching.CreatePolicyBuilder

Configuration option for the GeoServerPullPolicy.

setGeoserverPushPolicy(GeoServerPushPolicy) - Method in class com.scaleout.client.caching.ReadPolicyBuilder

Configuration option for the GeoServerPushPolicy.

setGeoServerPushPolicy(GeoServerPushPolicy) - Method in class com.scaleout.client.caching.CreatePolicyBuilder

Configuration option for the GeoServerPushPolicy.

setGeoserverReadMode(GeoServerReadMode) - Method in class com.scaleout.client.caching.ReadPolicyBuilder

Configuration option for the GeoServerReadMode.

setLoadObjectHandler(Cache<K, V>, ValueFactory<K, V>) - Static method in class com.scaleout.client.ServiceEvents

Sets a ValueFactory for loading objects into the target Cache.

setMaxReadThroughAttempts(int) - Method in class com.scaleout.client.caching.CacheBuilder

Specify the number of max read through attempts.

setMaxRegisterRemoteStoreNameAttempts(int) - Method in class com.scaleout.client.caching.CacheBuilder

Specifies the number of attempts to retry setting the remote store.

setObjectTimeout(Duration) - Method in class com.scaleout.client.caching.CreatePolicyBuilder

Configuration option for object timeout.

setObjectTimeoutType(TimeoutType) - Method in class com.scaleout.client.caching.CreatePolicyBuilder

Configuration option for the TimeoutType.

setPreemptionPriority(PreemptionPriority) - Method in class com.scaleout.client.caching.CreatePolicyBuilder

Configuration option for the PreemptionPriority.

setReadThroughRetryInterval(Duration) - Method in class com.scaleout.client.caching.CacheBuilder

Specify the amount of time the client will wait during a read through attempt.

setRegisterRemoteStoreRetryInterval(Duration) - Method in class com.scaleout.client.caching.CacheBuilder

Specifies the number of attempts to retry setting the remote store.

setStoreObjectHandler(Cache<K, V>, CacheEntryStoreHandler<K, V>) - Static method in class com.scaleout.client.ServiceEvents

Sets a CacheEntryStoreHandler for the target cache.

size() - Method in class com.scaleout.client.caching.ClientCacheEntry

Retrieve the size of the object (in bytes).

Sliding - Enum constant in enum class com.scaleout.client.caching.TimeoutType

The object uses a sliding timeout that is reset every time an object is accessed (either updated or read).

store(K, V) - Method in interface com.scaleout.client.caching.CacheEntryStoreHandler

Callback that writes the provided object to a backing store.

StringKeyCache - Class in com.scaleout.client.caching

Maintains an in-process cache of string keys.

StringKeyCache(GridConnection, String, int, boolean) - Constructor for class com.scaleout.client.caching.StringKeyCache

Instantiate the string key cache with a grid connection, name, max size, and record if legacy string (unicode) keys are in use.

StringKeyEncoder - Class in com.scaleout.client.caching

The StringKeyEncoder is an implementation of a KeyEncoder for String keys that is not compatible with the SOSS-JNC API.

StringKeyEncoder(StringKeyCache) - Constructor for class com.scaleout.client.caching.StringKeyEncoder

Instantiate a string key encoder with a string key cache.

Success - Enum constant in enum class com.scaleout.client.caching.RequestStatus

The cache operation completed successfully.

T

Taggable - Interface in com.scaleout.client.caching.query

Objects of classes implementing this interface can hold arbitrary tags scoped by the object's Cache.

TaggableObject - Class in com.scaleout.client.caching.query

An implementation of Taggable.

TaggableObject() - Constructor for class com.scaleout.client.caching.query.TaggableObject

Construct the taggable object.

Timeout - Enum constant in enum class com.scaleout.client.caching.RequestStatus

The request timed out.

TimeoutType - Enum Class in com.scaleout.client.caching

The TimeoutType enum is used to indicate the type of timeout an object uses.

U

unlock(K, LockToken) - Method in class com.scaleout.client.caching.Cache

Unlock a locked object within the ScaleOut cache.

unlockAsync(K, LockToken) - Method in class com.scaleout.client.caching.Cache

Asynchronously unlock a locked object within the ScaleOut cache.

update(K, V) - Method in class com.scaleout.client.caching.Cache

Update an object in the ScaleOut cache.

update(K, V, CreatePolicy) - Method in class com.scaleout.client.caching.Cache

Update an object in the ScaleOut cache.

updateAndRetainLock(K, V, LockToken) - Method in class com.scaleout.client.caching.Cache

Update a locked object in the ScaleOut cache and retain exclusive access to the object through a lock.

updateAndRetainLock(K, V, LockToken, CreatePolicy) - Method in class com.scaleout.client.caching.Cache

Update a locked object in the ScaleOut cache and retain exclusive access to the object through a lock.

updateAndRetainLockAsync(K, V, LockToken) - Method in class com.scaleout.client.caching.Cache

Asynchronously update a locked object in the ScaleOut cache and retain exclusive access to the object through a lock.

updateAndRetainLockAsync(K, V, LockToken, CreatePolicy) - Method in class com.scaleout.client.caching.Cache

Asynchronously update a locked object in the ScaleOut cache and retain exclusive access to the object through a lock.

updateAndUnlock(K, V, LockToken) - Method in class com.scaleout.client.caching.Cache

Update a locked object in the ScaleOut cache and unlock the object.

updateAndUnlock(K, V, LockToken, CreatePolicy) - Method in class com.scaleout.client.caching.Cache

Update a locked object in the ScaleOut cache and unlock the object.

updateAndUnlockAsync(K, V, LockToken) - Method in class com.scaleout.client.caching.Cache

Asynchronously update a locked object in the ScaleOut cache and unlock the object.

updateAndUnlockAsync(K, V, LockToken, CreatePolicy) - Method in class com.scaleout.client.caching.Cache

Asynchronously update a locked object in the ScaleOut cache and release exclusive access to the object.

updateAsync(K, V) - Method in class com.scaleout.client.caching.Cache

Asynchronously update an object in the ScaleOut cache.

updateAsync(K, V, CreatePolicy) - Method in class com.scaleout.client.caching.Cache

Asynchronously update an object in the ScaleOut cache.

updateOptimistic(K, V, VersionToken) - Method in class com.scaleout.client.caching.Cache

Update an object in the ScaleOut cache.

updateOptimistic(K, V, VersionToken, CreatePolicy) - Method in class com.scaleout.client.caching.Cache

Update an object in the ScaleOut cache.

useAsyncReadThrough() - Method in class com.scaleout.client.caching.CacheBuilder

Check to see if service events should raise an event for read through

UuidKeyEncoder - Class in com.scaleout.client.caching

The UuidKeyEncoder is an implementation of a KeyEncoder for UUID keys compatible with the SOSS-JNC API.

UuidKeyEncoder() - Constructor for class com.scaleout.client.caching.UuidKeyEncoder

Construct a key encoder for UUID keys.

V

value() - Method in class com.scaleout.client.caching.LockToken

Retrieve the LockToken value

value() - Element in annotation interface com.scaleout.client.caching.query.CacheObjectAttribute

Indicates the priority of an item annotated with CacheObjectAttribute for using the limited slots (8 total slots) in the in-memory data grid property index hash table.

ValueFactory<K,V> - Interface in com.scaleout.client.caching

Call back used to load objects into a Cache.

ValueFactoryResult<V> - Class in com.scaleout.client.caching

Created by a ValueFactory implementation.

ValueFactoryResult(V) - Constructor for class com.scaleout.client.caching.ValueFactoryResult

Creates a value factory result with the loaded value.

ValueFactoryResult(V, CreatePolicy) - Constructor for class com.scaleout.client.caching.ValueFactoryResult

Creates a value factory result with a value and a custom create policy.

ValueFactoryResult(V, CreatePolicy, TagHolder) - Constructor for class com.scaleout.client.caching.ValueFactoryResult

Creates a value factory result with a value, a custom create policy, and a tag holder for query.

valueOf(String) - Static method in enum class com.scaleout.client.caching.BackingStoreMode

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.scaleout.client.caching.CacheEntryDisposition

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.scaleout.client.caching.ClientCacheOptions

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.scaleout.client.caching.GeoServerCoherencyPolicy

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.scaleout.client.caching.GeoServerPullPolicy

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.scaleout.client.caching.GeoServerPushPolicy

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.scaleout.client.caching.GeoServerReadMode

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.scaleout.client.caching.PreemptionPriority

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.scaleout.client.caching.query.HashIndexPriority

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.scaleout.client.caching.RequestStatus

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.scaleout.client.caching.TimeoutType

Returns the enum constant of this class with the specified name.

values() - Static method in enum class com.scaleout.client.caching.BackingStoreMode

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.scaleout.client.caching.CacheEntryDisposition

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.scaleout.client.caching.ClientCacheOptions

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.scaleout.client.caching.GeoServerCoherencyPolicy

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.scaleout.client.caching.GeoServerPullPolicy

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.scaleout.client.caching.GeoServerPushPolicy

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.scaleout.client.caching.GeoServerReadMode

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.scaleout.client.caching.PreemptionPriority

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.scaleout.client.caching.query.HashIndexPriority

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.scaleout.client.caching.RequestStatus

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.scaleout.client.caching.TimeoutType

Returns an array containing the constants of this enum class, in the order they are declared.

version() - Method in class com.scaleout.client.caching.VersionToken

Retrieve the version number of this VersionToken

VersionToken - Class in com.scaleout.client.caching

The VersionToken is an identifier for the version of an object stored in the ScaleOut in-memory data grid.

VersionToken() - Constructor for class com.scaleout.client.caching.VersionToken

Default constructor.

W

WriteBehind - Enum constant in enum class com.scaleout.client.caching.BackingStoreMode

The server should periodically notify client code that the cached object needs to be written to a persistent backing store.

WrongClient - Enum constant in enum class com.scaleout.client.caching.RequestStatus

The ScaleOut cache rejected the request because the client was invalid.

WrongEpoch - Enum constant in enum class com.scaleout.client.caching.RequestStatus

The event channel was established against an older version of the server.

_

_hasValue - Variable in class com.scaleout.client.caching.LockToken

Flag to indicate if this lock token has a value.

_hasValue - Variable in class com.scaleout.client.caching.VersionToken

Flag to indicate if this version token has a value.

_key - Variable in class com.scaleout.client.caching.ClientCacheEntry

The key.

_lockToken - Variable in class com.scaleout.client.caching.ClientCacheEntry

The lock token.

_serializedValueSize - Variable in class com.scaleout.client.caching.ClientCacheEntry

The serialized size (in bytes).

_timestamp - Variable in class com.scaleout.client.caching.ClientCacheEntry

the timewhen this entry was created.

_value - Variable in class com.scaleout.client.caching.ClientCacheEntry

The value.

_value - Variable in class com.scaleout.client.caching.LockToken

The value of this lock token.

_version - Variable in class com.scaleout.client.caching.VersionToken

The value of this version token.

_versionToken - Variable in class com.scaleout.client.caching.ClientCacheEntry

The version token.