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

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