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

diff --git a/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/modification/MutableCompositeModification.java b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/modification/MutableCompositeModification.java
index d7e89597e2950473d056f0c806d8af3ca7b114c5..f2a8c00d19035120b8bcac7b522d3d97465cd29e 100644 (file)
--- a/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/modification/MutableCompositeModification.java
+++ b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/modification/MutableCompositeModification.java
@@ -8,28 +8,29 @@
 
 package org.opendaylight.controller.cluster.datastore.modification;
 
+import com.google.common.base.Preconditions;
 import java.io.IOException;
 import java.io.ObjectInput;
 import java.io.ObjectOutput;
 import java.util.ArrayList;
+import java.util.Collections;
 import java.util.List;
 import org.opendaylight.controller.cluster.datastore.DataStoreVersions;
 import org.opendaylight.controller.cluster.datastore.messages.VersionedExternalizableMessage;
 import org.opendaylight.controller.cluster.datastore.node.utils.stream.NormalizedNodeInputOutput;
 import org.opendaylight.controller.cluster.datastore.node.utils.stream.NormalizedNodeInputStreamReader;
-import org.opendaylight.controller.cluster.datastore.utils.SerializationUtils;
-import org.opendaylight.controller.protobuff.messages.persistent.PersistentMessages;
+import org.opendaylight.controller.cluster.datastore.node.utils.stream.SerializationUtils;
 import org.opendaylight.controller.sal.core.spi.data.DOMStoreWriteTransaction;
 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeModification;
 
 /**
- * MutableCompositeModification is just a mutable version of a
- * CompositeModification {@link org.opendaylight.controller.cluster.datastore.modification.MutableCompositeModification#addModification(Modification)}
+ * MutableCompositeModification is just a mutable version of a CompositeModification.
  */
 public class MutableCompositeModification extends VersionedExternalizableMessage implements CompositeModification {
     private static final long serialVersionUID = 1L;
 
     private final List<Modification> modifications = new ArrayList<>();
+    private List<Modification> immutableModifications = null;
 
     public MutableCompositeModification() {
         this(DataStoreVersions.CURRENT_VERSION);
@@ -59,18 +60,28 @@ public class MutableCompositeModification extends VersionedExternalizableMessage
     }
 
     /**
-     * Add a new Modification to the list of Modifications represented by this
-     * composite
+     * Add a new Modification to the list of Modifications represented by this composite.
      *
-     * @param modification
+     * @param modification the modification to add.
      */
     public void addModification(Modification modification) {
+        Preconditions.checkNotNull(modification);
         modifications.add(modification);
     }
 
+    public void addModifications(Iterable<Modification> newMods) {
+        for (Modification mod : newMods) {
+            addModification(mod);
+        }
+    }
+
     @Override
     public List<Modification> getModifications() {
-        return modifications;
+        if (immutableModifications == null) {
+            immutableModifications = Collections.unmodifiableList(modifications);
+        }
+
+        return immutableModifications;
     }
 
     @Override
@@ -79,25 +90,27 @@ public class MutableCompositeModification extends VersionedExternalizableMessage
 
         int size = in.readInt();
 
-        if(size > 1) {
+        if (size > 1) {
             SerializationUtils.REUSABLE_READER_TL.set(new NormalizedNodeInputStreamReader(in));
         }
 
         try {
-            for(int i = 0; i < size; i++) {
+            for (int i = 0; i < size; i++) {
                 byte type = in.readByte();
-                switch(type) {
-                case Modification.WRITE:
-                    modifications.add(WriteModification.fromStream(in, getVersion()));
-                    break;
-
-                case Modification.MERGE:
-                    modifications.add(MergeModification.fromStream(in, getVersion()));
-                    break;
-
-                case Modification.DELETE:
-                    modifications.add(DeleteModification.fromStream(in, getVersion()));
-                    break;
+                switch (type) {
+                    case Modification.WRITE:
+                        modifications.add(WriteModification.fromStream(in, getVersion()));
+                        break;
+
+                    case Modification.MERGE:
+                        modifications.add(MergeModification.fromStream(in, getVersion()));
+                        break;
+
+                    case Modification.DELETE:
+                        modifications.add(DeleteModification.fromStream(in, getVersion()));
+                        break;
+                    default:
+                        break;
                 }
             }
         } finally {
@@ -111,12 +124,12 @@ public class MutableCompositeModification extends VersionedExternalizableMessage
 
         out.writeInt(modifications.size());
 
-        if(modifications.size() > 1) {
+        if (modifications.size() > 1) {
             SerializationUtils.REUSABLE_WRITER_TL.set(NormalizedNodeInputOutput.newDataOutput(out));
         }
 
         try {
-            for(Modification mod: modifications) {
+            for (Modification mod: modifications) {
                 out.writeByte(mod.getType());
                 mod.writeExternal(out);
             }
@@ -125,48 +138,8 @@ public class MutableCompositeModification extends VersionedExternalizableMessage
         }
     }
 
-    @Override
-    @Deprecated
-    protected Object newLegacySerializedInstance() {
-        if(getVersion() >= DataStoreVersions.LITHIUM_VERSION) {
-            return this;
-        } else {
-            PersistentMessages.CompositeModification.Builder builder =
-                    PersistentMessages.CompositeModification.newBuilder();
-
-            builder.setTimeStamp(System.nanoTime());
-
-            for (Modification m : modifications) {
-                builder.addModification((PersistentMessages.Modification) m.toSerializable());
-            }
-
-            return builder.build();
-        }
-    }
-
     public static MutableCompositeModification fromSerializable(Object serializable) {
-        if(serializable instanceof MutableCompositeModification) {
-            return (MutableCompositeModification)serializable;
-        } else {
-            return fromLegacySerializable(serializable);
-        }
-    }
-
-    @Deprecated
-    private static MutableCompositeModification fromLegacySerializable(Object serializable) {
-        PersistentMessages.CompositeModification o = (PersistentMessages.CompositeModification) serializable;
-        MutableCompositeModification compositeModification = new MutableCompositeModification();
-
-        for(PersistentMessages.Modification m : o.getModificationList()){
-            if(m.getType().equals(DeleteModification.class.toString())){
-                compositeModification.addModification(DeleteModification.fromSerializable(m));
-            } else if(m.getType().equals(WriteModification.class.toString())){
-                compositeModification.addModification(WriteModification.fromSerializable(m));
-            } else if(m.getType().equals(MergeModification.class.toString())){
-                compositeModification.addModification(MergeModification.fromSerializable(m));
-            }
-        }
-
-        return compositeModification;
+        Preconditions.checkArgument(serializable instanceof MutableCompositeModification);
+        return (MutableCompositeModification)serializable;
     }
 }