Class Cache<K,V>

Method Details

• add

  public abstract CacheResponse<K,V> add(K key, V value) throws CacheException

  Add an object to the ScaleOut cache.

  The object is successfully added when CacheResponse.getStatus() returns RequestStatus.ObjectAdded.

  The object must not exist when calling add. If the object may already exists and the client should update the object, use addOrUpdate(Object, Object).

  If the object already exists, or is added by another client (or thread), the CacheResponse.getStatus() will return RequestStatus.ObjectExists.

  The CreatePolicy as defined by the CacheBuilder will be used.

  IllegalArgumentException is thrown if the key or value are null.

  Parameters:

  key - the unique identifier for this object.

  value - the object to add to the ScaleOut cache.

  Returns:

  a CacheResponse.

  Throws:

  CacheException - The cache will automatically retry the request if no ScaleOut gateways are available. If all retries are exhausted, a CacheException will be thrown.

• add

  public abstract CacheResponse<K,V> add(K key, V value, List<K> parentKeys) throws CacheException

  Add an object to the ScaleOut cache.

  The object is successfully added when CacheResponse.getStatus() returns RequestStatus.ObjectAdded.

  The object must not exist when calling add. If the object may already exists and the client should update the object, use addOrUpdate(Object, Object).

  If the object already exists, or is added by another client (or thread), the CacheResponse.getStatus() will return RequestStatus.ObjectExists.

  The CreatePolicy as defined by the CacheBuilder will be used.

  IllegalArgumentException is thrown if the key or value are null.

  Parameters:

  key - the unique identifier for this object.

  value - the object to add to the ScaleOut cache.

  parentKeys - the parent keys of which this object should be a child.

  Returns:

  a CacheResponse.

  Throws:

  CacheException - The cache will automatically retry the request if no ScaleOut gateways are available. If all retries are exhausted, a CacheException will be thrown.

• addAndLock

  public abstract CacheResponse<K,V> addAndLock(K key, V value) throws CacheException

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

  The object is successfully added when CacheResponse.getStatus() returns RequestStatus.ObjectAddedAndLocked and the CacheResponse.getLockToken() will have a value.

  The object must not exist when calling addExclusive.

  If the object already exists, or is added by another client (or thread), the CacheResponse.getStatus() will return RequestStatus.ObjectExists.

  The CreatePolicy as defined by the CacheBuilder will be used.

  IllegalArgumentException is thrown if the key or value are null.

  Parameters:

  key - the unique identifier for this object.

  value - the object to add to the ScaleOut cache.

  Returns:

  a CacheResponse.

  Throws:

  CacheException - The cache will automatically retry the request if no ScaleOut gateways are available. If all retries are exhausted, a CacheException will be thrown.

• addOrUpdate

  public abstract CacheResponse<K,V> addOrUpdate(K key, V value) throws CacheException

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

  The object is successfully added when CacheResponse.getStatus() returns RequestStatus.ObjectAdded and the object is successfully updated when CacheResponse.getStatus() returns RequestStatus.ObjectUpdated.

  The CreatePolicy as defined by the CacheBuilder will be used.

  IllegalArgumentException is thrown if the key or value are null.

  Parameters:

  key - the unique identifier for this object.

  value - the object to add to the ScaleOut cache.

  Returns:

  a CacheResponse.

  Throws:

  CacheException - The cache will automatically retry the request if no ScaleOut gateways are available. If all retries are exhausted, a CacheException will be thrown.

• update

  public abstract CacheResponse<K,V> update(K key, V value) throws CacheException

  Update an object in the ScaleOut cache.

  The object is successfully updated when CacheResponse.getStatus() returns RequestStatus.ObjectUpdated.

  The object must exist in the ScaleOut cache. If the object does not exist, CacheResponse.getStatus() returns RequestStatus.ObjectNotFound.

  Supplying a null value will remove the object from the ScaleOut cache.

  The CreatePolicy as defined by the CacheBuilder will be used.

  IllegalArgumentException is thrown if the key is null.

  Parameters:

  key - the unique identifier for this object.

  value - the object to update in the ScaleOut cache. Provide null if the object should be removed.

  Returns:

  a CacheResponse.

  Throws:

  CacheException - The cache will automatically retry the request if no ScaleOut gateways are available. If all retries are exhausted, a CacheException will be thrown.

• updateAndRetainLock

  public abstract CacheResponse<K,V> updateAndRetainLock(K key, V value, LockToken lockToken) throws CacheException

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

  A lock on an object is acquired through addExclusive, lock, or readAndLock.

  The object is successfully updated when CacheResponse.getStatus() returns RequestStatus.ObjectUpdatedAndLockRetained.

  The object must exist in the ScaleOut cache. If the object does not exist, CacheResponse.getStatus() returns RequestStatus.ObjectNotFound.

  Supplying a null value will remove the object from the ScaleOut cache. Note, the remove attempt will not bypass the lock. This means the lock token must be the appropriate lock in order to successfully remove the object.

  The CreatePolicy as defined by the CacheBuilder will be used.

  IllegalArgumentException is thrown if the key is null, the lock token is null, or the lock token has no value.

  Parameters:

  key - the unique identifier for this object.

  value - the object to update in the ScaleOut cache. Provide null if the object should be removed.

  lockToken - the LockToken to use.

  Returns:

  a CacheResponse.

  Throws:

  CacheException - The cache will automatically retry the request if no ScaleOut gateways are available. If all retries are exhausted, a CacheException will be thrown.

• updateAndUnlock

  public abstract CacheResponse<K,V> updateAndUnlock(K key, V value, LockToken lockToken) throws CacheException

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

  A lock on an object is acquired through addExclusive, lock, or readAndLock.

  The object is successfully updated when CacheResponse.getStatus() returns RequestStatus.ObjectUpdatedAndUnlocked.

  The object must exist in the ScaleOut cache. If the object does not exist, CacheResponse.getStatus() returns RequestStatus.ObjectNotFound.

  Supplying a null value will remove the object from the ScaleOut cache. Note, the remove attempt will not bypass the lock. This means the lock token must be the appropriate lock in order to successfully remove the object.

  The CreatePolicy as defined by the CacheBuilder will be used.

  IllegalArgumentException is thrown if the key is null, the lock token is null, or the lock token has no value.

  Parameters:

  key - the unique identifier for this object.

  value - the object to update in the ScaleOut cache. Provide null if the object should be removed.

  lockToken - the LockToken to use.

  Returns:

  a CacheResponse.

  Throws:

  CacheException - The cache will automatically retry the request if no ScaleOut gateways are available. If all retries are exhausted, a CacheException will be thrown.

• add

  public abstract CacheResponse<K,V> add(K key, V value, CreatePolicy policy) throws CacheException

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

  Specify a custom CreatePolicy to adjust object metadata such as TimeoutType, GeoServerReadMode, and other properties.

  The object is successfully added when CacheResponse.getStatus() returns RequestStatus.ObjectAdded.

  The object must not exist when calling add. If the object may already exists and the client should update the object, use addOrUpdate(Object, Object).

  If the object already exists, or is added by another client (or thread), the CacheResponse.getStatus() will return RequestStatus.ObjectExists.

  IllegalArgumentException is thrown if the key or value are null.

  Parameters:

  key - the unique identifier for this object.

  value - the object to add to the ScaleOut cache.

  policy - the policy to use.

  Returns:

  a CacheResponse.

  Throws:

  CacheException - The cache will automatically retry the request if no ScaleOut gateways are available. If all retries are exhausted, a CacheException will be thrown.

• add

  public abstract CacheResponse<K,V> add(K key, V value, CreatePolicy policy, List<K> parentKeys) throws CacheException

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

  Specify a custom CreatePolicy to adjust object metadata such as TimeoutType, GeoServerReadMode, and other properties.

  The object is successfully added when CacheResponse.getStatus() returns RequestStatus.ObjectAdded.

  The object must not exist when calling add. If the object may already exists and the client should update the object, use addOrUpdate(Object, Object).

  If the object already exists, or is added by another client (or thread), the CacheResponse.getStatus() will return RequestStatus.ObjectExists.

  IllegalArgumentException is thrown if the key or value are null.

  Parameters:

  key - the unique identifier for this object.

  value - the object to add to the ScaleOut cache.

  policy - the policy to use.

  parentKeys - the parent keys to which this object should be a dependant.

  Returns:

  a CacheResponse.

  Throws:

  CacheException - The cache will automatically retry the request if no ScaleOut gateways are available. If all retries are exhausted, a CacheException will be thrown.

• addAndLock

  public abstract CacheResponse<K,V> addAndLock(K key, V value, CreatePolicy policy) throws CacheException

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

  Specify a custom CreatePolicy to adjust object metadata such as TimeoutType, GeoServerReadMode, and other properties.

  The object is successfully added when CacheResponse.getStatus() returns RequestStatus.ObjectAddedAndLocked and the CacheResponse.getLockToken() will have a value.

  The object must not exist when calling addExclusive.

  If the object already exists, or is added by another client (or thread), the CacheResponse.getStatus() will return RequestStatus.ObjectExists.

  IllegalArgumentException is thrown if the key, value, or create policy are null.

  Parameters:

  key - the unique identifier for this object.

  value - the object to add to the ScaleOut cache.

  policy - the policy to use.

  Returns:

  a CacheResponse.

  Throws:

  CacheException - The cache will automatically retry the request if no ScaleOut gateways are available. If all retries are exhausted, a CacheException will be thrown.

• addOrUpdate

  public abstract CacheResponse<K,V> addOrUpdate(K key, V value, CreatePolicy policy) throws CacheException

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

  Specify a custom CreatePolicy to adjust object metadata such as TimeoutType, GeoServerReadMode, and other properties.

  The object is successfully added when CacheResponse.getStatus() returns RequestStatus.ObjectAdded and the object is successfully updated when CacheResponse.getStatus() returns RequestStatus.ObjectUpdated.

  IllegalArgumentException is thrown if the key or value are null.

  Parameters:

  key - the unique identifier for this object.

  value - the object to add to the ScaleOut cache.

  policy - the policy to use.

  Returns:

  a CacheResponse.

  Throws:

  CacheException - The cache will automatically retry the request if no ScaleOut gateways are available. If all retries are exhausted, a CacheException will be thrown.

• update

  public abstract CacheResponse<K,V> update(K key, V value, CreatePolicy policy) throws CacheException

  Update an object in the ScaleOut cache.

  Specify a custom CreatePolicy to adjust object metadata such as TimeoutType, GeoServerReadMode, and other properties.

  The object is successfully updated when CacheResponse.getStatus() returns RequestStatus.ObjectUpdated.

  The object must exist in the ScaleOut cache. If the object does not exist, CacheResponse.getStatus() returns RequestStatus.ObjectNotFound.

  Supplying a null value will remove the object from the ScaleOut cache.

  IllegalArgumentException is thrown if the key or create policy are null.

  Parameters:

  key - the unique identifier for this object.

  value - the object to update in the ScaleOut cache. Provide null if the object should be removed.

  policy - the policy to use.

  Returns:

  a CacheResponse.

  Throws:

  CacheException - The cache will automatically retry the request if no ScaleOut gateways are available. If all retries are exhausted, a CacheException will be thrown.

• updateOptimistic

  public abstract CacheResponse<K,V> updateOptimistic(K key, V value, VersionToken token) throws CacheException

  Update an object in the ScaleOut cache.

  If the version token supplied matches the version of the object stored in the cache then the object will be updated. Otherwise the operation will return RequestStatus.ObjectVersionMismatch.

  The object is successfully updated when CacheResponse.getStatus() returns RequestStatus.ObjectUpdated.

  Parameters:

  key - the unique identifier for this object.

  value - the object to update in the ScaleOut cache. Provide null if the object should be removed.

  token - the VersionToken to use.

  Returns:

  a CacheResponse.

  Throws:

  CacheException - The cache will automatically retry the request if no ScaleOut gateways are available. If all retries are exhausted, a CacheException will be thrown.

• updateOptimistic

  public abstract CacheResponse<K,V> updateOptimistic(K key, V value, VersionToken token, CreatePolicy policy) throws CacheException

  Update an object in the ScaleOut cache.

  If the version token supplied matches the version of the object stored in the cache then the object will be updated. Otherwise the operation will return RequestStatus.ObjectVersionMismatch.

  Specify a custom CreatePolicy to adjust object metadata such as TimeoutType, GeoServerReadMode, and other properties.

  Parameters:

  key - the unique identifier for this object.

  value - the object to update in the ScaleOut cache. Provide null if the object should be removed.

  token - the VersionToken to use.

  policy - the policy to use.

  Returns:

  a CacheResponse.

  Throws:

  CacheException - The cache will automatically retry the request if no ScaleOut gateways are available. If all retries are exhausted, a CacheException will be thrown.

• updateAndRetainLock

  public abstract CacheResponse<K,V> updateAndRetainLock(K key, V value, LockToken lockToken, CreatePolicy policy) throws CacheException

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

  Specify a custom CreatePolicy to adjust object metadata such as TimeoutType, GeoServerReadMode, and other properties.

  A lock on an object is acquired through addExclusive, lock, or readAndLock.

  The object is successfully updated when CacheResponse.getStatus() returns RequestStatus.ObjectUpdatedAndLockRetained.

  The object must exist in the ScaleOut cache. If the object does not exist, CacheResponse.getStatus() returns RequestStatus.ObjectNotFound.

  Supplying a null value will remove the object from the ScaleOut cache. Note, the remove attempt will not bypass the lock. This means the lock token must be the appropriate lock in order to successfully remove the object.

  IllegalArgumentException is thrown if the key is null, the lock token is null, the lock token has no value, or the create policy is null.

  Parameters:

  key - the unique identifier for this object.

  value - the object to update in the ScaleOut cache. Provide null if the object should be removed.

  lockToken - the LockToken to use.

  policy - the policy to use.

  Returns:

  a CacheResponse.

  Throws:

  CacheException - The cache will automatically retry the request if no ScaleOut gateways are available. If all retries are exhausted, a CacheException will be thrown.

• updateAndUnlock

  public abstract CacheResponse<K,V> updateAndUnlock(K key, V value, LockToken lockToken, CreatePolicy policy) throws CacheException

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

  Specify a custom CreatePolicy to adjust object metadata such as TimeoutType, GeoServerReadMode, and other properties.

  A lock on an object is acquired through addExclusive, lock, or readAndLock.

  The object is successfully updated when CacheResponse.getStatus() returns RequestStatus.ObjectUpdatedAndUnlocked.

  The object must exist in the ScaleOut cache. If the object does not exist, CacheResponse.getStatus() returns RequestStatus.ObjectNotFound.

  Supplying a null value will remove the object from the ScaleOut cache. Note, the remove attempt will not bypass the lock. This means the lock token must be the appropriate lock in order to successfully remove the object.

  IllegalArgumentException is thrown if the key is null, the lock token is null, the lock token has no value, or the create policy is null.

  Parameters:

  key - the unique identifier for this object.

  value - the object to update in the ScaleOut cache. Null if the object should be removed.

  lockToken - the LockToken to use.

  policy - the policy to use.

  Returns:

  a CacheResponse.

  Throws:

  CacheException - The cache will automatically retry the request if no ScaleOut gateways are available. If all retries are exhausted, a CacheException will be thrown.

• read

  public abstract CacheResponse<K,V> read(K key) throws CacheException

  Read an object from the ScaleOut cache.

  The object is successfully retrieved when CacheResponse.getStatus() returns RequestStatus.ObjectRetrieved.

  The object must exist in the ScaleOut cache. If the object does not exist, CacheResponse.getStatus() returns RequestStatus.ObjectNotFound.

  The ReadPolicy as defined by the CacheBuilder will be used.

  IllegalArgumentException is thrown if the key is null.

  Parameters:

  key - the unique identifier for this object.

  Returns:

  a CacheResponse.

  Throws:

  CacheException - The cache will automatically retry the request if no ScaleOut gateways are available. If all retries are exhausted, a CacheException will be thrown.

• readAndLock

  public abstract CacheResponse<K,V> readAndLock(K key) throws CacheException

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

  The object is successfully retrieved when CacheResponse.getStatus() returns RequestStatus.ObjectRetrievedAndLocked.

  The LockToken is retrieved from the CacheResponse.getLockToken()

  The object must exist in the ScaleOut cache. If the object does not exist, CacheResponse.getStatus() returns RequestStatus.ObjectNotFound.

  The object was locked by another client/thread in the ScaleOut cache if CacheResponse.getStatus() returns RequestStatus.ObjectLocked.

  The ReadPolicy as defined by the CacheBuilder will be used.

  IllegalArgumentException is thrown if the key is null.

  Parameters:

  key - the unique identifier for this object.

  Returns:

  a CacheResponse.

  Throws:

  CacheException - The cache will automatically retry the request if no ScaleOut gateways are available. If all retries are exhausted, a CacheException will be thrown.

• readLocked

  public abstract CacheResponse<K,V> readLocked(K key, LockToken lockToken) throws CacheException

  Read a locked object from the ScaleOut cache.

  The object is successfully retrieved when CacheResponse.getStatus() returns RequestStatus.ObjectRetrievedAndLocked.

  A lock on an object is acquired through addExclusive, lock, or readAndLock.

  The refreshed LockToken is retrieved from the CacheResponse.getLockToken()

  The object must exist in the ScaleOut cache. If the object does not exist, CacheResponse.getStatus() returns RequestStatus.ObjectNotFound.

  The object was locked by another client/thread in the ScaleOut cache if CacheResponse.getStatus() returns RequestStatus.ObjectLocked.

  The ReadPolicy as defined by the CacheBuilder will be used.

  IllegalArgumentException is thrown if the key is null, the lock token is null, or the lock token has no value.

  Parameters:

  key - the unique identifier for this object.

  lockToken - the LockToken to use.

  Returns:

  a CacheResponse.

  Throws:

  CacheException - The cache will automatically retry the request if no ScaleOut gateways are available. If all retries are exhausted, a CacheException will be thrown.

• read

  public abstract CacheResponse<K,V> read(K key, ReadPolicy policy) throws CacheException

  Read a locked object from the ScaleOut cache.

  Specify a custom ReadPolicy to adjust read properties.

  The object is successfully retrieved when CacheResponse.getStatus() returns RequestStatus.ObjectRetrievedAndLocked.

  The object must exist in the ScaleOut cache. If the object does not exist, CacheResponse.getStatus() returns RequestStatus.ObjectNotFound.

  IllegalArgumentException is thrown if the key is null or ReadPolicy is null.

  Parameters:

  key - the unique identifier for this object.

  policy - the ReadPolicy to use.

  Returns:

  a CacheResponse.

  Throws:

  CacheException - The cache will automatically retry the request if no ScaleOut gateways are available. If all retries are exhausted, a CacheException will be thrown.

• readAndLock

  public abstract CacheResponse<K,V> readAndLock(K key, ReadPolicy policy) throws CacheException

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

  Specify a custom ReadPolicy to adjust read properties.

  The object is successfully retrieved when CacheResponse.getStatus() returns RequestStatus.ObjectRetrievedAndLocked.

  The LockToken is retrieved from the CacheResponse.getLockToken()

  The object must exist in the ScaleOut cache. If the object does not exist, CacheResponse.getStatus() returns RequestStatus.ObjectNotFound.

  The object was locked by another client/thread in the ScaleOut cache if CacheResponse.getStatus() returns RequestStatus.ObjectLocked.

  IllegalArgumentException is thrown if the key is null or ReadPolicy is null.

  Parameters:

  key - the unique identifier for this object.

  policy - the ReadPolicy to use.

  Returns:

  a CacheResponse.

  Throws:

  CacheException - The cache will automatically retry the request if no ScaleOut gateways are available. If all retries are exhausted, a CacheException will be thrown.

• readOrAdd

  public abstract CacheResponse<K,V> readOrAdd(K key, ValueFactory<K,V> factory, ReadPolicy policy) throws CacheException

  Read an object from the ScaleOut cache. If the object is not present, the parameter ValueFactory will be called and the value will be added. Once the value has been added, the newly added value will be returned.

  Specify a custom ReadPolicy to adjust read properties.

  The object is successfully retrieved when CacheResponse.getStatus() returns RequestStatus.ObjectRetrieved.

  IllegalArgumentException is thrown if the key, value factory, or read policy, are null.

  Parameters:

  key - the unique identifier for this object.

  factory - the ValueFactory to use.

  policy - the ReadPolicy to use.

  Returns:

  a CacheResponse.

  Throws:

  CacheException - The cache will automatically retry the request if no ScaleOut gateways are available. If all retries are exhausted, a CacheException will be thrown.

• readLocked

  public abstract CacheResponse<K,V> readLocked(K key, LockToken lockToken, ReadPolicy policy) throws CacheException

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

  Specify a custom ReadPolicy to adjust read properties.

  The object is successfully retrieved when CacheResponse.getStatus() returns RequestStatus.ObjectRetrievedAndLocked.

  A lock on an object is acquired through addExclusive, lock, or readAndLock.

  s

  The refreshed LockToken is retrieved from the CacheResponse.getLockToken()

  The object must exist in the ScaleOut cache. If the object does not exist, CacheResponse.getStatus() returns RequestStatus.ObjectNotFound.

  The object was locked by another client/thread in the ScaleOut cache if CacheResponse.getStatus() returns RequestStatus.ObjectLocked.

  IllegalArgumentException is thrown if the key is null, the lock token is null, the lock token has no value, or the ReadPolicy is null.

  Parameters:

  key - the unique identifier for this object.

  lockToken - the LockToken to use.

  policy - the ReadPolicy to use.

  Returns:

  a CacheResponse.

  Throws:

  CacheException - The cache will automatically retry the request if no ScaleOut gateways are available. If all retries are exhausted, a CacheException will be thrown.

• remove

  public abstract CacheResponse<K,V> remove(K key) throws CacheException

  Remove an object from the ScaleOut cache.

  The object is successfully removed when CacheResponse.getStatus() returns RequestStatus.ObjectRemoved.

  IllegalArgumentException is thrown if the key is null.

  Parameters:

  key - the unique identifier for this object.

  Returns:

  a CacheResponse.

  Throws:

  CacheException - The cache will automatically retry the request if no ScaleOut gateways are available. If all retries are exhausted, a CacheException will be thrown.

• removeLocked

  public abstract CacheResponse<K,V> removeLocked(K key, LockToken lockToken) throws CacheException

  Remove a locked object from the ScaleOut cache.

  The object is successfully removed when CacheResponse.getStatus() returns RequestStatus.ObjectRemoved.

  A lock on an object is acquired through addExclusive, lock, or readAndLock.

  The object was locked by another client/thread in the ScaleOut cache if CacheResponse.getStatus() returns RequestStatus.ObjectLocked.

  IllegalArgumentException is thrown if the key is null, the lock token is null, or the lock token has no value.

  Parameters:

  key - the unique identifier for this object.

  lockToken - the LockToken to use.

  Returns:

  a CacheResponse.

  Throws:

  CacheException - The cache will automatically retry the request if no ScaleOut gateways are available. If all retries are exhausted, a CacheException will be thrown.

• removeOptimistic

  public abstract CacheResponse<K,V> removeOptimistic(K key, VersionToken versionToken) throws CacheException

  Remove an optimistically locked object from the ScaleOut cache.

  The object is successfully removed when CacheResponse.getStatus() returns RequestStatus.ObjectRemoved.

  Parameters:

  key - the unique identifier for this object.

  versionToken - the VersionToken to use.

  Returns:

  a CacheResponse.

  Throws:

  CacheException - The cache will automatically retry the request if no ScaleOut gateways are available. If all retries are exhausted, a CacheException will be thrown.

• lock

  public abstract CacheResponse<K,V> lock(K key) throws CacheException

  Lock an object within the ScaleOut cache for exclusive access.

  The LockToken is retrieved from the CacheResponse.getLockToken()

  The object is successfully locked when CacheResponse.getStatus() returns RequestStatus.ObjectLocked.

  IllegalArgumentException is thrown if the key is null

  Parameters:

  key - the unique identifier for this object.

  Returns:

  a CacheResponse.

  Throws:

  CacheException - The cache will automatically retry the request if no ScaleOut gateways are available. If all retries are exhausted, a CacheException will be thrown.

• refreshLock

  public abstract CacheResponse<K,V> refreshLock(K key, LockToken lockToken) throws CacheException

  Refresh a lock on an object within the ScaleOut cache.

  The LockToken is retrieved from the CacheResponse.getLockToken()

  The lock is successfully refreshed when CacheResponse.getStatus() returns RequestStatus.ObjectLocked.

  A lock on an object is acquired through addExclusive, lock, or readAndLock.

  IllegalArgumentException is thrown if the key is null, the lock token is null, or the lock token has no value.

  Parameters:

  key - the unique identifier for this object.

  lockToken - the LockToken to use.

  Returns:

  a CacheResponse.

  Throws:

  CacheException - The cache will automatically retry the request if no ScaleOut gateways are available. If all retries are exhausted, a CacheException will be thrown.

• unlock

  public abstract CacheResponse<K,V> unlock(K key, LockToken lockToken) throws CacheException

  Unlock a locked object within the ScaleOut cache.

  A lock on an object is acquired through addExclusive, lock, or readAndLock.

  The object is successfully unlocked when CacheResponse.getStatus() returns RequestStatus.ObjectUnlocked.

  IllegalArgumentException is thrown if the key is null, the lock token is null, or the lock token has no value.

  Parameters:

  key - the unique identifier for this object.

  lockToken - the LockToken to use.

  Returns:

  a CacheResponse.

  Throws:

  CacheException - The cache will automatically retry the request if no ScaleOut gateways are available. If all retries are exhausted, a CacheException will be thrown.

• clear

  public abstract CacheResponse<K,V> clear() throws CacheException

  Clear all objects from the ScaleOut cache.

  The cache is successfully cleared when CacheResponse.getStatus() returns RequestStatus.CacheCleared.

  Returns:

  a CacheResponse.

  Throws:

  CacheException - The cache will automatically retry the request if no ScaleOut gateways are available. If all retries are exhausted, a CacheException will be thrown.

• queryObjects

  public abstract <C extends V> Iterable<V> queryObjects(Filter filter, Class<C> clazz) throws CacheException

  Query the objects in this Cache with the parameter filter.

  Filters are constructed using the FilterFactory

  Type Parameters:

  C - the value type.

  Parameters:

  filter - the filter.

  clazz - the class type.

  Returns:

  an iterable of 0 to many objects of type Cache.

  Throws:

  CacheException - The cache will automatically retry the request if no ScaleOut gateways are available. If all retries are exhausted, a CacheException will be thrown.

• queryKeys

  public abstract <C extends V> Iterable<K> queryKeys(Filter filter, Class<C> clazz) throws CacheException

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

  Filters are constructed using the FilterFactory

  Type Parameters:

  C - the value type.

  Parameters:

  filter - the filter.

  clazz - the class type.

  Returns:

  an iterable of 0 to many keys of type Cache.

  Throws:

  CacheException - The cache will automatically retry the request if no ScaleOut gateways are available. If all retries are exhausted, a CacheException will be thrown.

• getMetadata

  public abstract CacheResponse<K,CachedObjectMetadata<K>> getMetadata(K key) throws CacheException

  Retrieves CachedObjectMetadata for an object stored in the cache.

  Returns RequestStatus.ObjectRetrieved if the object exists.

  Returns RequestStatus.ObjectNotFound if the object does not exist.

  Parameters:

  key - the key to get metadata for.

  Returns:

  the metadata for the cache object.

  Throws:

  CacheException - The cache will automatically retry the request if no ScaleOut gateways are available. If all retries are exhausted, a CacheException will be thrown.

• addAsync

  public abstract CompletableFuture<CacheResponse<K,V>> addAsync(K key, V value) throws CacheException

  Asynchronously add an object to the ScaleOut cache.

  The object is successfully added when CacheResponse.getStatus() returns RequestStatus.ObjectAdded.

  The object must not exist when calling add. If the object may already exists and the client should update the object, use addOrUpdate(Object, Object).

  If the object already exists, or is added by another client (or thread), the CacheResponse.getStatus() will return RequestStatus.ObjectExists.

  The CreatePolicy as defined by the CacheBuilder will be used.

  IllegalArgumentException is thrown if the key or value are null.

  Parameters:

  key - the unique identifier for this object.

  value - the object to add to the ScaleOut cache.

  Returns:

  a CompletableFuture that returns a CacheResponse.

  Throws:

  CacheException - The cache will automatically retry the request if no ScaleOut gateways are available. If all retries are exhausted, a CacheException will be thrown.

• addAndLockAsync

  public abstract CompletableFuture<CacheResponse<K,V>> addAndLockAsync(K key, V value) throws CacheException

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

  The object is successfully added when CacheResponse.getStatus() returns RequestStatus.ObjectAddedAndLocked and the CacheResponse.getLockToken() will have a value.

  The object must not exist when calling addExclusive.

  If the object already exists, or is added by another client (or thread), the CacheResponse.getStatus() will return RequestStatus.ObjectExists.

  The CreatePolicy as defined by the CacheBuilder will be used.

  IllegalArgumentException is thrown if the key or value are null.

  Parameters:

  key - the unique identifier for this object.

  value - the object to add to the ScaleOut cache.

  Returns:

  a CompletableFuture that returns a CacheResponse.

  Throws:

  CacheException - The cache will automatically retry the request if no ScaleOut gateways are available. If all retries are exhausted, a CacheException will be thrown.

• addOrUpdateAsync

  public abstract CompletableFuture<CacheResponse<K,V>> addOrUpdateAsync(K key, V value) throws CacheException

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

  The object is successfully added when CacheResponse.getStatus() returns RequestStatus.ObjectAdded and the object is successfully updated when CacheResponse.getStatus() returns RequestStatus.ObjectUpdated.

  The CreatePolicy as defined by the CacheBuilder will be used.

  IllegalArgumentException is thrown if the key or value are null.

  Parameters:

  key - the unique identifier for this object.

  value - the object to add to the ScaleOut cache.

  Returns:

  a CompletableFuture that returns a CacheResponse.

  Throws:

  CacheException - The cache will automatically retry the request if no ScaleOut gateways are available. If all retries are exhausted, a CacheException will be thrown.

• updateAsync

  public abstract CompletableFuture<CacheResponse<K,V>> updateAsync(K key, V value) throws CacheException

  Asynchronously update an object in the ScaleOut cache.

  The object is successfully updated when CacheResponse.getStatus() returns RequestStatus.ObjectUpdated.

  The object must exist in the ScaleOut cache. If the object does not exist, CacheResponse.getStatus() returns RequestStatus.ObjectNotFound.

  Supplying a null value will remove the object from the ScaleOut cache.

  The CreatePolicy as defined by the CacheBuilder will be used.

  IllegalArgumentException is thrown if the key is null.

  Parameters:

  key - the unique identifier for this object.

  value - the object to update in the ScaleOut cache. Provide null if the object should be removed.

  Returns:

  a CompletableFuture that returns a CacheResponse.

  Throws:

  CacheException - The cache will automatically retry the request if no ScaleOut gateways are available. If all retries are exhausted, a CacheException will be thrown.

• updateAndRetainLockAsync

  public abstract CompletableFuture<CacheResponse<K,V>> updateAndRetainLockAsync(K key, V value, LockToken lockToken) throws CacheException

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

  A lock on an object is acquired through addExclusive, lock, or readAndLock.

  The object is successfully updated when CacheResponse.getStatus() returns RequestStatus.ObjectUpdatedAndLockRetained.

  The object must exist in the ScaleOut cache. If the object does not exist, CacheResponse.getStatus() returns RequestStatus.ObjectNotFound.

  Supplying a null value will remove the object from the ScaleOut cache. Note, the remove attempt will not bypass the lock. This means the lock token must be the appropriate lock in order to successfully remove the object.

  The CreatePolicy as defined by the CacheBuilder will be used.

  IllegalArgumentException is thrown if the key is null, the lock token is null, or the lock token has no value.

  Parameters:

  key - the unique identifier for this object.

  value - the object to update in the ScaleOut cache. Provide null if the object should be removed.

  lockToken - the LockToken to use.

  Returns:

  a CompletableFuture that returns a CacheResponse.

  Throws:

  CacheException - The cache will automatically retry the request if no ScaleOut gateways are available. If all retries are exhausted, a CacheException will be thrown.

• updateAndUnlockAsync

  public abstract CompletableFuture<CacheResponse<K,V>> updateAndUnlockAsync(K key, V value, LockToken lockToken) throws CacheException

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

  A lock on an object is acquired through addExclusive, lock, or readAndLock.

  The object is successfully updated when CacheResponse.getStatus() returns RequestStatus.ObjectUpdatedAndUnlocked.

  The object must exist in the ScaleOut cache. If the object does not exist, CacheResponse.getStatus() returns RequestStatus.ObjectNotFound.

  Supplying a null value will remove the object from the ScaleOut cache. Note, the remove attempt will not bypass the lock. This means the lock token must be the appropriate lock in order to successfully remove the object.

  The CreatePolicy as defined by the CacheBuilder will be used.

  IllegalArgumentException is thrown if the key is null, the lock token is null, or the lock token has no value.

  Parameters:

  key - the unique identifier for this object.

  value - the object to update in the ScaleOut cache. Provide null if the object should be removed.

  lockToken - the LockToken to use.

  Returns:

  a CompletableFuture that returns a CacheResponse.

  Throws:

  CacheException - The cache will automatically retry the request if no ScaleOut gateways are available. If all retries are exhausted, a CacheException will be thrown.

• addAsync

  public abstract CompletableFuture<CacheResponse<K,V>> addAsync(K key, V value, CreatePolicy policy) throws CacheException

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

  Specify a custom CreatePolicy to adjust object metadata such as TimeoutType, GeoServerReadMode, and other properties.

  The object is successfully added when CacheResponse.getStatus() returns RequestStatus.ObjectAdded.

  The object must not exist when calling add. If the object may already exists and the client should update the object, use addOrUpdate(Object, Object).

  If the object already exists, or is added by another client (or thread), the CacheResponse.getStatus() will return RequestStatus.ObjectExists.

  IllegalArgumentException is thrown if the key or value are null.

  Parameters:

  key - the unique identifier for this object.

  value - the object to add to the ScaleOut cache.

  policy - the policy to use.

  Returns:

  a CompletableFuture that returns a CacheResponse.

  Throws:

  CacheException - The cache will automatically retry the request if no ScaleOut gateways are available. If all retries are exhausted, a CacheException will be thrown.

• addAndLockAsync

  public abstract CompletableFuture<CacheResponse<K,V>> addAndLockAsync(K key, V value, CreatePolicy policy) throws CacheException

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

  Specify a custom CreatePolicy to adjust object metadata such as TimeoutType, GeoServerReadMode, and other properties.

  The object is successfully added when CacheResponse.getStatus() returns RequestStatus.ObjectAddedAndLocked and the CacheResponse.getLockToken() will have a value.

  The object must not exist when calling addExclusive.

  If the object already exists, or is added by another client (or thread), the CacheResponse.getStatus() will return RequestStatus.ObjectExists.

  IllegalArgumentException is thrown if the key, value, or create policy are null.

  Parameters:

  key - the unique identifier for this object.

  value - the object to add to the ScaleOut cache.

  policy - the policy to use.

  Returns:

  a CompletableFuture that returns a CacheResponse.

  Throws:

  CacheException - The cache will automatically retry the request if no ScaleOut gateways are available. If all retries are exhausted, a CacheException will be thrown.

• addOrUpdateAsync

  public abstract CompletableFuture<CacheResponse<K,V>> addOrUpdateAsync(K key, V value, CreatePolicy policy) throws CacheException

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

  Specify a custom CreatePolicy to adjust object metadata such as TimeoutType, GeoServerReadMode, and other properties.

  The object is successfully added when CacheResponse.getStatus() returns RequestStatus.ObjectAdded and the object is successfully updated when CacheResponse.getStatus() returns RequestStatus.ObjectUpdated.

  IllegalArgumentException is thrown if the key or value are null.

  Parameters:

  key - the unique identifier for this object.

  value - the object to add to the ScaleOut cache.

  policy - the policy to use.

  Returns:

  a CompletableFuture that returns a CacheResponse.

  Throws:

  CacheException - The cache will automatically retry the request if no ScaleOut gateways are available. If all retries are exhausted, a CacheException will be thrown.

• updateAsync

  public abstract CompletableFuture<CacheResponse<K,V>> updateAsync(K key, V value, CreatePolicy policy) throws CacheException

  Asynchronously update an object in the ScaleOut cache.

  Specify a custom CreatePolicy to adjust object metadata such as TimeoutType, GeoServerReadMode, and other properties.

  The object is successfully updated when CacheResponse.getStatus() returns RequestStatus.ObjectUpdated.

  The object must exist in the ScaleOut cache. If the object does not exist, CacheResponse.getStatus() returns RequestStatus.ObjectNotFound.

  Supplying a null value will remove the object from the ScaleOut cache.

  IllegalArgumentException is thrown if the key or create policy are null.

  Parameters:

  key - the unique identifier for this object.

  value - the object to update in the ScaleOut cache. Provide null if the object should be removed.

  policy - the policy to use.

  Returns:

  a CompletableFuture that returns a CacheResponse.

  Throws:

  CacheException - The cache will automatically retry the request if no ScaleOut gateways are available. If all retries are exhausted, a CacheException will be thrown.

• updateAndRetainLockAsync

  public abstract CompletableFuture<CacheResponse<K,V>> updateAndRetainLockAsync(K key, V value, LockToken lockToken, CreatePolicy policy) throws CacheException

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

  Specify a custom CreatePolicy to adjust object metadata such as TimeoutType, GeoServerReadMode, and other properties.

  A lock on an object is acquired through addExclusive, lock, or readAndLock.

  The object is successfully updated when CacheResponse.getStatus() returns RequestStatus.ObjectUpdatedAndLockRetained.

  The object must exist in the ScaleOut cache. If the object does not exist, CacheResponse.getStatus() returns RequestStatus.ObjectNotFound.

  Supplying a null value will remove the object from the ScaleOut cache. Note, the remove attempt will not bypass the lock. This means the lock token must be the appropriate lock in order to successfully remove the object.

  IllegalArgumentException is thrown if the key is null, the lock token is null, the lock token has no value, or the create policy is null.

  Parameters:

  key - the unique identifier for this object.

  value - the object to update in the ScaleOut cache. Provide null if the object should be removed.

  lockToken - the LockToken to use.

  policy - the policy to use.

  Returns:

  a CompletableFuture that returns a CacheResponse.

  Throws:

  CacheException - The cache will automatically retry the request if no ScaleOut gateways are available. If all retries are exhausted, a CacheException will be thrown.

• updateAndUnlockAsync

  public abstract CompletableFuture<CacheResponse<K,V>> updateAndUnlockAsync(K key, V value, LockToken lockToken, CreatePolicy policy) throws CacheException

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

  Specify a custom CreatePolicy to adjust object metadata such as TimeoutType, GeoServerReadMode, and other properties.

  A lock on an object is acquired through addExclusive, lock, or readAndLock.

  The object is successfully updated when CacheResponse.getStatus() returns RequestStatus.ObjectUpdatedAndUnlocked.

  The object must exist in the ScaleOut cache. If the object does not exist, CacheResponse.getStatus() returns RequestStatus.ObjectNotFound.

  Supplying a null value will remove the object from the ScaleOut cache. Note, the remove attempt will not bypass the lock. This means the lock token must be the appropriate lock in order to successfully remove the object.

  IllegalArgumentException is thrown if the key is null, the lock token is null, the lock token has no value, or the create policy is null.

  Parameters:

  key - the unique identifier for this object.

  value - the object to update in the ScaleOut cache. Null if the object should be removed.

  lockToken - the LockToken to use.

  policy - the policy to use.

  Returns:

  a CompletableFuture that returns a CacheResponse.

  Throws:

  CacheException - The cache will automatically retry the request if no ScaleOut gateways are available. If all retries are exhausted, a CacheException will be thrown.

• readAsync

  public abstract CompletableFuture<CacheResponse<K,V>> readAsync(K key) throws CacheException

  Asynchronously read an object from the ScaleOut cache.

  The object is successfully retrieved when CacheResponse.getStatus() returns RequestStatus.ObjectRetrieved.

  The object must exist in the ScaleOut cache. If the object does not exist, CacheResponse.getStatus() returns RequestStatus.ObjectNotFound.

  The ReadPolicy as defined by the CacheBuilder will be used.

  IllegalArgumentException is thrown if the key is null.

  Parameters:

  key - the unique identifier for this object.

  Returns:

  a CompletableFuture that returns a CacheResponse.

  Throws:

  CacheException - The cache will automatically retry the request if no ScaleOut gateways are available. If all retries are exhausted, a CacheException will be thrown.

• readAndLockAsync

  public abstract CompletableFuture<CacheResponse<K,V>> readAndLockAsync(K key) throws CacheException

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

  The object is successfully retrieved when CacheResponse.getStatus() returns RequestStatus.ObjectRetrievedAndLocked.

  The LockToken is retrieved from the CacheResponse.getLockToken()

  The object must exist in the ScaleOut cache. If the object does not exist, CacheResponse.getStatus() returns RequestStatus.ObjectNotFound.

  The object was locked by another client/thread in the ScaleOut cache if CacheResponse.getStatus() returns RequestStatus.ObjectLocked.

  The ReadPolicy as defined by the CacheBuilder will be used.

  IllegalArgumentException is thrown if the key is null.

  Parameters:

  key - the unique identifier for this object.

  Returns:

  a CompletableFuture that returns a CacheResponse.

  Throws:

  CacheException - The cache will automatically retry the request if no ScaleOut gateways are available. If all retries are exhausted, a CacheException will be thrown.

• readLockedAsync

  public abstract CompletableFuture<CacheResponse<K,V>> readLockedAsync(K key, LockToken lockToken) throws CacheException

  Asynchronously read a locked object from the ScaleOut cache.

  The object is successfully retrieved when CacheResponse.getStatus() returns RequestStatus.ObjectRetrievedAndLocked.

  A lock on an object is acquired through addExclusive, lock, or readAndLock.

  The refreshed LockToken is retrieved from the CacheResponse.getLockToken()

  The object must exist in the ScaleOut cache. If the object does not exist, CacheResponse.getStatus() returns RequestStatus.ObjectNotFound.

  The object was locked by another client/thread in the ScaleOut cache if CacheResponse.getStatus() returns RequestStatus.ObjectLocked.

  The ReadPolicy as defined by the CacheBuilder will be used.

  IllegalArgumentException is thrown if the key is null, the lock token is null, or the lock token has no value.

  Parameters:

  key - the unique identifier for this object.

  lockToken - the LockToken to use.

  Returns:

  a CompletableFuture that returns a CacheResponse.

  Throws:

  CacheException - The cache will automatically retry the request if no ScaleOut gateways are available. If all retries are exhausted, a CacheException will be thrown.

• readAsync

  public abstract CompletableFuture<CacheResponse<K,V>> readAsync(K key, ReadPolicy policy) throws CacheException

  Asynchronously read a locked object from the ScaleOut cache.

  Specify a custom ReadPolicy to adjust read properties.

  The object is successfully retrieved when CacheResponse.getStatus() returns RequestStatus.ObjectRetrievedAndLocked.

  The object must exist in the ScaleOut cache. If the object does not exist, CacheResponse.getStatus() returns RequestStatus.ObjectNotFound.

  IllegalArgumentException is thrown if the key is null or ReadPolicy is null.

  Parameters:

  key - the unique identifier for this object.

  policy - the ReadPolicy to use.

  Returns:

  a CompletableFuture that returns a CacheResponse.

  Throws:

  CacheException - The cache will automatically retry the request if no ScaleOut gateways are available. If all retries are exhausted, a CacheException will be thrown.

• readAndLockAsync

  public abstract CompletableFuture<CacheResponse<K,V>> readAndLockAsync(K key, ReadPolicy policy) throws CacheException

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

  Specify a custom ReadPolicy to adjust read properties.

  The object is successfully retrieved when CacheResponse.getStatus() returns RequestStatus.ObjectRetrievedAndLocked.

  The LockToken is retrieved from the CacheResponse.getLockToken()

  The object must exist in the ScaleOut cache. If the object does not exist, CacheResponse.getStatus() returns RequestStatus.ObjectNotFound.

  The object was locked by another client/thread in the ScaleOut cache if CacheResponse.getStatus() returns RequestStatus.ObjectLocked.

  IllegalArgumentException is thrown if the key is null or ReadPolicy is null.

  Parameters:

  key - the unique identifier for this object.

  policy - the ReadPolicy to use.

  Returns:

  a CompletableFuture that returns a CacheResponse.

  Throws:

  CacheException - The cache will automatically retry the request if no ScaleOut gateways are available. If all retries are exhausted, a CacheException will be thrown.

• readOrAddAsync

  public abstract CompletableFuture<CacheResponse<K,V>> readOrAddAsync(K key, ValueFactory<K,V> factory, ReadPolicy policy) throws CacheException

  Read an object from the ScaleOut cache. If the object is not present, the parameter ValueFactory will be called and the value will be added. Once the value has been added, the newly added value will be returned.

  Specify a custom ReadPolicy to adjust read properties.

  The object is successfully retrieved when CacheResponse.getStatus() returns RequestStatus.ObjectRetrieved.

  IllegalArgumentException is thrown if the key, value factory, or read policy, are null.

  Parameters:

  key - the unique identifier for this object.

  factory - the ValueFactory to use.

  policy - the ReadPolicy to use.

  Returns:

  a CompletableFuture that returns a CacheResponse.

  Throws:

  CacheException - The cache will automatically retry the request if no ScaleOut gateways are available. If all retries are exhausted, a CacheException will be thrown.

• readLockedAsync

  public abstract CompletableFuture<CacheResponse<K,V>> readLockedAsync(K key, LockToken lockToken, ReadPolicy policy) throws CacheException

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

  Specify a custom ReadPolicy to adjust read properties.

  The object is successfully retrieved when CacheResponse.getStatus() returns RequestStatus.ObjectRetrievedAndLocked.

  A lock on an object is acquired through addExclusive, lock, or readAndLock.

  The refreshed LockToken is retrieved from the CacheResponse.getLockToken()

  The object must exist in the ScaleOut cache. If the object does not exist, CacheResponse.getStatus() returns RequestStatus.ObjectNotFound.

  The object was locked by another client/thread in the ScaleOut cache if CacheResponse.getStatus() returns RequestStatus.ObjectLocked.

  IllegalArgumentException is thrown if the key is null, the lock token is null, the lock token has no value, or the ReadPolicy is null.

  Parameters:

  key - the unique identifier for this object.

  lockToken - the LockToken to use.

  policy - the ReadPolicy to use.

  Returns:

  a CompletableFuture that returns a CacheResponse.

  Throws:

  CacheException - The cache will automatically retry the request if no ScaleOut gateways are available. If all retries are exhausted, a CacheException will be thrown.

• removeAsync

  public abstract CompletableFuture<CacheResponse<K,V>> removeAsync(K key) throws CacheException

  Asynchronously remove an object from the ScaleOut cache.

  The object is successfully removed when CacheResponse.getStatus() returns RequestStatus.ObjectRemoved.

  IllegalArgumentException is thrown if the key is null.

  Parameters:

  key - the unique identifier for this object.

  Returns:

  a CompletableFuture that returns a CacheResponse.

  Throws:

  CacheException - The cache will automatically retry the request if no ScaleOut gateways are available. If all retries are exhausted, a CacheException will be thrown.

• removeLockedAsync

  public abstract CompletableFuture<CacheResponse<K,V>> removeLockedAsync(K key, LockToken lockToken) throws CacheException

  Asynchronously remove a locked object from the ScaleOut cache.

  The object is successfully removed when CacheResponse.getStatus() returns RequestStatus.ObjectRemoved.

  A lock on an object is acquired through addExclusive, lock, or readAndLock.

  The object was locked by another client/thread in the ScaleOut cache if CacheResponse.getStatus() returns RequestStatus.ObjectLocked.

  IllegalArgumentException is thrown if the key is null, the lock token is null, or the lock token has no value.

  Parameters:

  key - the unique identifier for this object.

  lockToken - the LockToken to use.

  Returns:

  a CompletableFuture that returns a CacheResponse.

  Throws:

  CacheException - The cache will automatically retry the request if no ScaleOut gateways are available. If all retries are exhausted, a CacheException will be thrown.

• lockAsync

  public abstract CompletableFuture<CacheResponse<K,V>> lockAsync(K key) throws CacheException

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

  The LockToken is retrieved from the CacheResponse.getLockToken()

  The object is successfully locked when CacheResponse.getStatus() returns RequestStatus.ObjectLocked.

  IllegalArgumentException is thrown if the key is null

  Parameters:

  key - the unique identifier for this object.

  Returns:

  a CompletableFuture that returns a CacheResponse.

  Throws:

  CacheException - The cache will automatically retry the request if no ScaleOut gateways are available. If all retries are exhausted, a CacheException will be thrown.

• refreshLockAsync

  public abstract CompletableFuture<CacheResponse<K,V>> refreshLockAsync(K key, LockToken lockToken) throws CacheException

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

  The LockToken is retrieved from the CacheResponse.getLockToken()

  The lock is successfully refreshed when CacheResponse.getStatus() returns RequestStatus.ObjectLocked.

  A lock on an object is acquired through addExclusive, lock, or readAndLock.

  IllegalArgumentException is thrown if the key is null, the lock token is null, or the lock token has no value.

  Parameters:

  key - the unique identifier for this object.

  lockToken - the LockToken to use.

  Returns:

  a CompletableFuture that returns a CacheResponse.

  Throws:

  CacheException - The cache will automatically retry the request if no ScaleOut gateways are available. If all retries are exhausted, a CacheException will be thrown.

• unlockAsync

  public abstract CompletableFuture<CacheResponse<K,V>> unlockAsync(K key, LockToken lockToken) throws CacheException

  Asynchronously unlock a locked object within the ScaleOut cache.

  A lock on an object is acquired through addExclusive, lock, or readAndLock.

  The object is successfully unlocked when CacheResponse.getStatus() returns RequestStatus.ObjectUnlocked.

  IllegalArgumentException is thrown if the key is null, the lock token is null, or the lock token has no value.

  Parameters:

  key - the unique identifier for this object.

  lockToken - the LockToken to use.

  Returns:

  a CompletableFuture that returns a CacheResponse.

  Throws:

  CacheException - The cache will automatically retry the request if no ScaleOut gateways are available. If all retries are exhausted, a CacheException will be thrown.

• clearAsync

  public abstract CompletableFuture<CacheResponse<K,V>> clearAsync() throws CacheException

  Asynchronously clear all objects from the ScaleOut cache.

  The cache is successfully cleared when CacheResponse.getStatus() returns RequestStatus.CacheCleared.

  Returns:

  a CompletableFuture that returns a CacheResponse.

  Throws:

  CacheException - The cache will automatically retry the request if no ScaleOut gateways are available. If all retries are exhausted, a CacheException will be thrown.

• getMetadataAsync

  public abstract CompletableFuture<CacheResponse<K,CachedObjectMetadata<K>>> getMetadataAsync(K key) throws CacheException

  Retrieves CachedObjectMetadata for an object stored in the cache.

  Returns RequestStatus.ObjectRetrieved if the object exists.

  Returns RequestStatus.ObjectNotFound if the object does not exist.

  Parameters:

  key - the key to get metadata for.

  Returns:

  a CompletableFuture that returns a CacheResponse.

  Throws:

  CacheException - The cache will automatically retry the request if no ScaleOut gateways are available. If all retries are exhausted, a CacheException will be thrown.

• createPolicy

  public abstract CreatePolicy createPolicy()

  Retrieve the default CreatePolicy used by this Cache.

  Returns:

  the CreatePolicy used by this Cache.

• getAppId

  int getAppId()

  The application ID of this service event handler.

  Returns:

  the application id.

• getKeyEncoder

  KeyEncoder<K> getKeyEncoder()

  The KeyEncoder used by this service event handler.

  Returns:

  the KeyEncoder

• enableAsyncWriteThrough

  void enableAsyncWriteThrough(boolean writeThrough)

  Enable async write through on this service event handler.

  Parameters:

  writeThrough - true/false to enable/disable async write through on this service event handler.

• enableAsyncReadThrough

  void enableAsyncReadThrough(boolean readThrough)

  Enable async read through on this service event handler.

  Parameters:

  readThrough - true/false to enable/disable async write through on this service event handler.

• enableReadThrough

  void enableReadThrough(boolean readThrough)

  Enable read through on this service event handler.

  Parameters:

  readThrough - true/false to enable disable read through on this service event handler.

• getGridConnection

  GridConnection getGridConnection()

  Retrieve the GridConnection associated with this service event handler.

  Returns:

  the GridConnection.