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