Bug 7901: Prevent null Modification in BatchedModifications
[controller.git] / opendaylight / md-sal / sal-distributed-datastore / src / main / java / org / opendaylight / controller / cluster / datastore / modification / MutableCompositeModification.java
1 /*
2  * Copyright (c) 2014 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
9 package org.opendaylight.controller.cluster.datastore.modification;
10
11 import com.google.common.base.Preconditions;
12 import java.io.IOException;
13 import java.io.ObjectInput;
14 import java.io.ObjectOutput;
15 import java.util.ArrayList;
16 import java.util.Collections;
17 import java.util.List;
18 import org.opendaylight.controller.cluster.datastore.DataStoreVersions;
19 import org.opendaylight.controller.cluster.datastore.messages.VersionedExternalizableMessage;
20 import org.opendaylight.controller.cluster.datastore.node.utils.stream.NormalizedNodeInputOutput;
21 import org.opendaylight.controller.cluster.datastore.node.utils.stream.NormalizedNodeInputStreamReader;
22 import org.opendaylight.controller.cluster.datastore.node.utils.stream.SerializationUtils;
23 import org.opendaylight.controller.sal.core.spi.data.DOMStoreWriteTransaction;
24 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeModification;
25
26 /**
27  * MutableCompositeModification is just a mutable version of a CompositeModification.
28  */
29 public class MutableCompositeModification extends VersionedExternalizableMessage implements CompositeModification {
30     private static final long serialVersionUID = 1L;
31
32     private final List<Modification> modifications = new ArrayList<>();
33     private List<Modification> immutableModifications = null;
34
35     public MutableCompositeModification() {
36         this(DataStoreVersions.CURRENT_VERSION);
37     }
38
39     public MutableCompositeModification(short version) {
40         super(version);
41     }
42
43     @Override
44     public void apply(DOMStoreWriteTransaction transaction) {
45         for (Modification modification : modifications) {
46             modification.apply(transaction);
47         }
48     }
49
50     @Override
51     public void apply(DataTreeModification transaction) {
52         for (Modification modification : modifications) {
53             modification.apply(transaction);
54         }
55     }
56
57     @Override
58     public byte getType() {
59         return COMPOSITE;
60     }
61
62     /**
63      * Add a new Modification to the list of Modifications represented by this composite.
64      *
65      * @param modification the modification to add.
66      */
67     public void addModification(Modification modification) {
68         Preconditions.checkNotNull(modification);
69         modifications.add(modification);
70     }
71
72     public void addModifications(Iterable<Modification> newMods) {
73         for (Modification mod : newMods) {
74             addModification(mod);
75         }
76     }
77
78     @Override
79     public List<Modification> getModifications() {
80         if (immutableModifications == null) {
81             immutableModifications = Collections.unmodifiableList(modifications);
82         }
83
84         return immutableModifications;
85     }
86
87     @Override
88     public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException {
89         super.readExternal(in);
90
91         int size = in.readInt();
92
93         if (size > 1) {
94             SerializationUtils.REUSABLE_READER_TL.set(new NormalizedNodeInputStreamReader(in));
95         }
96
97         try {
98             for (int i = 0; i < size; i++) {
99                 byte type = in.readByte();
100                 switch (type) {
101                     case Modification.WRITE:
102                         modifications.add(WriteModification.fromStream(in, getVersion()));
103                         break;
104
105                     case Modification.MERGE:
106                         modifications.add(MergeModification.fromStream(in, getVersion()));
107                         break;
108
109                     case Modification.DELETE:
110                         modifications.add(DeleteModification.fromStream(in, getVersion()));
111                         break;
112                     default:
113                         break;
114                 }
115             }
116         } finally {
117             SerializationUtils.REUSABLE_READER_TL.remove();
118         }
119     }
120
121     @Override
122     public void writeExternal(ObjectOutput out) throws IOException {
123         super.writeExternal(out);
124
125         out.writeInt(modifications.size());
126
127         if (modifications.size() > 1) {
128             SerializationUtils.REUSABLE_WRITER_TL.set(NormalizedNodeInputOutput.newDataOutput(out));
129         }
130
131         try {
132             for (Modification mod: modifications) {
133                 out.writeByte(mod.getType());
134                 mod.writeExternal(out);
135             }
136         } finally {
137             SerializationUtils.REUSABLE_WRITER_TL.remove();
138         }
139     }
140
141     public static MutableCompositeModification fromSerializable(Object serializable) {
142         Preconditions.checkArgument(serializable instanceof MutableCompositeModification);
143         return (MutableCompositeModification)serializable;
144     }
145 }