Package com.arjuna.ats.arjuna.objectstore

Interface RecoveryStore

  • All Superinterfaces:
    BaseStore, TxLog
    All Known Subinterfaces:
    ObjectStoreAPI
    All Known Implementing Classes:
    ObjectStore, RecoveryStoreProxy
    public interface RecoveryStore
extends TxLog
    All ObjectStore implementations that are used to drive recovery MUST implement this interface. Because recovery is a superset of transaction logging, those methods are also available.
    Since:
    JTS 1.0.
    Version:
    $Id: ObjectStore.java 2342 2006-03-30 13:06:17Z $
    Author:
    Mark Little (mark@arjuna.com)

    • Method Detail

      • allObjUids

        boolean allObjUids​(java.lang.String s,
                   InputObjectState buff,
                   int m)
            throws ObjectStoreException
        Obtain all of the Uids for a specified type.
        Parameters:
        s - The type to scan for.
        buff - The object state in which to store the Uids
        m - The file type to look for (e.g., committed, shadowed). [StateStatus] Note: m=OS_UNKNOWN matches any state.
        Returns:
        true if no errors occurred, false otherwise.
        Throws:
        ObjectStoreException

      • allObjUids

        boolean allObjUids​(java.lang.String s,
                   InputObjectState buff)
            throws ObjectStoreException
        Obtain all of the Uids for a specified type, regardless of their state.
        Parameters:
        s - The type to scan for.
        buff - The object state in which to store the Uids
        Returns:
        true if no errors occurred, false otherwise.
        Throws:
        ObjectStoreException

      • allTypes

        boolean allTypes​(InputObjectState buff)
          throws ObjectStoreException
        Obtain all types of objects stored in the object store.
        Parameters:
        buff - The state in which to store the types.
        Returns:
        true if no errors occurred, false otherwise.
        Throws:
        ObjectStoreException

      • currentState

        int currentState​(Uid u,
                 java.lang.String tn)
          throws ObjectStoreException
        Parameters:
        u - The object to query.
        tn - 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

        boolean hide_state​(Uid u,
                   java.lang.String tn)
            throws ObjectStoreException
        Hide the object's state in the object store. Used by crash recovery.
        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

        boolean reveal_state​(Uid u,
                     java.lang.String tn)
              throws ObjectStoreException
        Reveal a hidden object's 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

      • isType

        boolean isType​(Uid u,
               java.lang.String tn,
               int st)
        throws ObjectStoreException
        Is the current state of the object the same as that provided as the last parameter?
        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