com.scaleoutsoftware.soss.client

Class ExtendedObjectMetadata

java.lang.Object

com.scaleoutsoftware.soss.client.ObjectMetadata

com.scaleoutsoftware.soss.client.ExtendedObjectMetadata

All Implemented Interfaces:

Serializable

public class ExtendedObjectMetadata
extends ObjectMetadata

ExtendedObjectMetadata augments the user-specified ObjectMetadata values with additional read-only values maintained automatically by the StateServer. Instances of ExtendedObjectMetadata are returned by NamedCache.getMetadata(com.scaleoutsoftware.soss.client.CachedObjectId, com.scaleoutsoftware.soss.client.ReadOptions).

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ExtendedObjectMetadata()

Method Summary

Modifier and Type	Method and Description
boolean	getAbsoluteTimeout() Returns true if the StateServer object corresponding to this metadata instance will be removed from the store at a specific absolute time as opposed to a sliding expiration timeout due to a period of inactivity.
boolean	getAllowRemoteAccess() Returns true if the object can be accessed by the remote store, false otherwise.
boolean	getAllowReplication() Returns true if the StateServer object corresponding to this metadata instance can be replicated to remote stores.
BackingStoreAsyncPolicy	getBackingStoreAsyncPolicy() Returns the type of backing store operations (none, refresh-ahead or write-behind) performed on the StateServer object corresponding to this metadata instance.
TimeSpan	getBackingStoreInterval() Gets the interval between asynchronous backing store events (refresh-ahead, write-behind) for the StateServer object corresponding to this metadata instance.
CoherencyPolicy	getDefaultCoherencyPolicy() Gets the default coherency policy or null if no coherency policy is set.
IndexCollection	getIndexCollection() Gets the IndexCollection
int	getObjectSize() Returns the size in bytes of the StateServer object corresponding to this metadata
Set<CachedObjectId>	getParents() Return a read-only list containing the dependency parents specified for the StateServer object corresponding to this ObjectMetadata instance.
ObjectPreemptionPriority	getPreemptionPriority() Returns the preemption priority of the StateServer object corresponding to this metadata instance.
TimeSpan	getTimeout() Returns the expiration timeout value for the StateServer object corresponding to this metadata.
boolean	isProxy() Checks if the object is a proxy object for "pull" replication.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExtendedObjectMetadata

public ExtendedObjectMetadata()

Method Detail

getObjectSize

public int getObjectSize()

Returns the size in bytes of the StateServer object corresponding to this metadata

Returns:

size in bytes

getTimeout

public TimeSpan getTimeout()

Returns the expiration timeout value for the StateServer object corresponding to this metadata.

Returns:

object containing timeout value

getAbsoluteTimeout

public boolean getAbsoluteTimeout()

Returns true if the StateServer object corresponding to this metadata instance will be removed from the store at a specific absolute time as opposed to a sliding expiration timeout due to a period of inactivity.

Returns:

true if timeout is absolute, false otherwise

getAllowReplication

public boolean getAllowReplication()

Returns true if the StateServer object corresponding to this metadata instance can be replicated to remote stores.

Returns:

true replication is allowed, false otherwise

getPreemptionPriority

public ObjectPreemptionPriority getPreemptionPriority()

Returns the preemption priority of the StateServer object corresponding to this metadata instance.

Returns:

preemption priority object

getParents

public Set<CachedObjectId> getParents()

Return a read-only list containing the dependency parents specified for the StateServer object corresponding to this ObjectMetadata instance.

Returns:

list of CachedObjectId's corresponding to parent objects

getBackingStoreAsyncPolicy

public BackingStoreAsyncPolicy getBackingStoreAsyncPolicy()

Returns the type of backing store operations (none, refresh-ahead or write-behind) performed on the StateServer object corresponding to this metadata instance.

Returns:

member of BackingStoreAsyncPolicy enumeration

getBackingStoreInterval

public TimeSpan getBackingStoreInterval()

Gets the interval between asynchronous backing store events (refresh-ahead, write-behind) for the StateServer object corresponding to this metadata instance.

Returns:

object containing interval value

getIndexCollection

public IndexCollection getIndexCollection()

Gets the IndexCollection

Overrides:

getIndexCollection in class ObjectMetadata

Returns:

IndexCollection containing object metadata.

getDefaultCoherencyPolicy

public CoherencyPolicy getDefaultCoherencyPolicy()

Gets the default coherency policy or null if no coherency policy is set.

Returns:

default coherency policy

getAllowRemoteAccess

public boolean getAllowRemoteAccess()

Returns true if the object can be accessed by the remote store, false otherwise.

Returns:

true if remote access is allowed, false otherwise

isProxy

public boolean isProxy()

Checks if the object is a proxy object for "pull" replication.

Returns:

true if the object is a proxy object, false otherwise