opendaylight/md-sal/cds-access-api/src/main/java/org/opendaylight/controller/cluster/access/commands/ReadTransactionSuccess.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 edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
  13 import java.io.IOException;
  14 import java.io.ObjectInput;
  15 import java.io.ObjectOutput;
  16 import java.util.Optional;
  17 import org.opendaylight.controller.cluster.access.ABIVersion;
  18 import org.opendaylight.controller.cluster.access.concepts.SliceableMessage;
  19 import org.opendaylight.controller.cluster.access.concepts.TransactionIdentifier;
  20 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  21 import org.opendaylight.yangtools.yang.data.codec.binfmt.NormalizedNodeDataInput;
  22
  23 /**
  24  * Successful reply to an {@link ReadTransactionRequest}. It indicates presence of requested data via
  25  * {@link #getData()}.
  26  */
  27 public final class ReadTransactionSuccess extends TransactionSuccess<ReadTransactionSuccess>
  28         implements SliceableMessage {
  29     interface SerialForm extends TransactionSuccess.SerialForm<ReadTransactionSuccess> {
  30         @Override
  31         default ReadTransactionSuccess readExternal(final ObjectInput in, final TransactionIdentifier target,
  32                 final long sequence) throws IOException {
  33             final Optional<NormalizedNode> data;
  34             if (in.readBoolean()) {
  35                 data = Optional.of(NormalizedNodeDataInput.newDataInput(in).readNormalizedNode());
  36             } else {
  37                 data = Optional.empty();
  38             }
  39             return new ReadTransactionSuccess(target, sequence, data);
  40         }
  41
  42         @Override
  43         default void writeExternal(final ObjectOutput out, final ReadTransactionSuccess msg) throws IOException {
  44             TransactionSuccess.SerialForm.super.writeExternal(out, msg);
  45
  46             final var data = msg.getData();
  47             if (data.isPresent()) {
  48                 out.writeBoolean(true);
  49                 try (var nnout = msg.getVersion().getStreamVersion().newDataOutput(out)) {
  50                     nnout.writeNormalizedNode(data.orElseThrow());
  51                 }
  52             } else {
  53                 out.writeBoolean(false);
  54             }
  55         }
  56     }
  57
  58     @java.io.Serial
  59     private static final long serialVersionUID = 1L;
  60
  61     @SuppressFBWarnings(value = "SE_BAD_FIELD", justification = "interface-based best effort")
  62     private final Optional<NormalizedNode> data;
  63
  64     private ReadTransactionSuccess(final ReadTransactionSuccess request, final ABIVersion version) {
  65         super(request, version);
  66         data = request.data;
  67     }
  68
  69     public ReadTransactionSuccess(final TransactionIdentifier identifier, final long sequence,
  70             final Optional<NormalizedNode> data) {
  71         super(identifier, sequence);
  72         this.data = requireNonNull(data);
  73     }
  74
  75     public Optional<NormalizedNode> getData() {
  76         return data;
  77     }
  78
  79     @Override
  80     protected SerialForm externalizableProxy(final ABIVersion version) {
  81         return ABIVersion.MAGNESIUM.lt(version) ? new RTS(this) : new ReadTransactionSuccessProxyV1(this);
  82     }
  83
  84     @Override
  85     protected ReadTransactionSuccess cloneAsVersion(final ABIVersion version) {
  86         return new ReadTransactionSuccess(this, version);
  87     }
  88 }