opendaylight/md-sal/cds-access-api/src/main/java/org/opendaylight/controller/cluster/access/commands/ModifyTransactionRequestProxyV1.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 static java.util.Objects.requireNonNull;
  11
  12 import akka.actor.ActorRef;
  13 import com.google.common.collect.ImmutableList;
  14 import java.io.IOException;
  15 import java.io.ObjectInput;
  16 import java.io.ObjectOutput;
  17 import java.io.Serial;
  18 import java.util.ArrayList;
  19 import java.util.List;
  20 import java.util.Optional;
  21 import org.opendaylight.controller.cluster.access.concepts.TransactionIdentifier;
  22 import org.opendaylight.yangtools.yang.data.codec.binfmt.NormalizedNodeDataInput;
  23 import org.opendaylight.yangtools.yang.data.codec.binfmt.NormalizedNodeDataOutput;
  24 import org.opendaylight.yangtools.yang.data.codec.binfmt.NormalizedNodeStreamVersion;
  25 import org.opendaylight.yangtools.yang.data.impl.schema.ReusableImmutableNormalizedNodeStreamWriter;
  26
  27 /**
  28  * Externalizable proxy for use with {@link ExistsTransactionRequest}. It implements the initial (Boron) serialization
  29  * format.
  30  *
  31  * @author Robert Varga
  32  */
  33 final class ModifyTransactionRequestProxyV1 extends AbstractTransactionRequestProxy<ModifyTransactionRequest> {
  34     @Serial
  35     private static final long serialVersionUID = 1L;
  36
  37     private List<TransactionModification> modifications;
  38     private Optional<PersistenceProtocol> protocol;
  39     private transient NormalizedNodeStreamVersion streamVersion;
  40
  41     // checkstyle flags the public modifier as redundant however it is explicitly needed for Java serialization to
  42     // be able to create instances via reflection.
  43     @SuppressWarnings("checkstyle:RedundantModifier")
  44     public ModifyTransactionRequestProxyV1() {
  45         // For Externalizable
  46     }
  47
  48     ModifyTransactionRequestProxyV1(final ModifyTransactionRequest request) {
  49         super(request);
  50         modifications = requireNonNull(request.getModifications());
  51         protocol = request.getPersistenceProtocol();
  52         streamVersion = request.getVersion().getStreamVersion();
  53     }
  54
  55     @Override
  56     public void readExternal(final ObjectInput in) throws IOException, ClassNotFoundException {
  57         super.readExternal(in);
  58
  59         protocol = Optional.ofNullable(PersistenceProtocol.readFrom(in));
  60
  61         final int size = in.readInt();
  62         if (size != 0) {
  63             modifications = new ArrayList<>(size);
  64             final NormalizedNodeDataInput nnin = NormalizedNodeDataInput.newDataInput(in);
  65             final ReusableImmutableNormalizedNodeStreamWriter writer =
  66                     ReusableImmutableNormalizedNodeStreamWriter.create();
  67             for (int i = 0; i < size; ++i) {
  68                 modifications.add(TransactionModification.readFrom(nnin, writer));
  69             }
  70         } else {
  71             modifications = ImmutableList.of();
  72         }
  73     }
  74
  75     @Override
  76     public void writeExternal(final ObjectOutput out) throws IOException {
  77         super.writeExternal(out);
  78
  79         out.writeByte(PersistenceProtocol.byteValue(protocol.orElse(null)));
  80         out.writeInt(modifications.size());
  81         if (!modifications.isEmpty()) {
  82             try (NormalizedNodeDataOutput nnout = streamVersion.newDataOutput(out)) {
  83                 for (TransactionModification op : modifications) {
  84                     op.writeTo(nnout);
  85                 }
  86             }
  87         }
  88     }
  89
  90     @Override
  91     protected ModifyTransactionRequest createRequest(final TransactionIdentifier target, final long sequence,
  92             final ActorRef replyTo) {
  93         return new ModifyTransactionRequest(target, sequence, replyTo, modifications, protocol.orElse(null));
  94     }
  95 }