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.Optional;
  11 import com.google.common.base.Preconditions;
  12 import com.google.common.collect.Lists;
  13 import io.netty.buffer.ByteBuf;
  14 import io.netty.buffer.ByteBufUtil;
  15 import java.util.List;
  16 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.iana.rev130816.EnterpriseNumber;
  17 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.Tlv;
  18 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.vendor.information.tlvs.VendorInformationTlv;
  19 import org.slf4j.Logger;
  20 import org.slf4j.LoggerFactory;
  21
  22 public abstract class AbstractObjectWithTlvsParser<T> implements ObjectParser, ObjectSerializer {
  23
  24     private static final Logger LOG = LoggerFactory.getLogger(AbstractObjectWithTlvsParser.class);
  25
  26     private final TlvRegistry tlvReg;
  27
  28     private final VendorInformationTlvRegistry viTlvReg;
  29
  30     protected AbstractObjectWithTlvsParser(final TlvRegistry tlvReg, final VendorInformationTlvRegistry viTlvReg) {
  31         this.tlvReg = Preconditions.checkNotNull(tlvReg);
  32         this.viTlvReg = Preconditions.checkNotNull(viTlvReg);
  33     }
  34
  35     protected final void parseTlvs(final T builder, final ByteBuf bytes) throws PCEPDeserializerException {
  36         Preconditions.checkArgument(bytes != null, "Array of bytes is mandatory. Can't be null.");
  37         if (!bytes.isReadable()) {
  38             return;
  39         }
  40         final List<VendorInformationTlv> viTlvs = Lists.newArrayList();
  41         while (bytes.isReadable()) {
  42             final int type = bytes.readUnsignedShort();
  43             final int length = bytes.readUnsignedShort();
  44             if (length > bytes.readableBytes()) {
  45                 throw new PCEPDeserializerException("Wrong length specified. Passed: " + length + "; Expected: <= " + bytes.readableBytes()
  46                     + ".");
  47             }
  48             final ByteBuf tlvBytes = bytes.readSlice(length);
  49             LOG.trace("Parsing PCEP TLV : {}", ByteBufUtil.hexDump(tlvBytes));
  50
  51             if (VendorInformationUtil.isVendorInformationTlv(type)) {
  52                 final EnterpriseNumber enterpriseNumber = new EnterpriseNumber(tlvBytes.readUnsignedInt());
  53                 final Optional<VendorInformationTlv> viTlv = this.viTlvReg.parseVendorInformationTlv(enterpriseNumber, tlvBytes);
  54                 if(viTlv.isPresent()) {
  55                     LOG.trace("Parsed VENDOR-INFORMATION TLV {}.", viTlv.get());
  56                     viTlvs.add(viTlv.get());
  57                 }
  58             } else {
  59                 final Tlv tlv = this.tlvReg.parseTlv(type, tlvBytes);
  60                 if(tlv != null) {
  61                     LOG.trace("Parsed PCEP TLV {}.", tlv);
  62                     addTlv(builder, tlv);
  63                 }
  64             }
  65             bytes.skipBytes(TlvUtil.getPadding(TlvUtil.HEADER_SIZE + length, TlvUtil.PADDED_TO));
  66         }
  67         addVendorInformationTlvs(builder, viTlvs);
  68     }
  69
  70     protected final void serializeTlv(final Tlv tlv, final ByteBuf buffer) {
  71         Preconditions.checkNotNull(tlv, "PCEP TLV is mandatory.");
  72         LOG.trace("Serializing PCEP TLV {}", tlv);
  73         this.tlvReg.serializeTlv(tlv, buffer);
  74         LOG.trace("Serialized PCEP TLV : {}.", ByteBufUtil.hexDump(buffer));
  75     }
  76
  77     protected void addTlv(final T builder, final Tlv tlv) {
  78         // FIXME: No TLVs by default, fallback to augments
  79     }
  80
  81     protected abstract void addVendorInformationTlvs(final T builder, final List<VendorInformationTlv> tlvs);
  82
  83     protected final void serializeVendorInformationTlvs(final List<VendorInformationTlv> tlvs, final ByteBuf buffer) {
  84         if (tlvs != null) {
  85             for (final VendorInformationTlv tlv : tlvs) {
  86                 LOG.trace("Serializing VENDOR-INFORMATION TLV {}", tlv);
  87                 this.viTlvReg.serializeVendorInformationTlv(tlv, buffer);
  88                 LOG.trace("Serialized VENDOR-INFORMATION TLV : {}.", ByteBufUtil.hexDump(buffer));
  89             }
  90         }
  91     }
  92 }