Interface CpeCheckpoint

  • All Superinterfaces:
    java.lang.Cloneable, MetaDataObject, java.io.Serializable, XMLizable
    All Known Implementing Classes:
    CpeCheckpointImpl

    public interface CpeCheckpoint
    extends MetaDataObject
    An object that holds configuration that is part of the CPE descriptor. It provides the means of configuring CPE checkpoint. The checkpoint contains a name of the file where the recovery information will be stored and a frequency of checkpoints.
    • Method Detail

      • setFilePath

        void setFilePath​(java.lang.String aCheckpointFilePath)
                  throws CpeDescriptorException
        Sets the file where checkpoint information will be stored
        Parameters:
        aCheckpointFilePath - - checkpoint file path
        Throws:
        CpeDescriptorException - tbd
      • getFilePath

        java.lang.String getFilePath()
        Returns file where checkpoint information is stored
        Returns:
        - checkpoint file path
      • setFrequency

        void setFrequency​(int aFrequency,
                          boolean aTimeBased)
        Sets frequency of checkpoints. Currently only time-based checkpointing is supported.
        Parameters:
        aFrequency - - number of millis between checkpoints
        aTimeBased - - true if checkpoint is based on time
      • getFrequency

        int getFrequency()
        Returns frequency of checkpoints.
        Returns:
        - number of millis between checkpoints
      • isTimeBased

        boolean isTimeBased()
        Returns true if frequency of checkpoints is time-based
        Returns:
        true;
      • setBatchSize

        void setBatchSize​(int aBatchSize)
        Parameters:
        aBatchSize - the size of the batch
      • getBatchSize

        int getBatchSize()