fabric.worker

Class RemoteStore

java.lang.Object

fabric.net.RemoteNode<RemoteStore>

fabric.worker.RemoteStore

All Implemented Interfaces:

Store, java.io.Serializable

Direct Known Subclasses:

InProcessStore

public class RemoteStore
extends RemoteNode<RemoteStore>
implements Store, java.io.Serializable

Encapsulates a Store. This class maintains two connections to the store (one with SSL, for worker requests; and one without, for dissemination requests) and manages all communication. Stores can only be obtained through the Worker.getStore() interface. For each remote store, there should be at most one RemoteStore object representing that store.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	RemoteStore.SerializationProxy

Field Summary

Fields inherited from class fabric.net.RemoteNode

name

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RemoteStore(java.lang.String name) Creates a store representing the store at the given host name.
protected	RemoteStore(java.lang.String name, java.security.PublicKey key) Creates a store representing the store at the given host name.

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	clearCache() Clears the worker's cache for this store.
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.
java.security.PublicKey	getPublicKey()
Map	getRoot() Returns the root map of the Store
protected java.util.List<SerializedObject>	getStaleObjects(LongKeyMap<java.lang.Integer> reads) Helper for checkForStaleObjects.
int	hashCode()
boolean	isLocalStore() Determines whether this is the local store.
java.security.cert.X509Certificate[]	makeWorkerPrincipal(Worker worker, java.security.PublicKey workerKey) Returns a certificate chain for a new principal object for the given worker key.
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) Sends a PREPARE message to the store.
ObjectGlob	readEncryptedObjectFromStore(long onum) Called by dissemination to fetch an encrypted object from the store.
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.
ObjectGroup	readObjectFromStore(long onum) Goes to the store to get object.
ObjectCache.Entry	readObjectNoDissem(long onum) Returns the cache entry for the requested object.
java.lang.Object	readResolve() Looks up the actual Store object when this store is deserialized.
protected void	reserve(int num) Ensure that a given number of objects can be created without contacting the store.
java.lang.String	toString()
void	updateCache(SerializedObject update) Updates the worker's cache of objects that originate from this store.

Methods inherited from class fabric.net.RemoteNode

getSocket, name, recycle, send

Methods inherited from class java.lang.Object

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

Methods inherited from interface fabric.worker.Store

name

Constructor Detail

RemoteStore

protected RemoteStore(java.lang.String name)

Creates a store representing the store at the given host name.

RemoteStore

protected RemoteStore(java.lang.String name,
                      java.security.PublicKey key)

Creates a store representing the store at the given host name.

Method Detail

createOnum

public long createOnum()
                throws UnreachableNodeException

Description copied from interface: Store

Obtains a new, unused object number from the Store.

Specified by:

createOnum in interface Store

Throws:

UnreachableNodeException

prepareTransaction

public 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 TransactionPrepareFailedException,
                               UnreachableNodeException

Sends a PREPARE message to the store.

Specified by:

prepareTransaction in interface Store

Throws:

TransactionPrepareFailedException

UnreachableNodeException

readObject

public final ObjectCache.Entry readObject(long onum)
                                   throws AccessException

Description copied from interface: Store

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

Specified by:

readObject in interface Store

Parameters:

onum - The identifier of the requested object

Returns:

cache entry for the requested object.

Throws:

AccessException

readObjectNoDissem

public final ObjectCache.Entry readObjectNoDissem(long onum)
                                           throws AccessException

Description copied from interface: Store

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

Specified by:

readObjectNoDissem in interface Store

Parameters:

onum - The identifier of the requested object

Returns:

the cache entry for the requested object.

Throws:

AccessException

readFromCache

public ObjectCache.Entry readFromCache(long onum)

Description copied from interface: Store

Returns the cache entry for the given onum.

Specified by:

readFromCache in interface Store

Parameters:

onum - The identifier of the requested object.

Returns:

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

readObjectFromStore

public ObjectGroup readObjectFromStore(long onum)
                                throws AccessException

Goes to the store to get object.

Parameters:

onum - The object number to fetch

Returns:

An ObjectGroup whose head object is the requested object.

Throws:

FetchException - if there was an error while fetching the object from the store.

AccessException

readEncryptedObjectFromStore

public ObjectGlob readEncryptedObjectFromStore(long onum)
                                        throws AccessException

Called by dissemination to fetch an encrypted object from the store.

Parameters:

onum - The object number to fetch.

Throws:

AccessException

readResolve

public java.lang.Object readResolve()

Looks up the actual Store object when this store is deserialized. While this method is not explicitly called in the code, it is used by the Java serialization framework when deserializing a Store object.

Returns:

The canonical Store object corresponding to this Store's onum

Throws:

java.io.ObjectStreamException

reserve

protected void reserve(int num)
                throws AccessException,
                       UnreachableNodeException

Ensure that a given number of objects can be created without contacting the store.

Parameters:

num - The number of objects to allocate

Throws:

AccessException

UnreachableNodeException

abortTransaction

public void abortTransaction(TransactionID tid)
                      throws AccessException

Description copied from interface: Store

Notifies the store that the transaction is being Aborted.

Specified by:

abortTransaction in interface Store

Parameters:

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

Throws:

AccessException

commitTransaction

public void commitTransaction(long transactionID)
                       throws UnreachableNodeException,
                              TransactionCommitFailedException

Description copied from interface: Store

Notifies the Store that the transaction should be committed.

Specified by:

commitTransaction in interface Store

Parameters:

transactionID - the ID of the transaction to commit

Throws:

UnreachableNodeException

TransactionCommitFailedException

checkForStaleObjects

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

Description copied from interface: Store

Determines whether the given set of objects are stale.

Specified by:

checkForStaleObjects in interface Store

Returns:

true iff stale objects were found.

getStaleObjects

protected java.util.List<SerializedObject> getStaleObjects(LongKeyMap<java.lang.Integer> reads)

Helper for checkForStaleObjects.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getRoot

public Map getRoot()

Description copied from interface: Store

Returns the root map of the Store

Specified by:

getRoot in interface Store

getPrincipal

public NodePrincipal getPrincipal()

Description copied from interface: Store

Returns the NodePrincipal associated with this store.

Specified by:

getPrincipal in interface Store

Specified by:

getPrincipal in class RemoteNode<RemoteStore>

isLocalStore

public final boolean isLocalStore()

Description copied from interface: Store

Determines whether this is the local store.

Specified by:

isLocalStore in interface Store

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

evict

public void evict(long onum)

Description copied from interface: Store

Evicts the object with the given onum from cache.

Specified by:

evict in interface Store

updateCache

public void updateCache(SerializedObject update)

Updates the worker's cache of objects that originate from this store. If an object with the given onum exists in cache, it is evicted and replaced with the given serialized object; any transactions using the object are aborted and retried. If the object does not exist in cache, then the cache is not updated.

cache

public void cache(Object._Impl impl)

Description copied from interface: Store

Adds the given object to the cache.

Specified by:

cache in interface Store

cache

public ObjectCache.Entry cache(SerializedObject obj)

Description copied from interface: Store

Adds the given object to the cache.

Specified by:

cache in interface Store

Returns:

the resulting cache entry.

getPublicKey

public java.security.PublicKey getPublicKey()

Returns:

The store's public key for verifying Glob signatures.

clearCache

public void clearCache()

Clears the worker's cache for this store. To be used for (performance) testing only.

See Also:

Worker.clearCache()

makeWorkerPrincipal

public java.security.cert.X509Certificate[] makeWorkerPrincipal(Worker worker,
                                                                java.security.PublicKey workerKey)

Returns a certificate chain for a new principal object for the given worker key. This certificate chain is not guaranteed to end in a trusted root.