Package com.arjuna.ats.arjuna.objectstore

Interface ParticipantStore

All Superinterfaces:

BaseStore, TxLog

All Known Subinterfaces:

ObjectStoreAPI

All Known Implementing Classes:

ObjectStore, ParticipantStoreProxy

public interface ParticipantStore
extends TxLog

Transactional participants MUST use this type of ObjectStore. It allows them to be driven through 2PC.

Since:

JTS 1.0.

Version:

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

Author:

Mark Little (mark@arjuna.com)

Method Summary

Modifier and Type	Method	Description
boolean	commit_state(Uid u, String tn)	Commit the object's state in the object store.
boolean	fullCommitNeeded()
InputObjectState	read_committed(Uid u, String tn)	Read the object's committed state.
InputObjectState	read_uncommitted(Uid u, String tn)	Read the object's shadowed state.
boolean	remove_uncommitted(Uid u, String tn)	Remove the object's uncommitted state.
boolean	write_uncommitted(Uid u, String tn, OutputObjectState buff)	Write a copy of the object's uncommitted state.

Methods inherited from interface com.arjuna.ats.arjuna.objectstore.BaseStore

getStoreName, start, stop

Methods inherited from interface com.arjuna.ats.arjuna.objectstore.TxLog

remove_committed, sync, write_committed

Method Detail

commit_state

boolean commit_state(Uid u,
                     String tn)
              throws ObjectStoreException

Commit the object's state in the object store.

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

InputObjectState read_committed(Uid u,
                                String tn)
                         throws ObjectStoreException

Read the object's committed state.

Parameters:

u - The object to work on.

tn - The type of the object to work on.

Returns:

the state of the object.

Throws:

ObjectStoreException

read_uncommitted

InputObjectState read_uncommitted(Uid u,
                                  String tn)
                           throws ObjectStoreException

Read the object's shadowed state.

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

boolean remove_uncommitted(Uid u,
                           String tn)
                    throws ObjectStoreException

Remove the object's uncommitted state.

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

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

Write a copy of the object's uncommitted state.

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

boolean fullCommitNeeded()