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

   1 /*
   2  * Copyright (c) 2016 Cisco Systems, Inc. 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 static java.util.Objects.requireNonNull;
  11
  12 import akka.actor.ActorRef;
  13 import com.google.common.base.MoreObjects.ToStringHelper;
  14 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
  15 import java.util.Optional;
  16 import org.eclipse.jdt.annotation.NonNull;
  17 import org.eclipse.jdt.annotation.Nullable;
  18 import org.opendaylight.controller.cluster.access.concepts.TransactionIdentifier;
  19 import org.opendaylight.yangtools.yang.data.tree.api.DataTreeModification;
  20
  21 /**
  22  * Request to commit a local transaction. Since local transactions do not introduce state on the backend until they
  23  * are ready, this message carries a complete set of modifications.
  24  */
  25 public final class CommitLocalTransactionRequest
  26         extends AbstractLocalTransactionRequest<CommitLocalTransactionRequest> {
  27     @java.io.Serial
  28     private static final long serialVersionUID = 1L;
  29
  30     @SuppressFBWarnings(value = "SE_BAD_FIELD", justification = "This field is not Serializable but this class "
  31             + "implements writeReplace to delegate serialization to a Proxy class and thus instances of this class "
  32             + "aren't serialized. FindBugs does not recognize this.")
  33     private final DataTreeModification mod;
  34     private final Exception delayedFailure;
  35     private final boolean coordinated;
  36
  37     public CommitLocalTransactionRequest(final @NonNull TransactionIdentifier identifier, final long sequence,
  38             final @NonNull ActorRef replyTo, final @NonNull DataTreeModification mod,
  39             final @Nullable Exception delayedFailure, final boolean coordinated) {
  40         super(identifier, sequence, replyTo);
  41         this.mod = requireNonNull(mod);
  42         this.delayedFailure = delayedFailure;
  43         this.coordinated = coordinated;
  44     }
  45
  46     /**
  47      * Return the delayed error detected on the frontend. If this error is present, it will be reported as the result
  48      * of the first step of the commit process.
  49      *
  50      * @return Delayed failure, if present.
  51      */
  52     public Optional<Exception> getDelayedFailure() {
  53         return Optional.ofNullable(delayedFailure);
  54     }
  55
  56     public DataTreeModification getModification() {
  57         return mod;
  58     }
  59
  60     /**
  61      * Indicate if this is a coordinated, multi-backend request. If this method returns true, the backend must
  62      * act as a cohort participating in the three-phase commit (3PC) protocol to commit this transaction.  If this
  63      * method returns false, the backend should proceed to commit the transaction and respond once the commit completes
  64      * or fails to complete.
  65      *
  66      * @return Indication of coordinated commit.
  67      */
  68     public boolean isCoordinated() {
  69         return coordinated;
  70     }
  71
  72     @Override
  73     protected ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
  74         return super.addToStringAttributes(toStringHelper).add("coordinated", coordinated)
  75                 .add("delayedError", delayedFailure);
  76     }
  77 }