336902e192fe0ce0eebf687d1fc202b20181fbed
[controller.git] / 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     private PersistenceProtocol protocol = null;
34
35     public ModifyTransactionRequestBuilder(final TransactionIdentifier identifier, final ActorRef replyTo) {
36         this.identifier = Preconditions.checkNotNull(identifier);
37         this.replyTo = Preconditions.checkNotNull(replyTo);
38     }
39
40     @Override
41     public TransactionIdentifier getIdentifier() {
42         return identifier;
43     }
44
45     private void checkFinished() {
46         Preconditions.checkState(protocol != null, "Batch has already been finished");
47     }
48
49     public void addModification(final TransactionModification modification) {
50         checkFinished();
51         modifications.add(Preconditions.checkNotNull(modification));
52     }
53
54     public void setAbort() {
55         checkFinished();
56         // Transaction is being aborted, no need to transmit operations
57         modifications.clear();
58         protocol = PersistenceProtocol.ABORT;
59     }
60
61     public void setCommit(final boolean coordinated) {
62         checkFinished();
63         protocol = coordinated ? PersistenceProtocol.THREE_PHASE : PersistenceProtocol.SIMPLE;
64     }
65
66     public int size() {
67         return modifications.size();
68     }
69
70     @Override
71     public ModifyTransactionRequest build() {
72         final ModifyTransactionRequest ret = new ModifyTransactionRequest(identifier, replyTo, modifications, protocol);
73         modifications.clear();
74         protocol = null;
75         return ret;
76     }
77 }