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