Class ContainerBasicOperation

java.lang.Object
org.apache.derby.impl.store.raw.data.ContainerBasicOperation
All Implemented Interfaces:
Externalizable, Serializable, Formatable, TypedFormat, Loggable
Direct Known Subclasses:
ContainerOperation, ContainerUndoOperation
public abstract class ContainerBasicOperation extends Object implements Loggable
A Container Operation change the state of the container. A ContainerBasicOperation is the base class for all container operations.
See Also:

  • Field Details

    • containerVersion

      private long containerVersion

    • containerId

      protected ContainerKey containerId

    • containerHdl

      protected transient RawContainerHandle containerHdl

    • foundHere

      private transient boolean foundHere

  • Constructor Details

  • Method Details

    • writeExternal

      public void writeExternal(ObjectOutput out) throws IOException
      Specified by:
      writeExternal in interface Externalizable
      Throws:
      IOException

    • readExternal

      public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException
      Specified by:
      readExternal in interface Externalizable
      Throws:
      IOException
      ClassNotFoundException

    • getPreparedLog

      public ByteArray getPreparedLog()
      the default for prepared log is always null for all the operations that don't have optionalData. If an operation has optional data, the operation need to prepare the optional data for this method. Space Operation has no optional data to write out
      Specified by:
      getPreparedLog in interface Loggable

    • releaseResource

      public void releaseResource(Transaction tran)
      Description copied from interface: Loggable
      Release any resource that was acquired for doMe for rollback or recovery redo. This resource is acquired in either generateUndo (if this is a compensation operation during run time rollback or recovery rollback) or in needsRedo (if this is during recovery redo). The run time transaction context should have all the resource already acquird for run time roll forward, so there is no need to releaseResource during run time roll forward. This method must be safe to be called multiple times.
      Specified by:
      releaseResource in interface Loggable

    • group

      public int group()
      A space operation is a RAWSTORE log record
      Specified by:
      group in interface Loggable

    • findContainer

      protected RawContainerHandle findContainer(Transaction tran) throws StandardException
      Open the container with this segmentId and containerId. This method should only be called if the container has already been created.
      Throws:
      StandardException - the container cannot be found or cannot be opened.

    • findContainerForRedoRecovery

      protected RawContainerHandle findContainerForRedoRecovery(RawTransaction tran) throws StandardException
      Subclass (e.g., ContainerOperation) that wishes to do something abou missing container in load tran should override this method to return the recreated container
      Throws:
      StandardException - Standard Derby error policy

    • needsRedo

      public boolean needsRedo(Transaction xact) throws StandardException
      Description copied from interface: Loggable
      Determine if the operation should be reapplied in recovery redo. If redo is needed, acquire any resource that is necessary for the loggable's doMe method. These need to be released in the releaseResource method.

      The sequence of events in recovery redo of a Loggable operation is:

    • Get the loggable operation. If loggable.needsRedo is false, then no need to redo this operation.
    • If loggable.needsRedo is true, all the resources necessary for applying the doMe is acquired in needsRedo.
    • If the loggable is actually a compensation operation, then the logging system will find the undoable operation that needs to be undone, call compensation.setUndoOp with the undoable operation.
    • The recovery system then calls loggable.doMe, which re-applies the loggable operation, or re-applies the compensation operation
    • The recovery system then calls loggable.releaseResource.
      • Specified by:
      needsRedo in interface Loggable
      Parameters:
      xact - The transaction trying to redo this operation
      Returns:
      true if operation needs redoing, false if not.
      Throws:
      StandardException - Standard Derby error policy
      See Also:

    • toString

      public String toString()
      Overrides:
      toString in class Object