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

   1 /*
   2  * Copyright (c) 2015 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.node.utils.stream;
   9
  10 import com.google.common.base.Preconditions;
  11 import java.io.DataOutput;
  12 import java.io.IOException;
  13 import java.io.OutputStream;
  14 import java.nio.charset.StandardCharsets;
  15 import java.util.Collection;
  16 import java.util.Map;
  17 import java.util.Set;
  18 import org.opendaylight.yangtools.yang.common.QName;
  19 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  20 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.AugmentationIdentifier;
  21 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  22 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
  23 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeWithValue;
  24 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  25 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  26 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
  27 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeWriter;
  28 import org.slf4j.Logger;
  29 import org.slf4j.LoggerFactory;
  30
  31 abstract class AbstractNormalizedNodeDataOutput implements NormalizedNodeDataOutput, NormalizedNodeStreamWriter {
  32     private static final Logger LOG = LoggerFactory.getLogger(AbstractNormalizedNodeDataOutput.class);
  33
  34     private final DataOutput output;
  35
  36     private NormalizedNodeWriter normalizedNodeWriter;
  37     private boolean headerWritten;
  38     private QName lastLeafSetQName;
  39
  40     AbstractNormalizedNodeDataOutput(final DataOutput output) {
  41         this.output = Preconditions.checkNotNull(output);
  42     }
  43
  44     private void ensureHeaderWritten() throws IOException {
  45         if (!headerWritten) {
  46             output.writeByte(TokenTypes.SIGNATURE_MARKER);
  47             output.writeShort(streamVersion());
  48             headerWritten = true;
  49         }
  50     }
  51
  52     protected abstract short streamVersion();
  53     protected abstract void writeQName(QName qname) throws IOException;
  54     protected abstract void writeString(String string) throws IOException;
  55
  56     @Override
  57     public final void write(final int b) throws IOException {
  58         ensureHeaderWritten();
  59         output.write(b);
  60     }
  61
  62     @Override
  63     public final void write(final byte[] b) throws IOException {
  64         ensureHeaderWritten();
  65         output.write(b);
  66     }
  67
  68     @Override
  69     public final void write(final byte[] b, final int off, final int len) throws IOException {
  70         ensureHeaderWritten();
  71         output.write(b, off, len);
  72     }
  73
  74     @Override
  75     public final void writeBoolean(final boolean v) throws IOException {
  76         ensureHeaderWritten();
  77         output.writeBoolean(v);
  78     }
  79
  80     @Override
  81     public final void writeByte(final int v) throws IOException {
  82         ensureHeaderWritten();
  83         output.writeByte(v);
  84     }
  85
  86     @Override
  87     public final void writeShort(final int v) throws IOException {
  88         ensureHeaderWritten();
  89         output.writeShort(v);
  90     }
  91
  92     @Override
  93     public final void writeChar(final int v) throws IOException {
  94         ensureHeaderWritten();
  95         output.writeChar(v);
  96     }
  97
  98     @Override
  99     public final void writeInt(final int v) throws IOException {
 100         ensureHeaderWritten();
 101         output.writeInt(v);
 102     }
 103
 104     @Override
 105     public final void writeLong(final long v) throws IOException {
 106         ensureHeaderWritten();
 107         output.writeLong(v);
 108     }
 109
 110     @Override
 111     public final void writeFloat(final float v) throws IOException {
 112         ensureHeaderWritten();
 113         output.writeFloat(v);
 114     }
 115
 116     @Override
 117     public final void writeDouble(final double v) throws IOException {
 118         ensureHeaderWritten();
 119         output.writeDouble(v);
 120     }
 121
 122     @Override
 123     public final void writeBytes(final String s) throws IOException {
 124         ensureHeaderWritten();
 125         output.writeBytes(s);
 126     }
 127
 128     @Override
 129     public final void writeChars(final String s) throws IOException {
 130         ensureHeaderWritten();
 131         output.writeChars(s);
 132     }
 133
 134     @Override
 135     public final void writeUTF(final String s) throws IOException {
 136         ensureHeaderWritten();
 137         output.writeUTF(s);
 138     }
 139
 140     private NormalizedNodeWriter normalizedNodeWriter() {
 141         if(normalizedNodeWriter == null) {
 142             normalizedNodeWriter = NormalizedNodeWriter.forStreamWriter(this);
 143         }
 144
 145         return normalizedNodeWriter;
 146     }
 147
 148     @Override
 149     public void writeNormalizedNode(final NormalizedNode<?, ?> node) throws IOException {
 150         ensureHeaderWritten();
 151         normalizedNodeWriter().write(node);
 152     }
 153
 154     @Override
 155     public void leafNode(final NodeIdentifier name, final Object value) throws IOException, IllegalArgumentException {
 156         Preconditions.checkNotNull(name, "Node identifier should not be null");
 157         LOG.debug("Writing a new leaf node");
 158         startNode(name.getNodeType(), NodeTypes.LEAF_NODE);
 159
 160         writeObject(value);
 161     }
 162
 163     @Override
 164     public void startLeafSet(final NodeIdentifier name, final int childSizeHint) throws IOException, IllegalArgumentException {
 165         Preconditions.checkNotNull(name, "Node identifier should not be null");
 166         LOG.debug("Starting a new leaf set");
 167
 168         lastLeafSetQName = name.getNodeType();
 169         startNode(name.getNodeType(), NodeTypes.LEAF_SET);
 170     }
 171
 172     @Override
 173     public void startOrderedLeafSet(final NodeIdentifier name, final int childSizeHint) throws IOException, IllegalArgumentException {
 174         Preconditions.checkNotNull(name, "Node identifier should not be null");
 175         LOG.debug("Starting a new ordered leaf set");
 176
 177         lastLeafSetQName = name.getNodeType();
 178         startNode(name.getNodeType(), NodeTypes.ORDERED_LEAF_SET);
 179     }
 180
 181     @Override
 182     public void leafSetEntryNode(final QName name, final Object value) throws IOException, IllegalArgumentException {
 183         LOG.debug("Writing a new leaf set entry node");
 184
 185         output.writeByte(NodeTypes.LEAF_SET_ENTRY_NODE);
 186
 187         // lastLeafSetQName is set if the parent LeafSetNode was previously written. Otherwise this is a
 188         // stand alone LeafSetEntryNode so write out it's name here.
 189         if(lastLeafSetQName == null) {
 190             writeQName(name);
 191         }
 192
 193         writeObject(value);
 194     }
 195
 196     @Override
 197     public void startContainerNode(final NodeIdentifier name, final int childSizeHint) throws IOException, IllegalArgumentException {
 198         Preconditions.checkNotNull(name, "Node identifier should not be null");
 199
 200         LOG.debug("Starting a new container node");
 201
 202         startNode(name.getNodeType(), NodeTypes.CONTAINER_NODE);
 203     }
 204
 205     @Override
 206     public void startYangModeledAnyXmlNode(final NodeIdentifier name, final int childSizeHint) throws IOException, IllegalArgumentException {
 207         Preconditions.checkNotNull(name, "Node identifier should not be null");
 208
 209         LOG.debug("Starting a new yang modeled anyXml node");
 210
 211         startNode(name.getNodeType(), NodeTypes.YANG_MODELED_ANY_XML_NODE);
 212     }
 213
 214     @Override
 215     public void startUnkeyedList(final NodeIdentifier name, final int childSizeHint) throws IOException, IllegalArgumentException {
 216         Preconditions.checkNotNull(name, "Node identifier should not be null");
 217         LOG.debug("Starting a new unkeyed list");
 218
 219         startNode(name.getNodeType(), NodeTypes.UNKEYED_LIST);
 220     }
 221
 222     @Override
 223     public void startUnkeyedListItem(final NodeIdentifier name, final int childSizeHint) throws IOException, IllegalStateException {
 224         Preconditions.checkNotNull(name, "Node identifier should not be null");
 225         LOG.debug("Starting a new unkeyed list item");
 226
 227         startNode(name.getNodeType(), NodeTypes.UNKEYED_LIST_ITEM);
 228     }
 229
 230     @Override
 231     public void startMapNode(final NodeIdentifier name, final int childSizeHint) throws IOException, IllegalArgumentException {
 232         Preconditions.checkNotNull(name, "Node identifier should not be null");
 233         LOG.debug("Starting a new map node");
 234
 235         startNode(name.getNodeType(), NodeTypes.MAP_NODE);
 236     }
 237
 238     @Override
 239     public void startMapEntryNode(final NodeIdentifierWithPredicates identifier, final int childSizeHint) throws IOException, IllegalArgumentException {
 240         Preconditions.checkNotNull(identifier, "Node identifier should not be null");
 241         LOG.debug("Starting a new map entry node");
 242         startNode(identifier.getNodeType(), NodeTypes.MAP_ENTRY_NODE);
 243
 244         writeKeyValueMap(identifier.getKeyValues());
 245
 246     }
 247
 248     @Override
 249     public void startOrderedMapNode(final NodeIdentifier name, final int childSizeHint) throws IOException, IllegalArgumentException {
 250         Preconditions.checkNotNull(name, "Node identifier should not be null");
 251         LOG.debug("Starting a new ordered map node");
 252
 253         startNode(name.getNodeType(), NodeTypes.ORDERED_MAP_NODE);
 254     }
 255
 256     @Override
 257     public void startChoiceNode(final NodeIdentifier name, final int childSizeHint) throws IOException, IllegalArgumentException {
 258         Preconditions.checkNotNull(name, "Node identifier should not be null");
 259         LOG.debug("Starting a new choice node");
 260
 261         startNode(name.getNodeType(), NodeTypes.CHOICE_NODE);
 262     }
 263
 264     @Override
 265     public void startAugmentationNode(final AugmentationIdentifier identifier) throws IOException, IllegalArgumentException {
 266         Preconditions.checkNotNull(identifier, "Node identifier should not be null");
 267         LOG.debug("Starting a new augmentation node");
 268
 269         output.writeByte(NodeTypes.AUGMENTATION_NODE);
 270         writeQNameSet(identifier.getPossibleChildNames());
 271     }
 272
 273     @Override
 274     public void anyxmlNode(final NodeIdentifier name, final Object value) throws IOException, IllegalArgumentException {
 275         Preconditions.checkNotNull(name, "Node identifier should not be null");
 276         LOG.debug("Writing a new xml node");
 277
 278         startNode(name.getNodeType(), NodeTypes.ANY_XML_NODE);
 279
 280         writeObject(value);
 281     }
 282
 283     @Override
 284     public void endNode() throws IOException, IllegalStateException {
 285         LOG.debug("Ending the node");
 286
 287         output.writeByte(NodeTypes.END_NODE);
 288     }
 289
 290     @Override
 291     public void close() throws IOException {
 292         flush();
 293     }
 294
 295     @Override
 296     public void flush() throws IOException {
 297         if (output instanceof OutputStream) {
 298             ((OutputStream)output).flush();
 299         }
 300     }
 301
 302     private void startNode(final QName qName, final byte nodeType) throws IOException {
 303
 304         Preconditions.checkNotNull(qName, "QName of node identifier should not be null.");
 305
 306         ensureHeaderWritten();
 307
 308         // First write the type of node
 309         output.writeByte(nodeType);
 310         // Write Start Tag
 311         writeQName(qName);
 312     }
 313
 314     private void writeObjSet(final Set<?> set) throws IOException {
 315         output.writeInt(set.size());
 316         for (Object o : set) {
 317             Preconditions.checkArgument(o instanceof String, "Expected value type to be String but was %s (%s)",
 318                 o.getClass(), o);
 319
 320             writeString((String) o);
 321         }
 322     }
 323
 324     @Override
 325     public void writeYangInstanceIdentifier(final YangInstanceIdentifier identifier) throws IOException {
 326         ensureHeaderWritten();
 327         writeYangInstanceIdentifierInternal(identifier);
 328     }
 329
 330     private void writeYangInstanceIdentifierInternal(final YangInstanceIdentifier identifier) throws IOException {
 331         Collection<PathArgument> pathArguments = identifier.getPathArguments();
 332         output.writeInt(pathArguments.size());
 333
 334         for(PathArgument pathArgument : pathArguments) {
 335             writePathArgument(pathArgument);
 336         }
 337     }
 338
 339     @Override
 340     public void writePathArgument(final PathArgument pathArgument) throws IOException {
 341
 342         byte type = PathArgumentTypes.getSerializablePathArgumentType(pathArgument);
 343
 344         output.writeByte(type);
 345
 346         switch(type) {
 347             case PathArgumentTypes.NODE_IDENTIFIER:
 348
 349                 NodeIdentifier nodeIdentifier = (NodeIdentifier) pathArgument;
 350
 351                 writeQName(nodeIdentifier.getNodeType());
 352                 break;
 353
 354             case PathArgumentTypes.NODE_IDENTIFIER_WITH_PREDICATES:
 355
 356                 NodeIdentifierWithPredicates nodeIdentifierWithPredicates =
 357                     (NodeIdentifierWithPredicates) pathArgument;
 358                 writeQName(nodeIdentifierWithPredicates.getNodeType());
 359
 360                 writeKeyValueMap(nodeIdentifierWithPredicates.getKeyValues());
 361                 break;
 362
 363             case PathArgumentTypes.NODE_IDENTIFIER_WITH_VALUE :
 364
 365                 NodeWithValue<?> nodeWithValue = (NodeWithValue<?>) pathArgument;
 366
 367                 writeQName(nodeWithValue.getNodeType());
 368                 writeObject(nodeWithValue.getValue());
 369                 break;
 370
 371             case PathArgumentTypes.AUGMENTATION_IDENTIFIER :
 372
 373                 AugmentationIdentifier augmentationIdentifier = (AugmentationIdentifier) pathArgument;
 374
 375                 // No Qname in augmentation identifier
 376                 writeQNameSet(augmentationIdentifier.getPossibleChildNames());
 377                 break;
 378             default :
 379                 throw new IllegalStateException("Unknown node identifier type is found : " + pathArgument.getClass().toString() );
 380         }
 381     }
 382
 383     private void writeKeyValueMap(final Map<QName, Object> keyValueMap) throws IOException {
 384         if (keyValueMap != null && !keyValueMap.isEmpty()) {
 385             output.writeInt(keyValueMap.size());
 386
 387             for (QName qName : keyValueMap.keySet()) {
 388                 writeQName(qName);
 389                 writeObject(keyValueMap.get(qName));
 390             }
 391         } else {
 392             output.writeInt(0);
 393         }
 394     }
 395
 396     private void writeQNameSet(final Set<QName> children) throws IOException {
 397         // Write each child's qname separately, if list is empty send count as 0
 398         if (children != null && !children.isEmpty()) {
 399             output.writeInt(children.size());
 400             for (QName qName : children) {
 401                 writeQName(qName);
 402             }
 403         } else {
 404             LOG.debug("augmentation node does not have any child");
 405             output.writeInt(0);
 406         }
 407     }
 408
 409     private void writeObject(final Object value) throws IOException {
 410
 411         byte type = ValueTypes.getSerializableType(value);
 412         // Write object type first
 413         output.writeByte(type);
 414
 415         switch (type) {
 416             case ValueTypes.BOOL_TYPE:
 417                 output.writeBoolean((Boolean) value);
 418                 break;
 419             case ValueTypes.QNAME_TYPE:
 420                 writeQName((QName) value);
 421                 break;
 422             case ValueTypes.INT_TYPE:
 423                 output.writeInt((Integer) value);
 424                 break;
 425             case ValueTypes.BYTE_TYPE:
 426                 output.writeByte((Byte) value);
 427                 break;
 428             case ValueTypes.LONG_TYPE:
 429                 output.writeLong((Long) value);
 430                 break;
 431             case ValueTypes.SHORT_TYPE:
 432                 output.writeShort((Short) value);
 433                 break;
 434             case ValueTypes.BITS_TYPE:
 435                 writeObjSet((Set<?>) value);
 436                 break;
 437             case ValueTypes.BINARY_TYPE:
 438                 byte[] bytes = (byte[]) value;
 439                 output.writeInt(bytes.length);
 440                 output.write(bytes);
 441                 break;
 442             case ValueTypes.YANG_IDENTIFIER_TYPE:
 443                 writeYangInstanceIdentifierInternal((YangInstanceIdentifier) value);
 444                 break;
 445             case ValueTypes.NULL_TYPE :
 446                 break;
 447             case ValueTypes.STRING_BYTES_TYPE:
 448                 final byte[] valueBytes = value.toString().getBytes(StandardCharsets.UTF_8);
 449                 output.writeInt(valueBytes.length);
 450                 output.write(valueBytes);
 451                 break;
 452             default:
 453                 output.writeUTF(value.toString());
 454                 break;
 455         }
 456     }
 457 }