bgp/extensions/linkstate/src/main/java/org/opendaylight/protocol/bgp/linkstate/impl/nlri/NodeNlriParser.java

   1 /*
   2  * Copyright (c) 2014 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.linkstate.impl.nlri;
   9
  10 import com.google.common.annotations.VisibleForTesting;
  11 import io.netty.buffer.ByteBuf;
  12 import java.util.Optional;
  13 import org.opendaylight.protocol.bgp.linkstate.impl.tlvs.AreaIdTlvParser;
  14 import org.opendaylight.protocol.bgp.linkstate.impl.tlvs.AsNumTlvParser;
  15 import org.opendaylight.protocol.bgp.linkstate.impl.tlvs.BgpRouterIdTlvParser;
  16 import org.opendaylight.protocol.bgp.linkstate.impl.tlvs.DomainIdTlvParser;
  17 import org.opendaylight.protocol.bgp.linkstate.impl.tlvs.MemAsNumTlvParser;
  18 import org.opendaylight.protocol.bgp.linkstate.spi.AbstractNlriTypeCodec;
  19 import org.opendaylight.protocol.bgp.linkstate.spi.pojo.SimpleNlriTypeRegistry;
  20 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber;
  21 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address;
  22 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev180329.AreaIdentifier;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev180329.DomainIdentifier;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev180329.NlriType;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev180329.OspfInterfaceIdentifier;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev180329.isis.lan.identifier.IsIsRouterIdentifierBuilder;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev180329.linkstate.ObjectType;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev180329.linkstate.object.type.NodeCase;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev180329.linkstate.object.type.NodeCaseBuilder;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev180329.linkstate.object.type.link._case.LocalNodeDescriptors;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev180329.linkstate.object.type.link._case.LocalNodeDescriptorsBuilder;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev180329.linkstate.object.type.link._case.RemoteNodeDescriptors;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev180329.linkstate.object.type.link._case.RemoteNodeDescriptorsBuilder;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev180329.linkstate.object.type.node._case.NodeDescriptors;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev180329.linkstate.object.type.node._case.NodeDescriptorsBuilder;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev180329.linkstate.object.type.prefix._case.AdvertisingNodeDescriptors;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev180329.linkstate.object.type.prefix._case.AdvertisingNodeDescriptorsBuilder;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev180329.node.identifier.CRouterIdentifier;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev180329.node.identifier.c.router.identifier.IsisNodeCase;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev180329.node.identifier.c.router.identifier.IsisNodeCaseBuilder;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev180329.node.identifier.c.router.identifier.IsisPseudonodeCase;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev180329.node.identifier.c.router.identifier.IsisPseudonodeCaseBuilder;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev180329.node.identifier.c.router.identifier.OspfNodeCase;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev180329.node.identifier.c.router.identifier.OspfNodeCaseBuilder;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev180329.node.identifier.c.router.identifier.OspfPseudonodeCaseBuilder;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev180329.node.identifier.c.router.identifier.isis.node._case.IsisNode;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev180329.node.identifier.c.router.identifier.isis.node._case.IsisNodeBuilder;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev180329.node.identifier.c.router.identifier.isis.pseudonode._case.IsisPseudonode;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev180329.node.identifier.c.router.identifier.isis.pseudonode._case.IsisPseudonodeBuilder;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev180329.node.identifier.c.router.identifier.ospf.node._case.OspfNode;
  51 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev180329.node.identifier.c.router.identifier.ospf.node._case.OspfNodeBuilder;
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev180329.node.identifier.c.router.identifier.ospf.pseudonode._case.OspfPseudonode;
  53 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev180329.node.identifier.c.router.identifier.ospf.pseudonode._case.OspfPseudonodeBuilder;
  54 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.network.concepts.rev131125.IsoSystemIdentifier;
  55 import org.opendaylight.yangtools.yang.common.QName;
  56 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  57 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  58 import org.opendaylight.yangtools.yang.data.api.schema.ChoiceNode;
  59 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  60 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
  61
  62 public final class NodeNlriParser extends AbstractNlriTypeCodec {
  63
  64     /* Node Descriptor QNames */
  65     @VisibleForTesting
  66     public static final NodeIdentifier AS_NUMBER_NID = NodeIdentifier.create(AsNumTlvParser.AS_NUMBER_QNAME);
  67     @VisibleForTesting
  68     public static final NodeIdentifier AREA_NID = NodeIdentifier.create(AreaIdTlvParser.AREA_ID_QNAME);
  69     @VisibleForTesting
  70     public static final NodeIdentifier DOMAIN_NID = NodeIdentifier.create(DomainIdTlvParser.DOMAIN_ID_QNAME);
  71     @VisibleForTesting
  72     private static final NodeIdentifier ROUTER_NID = NodeIdentifier.create(CRouterIdentifier.QNAME);
  73     @VisibleForTesting
  74     public static final NodeIdentifier BGP_ROUTER_NID = NodeIdentifier.create(BgpRouterIdTlvParser.BGP_ROUTER_ID_QNAME);
  75     @VisibleForTesting
  76     public static final NodeIdentifier MEMBER_ASN_NID = NodeIdentifier.create(MemAsNumTlvParser.MEMBER_AS_NUMBER_QNAME);
  77
  78     /* Router Identifier QNames */
  79     @VisibleForTesting
  80     public static final NodeIdentifier ISIS_NODE_NID = NodeIdentifier.create(IsisNode.QNAME);
  81     @VisibleForTesting
  82     public static final NodeIdentifier ISIS_PSEUDONODE_NID = NodeIdentifier.create(IsisPseudonode.QNAME);
  83     @VisibleForTesting
  84     public static final NodeIdentifier OSPF_NODE_NID = NodeIdentifier.create(OspfNode.QNAME);
  85     @VisibleForTesting
  86     private static final NodeIdentifier OSPF_PSEUDONODE_NID = NodeIdentifier.create(OspfPseudonode.QNAME);
  87     @VisibleForTesting
  88     public static final NodeIdentifier ISO_SYSTEM_NID = NodeIdentifier.create(
  89             QName.create(NodeDescriptors.QNAME, "iso-system-id"));
  90     @VisibleForTesting
  91     public static final NodeIdentifier ISIS_ROUTER_NID = NodeIdentifier.create(
  92             QName.create(NodeDescriptors.QNAME, "is-is-router-identifier").intern());
  93     @VisibleForTesting
  94     public static final NodeIdentifier PSN_NID = NodeIdentifier.create(
  95             QName.create(NodeDescriptors.QNAME, "psn").intern());
  96     @VisibleForTesting
  97     public static final NodeIdentifier OSPF_ROUTER_NID = NodeIdentifier.create(
  98             QName.create(NodeDescriptors.QNAME, "ospf-router-id").intern());
  99     private static final NodeIdentifier LAN_IFACE_NID = NodeIdentifier.create(
 100             QName.create(NodeDescriptors.QNAME, "lan-interface").intern());
 101
 102     @Override
 103     protected ObjectType parseObjectType(final ByteBuf buffer) {
 104         final NodeCaseBuilder builder = new NodeCaseBuilder();
 105         builder.setNodeDescriptors(new NodeDescriptorsBuilder((org.opendaylight.yang.gen.v1.urn.opendaylight.params
 106                 .xml.ns.yang.bgp.linkstate.rev180329.NodeIdentifier) SimpleNlriTypeRegistry.getInstance()
 107                 .parseTlv(buffer)).build());
 108         return builder.build();
 109     }
 110
 111     @Override
 112     protected void serializeObjectType(final ObjectType objectType, final ByteBuf buffer) {
 113         final NodeCase node = (NodeCase) objectType;
 114         SimpleNlriTypeRegistry.getInstance().serializeTlv(NodeDescriptors.QNAME, node.getNodeDescriptors(), buffer);
 115     }
 116
 117     @Override
 118     public int getNlriType() {
 119         return NlriType.Node.getIntValue();
 120     }
 121
 122     private static IsisNodeCase serializeIsisNode(final ContainerNode isis) {
 123         return new IsisNodeCaseBuilder()
 124                 .setIsisNode(new IsisNodeBuilder().setIsoSystemId(
 125                     new IsoSystemIdentifier((byte[]) isis.getChild(ISO_SYSTEM_NID).get().getValue())).build())
 126                 .build();
 127     }
 128
 129     private static IsisPseudonodeCase serializeIsisPseudoNode(final ContainerNode pseudoIsisNode) {
 130         final IsIsRouterIdentifierBuilder isisRouterId = new IsIsRouterIdentifierBuilder();
 131         if (pseudoIsisNode.getChild(ISIS_ROUTER_NID).isPresent()) {
 132             final ContainerNode isisRouterNid = (ContainerNode) pseudoIsisNode.getChild(ISIS_ROUTER_NID).get();
 133             if (isisRouterNid.getChild(ISO_SYSTEM_NID).isPresent()) {
 134                 isisRouterId.setIsoSystemId(new IsoSystemIdentifier((byte[]) isisRouterNid.getChild(ISO_SYSTEM_NID)
 135                         .get().getValue()));
 136             }
 137         }
 138
 139         final IsisPseudonodeBuilder nodeBuilder = new IsisPseudonodeBuilder();
 140         nodeBuilder.setIsIsRouterIdentifier(isisRouterId.build());
 141
 142         if (pseudoIsisNode.getChild(PSN_NID).isPresent()) {
 143             nodeBuilder.setPsn((Short) pseudoIsisNode.getChild(PSN_NID).get().getValue());
 144         } else {
 145             nodeBuilder.setPsn((short) 0);
 146         }
 147
 148         return new IsisPseudonodeCaseBuilder().setIsisPseudonode(nodeBuilder.build()).build();
 149     }
 150
 151     private static OspfNodeCase serializeOspfNode(final ContainerNode ospf) {
 152         final OspfNodeCaseBuilder builder = new OspfNodeCaseBuilder();
 153         if (ospf.getChild(OSPF_ROUTER_NID).isPresent()) {
 154             final OspfNodeBuilder nodeBuilder = new OspfNodeBuilder();
 155             nodeBuilder.setOspfRouterId((Long) ospf.getChild(OSPF_ROUTER_NID).get().getValue());
 156             builder.setOspfNode(nodeBuilder.build());
 157         }
 158         return builder.build();
 159     }
 160
 161     private static CRouterIdentifier serializeOspfPseudoNode(final ContainerNode ospfPseudonode) {
 162         final OspfPseudonodeCaseBuilder builder = new OspfPseudonodeCaseBuilder();
 163         final OspfPseudonodeBuilder nodeBuilder = new OspfPseudonodeBuilder();
 164         if (ospfPseudonode.getChild(LAN_IFACE_NID).isPresent()) {
 165             nodeBuilder.setLanInterface(new OspfInterfaceIdentifier((Long)ospfPseudonode.getChild(LAN_IFACE_NID)
 166                     .get().getValue()));
 167         }
 168         if (ospfPseudonode.getChild(OSPF_ROUTER_NID).isPresent()) {
 169             nodeBuilder.setOspfRouterId((Long)ospfPseudonode.getChild(OSPF_ROUTER_NID).get().getValue());
 170         }
 171         builder.setOspfPseudonode(nodeBuilder.build());
 172         return builder.build();
 173     }
 174
 175     private static CRouterIdentifier serializeRouterId(final ContainerNode descriptorsData) {
 176         CRouterIdentifier ret = null;
 177         final Optional<DataContainerChild<? extends PathArgument, ?>> maybeRouterId =
 178                 descriptorsData.getChild(ROUTER_NID);
 179         if (maybeRouterId.isPresent()) {
 180             final ChoiceNode routerId = (ChoiceNode) maybeRouterId.get();
 181             if (routerId.getChild(ISIS_NODE_NID).isPresent()) {
 182                 ret = serializeIsisNode((ContainerNode) routerId.getChild(ISIS_NODE_NID).get());
 183             } else if (routerId.getChild(ISIS_PSEUDONODE_NID).isPresent()) {
 184                 ret = serializeIsisPseudoNode((ContainerNode) routerId.getChild(ISIS_PSEUDONODE_NID).get());
 185             } else if (routerId.getChild(OSPF_NODE_NID).isPresent()) {
 186                 ret = serializeOspfNode((ContainerNode) routerId.getChild(OSPF_NODE_NID).get());
 187             } else if (routerId.getChild(OSPF_PSEUDONODE_NID).isPresent()) {
 188                 ret = serializeOspfPseudoNode((ContainerNode) routerId.getChild(OSPF_PSEUDONODE_NID).get());
 189             }
 190         }
 191         return ret;
 192     }
 193
 194     private static AsNumber serializeAsNumber(final ContainerNode descriptorsData) {
 195         return descriptorsData.getChild(AS_NUMBER_NID).map(
 196             dataContainerChild -> new AsNumber((Long) dataContainerChild.getValue())).orElse(null);
 197     }
 198
 199     private static DomainIdentifier serializeDomainId(final ContainerNode descriptorsData) {
 200         return descriptorsData.getChild(DOMAIN_NID).map(
 201             dataContainerChild -> new DomainIdentifier((Long) dataContainerChild.getValue())).orElse(null);
 202     }
 203
 204     private static AreaIdentifier serializeAreaId(final ContainerNode descriptorsData) {
 205         return descriptorsData.getChild(AREA_NID).map(
 206             dataContainerChild -> new AreaIdentifier((Long) dataContainerChild.getValue())).orElse(null);
 207     }
 208
 209     private static Ipv4Address serializeBgpRouterId(final ContainerNode descriptorsData) {
 210         return descriptorsData.getChild(BGP_ROUTER_NID).map(
 211             dataContainerChild -> new Ipv4Address((String) dataContainerChild.getValue())).orElse(null);
 212     }
 213
 214     private static AsNumber serializeMemberAsn(final ContainerNode descriptorsData) {
 215         return descriptorsData.getChild(MEMBER_ASN_NID).map(
 216             dataContainerChild -> new AsNumber((Long) dataContainerChild.getValue())).orElse(null);
 217     }
 218
 219     static LocalNodeDescriptors serializeLocalNodeDescriptors(final ContainerNode descriptorsData) {
 220         return new LocalNodeDescriptorsBuilder()
 221                 .setAsNumber(serializeAsNumber(descriptorsData))
 222                 .setDomainId(serializeDomainId(descriptorsData))
 223                 .setAreaId(serializeAreaId(descriptorsData))
 224                 .setCRouterIdentifier(serializeRouterId(descriptorsData))
 225                 .setBgpRouterId(serializeBgpRouterId(descriptorsData))
 226                 .setMemberAsn(serializeMemberAsn(descriptorsData))
 227                 .build();
 228     }
 229
 230     static RemoteNodeDescriptors serializeRemoteNodeDescriptors(final ContainerNode descriptorsData) {
 231         return new RemoteNodeDescriptorsBuilder()
 232                 .setAsNumber(serializeAsNumber(descriptorsData))
 233                 .setDomainId(serializeDomainId(descriptorsData))
 234                 .setAreaId(serializeAreaId(descriptorsData))
 235                 .setCRouterIdentifier(serializeRouterId(descriptorsData))
 236                 .setBgpRouterId(serializeBgpRouterId(descriptorsData))
 237                 .setMemberAsn(serializeMemberAsn(descriptorsData))
 238                 .build();
 239     }
 240
 241     static AdvertisingNodeDescriptors serializeAdvNodeDescriptors(final ContainerNode descriptorsData) {
 242         return new AdvertisingNodeDescriptorsBuilder()
 243                 .setAsNumber(serializeAsNumber(descriptorsData))
 244                 .setDomainId(serializeDomainId(descriptorsData))
 245                 .setAreaId(serializeAreaId(descriptorsData))
 246                 .setCRouterIdentifier(serializeRouterId(descriptorsData))
 247                 .build();
 248     }
 249
 250     static NodeDescriptors serializeNodeDescriptors(final ContainerNode descriptorsData) {
 251         return new NodeDescriptorsBuilder()
 252                 .setAsNumber(serializeAsNumber(descriptorsData))
 253                 .setDomainId(serializeDomainId(descriptorsData))
 254                 .setAreaId(serializeAreaId(descriptorsData))
 255                 .setCRouterIdentifier(serializeRouterId(descriptorsData))
 256                 .build();
 257     }
 258 }