content: /*
   * Licensed to the Apache Software Foundation (ASF) under one
   * or more contributor license agreements.  See the NOTICE file
   * distributed with this work for additional information
   * regarding copyright ownership.  The ASF licenses this file
   * to you under the Apache License, Version 2.0 (the
   * "License"); you may not use this file except in compliance
   * with the License.  You may obtain a copy of the License at
   *
   *   http://www.apache.org/licenses/LICENSE-2.0
   *
   * Unless required by applicable law or agreed to in writing,
   * software distributed under the License is distributed on an
   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
   * KIND, either express or implied.  See the License for the
   * specific language governing permissions and limitations
   * under the License.
   */
  package org.apache.asterix.common.storage;
  
  import org.apache.hyracks.api.exceptions.HyracksDataException;
  
  public interface IIndexCheckpointManager {
  
      /**
       * Initializes the first checkpoint of an index with low watermark {@code lsn}
       *
       * @param validComponentSequence
       * @param lsn
       * @param validComponentId
       * @param masterNodeId
       * @throws HyracksDataException
       */
      void init(long validComponentSequence, long lsn, long validComponentId, String masterNodeId)
              throws HyracksDataException;
  
      /**
       * Called when a new LSM disk component is flushed due to a replicated component.
       * When called, the index checkpoint is updated with the latest valid {@code componentSequence}
       * and low watermark {@code lsn}
       *
       * @param componentSequence
       * @param lsn
       * @param masterNodeId
       * @throws HyracksDataException
       */
      void flushed(long componentSequence, long lsn, long componentId, String masterNodeId) throws HyracksDataException;
  
      /**
       * Called when a new LSM disk component is flushed. When called, the index checkpoint is updated
       * with the latest valid {@code componentSequence} and low watermark {@code lsn}
       *
       * @param componentSequence
       * @param lsn
       * @throws HyracksDataException
       */
      void flushed(long componentSequence, long lsn, long componentId) throws HyracksDataException;
  
      /**
       * Called when a new LSM disk component is replicated from master. When called, the index checkpoint is updated
       * with the latest valid {@code componentSequence} and the local lsn mapping of {@code masterLsn} is set as the
       * new low watermark.
       *
       * @param componentSequence
       * @param masterLsn
       * @param componentId
       * @param masterNodeId
       * @throws HyracksDataException
       */
      void replicated(long componentSequence, long masterLsn, long componentId, String masterNodeId)
              throws HyracksDataException;
  
      /**
       * Called when a flush log is received and replicated from master. The mapping between
       * {@code masterLsn} and {@code localLsn} is updated in the checkpoint.
       *
       * @param masterLsn
       * @param localLsn
       * @throws HyracksDataException
       */
      void masterFlush(long masterLsn, long localLsn) throws HyracksDataException;
  
      /**
       * The index low watermark
       *
       * @return The low watermark
       * @throws HyracksDataException
       */
      long getLowWatermark() throws HyracksDataException;
  
      /**
       * True if a mapping exists between {@code masterLsn} and a localLsn. Otherwise false.
       *
       * @param masterLsn
       * @return True if the mapping exists. Otherwise false.
       * @throws HyracksDataException
       */
      boolean isFlushed(long masterLsn) throws HyracksDataException;
  
      /**
       * Deletes all checkpoints
       */
      void delete();
  
      void deleteLatest(long latestId);
  
      /**
       * Gets the index last valid component sequence.
       *
       * @return the index last valid component sequence
       * @throws HyracksDataException
       */
      long getValidComponentSequence() throws HyracksDataException;
  
      /**
       * Gets the number of valid checkpoints the index has.
       *
       * @return the number of valid checkpoints
       * @throws HyracksDataException
       */
      int getCheckpointCount() throws HyracksDataException;
  
      /**
       * @return the latest checkpoint
       * @throws HyracksDataException
       */
      IndexCheckpoint getLatest() throws HyracksDataException;
  
      /**
       * Advance the last valid component. Used for replicated bulkloaded components
       *
       * @param componentSequence
       * @param componentId
       * @throws HyracksDataException
       */
      void advanceValidComponent(long componentSequence, long componentId) throws HyracksDataException;
  
      /**
       * Set the last component id. Used during recovery or after component delete
       *
       * @param componentId
       * @throws HyracksDataException
       */
      void setLastComponentId(long componentId) throws HyracksDataException;
  
      /**
       * Indicates that the index has at least one valid checkpoint
       *
       * @return true if the index has at least one valid checkpoint. Otherwise false
       * @throws HyracksDataException
       */
      boolean isValidIndex() throws HyracksDataException;
  }
  