Package com.atlassian.confluence.impl.backuprestore.restore.stash

Interface ImportedObjectsStash

All Known Implementing Classes:
ImportedObjectsStashImpl
public interface ImportedObjectsStash
Allows to temporarily "stash" imported objects and read them later. Objects should be kept on the disk (compressed) to keep the RAM free.
Since:
8.0.0

  • Method Details

    • add

      void add(ImportedObjectV2 object) throws BackupRestoreException
      Add object to stash.
      Throws:
      BackupRestoreException

    • readObjects

      List<ImportedObjectV2> readObjects(int numberOfObjects) throws BackupRestoreException
      Read a collection of objects from the stash. If the stash has fewer objects than numberOfObjects, all objects will be returned.
      Parameters:
      numberOfObjects - number of objects.
      Returns:
      collection of objects
      Throws:
      BackupRestoreException

    • getName

      String getName()
      Returns:
      stash name

    • getIterationNumber

      Integer getIterationNumber()
      Returns:
      iteration number

    • getNumberOfWrittenObjects

      long getNumberOfWrittenObjects()
      Returns:
      number of objects written to the stash.

    • getNumberOfRetrievedObjects

      long getNumberOfRetrievedObjects()
      Returns:
      number of objects read from the stash by this moment.

    • hasMoreRecords

      boolean hasMoreRecords()
      Returns:
      true if the stash has records to read.