Package com.arjuna.ats.internal.arjuna.objectstore

Class CacheStore

java.lang.Object

com.arjuna.ats.arjuna.objectstore.ObjectStore

com.arjuna.ats.internal.arjuna.objectstore.FileSystemStore

com.arjuna.ats.internal.arjuna.objectstore.ShadowingStore

com.arjuna.ats.internal.arjuna.objectstore.ShadowNoFileLockStore

com.arjuna.ats.internal.arjuna.objectstore.HashedStore

com.arjuna.ats.internal.arjuna.objectstore.CacheStore

All Implemented Interfaces:

BaseStore, ObjectStoreAPI, ParticipantStore, RecoveryStore, TxLog

public class CacheStore
extends HashedStore

A cached object store implementation.

Since:

JTS 3.0.

Version:

$Id: CacheStore.java 2342 2006-03-30 13:06:17Z $

Author:

Mark Little (mark@arjuna.com)

Field Summary

Fields inherited from class com.arjuna.ats.internal.arjuna.objectstore.HashedStore

DEFAULT_NUMBER_DIRECTORIES, SHADOWCHAR

Fields inherited from class com.arjuna.ats.internal.arjuna.objectstore.ShadowingStore

HIDDINGCHAR

Fields inherited from class com.arjuna.ats.internal.arjuna.objectstore.FileSystemStore

doSync, scanZeroLengthFiles, syncWrites

Fields inherited from class com.arjuna.ats.arjuna.objectstore.ObjectStore

_objectStoreRoot, shareStatus

Constructor Summary

Constructors

Constructor	Description
CacheStore(ObjectStoreEnvironmentBean objectStoreEnvironmentBean)

Method Summary

Modifier and Type	Method	Description
boolean	commit_state(Uid objUid, String tName)	Commit a previous write_state operation which was made with the SHADOW StateType argument.
protected boolean	commitState(Uid objUid, String tName)
protected InputObjectState	read_state(Uid objUid, String tName, int ft)	Before we look at the disk let's look in the state cache first for the state, just in case it hasn't been written out to persistent store yet.
protected boolean	remove_state(Uid objUid, String name, int ft)
protected boolean	removeState(Uid objUid, String name, int ft)
void	sync()	Some object store implementations may be running with automatic sync disabled.
protected boolean	write_state(Uid objUid, String tName, OutputObjectState state, int ft)	write_state saves the ObjectState in a file named by the type and Uid of the ObjectState.
protected boolean	writeState(Uid objUid, String tName, OutputObjectState state, int ft)

Methods inherited from class com.arjuna.ats.internal.arjuna.objectstore.HashedStore

allObjUids, genPathName, truncate

Methods inherited from class com.arjuna.ats.internal.arjuna.objectstore.ShadowNoFileLockStore

lock, unlock

Methods inherited from class com.arjuna.ats.internal.arjuna.objectstore.ShadowingStore

currentState, hide_state, reveal_state, revealedId

Methods inherited from class com.arjuna.ats.internal.arjuna.objectstore.FileSystemStore

addToCache, allTypes, allTypes, closeAndUnlock, createHierarchy, exists, getStoreName, openAndLock, read_committed, read_uncommitted, remove_committed, remove_uncommitted, removeFromCache, removeFromCache, renameFromTo, renameFromToInternal, supressEntry, synchronousWrites, write_committed, write_uncommitted

Methods inherited from class com.arjuna.ats.arjuna.objectstore.ObjectStore

allObjUids, fullCommitNeeded, initialise, isType, locateStore, shareState, start, stop, storeDir, storeRoot

Methods inherited from class java.lang.Object

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

Constructor Details

CacheStore

public CacheStore(ObjectStoreEnvironmentBean objectStoreEnvironmentBean)
           throws ObjectStoreException

Throws:

ObjectStoreException

Method Details

commit_state

public boolean commit_state(Uid objUid,
 String tName)
                     throws ObjectStoreException

Description copied from class: ShadowingStore

Commit a previous write_state operation which was made with the SHADOW StateType argument. This is achieved by renaming the shadow and removing the hidden version.

Specified by:

commit_state in interface ParticipantStore

Overrides:

commit_state in class ShadowingStore

Parameters:

objUid - The object to work on.

tName - The type of the object to work on.

Returns:

true if no errors occurred, false otherwise.

Throws:

ObjectStoreException

sync

public void sync()
          throws SyncFailedException,
ObjectStoreException

Description copied from class: ObjectStore

Some object store implementations may be running with automatic sync disabled. Calling this method will ensure that any states are flushed to disk.

Specified by:

sync in interface TxLog

Overrides:

sync in class ObjectStore

Throws:

SyncFailedException

ObjectStoreException

remove_state

protected boolean remove_state(Uid objUid,
 String name,
 int ft)
                        throws ObjectStoreException

Overrides:

remove_state in class ShadowingStore

Throws:

ObjectStoreException

write_state

protected boolean write_state(Uid objUid,
 String tName,
 OutputObjectState state,
 int ft)
                       throws ObjectStoreException

Description copied from class: ShadowingStore

write_state saves the ObjectState in a file named by the type and Uid of the ObjectState. If the second argument is SHADOW, then the file name is different so that a subsequent commit_state invocation will rename the file.

Overrides:

write_state in class ShadowingStore

Throws:

ObjectStoreException

read_state

protected InputObjectState read_state(Uid objUid,
 String tName,
 int ft)
                               throws ObjectStoreException

Before we look at the disk let's look in the state cache first for the state, just in case it hasn't been written out to persistent store yet.

Overrides:

read_state in class ShadowingStore

Throws:

ObjectStoreException

commitState

protected boolean commitState(Uid objUid,
 String tName)
                       throws ObjectStoreException

Throws:

ObjectStoreException

removeState

protected boolean removeState(Uid objUid,
 String name,
 int ft)
                       throws ObjectStoreException

Throws:

ObjectStoreException

writeState

protected boolean writeState(Uid objUid,
 String tName,
 OutputObjectState state,
 int ft)
                      throws ObjectStoreException

Throws:

ObjectStoreException