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 package org.opendaylight.controller.cluster.datastore.modification;
   9
  10 import static com.google.common.base.Preconditions.checkArgument;
  11 import static java.util.Objects.requireNonNull;
  12
  13 import java.io.IOException;
  14 import java.io.ObjectInput;
  15 import java.io.ObjectOutput;
  16 import java.util.ArrayList;
  17 import java.util.Collections;
  18 import java.util.List;
  19 import org.opendaylight.controller.cluster.datastore.DataStoreVersions;
  20 import org.opendaylight.controller.cluster.datastore.messages.VersionedExternalizableMessage;
  21 import org.opendaylight.mdsal.dom.spi.store.DOMStoreWriteTransaction;
  22 import org.opendaylight.yangtools.yang.data.api.schema.stream.ReusableStreamReceiver;
  23 import org.opendaylight.yangtools.yang.data.codec.binfmt.NormalizedNodeDataInput;
  24 import org.opendaylight.yangtools.yang.data.codec.binfmt.NormalizedNodeDataOutput;
  25 import org.opendaylight.yangtools.yang.data.impl.schema.ReusableImmutableNormalizedNodeStreamWriter;
  26 import org.opendaylight.yangtools.yang.data.tree.api.DataTreeModification;
  27
  28 /**
  29  * MutableCompositeModification is just a mutable version of a CompositeModification.
  30  */
  31 @Deprecated(since = "9.0.0", forRemoval = true)
  32 public class MutableCompositeModification extends VersionedExternalizableMessage implements CompositeModification {
  33     private static final long serialVersionUID = 1L;
  34
  35     private final List<Modification> modifications = new ArrayList<>();
  36     private List<Modification> immutableModifications = null;
  37
  38     public MutableCompositeModification() {
  39         this(DataStoreVersions.CURRENT_VERSION);
  40     }
  41
  42     public MutableCompositeModification(final short version) {
  43         super(version);
  44     }
  45
  46     @Override
  47     public void apply(final DOMStoreWriteTransaction transaction) {
  48         for (Modification modification : modifications) {
  49             modification.apply(transaction);
  50         }
  51     }
  52
  53     @Override
  54     public void apply(final DataTreeModification transaction) {
  55         for (Modification modification : modifications) {
  56             modification.apply(transaction);
  57         }
  58     }
  59
  60     @Override
  61     public byte getType() {
  62         return COMPOSITE;
  63     }
  64
  65     /**
  66      * Add a new Modification to the list of Modifications represented by this composite.
  67      *
  68      * @param modification the modification to add.
  69      */
  70     public void addModification(final Modification modification) {
  71         modifications.add(requireNonNull(modification));
  72     }
  73
  74     public void addModifications(final Iterable<Modification> newMods) {
  75         for (Modification mod : newMods) {
  76             addModification(mod);
  77         }
  78     }
  79
  80     @Override
  81     public List<Modification> getModifications() {
  82         if (immutableModifications == null) {
  83             immutableModifications = Collections.unmodifiableList(modifications);
  84         }
  85
  86         return immutableModifications;
  87     }
  88
  89     @Override
  90     public void readExternal(final ObjectInput in) throws IOException, ClassNotFoundException {
  91         super.readExternal(in);
  92         final int size = in.readInt();
  93         if (size > 0) {
  94             if (getVersion() >= DataStoreVersions.PHOSPHORUS_VERSION) {
  95                 readExternalModern(NormalizedNodeDataInput.newDataInput(in), size);
  96             } else {
  97                 readExternalLegacy(in, size);
  98             }
  99         }
 100     }
 101
 102     @Override
 103     public void writeExternal(final ObjectOutput out) throws IOException {
 104         super.writeExternal(out);
 105         final int size = modifications.size();
 106         out.writeInt(size);
 107         if (size > 0) {
 108             if (getVersion() >= DataStoreVersions.PHOSPHORUS_VERSION) {
 109                 writeExternalModern(out);
 110             } else {
 111                 writeExternalLegacy(out);
 112             }
 113         }
 114     }
 115
 116     private void readExternalLegacy(final ObjectInput in, final int size) throws IOException {
 117         final NormalizedNodeDataInput input = NormalizedNodeDataInput.newDataInputWithoutValidation(in);
 118         final ReusableStreamReceiver receiver = ReusableImmutableNormalizedNodeStreamWriter.create();
 119         for (int i = 0; i < size; i++) {
 120             final byte type = in.readByte();
 121             switch (type) {
 122                 case Modification.WRITE:
 123                     modifications.add(WriteModification.fromStream(input, getVersion(), receiver));
 124                     break;
 125                 case Modification.MERGE:
 126                     modifications.add(MergeModification.fromStream(input, getVersion(), receiver));
 127                     break;
 128                 case Modification.DELETE:
 129                     modifications.add(DeleteModification.fromStream(input, getVersion()));
 130                     break;
 131                 default:
 132                     break;
 133             }
 134         }
 135     }
 136
 137     private void writeExternalLegacy(final ObjectOutput out) throws IOException {
 138         try (NormalizedNodeDataOutput stream = getStreamVersion().newDataOutput(out)) {
 139             for (Modification mod : modifications) {
 140                 out.writeByte(mod.getType());
 141                 mod.writeTo(stream);
 142             }
 143         }
 144     }
 145
 146     private void readExternalModern(final NormalizedNodeDataInput in, final int size) throws IOException {
 147         final ReusableStreamReceiver receiver = ReusableImmutableNormalizedNodeStreamWriter.create();
 148         for (int i = 0; i < size; i++) {
 149             final byte type = in.readByte();
 150             switch (type) {
 151                 case Modification.WRITE:
 152                     modifications.add(WriteModification.fromStream(in, getVersion(), receiver));
 153                     break;
 154                 case Modification.MERGE:
 155                     modifications.add(MergeModification.fromStream(in, getVersion(), receiver));
 156                     break;
 157                 case Modification.DELETE:
 158                     modifications.add(DeleteModification.fromStream(in, getVersion()));
 159                     break;
 160                 default:
 161                     break;
 162             }
 163         }
 164     }
 165
 166     private void writeExternalModern(final ObjectOutput out) throws IOException {
 167         try (NormalizedNodeDataOutput stream = getStreamVersion().newDataOutput(out)) {
 168             for (Modification mod : modifications) {
 169                 stream.writeByte(mod.getType());
 170                 mod.writeTo(stream);
 171             }
 172         }
 173     }
 174
 175     public static MutableCompositeModification fromSerializable(final Object serializable) {
 176         checkArgument(serializable instanceof MutableCompositeModification);
 177         return (MutableCompositeModification)serializable;
 178     }
 179
 180     @Override
 181     public void writeTo(final NormalizedNodeDataOutput out) throws IOException {
 182         throw new UnsupportedOperationException();
 183     }
 184 }