pcep/spi/src/main/java/org/opendaylight/protocol/pcep/spi/AbstractObjectWithTlvsParser.java

   1 /*
   2  * Copyright (c) 2013 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.protocol.pcep.spi;
   9
  10 import com.google.common.base.Preconditions;
  11 import io.netty.buffer.ByteBuf;
  12 import io.netty.buffer.ByteBufUtil;
  13 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.Tlv;
  14 import org.slf4j.Logger;
  15 import org.slf4j.LoggerFactory;
  16
  17 public abstract class AbstractObjectWithTlvsParser<T> implements ObjectParser, ObjectSerializer {
  18
  19     private static final Logger LOG = LoggerFactory.getLogger(AbstractObjectWithTlvsParser.class);
  20
  21     private static final int TLV_TYPE_F_LENGTH = 2;
  22     private static final int TLV_LENGTH_F_LENGTH = 2;
  23     private static final int TLV_HEADER_LENGTH = TLV_LENGTH_F_LENGTH + TLV_TYPE_F_LENGTH;
  24
  25     public static final int PADDED_TO = 4;
  26
  27     private final TlvRegistry tlvReg;
  28
  29     protected AbstractObjectWithTlvsParser(final TlvRegistry tlvReg) {
  30         this.tlvReg = Preconditions.checkNotNull(tlvReg);
  31     }
  32
  33     protected final void parseTlvs(final T builder, final ByteBuf bytes) throws PCEPDeserializerException {
  34         Preconditions.checkArgument(bytes != null, "Array of bytes is mandatory. Can't be null.");
  35         if (!bytes.isReadable()) {
  36             return;
  37         }
  38         while (bytes.isReadable()) {
  39             int type = bytes.readUnsignedShort();
  40             int length = bytes.readUnsignedShort();
  41             if (length > bytes.readableBytes()) {
  42                 throw new PCEPDeserializerException("Wrong length specified. Passed: " + length + "; Expected: <= " + bytes.readableBytes()
  43                     + ".");
  44             }
  45             final ByteBuf tlvBytes = bytes.slice(bytes.readerIndex(), length);
  46             LOG.trace("Parsing PCEP TLV : {}", ByteBufUtil.hexDump(tlvBytes));
  47             final Tlv tlv = this.tlvReg.parseTlv(type, tlvBytes);
  48             LOG.trace("Parsed PCEP TLV {}.", tlv);
  49             addTlv(builder, tlv);
  50             bytes.skipBytes(length + TlvUtil.getPadding(TlvUtil.HEADER_SIZE + length, TlvUtil.PADDED_TO));
  51         }
  52     }
  53
  54     protected final void serializeTlv(final Tlv tlv, final ByteBuf buffer) {
  55         Preconditions.checkNotNull(tlv, "PCEP TLV is mandatory.");
  56         LOG.trace("Serializing PCEP TLV {}", tlv);
  57         this.tlvReg.serializeTlv(tlv, buffer);
  58         LOG.trace("Serialized PCEP TLV : {}.", ByteBufUtil.hexDump(buffer));
  59     }
  60
  61     protected void addTlv(final T builder, final Tlv tlv) {
  62         // FIXME: No TLVs by default, fallback to augments
  63     }
  64 }