opendaylight/md-sal/cds-access-api/src/main/java/org/opendaylight/controller/cluster/access/commands/ModifyTransactionRequestBuilder.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 akka.actor.ActorRef;
  11 import com.google.common.annotations.Beta;
  12 import com.google.common.base.Preconditions;
  13 import java.util.ArrayList;
  14 import java.util.List;
  15 import javax.annotation.concurrent.NotThreadSafe;
  16 import org.opendaylight.controller.cluster.access.concepts.TransactionIdentifier;
  17 import org.opendaylight.yangtools.concepts.Builder;
  18 import org.opendaylight.yangtools.concepts.Identifiable;
  19
  20 /**
  21  * A reusable {@link Builder} for creating {@link ModifyTransactionRequest} message instances. Its internal state is
  22  * reset when {@link #build()} is invoked, hence it can be used to create a sequence of messages.
  23  *
  24  * @author Robert Varga
  25  */
  26 @Beta
  27 @NotThreadSafe
  28 public final class ModifyTransactionRequestBuilder implements Builder<ModifyTransactionRequest>,
  29         Identifiable<TransactionIdentifier> {
  30     private final List<TransactionModification> modifications = new ArrayList<>(1);
  31     private final TransactionIdentifier identifier;
  32     private final ActorRef replyTo;
  33
  34     private PersistenceProtocol protocol;
  35     private boolean haveSequence;
  36     private long sequence;
  37
  38     public ModifyTransactionRequestBuilder(final TransactionIdentifier identifier, final ActorRef replyTo) {
  39         this.identifier = Preconditions.checkNotNull(identifier);
  40         this.replyTo = Preconditions.checkNotNull(replyTo);
  41     }
  42
  43     @Override
  44     public TransactionIdentifier getIdentifier() {
  45         return identifier;
  46     }
  47
  48     private void checkNotFinished() {
  49         Preconditions.checkState(protocol == null, "Batch has already been finished");
  50     }
  51
  52     public void addModification(final TransactionModification modification) {
  53         checkNotFinished();
  54         modifications.add(Preconditions.checkNotNull(modification));
  55     }
  56
  57     public void setSequence(final long sequence) {
  58         Preconditions.checkState(!haveSequence, "Sequence has already been set");
  59         this.sequence = sequence;
  60         haveSequence = true;
  61     }
  62
  63     public void setAbort() {
  64         checkNotFinished();
  65         // Transaction is being aborted, no need to transmit operations
  66         modifications.clear();
  67         protocol = PersistenceProtocol.ABORT;
  68     }
  69
  70     public void setCommit(final boolean coordinated) {
  71         checkNotFinished();
  72         protocol = coordinated ? PersistenceProtocol.THREE_PHASE : PersistenceProtocol.SIMPLE;
  73     }
  74
  75     public void setReady() {
  76         checkNotFinished();
  77         protocol = PersistenceProtocol.READY;
  78     }
  79
  80     public int size() {
  81         return modifications.size();
  82     }
  83
  84     @Override
  85     public ModifyTransactionRequest build() {
  86         Preconditions.checkState(haveSequence, "Request sequence has not been set");
  87
  88         final ModifyTransactionRequest ret = new ModifyTransactionRequest(identifier, sequence, replyTo, modifications,
  89             protocol);
  90         modifications.clear();
  91         protocol = null;
  92         haveSequence = false;
  93         return ret;
  94     }
  95 }