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