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

Class SlotStoreAdaptor

java.lang.Object

com.arjuna.ats.internal.arjuna.objectstore.slot.SlotStoreAdaptor

All Implemented Interfaces:

BaseStore, ObjectStoreAPI, ParticipantStore, RecoveryStore, TxLog

public class SlotStoreAdaptor
extends Object
implements ObjectStoreAPI

Adaptor class that wraps the SlotStore to make it look like an ObjectStore. Modelled on HornetqObjectStoreAdaptor.

Author:

Jonathan Halliday (jonathan.halliday@redhat.com), 2020-03

Constructor Summary

Constructors

Constructor	Description
SlotStoreAdaptor()
SlotStoreAdaptor(SlotStore slotStore)

Method Summary

Modifier and Type	Method	Description
boolean	allObjUids(String typeName, InputObjectState foundInstances)	Obtain all of the Uids for a specified type, regardless of their state.
boolean	allObjUids(String typeName, InputObjectState foundInstances, int matchState)	Obtain all of the Uids for a specified type.
boolean	allTypes(InputObjectState foundTypes)	Obtain all types of objects stored in the object store.
boolean	commit_state(Uid u, String tn)	Commit the object's state in the object store.
int	currentState(Uid uid, String typeName)
boolean	fullCommitNeeded()
String	getStoreName()
boolean	hide_state(Uid u, String tn)	Hide the object's state in the object store.
boolean	isType(Uid u, String tn, int st)	Is the current state of the object the same as that provided as the last parameter?
InputObjectState	read_committed(Uid uid, String typeName)	Read the object's committed state.
InputObjectState	read_uncommitted(Uid u, String tn)	Read the object's shadowed state.
boolean	remove_committed(Uid uid, String typeName)	Remove the object's committed state.
boolean	remove_uncommitted(Uid u, String tn)	Remove the object's uncommitted state.
boolean	reveal_state(Uid u, String tn)	Reveal a hidden object's state.
void	start()
void	stop()
void	sync()	Some object store implementations may be running with automatic sync disabled.
boolean	write_committed(Uid uid, String typeName, OutputObjectState buff)	Write a new copy of the object's committed state.
boolean	write_uncommitted(Uid u, String tn, OutputObjectState buff)	Write a copy of the object's uncommitted state.

Methods inherited from class java.lang.Object

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

Constructor Details

SlotStoreAdaptor

public SlotStoreAdaptor()
                 throws IOException

Throws:

IOException

SlotStoreAdaptor

public SlotStoreAdaptor(SlotStore slotStore)

Method Details

allObjUids

public boolean allObjUids(String typeName,
 InputObjectState foundInstances,
 int matchState)
                   throws ObjectStoreException

Obtain all of the Uids for a specified type.

Specified by:

allObjUids in interface RecoveryStore

Parameters:

typeName - The type to scan for.

foundInstances - The object state in which to store the Uids

matchState - The file type to look for (e.g., committed, shadowed). [StateStatus] Note: matchState=OS_UNKNOWN matches any state.

Returns:

true if no errors occurred, false otherwise.

Throws:

ObjectStoreException

allObjUids

public boolean allObjUids(String typeName,
 InputObjectState foundInstances)
                   throws ObjectStoreException

Obtain all of the Uids for a specified type, regardless of their state.

Specified by:

allObjUids in interface RecoveryStore

Parameters:

typeName - The type to scan for.

foundInstances - The object state in which to store the Uids

Returns:

true if no errors occurred, false otherwise.

Throws:

ObjectStoreException

allTypes

public boolean allTypes(InputObjectState foundTypes)
                 throws ObjectStoreException

Obtain all types of objects stored in the object store.

Specified by:

allTypes in interface RecoveryStore

Parameters:

foundTypes - The state in which to store the types.

Returns:

true if no errors occurred, false otherwise.

Throws:

ObjectStoreException

currentState

public int currentState(Uid uid,
 String typeName)
                 throws ObjectStoreException

Specified by:

currentState in interface RecoveryStore

Parameters:

uid - The object to query.

typeName - The type of the object to query.

Returns:

the current state of the object's state (e.g., shadowed, committed ...) [StateStatus]

Throws:

ObjectStoreException

hide_state

public boolean hide_state(Uid u,
 String tn)
                   throws ObjectStoreException

Hide the object's state in the object store. Used by crash recovery.

Specified by:

hide_state in interface RecoveryStore

Parameters:

u - The object to work on.

tn - The type of the object to work on.

Returns:

true if no errors occurred, false otherwise.

Throws:

ObjectStoreException

reveal_state

public boolean reveal_state(Uid u,
 String tn)
                     throws ObjectStoreException

Reveal a hidden object's state.

Specified by:

reveal_state in interface RecoveryStore

Parameters:

u - The object to work on.

tn - The type of the object to work on.

Returns:

true if no errors occurred, false otherwise.

Throws:

ObjectStoreException

read_committed

public InputObjectState read_committed(Uid uid,
 String typeName)
                                throws ObjectStoreException

Read the object's committed state.

Specified by:

read_committed in interface ParticipantStore

Specified by:

read_committed in interface RecoveryStore

Parameters:

uid - The object to work on.

typeName - The type of the object to work on.

Returns:

the state of the object.

Throws:

ObjectStoreException

isType

public boolean isType(Uid u,
 String tn,
 int st)
               throws ObjectStoreException

Is the current state of the object the same as that provided as the last parameter?

Specified by:

isType in interface RecoveryStore

Parameters:

u - The object to work on.

tn - The type of the object.

st - The expected type of the object. [StateType]

Returns:

true if the current state is as expected, false otherwise.

Throws:

ObjectStoreException

remove_committed

public boolean remove_committed(Uid uid,
 String typeName)
                         throws ObjectStoreException

Remove the object's committed state.

Specified by:

remove_committed in interface TxLog

Parameters:

uid - The object to work on.

typeName - The type of the object to work on.

Returns:

true if no errors occurred, false otherwise.

Throws:

ObjectStoreException

write_committed

public boolean write_committed(Uid uid,
 String typeName,
 OutputObjectState buff)
                        throws ObjectStoreException

Write a new copy of the object's committed state.

Specified by:

write_committed in interface TxLog

Parameters:

uid - The object to work on.

typeName - The type of the object to work on.

buff - The state to write.

Returns:

true if no errors occurred, false otherwise.

Throws:

ObjectStoreException

sync

public void sync()
          throws SyncFailedException,
ObjectStoreException

Description copied from interface: TxLog

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

Throws:

SyncFailedException

ObjectStoreException

commit_state

public boolean commit_state(Uid u,
 String tn)
                     throws ObjectStoreException

Description copied from interface: ParticipantStore

Commit the object's state in the object store.

Specified by:

commit_state in interface ParticipantStore

Parameters:

u - The object to work on.

tn - The type of the object to work on.

Returns:

true if no errors occurred, false otherwise.

Throws:

ObjectStoreException

read_uncommitted

public InputObjectState read_uncommitted(Uid u,
 String tn)
                                  throws ObjectStoreException

Description copied from interface: ParticipantStore

Read the object's shadowed state.

Specified by:

read_uncommitted in interface ParticipantStore

Parameters:

u - The object to work on.

tn - The type of the object to work on.

Returns:

the state of the object.

Throws:

ObjectStoreException

remove_uncommitted

public boolean remove_uncommitted(Uid u,
 String tn)
                           throws ObjectStoreException

Description copied from interface: ParticipantStore

Remove the object's uncommitted state.

Specified by:

remove_uncommitted in interface ParticipantStore

Parameters:

u - The object to work on.

tn - The type of the object to work on.

Returns:

true if no errors occurred, false otherwise.

Throws:

ObjectStoreException

write_uncommitted

public boolean write_uncommitted(Uid u,
 String tn,
 OutputObjectState buff)
                          throws ObjectStoreException

Description copied from interface: ParticipantStore

Write a copy of the object's uncommitted state.

Specified by:

write_uncommitted in interface ParticipantStore

Parameters:

u - The object to work on.

tn - The type of the object to work on.

buff - The state to write.

Returns:

true if no errors occurred, false otherwise.

Throws:

ObjectStoreException

fullCommitNeeded

public boolean fullCommitNeeded()

Specified by:

fullCommitNeeded in interface ParticipantStore

getStoreName

public String getStoreName()

Specified by:

getStoreName in interface BaseStore

Returns:

the "name" of the object store. Where in the hierarchy it appears, e.g., /ObjectStore/MyName/...

start

public void start()

Specified by:

start in interface BaseStore

stop

public void stop()

Specified by:

stop in interface BaseStore