opendaylight/md-sal/sal-clustering-commons/src/main/java/org/opendaylight/controller/cluster/datastore/node/utils/stream/SerializationUtils.java

   1 /*
   2  * Copyright (c) 2014 Brocade Communications 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.node.utils.stream;
   9
  10 import static org.opendaylight.yangtools.yang.data.codec.binfmt.NormalizedNodeStreamVersion.MAGNESIUM;
  11
  12 import java.io.DataInput;
  13 import java.io.DataOutput;
  14 import java.io.IOException;
  15 import java.util.Optional;
  16 import org.eclipse.jdt.annotation.NonNull;
  17 import org.eclipse.jdt.annotation.Nullable;
  18 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  19 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  20 import org.opendaylight.yangtools.yang.data.codec.binfmt.NormalizedNodeDataInput;
  21 import org.opendaylight.yangtools.yang.data.codec.binfmt.NormalizedNodeDataOutput;
  22 import org.opendaylight.yangtools.yang.data.codec.binfmt.NormalizedNodeStreamVersion;
  23
  24 /**
  25  * Provides various utility methods for serialization and de-serialization.
  26  *
  27  * @author Thomas Pantelis
  28  */
  29 public final class SerializationUtils {
  30     private SerializationUtils() {
  31
  32     }
  33
  34     @FunctionalInterface
  35     public interface Applier<T> {
  36         void apply(T instance, YangInstanceIdentifier path, NormalizedNode node);
  37     }
  38
  39     public static Optional<NormalizedNode> readNormalizedNode(final DataInput in) throws IOException {
  40         if (!in.readBoolean()) {
  41             return Optional.empty();
  42         }
  43         return Optional.of(NormalizedNodeDataInput.newDataInput(in).readNormalizedNode());
  44     }
  45
  46     public static void writeNormalizedNode(final DataOutput out, final @Nullable NormalizedNode node)
  47             throws IOException {
  48         writeNormalizedNode(out, MAGNESIUM, node);
  49     }
  50
  51     public static void writeNormalizedNode(final DataOutput out, final NormalizedNodeStreamVersion version,
  52             final @Nullable NormalizedNode node) throws IOException {
  53         if (node != null) {
  54             out.writeBoolean(true);
  55
  56             try (NormalizedNodeDataOutput stream = version.newDataOutput(out)) {
  57                 stream.writeNormalizedNode(node);
  58             }
  59         } else {
  60             out.writeBoolean(false);
  61         }
  62     }
  63
  64     public static YangInstanceIdentifier readPath(final DataInput in) throws IOException {
  65         return NormalizedNodeDataInput.newDataInput(in).readYangInstanceIdentifier();
  66     }
  67
  68     public static void writePath(final DataOutput out, final @NonNull YangInstanceIdentifier path)
  69             throws IOException {
  70         writePath(out, MAGNESIUM, path);
  71     }
  72
  73     public static void writePath(final DataOutput out, final NormalizedNodeStreamVersion version,
  74             final @NonNull YangInstanceIdentifier path) throws IOException {
  75         try (NormalizedNodeDataOutput stream = version.newDataOutput(out)) {
  76             stream.writeYangInstanceIdentifier(path);
  77         }
  78     }
  79
  80     public static <T> void readNodeAndPath(final DataInput in, final T instance, final Applier<T> applier)
  81             throws IOException {
  82         final NormalizedNodeDataInput stream = NormalizedNodeDataInput.newDataInput(in);
  83         NormalizedNode node = stream.readNormalizedNode();
  84         YangInstanceIdentifier path = stream.readYangInstanceIdentifier();
  85         applier.apply(instance, path, node);
  86     }
  87
  88     public static void writeNodeAndPath(final DataOutput out, final NormalizedNodeStreamVersion version,
  89             final YangInstanceIdentifier path, final NormalizedNode node) throws IOException {
  90         try (NormalizedNodeDataOutput stream = version.newDataOutput(out)) {
  91             stream.writeNormalizedNode(node);
  92             stream.writeYangInstanceIdentifier(path);
  93         }
  94     }
  95
  96     public static void writeNodeAndPath(final DataOutput out, final YangInstanceIdentifier path,
  97             final NormalizedNode node) throws IOException {
  98         writeNodeAndPath(out, MAGNESIUM, path, node);
  99     }
 100
 101     public static <T> void readPathAndNode(final DataInput in, final T instance, final Applier<T> applier)
 102             throws IOException {
 103         final NormalizedNodeDataInput stream = NormalizedNodeDataInput.newDataInput(in);
 104         YangInstanceIdentifier path = stream.readYangInstanceIdentifier();
 105         NormalizedNode node = stream.readNormalizedNode();
 106         applier.apply(instance, path, node);
 107     }
 108
 109     public static void writePathAndNode(final DataOutput out,
 110             final org.opendaylight.yangtools.yang.data.codec.binfmt.NormalizedNodeStreamVersion version,
 111             final YangInstanceIdentifier path, final NormalizedNode node) throws IOException {
 112         try (NormalizedNodeDataOutput stream = version.newDataOutput(out)) {
 113             stream.writeYangInstanceIdentifier(path);
 114             stream.writeNormalizedNode(node);
 115         }
 116     }
 117
 118     public static void writePathAndNode(final DataOutput out, final YangInstanceIdentifier path,
 119             final NormalizedNode node) throws IOException {
 120         writePathAndNode(out, MAGNESIUM, path, node);
 121     }
 122 }