bgp/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 = new NodeIdentifier(AsNumTlvParser.AS_NUMBER_QNAME);
  67     @VisibleForTesting
  68     public static final NodeIdentifier AREA_NID = new NodeIdentifier(AreaIdTlvParser.AREA_ID_QNAME);
  69     @VisibleForTesting
  70     public static final NodeIdentifier DOMAIN_NID = new NodeIdentifier(DomainIdTlvParser.DOMAIN_ID_QNAME);
  71     @VisibleForTesting
  72     private static final NodeIdentifier ROUTER_NID = new NodeIdentifier(CRouterIdentifier.QNAME);
  73     @VisibleForTesting
  74     public static final NodeIdentifier BGP_ROUTER_NID = new NodeIdentifier(BgpRouterIdTlvParser.BGP_ROUTER_ID_QNAME);
  75     @VisibleForTesting
  76     public static final NodeIdentifier MEMBER_ASN_NID = new NodeIdentifier(MemAsNumTlvParser.MEMBER_AS_NUMBER_QNAME);
  77
  78     /* Router Identifier QNames */
  79     @VisibleForTesting
  80     public static final NodeIdentifier ISIS_NODE_NID = new NodeIdentifier(IsisNode.QNAME);
  81     @VisibleForTesting
  82     public static final NodeIdentifier ISIS_PSEUDONODE_NID = new NodeIdentifier(IsisPseudonode.QNAME);
  83     @VisibleForTesting
  84     public static final NodeIdentifier OSPF_NODE_NID = new NodeIdentifier(OspfNode.QNAME);
  85     @VisibleForTesting
  86     private static final NodeIdentifier OSPF_PSEUDONODE_NID = new NodeIdentifier(OspfPseudonode.QNAME);
  87     @VisibleForTesting
  88     public static final NodeIdentifier ISO_SYSTEM_NID = new NodeIdentifier(
  89             QName.create(NodeDescriptors.QNAME.getModule(), "iso-system-id"));
  90     @VisibleForTesting
  91     public static final NodeIdentifier ISIS_ROUTER_NID = new NodeIdentifier(
  92             QName.create(NodeDescriptors.QNAME.getModule(),"is-is-router-identifier"));
  93     @VisibleForTesting
  94     public static final NodeIdentifier PSN_NID = new NodeIdentifier(
  95             QName.create(NodeDescriptors.QNAME.getModule(),"psn"));
  96     @VisibleForTesting
  97     public static final NodeIdentifier OSPF_ROUTER_NID = new NodeIdentifier(
  98             QName.create(NodeDescriptors.QNAME.getModule(),"ospf-router-id"));
  99     private static final NodeIdentifier LAN_IFACE_NID = new NodeIdentifier(
 100             QName.create(NodeDescriptors.QNAME.getModule(),"lan-interface"));
 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         final IsisNodeCaseBuilder builder = new IsisNodeCaseBuilder();
 124         final IsisNodeBuilder isisBuilder = new IsisNodeBuilder();
 125         isisBuilder.setIsoSystemId(new IsoSystemIdentifier((byte[]) isis.getChild(ISO_SYSTEM_NID).get().getValue()));
 126         builder.setIsisNode(isisBuilder.build());
 127         return builder.build();
 128     }
 129
 130     private static IsisPseudonodeCase serializeIsisPseudoNode(final ContainerNode pseudoIsisNode) {
 131         final IsIsRouterIdentifierBuilder isisRouterId = new IsIsRouterIdentifierBuilder();
 132         if (pseudoIsisNode.getChild(ISIS_ROUTER_NID).isPresent()) {
 133             final ContainerNode isisRouterNid = (ContainerNode) pseudoIsisNode.getChild(ISIS_ROUTER_NID).get();
 134             if (isisRouterNid.getChild(ISO_SYSTEM_NID).isPresent()) {
 135                 isisRouterId.setIsoSystemId(new IsoSystemIdentifier((byte[]) isisRouterNid.getChild(ISO_SYSTEM_NID)
 136                         .get().getValue()));
 137             }
 138         }
 139
 140         final IsisPseudonodeBuilder nodeBuilder = new IsisPseudonodeBuilder();
 141         nodeBuilder.setIsIsRouterIdentifier(isisRouterId.build());
 142
 143         if (pseudoIsisNode.getChild(PSN_NID).isPresent()) {
 144             nodeBuilder.setPsn((Short) pseudoIsisNode.getChild(PSN_NID).get().getValue());
 145         } else {
 146             nodeBuilder.setPsn((short) 0);
 147         }
 148
 149         return new IsisPseudonodeCaseBuilder().setIsisPseudonode(nodeBuilder.build()).build();
 150     }
 151
 152     private static OspfNodeCase serializeOspfNode(final ContainerNode ospf) {
 153         final OspfNodeCaseBuilder builder = new OspfNodeCaseBuilder();
 154         if (ospf.getChild(OSPF_ROUTER_NID).isPresent()) {
 155             final OspfNodeBuilder nodeBuilder = new OspfNodeBuilder();
 156             nodeBuilder.setOspfRouterId((Long) ospf.getChild(OSPF_ROUTER_NID).get().getValue());
 157             builder.setOspfNode(nodeBuilder.build());
 158         }
 159         return builder.build();
 160     }
 161
 162     private static CRouterIdentifier serializeOspfPseudoNode(final ContainerNode ospfPseudonode) {
 163         final OspfPseudonodeCaseBuilder builder = new OspfPseudonodeCaseBuilder();
 164         final OspfPseudonodeBuilder nodeBuilder = new OspfPseudonodeBuilder();
 165         if (ospfPseudonode.getChild(LAN_IFACE_NID).isPresent()) {
 166             nodeBuilder.setLanInterface(new OspfInterfaceIdentifier((Long)ospfPseudonode.getChild(LAN_IFACE_NID)
 167                     .get().getValue()));
 168         }
 169         if (ospfPseudonode.getChild(OSPF_ROUTER_NID).isPresent()) {
 170             nodeBuilder.setOspfRouterId((Long)ospfPseudonode.getChild(OSPF_ROUTER_NID).get().getValue());
 171         }
 172         builder.setOspfPseudonode(nodeBuilder.build());
 173         return builder.build();
 174     }
 175
 176     private static CRouterIdentifier serializeRouterId(final ContainerNode descriptorsData) {
 177         CRouterIdentifier cRouterId = null;
 178         final Optional<DataContainerChild<? extends PathArgument, ?>> maybeRouterId
 179                 = descriptorsData.getChild(ROUTER_NID);
 180         if (maybeRouterId.isPresent()) {
 181             final ChoiceNode routerId = (ChoiceNode) maybeRouterId.get();
 182             if (routerId.getChild(ISIS_NODE_NID).isPresent()) {
 183                 cRouterId = serializeIsisNode((ContainerNode) routerId.getChild(ISIS_NODE_NID).get());
 184             } else if (routerId.getChild(ISIS_PSEUDONODE_NID).isPresent()) {
 185                 cRouterId = serializeIsisPseudoNode((ContainerNode) routerId.getChild(ISIS_PSEUDONODE_NID).get());
 186             } else if (routerId.getChild(OSPF_NODE_NID).isPresent()) {
 187                 cRouterId = serializeOspfNode((ContainerNode) routerId.getChild(OSPF_NODE_NID).get());
 188             } else if (routerId.getChild(OSPF_PSEUDONODE_NID).isPresent()) {
 189                 cRouterId = serializeOspfPseudoNode((ContainerNode) routerId.getChild(OSPF_PSEUDONODE_NID).get());
 190             }
 191         }
 192         return cRouterId;
 193     }
 194
 195     private static AsNumber serializeAsNumber(final ContainerNode descriptorsData) {
 196         final Optional<DataContainerChild<? extends PathArgument, ?>> asNumber
 197                 = descriptorsData.getChild(AS_NUMBER_NID);
 198         return asNumber.map(dataContainerChild -> new AsNumber((Long) dataContainerChild.getValue())).orElse(null);
 199     }
 200
 201     private static DomainIdentifier serializeDomainId(final ContainerNode descriptorsData) {
 202         final Optional<DataContainerChild<? extends PathArgument, ?>> domainId = descriptorsData.getChild(DOMAIN_NID);
 203         return domainId.map(dataContainerChild
 204                 -> new DomainIdentifier((Long) dataContainerChild.getValue())).orElse(null);
 205     }
 206
 207     private static AreaIdentifier serializeAreaId(final ContainerNode descriptorsData) {
 208         final Optional<DataContainerChild<? extends PathArgument, ?>> areaId = descriptorsData.getChild(AREA_NID);
 209         return areaId.map(dataContainerChild
 210                 -> new AreaIdentifier((Long) dataContainerChild.getValue())).orElse(null);
 211     }
 212
 213     private static Ipv4Address serializeBgpRouterId(final ContainerNode descriptorsData) {
 214         final Optional<DataContainerChild<? extends PathArgument, ?>> bgpRouterId
 215                 = descriptorsData.getChild(BGP_ROUTER_NID);
 216         return bgpRouterId.map(dataContainerChild
 217                 -> new Ipv4Address((String) dataContainerChild.getValue())).orElse(null);
 218     }
 219
 220     private static AsNumber serializeMemberAsn(final ContainerNode descriptorsData) {
 221         final Optional<DataContainerChild<? extends PathArgument, ?>> memberAsn
 222                 = descriptorsData.getChild(MEMBER_ASN_NID);
 223         return memberAsn.map(dataContainerChild -> new AsNumber((Long) dataContainerChild.getValue())).orElse(null);
 224     }
 225
 226     static LocalNodeDescriptors serializeLocalNodeDescriptors(final ContainerNode descriptorsData) {
 227         final LocalNodeDescriptorsBuilder builder = new LocalNodeDescriptorsBuilder();
 228         builder.setAsNumber(serializeAsNumber(descriptorsData));
 229         builder.setDomainId(serializeDomainId(descriptorsData));
 230         builder.setAreaId(serializeAreaId(descriptorsData));
 231         builder.setCRouterIdentifier(serializeRouterId(descriptorsData));
 232         builder.setBgpRouterId(serializeBgpRouterId(descriptorsData));
 233         builder.setMemberAsn(serializeMemberAsn(descriptorsData));
 234         return builder.build();
 235     }
 236
 237     static RemoteNodeDescriptors serializeRemoteNodeDescriptors(final ContainerNode descriptorsData) {
 238         final RemoteNodeDescriptorsBuilder builder = new RemoteNodeDescriptorsBuilder();
 239         builder.setAsNumber(serializeAsNumber(descriptorsData));
 240         builder.setDomainId(serializeDomainId(descriptorsData));
 241         builder.setAreaId(serializeAreaId(descriptorsData));
 242         builder.setCRouterIdentifier(serializeRouterId(descriptorsData));
 243         builder.setBgpRouterId(serializeBgpRouterId(descriptorsData));
 244         builder.setMemberAsn(serializeMemberAsn(descriptorsData));
 245         return builder.build();
 246     }
 247
 248     static AdvertisingNodeDescriptors serializeAdvNodeDescriptors(final ContainerNode descriptorsData) {
 249         final AdvertisingNodeDescriptorsBuilder builder = new AdvertisingNodeDescriptorsBuilder();
 250         builder.setAsNumber(serializeAsNumber(descriptorsData));
 251         builder.setDomainId(serializeDomainId(descriptorsData));
 252         builder.setAreaId(serializeAreaId(descriptorsData));
 253         builder.setCRouterIdentifier(serializeRouterId(descriptorsData));
 254         return builder.build();
 255     }
 256
 257     static NodeDescriptors serializeNodeDescriptors(final ContainerNode descriptorsData) {
 258         final NodeDescriptorsBuilder builder = new NodeDescriptorsBuilder();
 259         builder.setAsNumber(serializeAsNumber(descriptorsData));
 260         builder.setDomainId(serializeDomainId(descriptorsData));
 261         builder.setAreaId(serializeAreaId(descriptorsData));
 262         builder.setCRouterIdentifier(serializeRouterId(descriptorsData));
 263         return builder.build();
 264     }
 265 }