bgp/topology-provider/src/main/java/org/opendaylight/bgpcep/bgp/topology/provider/AbstractReachabilityTopologyBuilder.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.bgpcep.bgp.topology.provider;
   9
  10 import com.google.common.base.Optional;
  11 import java.util.ArrayList;
  12 import java.util.concurrent.ExecutionException;
  13 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  14 import org.opendaylight.controller.md.sal.binding.api.ReadTransaction;
  15 import org.opendaylight.controller.md.sal.binding.api.ReadWriteTransaction;
  16 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  17 import org.opendaylight.protocol.bgp.rib.RibReference;
  18 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.IpPrefix;
  19 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.Route;
  20 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.route.Attributes;
  21 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.next.hop.CNextHop;
  22 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.next.hop.c.next.hop.Ipv4NextHopCase;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.next.hop.c.next.hop.Ipv6NextHopCase;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.next.hop.c.next.hop.ipv4.next.hop._case.Ipv4NextHop;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.next.hop.c.next.hop.ipv6.next.hop._case.Ipv6NextHop;
  26 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
  27 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.TopologyId;
  28 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
  29 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeKey;
  30 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.TopologyTypesBuilder;
  31 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.nt.l3.unicast.igp.topology.rev131021.Node1;
  32 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.nt.l3.unicast.igp.topology.rev131021.Node1Builder;
  33 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.nt.l3.unicast.igp.topology.rev131021.igp.node.attributes.IgpNodeAttributesBuilder;
  34 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.nt.l3.unicast.igp.topology.rev131021.igp.node.attributes.igp.node.attributes.Prefix;
  35 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.nt.l3.unicast.igp.topology.rev131021.igp.node.attributes.igp.node.attributes.PrefixBuilder;
  36 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.nt.l3.unicast.igp.topology.rev131021.igp.node.attributes.igp.node.attributes.PrefixKey;
  37 import org.opendaylight.yangtools.yang.binding.DataObject;
  38 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  39 import org.slf4j.Logger;
  40 import org.slf4j.LoggerFactory;
  41
  42 /**
  43  *
  44  */
  45 abstract class AbstractReachabilityTopologyBuilder<T extends Route> extends AbstractTopologyBuilder<T> {
  46     private static final Logger LOG = LoggerFactory.getLogger(AbstractReachabilityTopologyBuilder.class);
  47
  48     protected AbstractReachabilityTopologyBuilder(final DataBroker dataProvider, final RibReference locRibReference,
  49             final TopologyId topologyId, final Class<T> idClass) {
  50         super(dataProvider, locRibReference, topologyId, new TopologyTypesBuilder().build(), idClass);
  51     }
  52
  53     private NodeId advertizingNode(final Attributes attrs) {
  54         final CNextHop nh = attrs.getCNextHop();
  55         if (nh instanceof Ipv4NextHopCase) {
  56             final Ipv4NextHop ipv4 = ((Ipv4NextHopCase) nh).getIpv4NextHop();
  57
  58             return new NodeId(ipv4.getGlobal().getValue());
  59         } else if (nh instanceof Ipv6NextHopCase) {
  60             final Ipv6NextHop ipv6 = ((Ipv6NextHopCase) nh).getIpv6NextHop();
  61
  62             return new NodeId(ipv6.getGlobal().getValue());
  63         } else {
  64             LOG.warn("Unhandled next hop class {}", nh.getImplementedInterface());
  65             return null;
  66         }
  67     }
  68
  69     private InstanceIdentifier<Node1> nodeInstanceId(final NodeId ni) {
  70         return getInstanceIdentifier().builder().child(Node.class, new NodeKey(ni)).augmentation(Node1.class).toInstance();
  71     }
  72
  73     private static <T extends DataObject> T read(final ReadTransaction t, final InstanceIdentifier<T> id) {
  74         final Optional<T> o;
  75         try {
  76             o = t.read(LogicalDatastoreType.OPERATIONAL, id).get();
  77         } catch (InterruptedException | ExecutionException e) {
  78             LOG.warn("Failed to read {}, assuming non-existent", id, e);
  79             return null;
  80         }
  81
  82         return (T)o.orNull();
  83     }
  84
  85     private InstanceIdentifier<Node1> ensureNodePresent(final ReadWriteTransaction trans, final NodeId ni) {
  86         final InstanceIdentifier<Node1> nii = nodeInstanceId(ni);
  87         LOG.debug("Looking for pre-existing node at {}", nii);
  88
  89         if (read(trans, nii) == null) {
  90             LOG.debug("Create a new node at {}", nii);
  91             trans.put(LogicalDatastoreType.OPERATIONAL, nii, new Node1Builder().setIgpNodeAttributes(
  92                     new IgpNodeAttributesBuilder().setPrefix(new ArrayList<Prefix>()).build()).build());
  93         }
  94
  95         return nii;
  96     }
  97
  98     private void removeEmptyNode(final ReadWriteTransaction trans, final InstanceIdentifier<Node1> nii) {
  99         final Node1 node = read(trans, nii);
 100         if (node != null && node.getIgpNodeAttributes().getPrefix().isEmpty()) {
 101             trans.delete(LogicalDatastoreType.OPERATIONAL, nii);
 102         }
 103     }
 104
 105     protected abstract Attributes getAttributes(final T value);
 106
 107     protected abstract IpPrefix getPrefix(final T value);
 108
 109     @Override
 110     protected final void createObject(final ReadWriteTransaction trans, final InstanceIdentifier<T> id, final T value) {
 111         final NodeId ni = advertizingNode(getAttributes(value));
 112         final InstanceIdentifier<Node1> nii = ensureNodePresent(trans, ni);
 113
 114         final IpPrefix prefix = getPrefix(value);
 115         final PrefixKey pk = new PrefixKey(prefix);
 116
 117         trans.put(LogicalDatastoreType.OPERATIONAL,
 118                 nii.builder().child(
 119                         org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.nt.l3.unicast.igp.topology.rev131021.igp.node.attributes.IgpNodeAttributes.class).child(
 120                                 Prefix.class, pk).toInstance(), new PrefixBuilder().setKey(pk).setPrefix(prefix).build());
 121     }
 122
 123     @Override
 124     protected final void removeObject(final ReadWriteTransaction trans, final InstanceIdentifier<T> id, final T value) {
 125         final NodeId ni = advertizingNode(getAttributes(value));
 126         final InstanceIdentifier<Node1> nii = nodeInstanceId(ni);
 127
 128         final IpPrefix prefix = getPrefix(value);
 129         final PrefixKey pk = new PrefixKey(prefix);
 130
 131         trans.delete(LogicalDatastoreType.OPERATIONAL, nii.builder().child(
 132                 org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.nt.l3.unicast.igp.topology.rev131021.igp.node.attributes.IgpNodeAttributes.class).child(
 133                         Prefix.class, pk).toInstance());
 134
 135         removeEmptyNode(trans, nii);
 136     }
 137
 138 }