git.opendaylight Code Review - controller.git/blob

   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 com.google.common.base.Preconditions.checkState;
  11 import static java.util.Objects.requireNonNull;
  12
  13 import java.util.ArrayList;
  14 import org.apache.pekko.actor.ActorRef;
  15 import org.eclipse.jdt.annotation.NonNull;
  16 import org.opendaylight.controller.cluster.access.concepts.TransactionIdentifier;
  17 import org.opendaylight.yangtools.concepts.Identifiable;
  18 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  19 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  20
  21 /**
  22  * A reusable builder for creating {@link ModifyTransactionRequest} message instances. Its internal state is reset when
  23  * {@link #build()} is invoked, hence it can be used to create a sequence of messages. This class is NOT thread-safe.
  24  */
  25 public final class ModifyTransactionRequestBuilder implements Identifiable<TransactionIdentifier> {
  26     private final ArrayList<TransactionModification> modifications = new ArrayList<>(1);
  27     private final @NonNull TransactionIdentifier identifier;
  28     private final ActorRef replyTo;
  29
  30     private PersistenceProtocol protocol;
  31     private boolean haveSequence;
  32     private long sequence;
  33
  34     public ModifyTransactionRequestBuilder(final TransactionIdentifier identifier, final ActorRef replyTo) {
  35         this.identifier = requireNonNull(identifier);
  36         this.replyTo = requireNonNull(replyTo);
  37     }
  38
  39     @Override
  40     public TransactionIdentifier getIdentifier() {
  41         return identifier;
  42     }
  43
  44     private void checkNotFinished() {
  45         checkState(protocol == null, "Batch has already been finished");
  46     }
  47
  48     public ModifyTransactionRequestBuilder addModification(final TransactionModification modification) {
  49         checkNotFinished();
  50         modifications.add(requireNonNull(modification));
  51         return this;
  52     }
  53
  54     public ModifyTransactionRequestBuilder addDelete(final YangInstanceIdentifier path) {
  55         return addModification(new TransactionDelete(path));
  56     }
  57
  58     public ModifyTransactionRequestBuilder addMerge(final YangInstanceIdentifier path, final NormalizedNode data) {
  59         return addModification(new TransactionMerge(path, data));
  60     }
  61
  62     public ModifyTransactionRequestBuilder addWrite(final YangInstanceIdentifier path, final NormalizedNode data) {
  63         return addModification(new TransactionWrite(path, data));
  64     }
  65
  66     public ModifyTransactionRequestBuilder setSequence(final long sequence) {
  67         checkState(!haveSequence, "Sequence has already been set");
  68         this.sequence = sequence;
  69         haveSequence = true;
  70         return this;
  71     }
  72
  73     public ModifyTransactionRequestBuilder setAbort() {
  74         checkNotFinished();
  75         // Transaction is being aborted, no need to transmit operations
  76         modifications.clear();
  77         protocol = PersistenceProtocol.ABORT;
  78         return this;
  79     }
  80
  81     public ModifyTransactionRequestBuilder setCommit(final boolean coordinated) {
  82         checkNotFinished();
  83         protocol = coordinated ? PersistenceProtocol.THREE_PHASE : PersistenceProtocol.SIMPLE;
  84         return this;
  85     }
  86
  87     public ModifyTransactionRequestBuilder setReady() {
  88         checkNotFinished();
  89         protocol = PersistenceProtocol.READY;
  90         return this;
  91     }
  92
  93     public int size() {
  94         return modifications.size();
  95     }
  96
  97     public @NonNull ModifyTransactionRequest build() {
  98         checkState(haveSequence, "Request sequence has not been set");
  99
 100         final ModifyTransactionRequest ret = new ModifyTransactionRequest(identifier, sequence, replyTo, modifications,
 101             protocol);
 102         modifications.clear();
 103         protocol = null;
 104         haveSequence = false;
 105         return ret;
 106     }
 107 }