opendaylight/md-sal/cds-access-api/src/main/java/org/opendaylight/controller/cluster/access/commands/IncrementTransactionSequenceRequest.java

   1 /*
   2  * Copyright (c) 2017 Pantheon Technologies, 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.cluster.access.commands;
   9
  10 import akka.actor.ActorRef;
  11 import com.google.common.base.Preconditions;
  12 import java.io.Serial;
  13 import org.opendaylight.controller.cluster.access.ABIVersion;
  14 import org.opendaylight.controller.cluster.access.concepts.TransactionIdentifier;
  15
  16 /**
  17  * A blank transaction request. This is used to provide backfill requests in converted retransmit scenarios, such as
  18  * when a initial request to a transaction (such as a {@link ReadTransactionRequest}) is satisfied by the backend
  19  * before the need to replay the transaction to a different remote backend.
  20  *
  21  * @author Robert Varga
  22  */
  23 public final class IncrementTransactionSequenceRequest extends
  24         AbstractReadTransactionRequest<IncrementTransactionSequenceRequest> {
  25     @Serial
  26     private static final long serialVersionUID = 1L;
  27
  28     private final long increment;
  29
  30     public IncrementTransactionSequenceRequest(final TransactionIdentifier identifier, final long sequence,
  31             final ActorRef replyTo, final boolean snapshotOnly, final long increment) {
  32         super(identifier, sequence, replyTo, snapshotOnly);
  33         Preconditions.checkArgument(increment >= 0);
  34         this.increment = increment;
  35     }
  36
  37     /**
  38      * Return the sequence increment beyond this request's sequence.
  39      *
  40      * @return Sequence increment, guaranteed to be non-negative.
  41      */
  42     public long getIncrement() {
  43         return increment;
  44     }
  45
  46     @Override
  47     protected IncrementTransactionSequenceRequestProxyV1 externalizableProxy(final ABIVersion version) {
  48         return new IncrementTransactionSequenceRequestProxyV1(this);
  49     }
  50
  51     @Override
  52     protected IncrementTransactionSequenceRequest cloneAsVersion(final ABIVersion targetVersion) {
  53         return this;
  54     }
  55 }