171e5dce3db0dea3790f4d599aaa3da55b97cf22
[controller.git] / opendaylight / md-sal / cds-access-api / src / main / java / org / opendaylight / controller / cluster / access / commands / ModifyTransactionRequest.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.MoreObjects.ToStringHelper;
13 import com.google.common.collect.ImmutableList;
14 import java.util.List;
15 import java.util.Optional;
16 import org.opendaylight.controller.cluster.access.ABIVersion;
17 import org.opendaylight.controller.cluster.access.concepts.TransactionIdentifier;
18
19 /**
20  * A transaction request to apply a particular set of operations on top of the current transaction. This message is
21  * used to also finish a transaction by specifying a {@link PersistenceProtocol}.
22  *
23  * @author Robert Varga
24  */
25 @Beta
26 public final class ModifyTransactionRequest extends TransactionRequest<ModifyTransactionRequest> {
27     private static final long serialVersionUID = 1L;
28     private final List<TransactionModification> modifications;
29     private final PersistenceProtocol protocol;
30
31     private ModifyTransactionRequest(final ModifyTransactionRequest request, final long retry) {
32         super(request, retry);
33         this.modifications = request.modifications;
34         this.protocol = request.protocol;
35     }
36
37     ModifyTransactionRequest(final TransactionIdentifier target, final long sequence, final long retry,
38         final ActorRef replyTo, final List<TransactionModification> modifications, final PersistenceProtocol protocol) {
39         super(target, sequence, retry, replyTo);
40         this.modifications = ImmutableList.copyOf(modifications);
41         this.protocol = protocol;
42     }
43
44     public Optional<PersistenceProtocol> getPersistenceProtocol() {
45         return Optional.ofNullable(protocol);
46     }
47
48     public List<TransactionModification> getModifications() {
49         return modifications;
50     }
51
52     @Override
53     protected ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
54         return super.addToStringAttributes(toStringHelper).add("operations", modifications).add("protocol", protocol);
55     }
56
57     @Override
58     protected ModifyTransactionRequestProxyV1 externalizableProxy(final ABIVersion version) {
59         return new ModifyTransactionRequestProxyV1(this);
60     }
61
62     @Override
63     protected ModifyTransactionRequest cloneAsRetry(final long retry) {
64         return new ModifyTransactionRequest(this, retry);
65     }
66
67     @Override
68     protected ModifyTransactionRequest cloneAsVersion(final ABIVersion version) {
69         return this;
70     }
71
72 }