openflow-protocol-impl/src/main/java/org/opendaylight/openflowjava/protocol/impl/util/ListDeserializer.java

   1 /*
   2  * Copyright (c) 2013 Pantheon Technologies s.r.o. 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.openflowjava.protocol.impl.util;
  10
  11 import io.netty.buffer.ByteBuf;
  12
  13 import java.util.ArrayList;
  14 import java.util.List;
  15
  16 import org.opendaylight.openflowjava.protocol.api.extensibility.DeserializerRegistry;
  17 import org.opendaylight.openflowjava.protocol.api.extensibility.HeaderDeserializer;
  18 import org.opendaylight.openflowjava.protocol.api.extensibility.OFDeserializer;
  19 import org.opendaylight.openflowjava.protocol.api.keys.MessageCodeKey;
  20 import org.opendaylight.openflowjava.protocol.api.util.EncodeConstants;
  21 import org.opendaylight.yangtools.yang.binding.DataObject;
  22 import org.slf4j.Logger;
  23 import org.slf4j.LoggerFactory;
  24
  25 /**
  26  * @author michal.polkorab
  27  *
  28  */
  29 public final class ListDeserializer {
  30     private static final Logger LOG = LoggerFactory.getLogger(ListDeserializer.class);
  31
  32     private ListDeserializer() {
  33         throw new UnsupportedOperationException("Utility class shouldn't be instantiated");
  34     }
  35
  36     /**
  37      * Deserializes items into list
  38      * @param version openflow wire version
  39      * @param length length of list in ByteBuf (bytes)
  40      * @param input input buffer
  41      * @param keyMaker creates keys for deserializer lookup
  42      * @param registry stores deserializers
  43      * @return list of items
  44      */
  45     public static <E extends DataObject> List<E> deserializeList(short version, int length,
  46             ByteBuf input, CodeKeyMaker keyMaker, DeserializerRegistry registry) {
  47         List<E> items = null;
  48         if (input.readableBytes() > 0) {
  49             items = new ArrayList<>();
  50             int startIndex = input.readerIndex();
  51             while ((input.readerIndex() - startIndex) < length){
  52                 OFDeserializer<E> deserializer = registry.getDeserializer(keyMaker.make(input));
  53                 E item = deserializer.deserialize(input);
  54                 items.add(item);
  55             }
  56         }
  57         return items;
  58     }
  59
  60     /**
  61      * Deserializes headers of items into list (used in MultipartReplyMessage - Table features)
  62      * @param version openflow wire version
  63      * @param length length of list in ByteBuf (bytes)
  64      * @param input input buffer
  65      * @param keyMaker creates keys for deserializer lookup
  66      * @param registry stores deserializers
  67      * @return list of items
  68      */
  69     public static <E extends DataObject> List<E> deserializeHeaders(short version, int length,
  70             ByteBuf input, CodeKeyMaker keyMaker, DeserializerRegistry registry) {
  71         List<E> items = null;
  72         if (input.readableBytes() > 0) {
  73             items = new ArrayList<>();
  74             int startIndex = input.readerIndex();
  75             boolean exceptionLogged = false;
  76             while ((input.readerIndex() - startIndex) < length){
  77                 HeaderDeserializer<E> deserializer;
  78                 MessageCodeKey key = keyMaker.make(input);
  79                 try {
  80                     deserializer = registry.getDeserializer(key);
  81                 } catch (ClassCastException | IllegalStateException e) {
  82                     if (!exceptionLogged) {
  83                         LOG.warn("Problem during reading table feature property. Skipping unknown feature property: {}",
  84                                 key, e);
  85                         LOG.warn("This exception is logged only once for each multipart reply (table features) to "
  86                                 + "prevent log flooding. There might be more of table features related exceptions.");
  87                         exceptionLogged = true;
  88                     }
  89                     input.skipBytes(2 * EncodeConstants.SIZE_OF_SHORT_IN_BYTES);
  90                     continue;
  91                 }
  92                 E item = deserializer.deserializeHeader(input);
  93                 items.add(item);
  94             }
  95         }
  96         return items;
  97     }
  98 }