bgp/parser-impl/src/main/java/org/opendaylight/protocol/bgp/parser/impl/message/open/CapabilityParameterParser.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.bgp.parser.impl.message.open;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  12 import com.google.common.base.Preconditions;
  13 import io.netty.buffer.ByteBuf;
  14 import io.netty.buffer.ByteBufUtil;
  15 import io.netty.buffer.Unpooled;
  16 import java.util.ArrayList;
  17 import java.util.Arrays;
  18 import java.util.List;
  19 import org.opendaylight.protocol.bgp.parser.BGPDocumentedException;
  20 import org.opendaylight.protocol.bgp.parser.BGPParsingException;
  21 import org.opendaylight.protocol.bgp.parser.spi.CapabilityRegistry;
  22 import org.opendaylight.protocol.bgp.parser.spi.ParameterParser;
  23 import org.opendaylight.protocol.bgp.parser.spi.ParameterSerializer;
  24 import org.opendaylight.protocol.bgp.parser.spi.ParameterUtil;
  25 import org.opendaylight.protocol.util.ByteArray;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.open.message.BgpParameters;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.open.message.BgpParametersBuilder;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.open.message.bgp.parameters.OptionalCapabilities;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.open.message.bgp.parameters.OptionalCapabilitiesBuilder;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.open.message.bgp.parameters.optional.capabilities.CParameters;
  31 import org.slf4j.Logger;
  32 import org.slf4j.LoggerFactory;
  33
  34 /**
  35  * Parser for BGP Capability Parameter.
  36  */
  37 public final class CapabilityParameterParser implements ParameterParser, ParameterSerializer {
  38     public static final int TYPE = 2;
  39
  40     private static final Logger LOG = LoggerFactory.getLogger(CapabilityParameterParser.class);
  41     private final CapabilityRegistry reg;
  42
  43     public CapabilityParameterParser(final CapabilityRegistry reg) {
  44         this.reg = requireNonNull(reg);
  45     }
  46
  47     @Override
  48     public BgpParameters parseParameter(final ByteBuf buffer) throws BGPParsingException, BGPDocumentedException {
  49         Preconditions.checkArgument(buffer != null && buffer.readableBytes() != 0,
  50                 "Byte array cannot be null or empty.");
  51
  52         if (LOG.isTraceEnabled()) {
  53             LOG.trace("Started parsing of BGP Capabilities: {}", Arrays.toString(ByteArray.getAllBytes(buffer)));
  54         }
  55
  56         final List<OptionalCapabilities> optionalCapas = new ArrayList<>();
  57         while (buffer.isReadable()) {
  58             final OptionalCapabilities optionalCapa = parseOptionalCapability(buffer);
  59             if (optionalCapa != null) {
  60                 optionalCapas.add(optionalCapa);
  61             }
  62         }
  63         return new BgpParametersBuilder().setOptionalCapabilities(optionalCapas).build();
  64     }
  65
  66     private OptionalCapabilities parseOptionalCapability(final ByteBuf buffer) throws BGPDocumentedException,
  67             BGPParsingException {
  68         final int capCode = buffer.readUnsignedByte();
  69         final int capLength = buffer.readUnsignedByte();
  70         final ByteBuf paramBody = buffer.readSlice(capLength);
  71         final CParameters ret = this.reg.parseCapability(capCode, paramBody);
  72         if (ret == null) {
  73             LOG.info("Ignoring unsupported capability {}", capCode);
  74             return null;
  75         }
  76         return new OptionalCapabilitiesBuilder().setCParameters(ret).build();
  77     }
  78
  79     @Override
  80     public void serializeParameter(final BgpParameters parameter, final ByteBuf byteAggregator) {
  81         if (parameter.getOptionalCapabilities() != null) {
  82             final ByteBuf buffer = Unpooled.buffer();
  83             for (final OptionalCapabilities optionalCapa : parameter.getOptionalCapabilities()) {
  84                 LOG.trace("Started serializing BGP Capability: {}", optionalCapa);
  85                 serializeOptionalCapability(optionalCapa, buffer);
  86             }
  87             ParameterUtil.formatParameter(TYPE, buffer, byteAggregator);
  88         }
  89     }
  90
  91     private void serializeOptionalCapability(final OptionalCapabilities optionalCapa, final ByteBuf byteAggregator) {
  92         if (optionalCapa.getCParameters() != null) {
  93             final CParameters cap = optionalCapa.getCParameters();
  94             final ByteBuf bytes = Unpooled.buffer();
  95             this.reg.serializeCapability(cap, bytes);
  96             Preconditions.checkArgument(bytes != null, "Unhandled capability class %s", cap.getImplementedInterface());
  97
  98             if (LOG.isTraceEnabled()) {
  99                 LOG.trace("BGP capability serialized to: {}", ByteBufUtil.hexDump(bytes));
 100             }
 101             byteAggregator.writeBytes(bytes);
 102         }
 103     }
 104 }