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

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