opendaylight/md-sal/sal-akka-segmented-journal/src/main/java/org/opendaylight/controller/akka/segjournal/DataJournal.java

   1 /*
   2  * Copyright (c) 2020 PANTHEON.tech, s.r.o. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.controller.akka.segjournal;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  12 import com.codahale.metrics.Histogram;
  13 import org.eclipse.jdt.annotation.NonNull;
  14 import org.opendaylight.controller.akka.segjournal.SegmentedJournalActor.ReplayMessages;
  15 import org.opendaylight.controller.akka.segjournal.SegmentedJournalActor.WriteMessages;
  16
  17 /**
  18  * Abstraction of a data journal. This provides a unified interface towards {@link SegmentedJournalActor}, allowing
  19  * specialization for various formats.
  20  */
  21 abstract class DataJournal {
  22     // Mirrors fields from associated actor
  23     final @NonNull String persistenceId;
  24     private final Histogram messageSize;
  25
  26     // Tracks largest message size we have observed either during recovery or during write
  27     private int largestObservedSize;
  28
  29     DataJournal(final String persistenceId, final Histogram messageSize) {
  30         this.persistenceId = requireNonNull(persistenceId);
  31         this.messageSize = requireNonNull(messageSize);
  32     }
  33
  34     final void recordMessageSize(final int size) {
  35         messageSize.update(size);
  36         updateLargestSize(size);
  37     }
  38
  39     final void updateLargestSize(final int size) {
  40         if (size > largestObservedSize) {
  41             largestObservedSize = size;
  42         }
  43     }
  44
  45     /**
  46      * Return the last sequence number completely written to the journal.
  47      *
  48      * @return Last written sequence number, {@code -1} if there are no in the journal.
  49      */
  50     abstract long lastWrittenSequenceNr();
  51
  52     /**
  53      * Delete all messages up to specified sequence number.
  54      *
  55      * @param sequenceNr Sequence number to delete to.
  56      */
  57     abstract void deleteTo(long sequenceNr);
  58
  59     /**
  60      * Delete all messages up to specified sequence number.
  61      *
  62      * @param sequenceNr Sequence number to compact to.
  63      */
  64     abstract void compactTo(long sequenceNr);
  65
  66     /**
  67      * Close this journal, freeing up resources associated with it.
  68      */
  69     abstract void close();
  70
  71     /**
  72      * Handle a request to replay messages.
  73      *
  74      * @param message Request message
  75      * @param fromSequenceNr Sequence number to replay from, adjusted for deletions
  76      */
  77     abstract void handleReplayMessages(@NonNull ReplayMessages message, long fromSequenceNr);
  78
  79     /**
  80      * Handle a request to store some messages.
  81      *
  82      * @param message Request message
  83      */
  84     abstract void handleWriteMessages(@NonNull WriteMessages message);
  85 }