fabric.worker

Interface Store

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

InProcessStore, LocalStore, RemoteStore

public interface Store
extends java.io.Serializable

Method Summary

Modifier and Type	Method and Description
void	abortTransaction(TransactionID tid) Notifies the store that the transaction is being Aborted.
void	cache(Object._Impl impl) Adds the given object to the cache.
ObjectCache.Entry	cache(SerializedObject obj) Adds the given object to the cache.
boolean	checkForStaleObjects(LongKeyMap<java.lang.Integer> reads) Determines whether the given set of objects are stale.
void	commitTransaction(long transactionID) Notifies the Store that the transaction should be committed.
long	createOnum() Obtains a new, unused object number from the Store.
void	evict(long onum) Evicts the object with the given onum from cache.
NodePrincipal	getPrincipal() Returns the NodePrincipal associated with this store.
fabric.util.Map	getRoot() Returns the root map of the Store
boolean	isLocalStore() Determines whether this is the local store.
java.lang.String	name() Returns this store's host name.
void	prepareTransaction(long tid, boolean singleStore, boolean readOnly, java.util.Collection<Object._Impl> toCreate, LongKeyMap<java.lang.Integer> reads, java.util.Collection<Object._Impl> writes) Notifies the store that the transaction is entering the Prepare phase.
ObjectCache.Entry	readFromCache(long onum) Returns the cache entry for the given onum.
ObjectCache.Entry	readObject(long onum) Returns the cache entry for the given onum.
ObjectCache.Entry	readObjectNoDissem(long onum) Returns the cache entry for the requested object.

Method Detail

name

java.lang.String name()

Returns this store's host name.

getPrincipal

NodePrincipal getPrincipal()

Returns the NodePrincipal associated with this store.

isLocalStore

boolean isLocalStore()

Determines whether this is the local store.

prepareTransaction

void prepareTransaction(long tid,
                        boolean singleStore,
                        boolean readOnly,
                        java.util.Collection<Object._Impl> toCreate,
                        LongKeyMap<java.lang.Integer> reads,
                        java.util.Collection<Object._Impl> writes)
                 throws UnreachableNodeException,
                        TransactionPrepareFailedException

Notifies the store that the transaction is entering the Prepare phase.

Throws:

UnreachableNodeException

TransactionPrepareFailedException

readObject

ObjectCache.Entry readObject(long onum)
                      throws AccessException

Returns the cache entry for the given onum. If the object is not resident, it is fetched from the store via dissemination.

Parameters:

onum - The identifier of the requested object

Returns:

cache entry for the requested object.

Throws:

AccessException

readObjectNoDissem

ObjectCache.Entry readObjectNoDissem(long onum)
                              throws AccessException

Returns the cache entry for the requested object. If the object is not resident, it is fetched directly from the store.

Parameters:

onum - The identifier of the requested object

Returns:

the cache entry for the requested object.

Throws:

AccessException

readFromCache

ObjectCache.Entry readFromCache(long onum)

Returns the cache entry for the given onum.

Parameters:

onum - The identifier of the requested object.

Returns:

The entry if it exists in the object cache; otherwise, null.

abortTransaction

void abortTransaction(TransactionID tid)
               throws AccessException

Notifies the store that the transaction is being Aborted.

Parameters:

tid - the ID of the aborting transaction. This is assumed to specify a top-level transaction.

Throws:

AccessException

commitTransaction

void commitTransaction(long transactionID)
                throws UnreachableNodeException,
                       TransactionCommitFailedException

Notifies the Store that the transaction should be committed.

Parameters:

transactionID - the ID of the transaction to commit

Throws:

UnreachableNodeException

TransactionCommitFailedException

checkForStaleObjects

boolean checkForStaleObjects(LongKeyMap<java.lang.Integer> reads)

Determines whether the given set of objects are stale.

Returns:

true iff stale objects were found.

createOnum

long createOnum()
         throws UnreachableNodeException

Obtains a new, unused object number from the Store.

Throws:

UnreachableNodeException

getRoot

fabric.util.Map getRoot()

Returns the root map of the Store

evict

void evict(long onum)

Evicts the object with the given onum from cache.

cache

void cache(Object._Impl impl)

Adds the given object to the cache.

cache

ObjectCache.Entry cache(SerializedObject obj)

Adds the given object to the cache.

Returns:

the resulting cache entry.