com.scaleoutsoftware.soss.client

Class ReadOptions

java.lang.Object

com.scaleoutsoftware.soss.client.ReadOptions

All Implemented Interfaces:

java.io.Serializable

public final class ReadOptions
extends java.lang.Object
implements java.io.Serializable

Class containing options that can be used when retrieving an object or a metadata in ScaleOut StateServer.

See Also:

ReadLockingMode, GeoServerReadMode, Serialized Form

Constructor Summary

Constructors

Constructor and Description
ReadOptions(ReadLockingMode lockingMode) Creates a new instance of read options to be used in NamedCache.retrieve(com.scaleoutsoftware.soss.client.CachedObjectId<T>, boolean) and NamedCache.getMetadata(com.scaleoutsoftware.soss.client.CachedObjectId, com.scaleoutsoftware.soss.client.ReadOptions) calls.
ReadOptions(ReadLockingMode lockingMode, GeoServerReadMode geoServerReadMode) Creates a new instance of read options to be used in NamedCache.retrieve(com.scaleoutsoftware.soss.client.CachedObjectId<T>, boolean) and NamedCache.getMetadata(com.scaleoutsoftware.soss.client.CachedObjectId, com.scaleoutsoftware.soss.client.ReadOptions) calls.
ReadOptions(ReadLockingMode lockingMode, GeoServerReadMode geoServerReadMode, CreateHandler createHandler, java.lang.Object createArgument, CreatePolicy createPolicy) Creates a new instance of read options to be used in NamedCache.retrieve(com.scaleoutsoftware.soss.client.CachedObjectId<T>, boolean) and NamedCache.getMetadata(com.scaleoutsoftware.soss.client.CachedObjectId, com.scaleoutsoftware.soss.client.ReadOptions) calls.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getCreateArgument() Gets an argument that will be passed to the provided CreateHandler if a read-through operation is required.
CreateHandler	getCreateHandler() Gets the custom read-through callback to use when an attempt is made to retrieve an object that is not in the cache.
CreatePolicy	getCreatePolicy() Gets a cache policy object to be used when a read-though operation inserts an object into the named cache.
GeoServerReadMode	getGeoServerReadMode() Gets the remote store's read mode.
ReadLockingMode	getLockingMode() Gets the locking mode (ReadLockingMode).
ReadMode	getReadMode() Returns the reading mode.
void	setCreateHandler(CreateHandler createHandler) Sets custom read-through callback to use when an attempt is made to retrieve an object that is not in the cache.
void	setGeoServerReadMode(GeoServerReadMode geoServerReadMode) Sets GeoServer "pull" replication behavior when retrieving the object from the StateServer.
void	setLockingMode(ReadLockingMode lockingMode) Sets whether the Retrieve method should attempt to acquire a StateServer lock when reading the object.
void	setReadMode(ReadMode mode) Sets the read mode for this ReadOptions.
void	setReadThroughArgument(java.lang.Object readThroughArgument) Sets an argument that will be passed to the provided CreateHandler if a missing object is to be created.
void	setReadThroughCreatePolicy(CreatePolicy readThroughCreatePolicy) Sets a cache policy object to be used when a NamedCache.retrieve(CachedObjectId, ReadOptions) operation is configured to transparently insert a missing object into the named cache using CreateHandler.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ReadOptions

public ReadOptions(ReadLockingMode lockingMode)

Creates a new instance of read options to be used in NamedCache.retrieve(com.scaleoutsoftware.soss.client.CachedObjectId<T>, boolean) and NamedCache.getMetadata(com.scaleoutsoftware.soss.client.CachedObjectId, com.scaleoutsoftware.soss.client.ReadOptions) calls.

Parameters:

lockingMode - locking mode

ReadOptions

public ReadOptions(ReadLockingMode lockingMode,
                   GeoServerReadMode geoServerReadMode)

Creates a new instance of read options to be used in NamedCache.retrieve(com.scaleoutsoftware.soss.client.CachedObjectId<T>, boolean) and NamedCache.getMetadata(com.scaleoutsoftware.soss.client.CachedObjectId, com.scaleoutsoftware.soss.client.ReadOptions) calls.

Parameters:

lockingMode - determines whether the Retrieve method should attempt to acquire a StateServer lock when reading the object.

geoServerReadMode - determines GeoServer "pull" replication behavior when retrieving the object from the StateServer.

ReadOptions

public ReadOptions(ReadLockingMode lockingMode,
                   GeoServerReadMode geoServerReadMode,
                   CreateHandler createHandler,
                   java.lang.Object createArgument,
                   CreatePolicy createPolicy)

Creates a new instance of read options to be used in NamedCache.retrieve(com.scaleoutsoftware.soss.client.CachedObjectId<T>, boolean) and NamedCache.getMetadata(com.scaleoutsoftware.soss.client.CachedObjectId, com.scaleoutsoftware.soss.client.ReadOptions) calls.

Parameters:

lockingMode - determines whether the Retrieve method should attempt to acquire a StateServer lock when reading the object.

geoServerReadMode - determines GeoServer "pull" replication behavior when retrieving the object from the StateServer.

createHandler - custom read-through callback to use when an attempt is made to retrieve an object that is not in the cache. If this callback is non-null then it will override any existing read-though backing store behavior that has been specified at the named cache level through the NamedCache.setBackingStoreAdapter(BackingStore, BackingStorePolicy) method.

createArgument - an argument that will be passed to the provided CreateHandler if a missing object is to be created.

createPolicy - a cache policy object to be used when a NamedCache.retrieve(CachedObjectId, ReadOptions) operation is configured to transparently insert a missing object into the named cache using CreateHandler. If null, the read-through will fall back to using the policy specified at the named cache level through the NamedCache.setBackingStoreAdapter(BackingStore, BackingStorePolicy) (as implemented in an BackingStore.getCreatePolicy(CachedObjectId) implementation). If no BackingStore implementation is associated with the NamedCache (or if BackingStore.getCreatePolicy(CachedObjectId) returns null), the read-through will then fall back to using the policy specified in the named cache's NamedCache.setDefaultCreatePolicy(CreatePolicy) property.

Method Detail

setReadMode

public void setReadMode(ReadMode mode)

Sets the read mode for this ReadOptions.

Parameters:

mode - the ReadMode to use.

getReadMode

public ReadMode getReadMode()

Returns the reading mode.

Returns:

the reading mode.

getLockingMode

public ReadLockingMode getLockingMode()

Gets the locking mode (ReadLockingMode).

Returns:

locking mode

getGeoServerReadMode

public GeoServerReadMode getGeoServerReadMode()

Gets the remote store's read mode.

Returns:

remote store read mode.

getCreateHandler

public CreateHandler getCreateHandler()

Gets the custom read-through callback to use when an attempt is made to retrieve an object that is not in the cache. The default is null.

Returns:

create handler

getCreateArgument

public java.lang.Object getCreateArgument()

Gets an argument that will be passed to the provided CreateHandler if a read-through operation is required.

Returns:

an argument object to read-through handler

getCreatePolicy

public CreatePolicy getCreatePolicy()

Gets a cache policy object to be used when a read-though operation inserts an object into the named cache.

Returns:

create policy for the backing store object

setLockingMode

public void setLockingMode(ReadLockingMode lockingMode)

Sets whether the Retrieve method should attempt to acquire a StateServer lock when reading the object. Default is ReadLockingMode.NoLockOnRead.

Parameters:

lockingMode - new locking mode

setGeoServerReadMode

public void setGeoServerReadMode(GeoServerReadMode geoServerReadMode)

Sets GeoServer "pull" replication behavior when retrieving the object from the StateServer. Default is GeoServerReadMode.None.

Parameters:

geoServerReadMode - the GeoServerReadMode

setCreateHandler

public void setCreateHandler(CreateHandler createHandler)

Sets custom read-through callback to use when an attempt is made to retrieve an object that is not in the cache. If this callback is non-null then it will override any existing read-though backing store behavior that has been specified at the named cache level through the NamedCache.setBackingStoreAdapter(BackingStore, BackingStorePolicy) method. Default is null.

Parameters:

createHandler - create handler implementation

setReadThroughArgument

public void setReadThroughArgument(java.lang.Object readThroughArgument)

Sets an argument that will be passed to the provided CreateHandler if a missing object is to be created.

Parameters:

readThroughArgument - an argument for create handler

setReadThroughCreatePolicy

public void setReadThroughCreatePolicy(CreatePolicy readThroughCreatePolicy)

Sets a cache policy object to be used when a NamedCache.retrieve(CachedObjectId, ReadOptions) operation is configured to transparently insert a missing object into the named cache using CreateHandler. If null, the read-through will fall back to using the policy specified at the named cache level through the NamedCache.setBackingStoreAdapter(BackingStore, BackingStorePolicy) (as implemented in an BackingStore.getCreatePolicy(CachedObjectId) implementation). If no BackingStore implementation is associated with the NamedCache (or if BackingStore.getCreatePolicy(CachedObjectId) returns null), the read-through will then fall back to using the policy specified in the named cache's NamedCache.setDefaultCreatePolicy(CreatePolicy) property.

Parameters:

readThroughCreatePolicy - the create policy for read-trough object