Merge "Topology builders should require a local rib reference"
[bgpcep.git] / 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 java.util.ArrayList;
11
12 import org.opendaylight.controller.md.sal.common.api.data.DataModification;
13 import org.opendaylight.controller.sal.binding.api.data.DataProviderService;
14 import org.opendaylight.protocol.bgp.rib.LocRibReference;
15 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.IpPrefix;
16 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.Route;
17 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.route.Attributes;
18 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.next.hop.CNextHop;
19 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.next.hop.c.next.hop.Ipv4NextHopCase;
20 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.next.hop.c.next.hop.Ipv6NextHopCase;
21 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;
22 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;
23 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
24 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.TopologyId;
25 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
26 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeKey;
27 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.nt.l3.unicast.igp.topology.rev131021.Node1;
28 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.nt.l3.unicast.igp.topology.rev131021.Node1Builder;
29 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.nt.l3.unicast.igp.topology.rev131021.igp.node.attributes.IgpNodeAttributesBuilder;
30 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;
31 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;
32 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;
33 import org.opendaylight.yangtools.yang.binding.DataObject;
34 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
35 import org.slf4j.Logger;
36 import org.slf4j.LoggerFactory;
37
38 /**
39  *
40  */
41 abstract class AbstractReachabilityTopologyBuilder<T extends Route> extends AbstractTopologyBuilder<T> {
42         private static final Logger LOG = LoggerFactory.getLogger(AbstractReachabilityTopologyBuilder.class);
43
44         protected AbstractReachabilityTopologyBuilder(final DataProviderService dataProvider, final LocRibReference locRibReference, final TopologyId topologyId,
45                         final Class<T> idClass) {
46                 super(dataProvider, locRibReference, topologyId, idClass);
47         }
48
49         private NodeId advertizingNode(final Attributes attrs) {
50                 final CNextHop nh = attrs.getCNextHop();
51                 if (nh instanceof Ipv4NextHopCase) {
52                         final Ipv4NextHop ipv4 = ((Ipv4NextHopCase) nh).getIpv4NextHop();
53
54                         return new NodeId(ipv4.getGlobal().getValue());
55                 } else if (nh instanceof Ipv6NextHopCase) {
56                         final Ipv6NextHop ipv6 = ((Ipv6NextHopCase) nh).getIpv6NextHop();
57
58                         return new NodeId(ipv6.getGlobal().getValue());
59                 } else {
60                         LOG.warn("Unhandled next hop class {}", nh.getImplementedInterface());
61                         return null;
62                 }
63         }
64
65         private InstanceIdentifier<Node1> nodeInstanceId(final NodeId ni) {
66                 return InstanceIdentifier.builder(getInstanceIdentifier()).child(Node.class, new NodeKey(ni)).augmentation(Node1.class).toInstance();
67         }
68
69         private InstanceIdentifier<Node1> ensureNodePresent(final DataModification<InstanceIdentifier<?>, DataObject> trans, final NodeId ni) {
70                 final InstanceIdentifier<Node1> nii = nodeInstanceId(ni);
71
72                 if (trans.readOperationalData(nii) == null) {
73                         LOG.debug("Create a new node at {}", nii);
74                         trans.putOperationalData(
75                                         nii,
76                                         new Node1Builder().setIgpNodeAttributes(new IgpNodeAttributesBuilder().setPrefix(new ArrayList<Prefix>()).build()).build());
77                 }
78
79                 return nii;
80         }
81
82         private void removeEmptyNode(final DataModification<InstanceIdentifier<?>, DataObject> trans, final InstanceIdentifier<Node1> nii) {
83                 final Node1 node = (Node1) trans.readOperationalData(nii);
84                 if (node != null && node.getIgpNodeAttributes().getPrefix().isEmpty()) {
85                         trans.removeOperationalData(nii);
86                 }
87         }
88
89         protected abstract Attributes getAttributes(final T value);
90
91         protected abstract IpPrefix getPrefix(final T value);
92
93         @Override
94         protected final void createObject(final DataModification<InstanceIdentifier<?>, DataObject> trans, final InstanceIdentifier<T> id,
95                         final T value) {
96                 final NodeId ni = advertizingNode(getAttributes(value));
97                 final InstanceIdentifier<Node1> nii = ensureNodePresent(trans, ni);
98
99                 final IpPrefix prefix = getPrefix(value);
100                 final PrefixKey pk = new PrefixKey(prefix);
101
102                 trans.putOperationalData(
103                                 InstanceIdentifier.builder(nii).child(
104                                                 org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.nt.l3.unicast.igp.topology.rev131021.igp.node.attributes.IgpNodeAttributes.class).child(
105                                                                 Prefix.class, pk).toInstance(), new PrefixBuilder().setKey(pk).setPrefix(prefix).build());
106         }
107
108         @Override
109         protected final void removeObject(final DataModification<InstanceIdentifier<?>, DataObject> trans, final InstanceIdentifier<T> id,
110                         final T value) {
111                 final NodeId ni = advertizingNode(getAttributes(value));
112                 final InstanceIdentifier<Node1> nii = nodeInstanceId(ni);
113
114                 final IpPrefix prefix = getPrefix(value);
115                 final PrefixKey pk = new PrefixKey(prefix);
116
117                 trans.removeOperationalData(InstanceIdentifier.builder(nii).child(
118                                 org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.nt.l3.unicast.igp.topology.rev131021.igp.node.attributes.IgpNodeAttributes.class).child(
119                                                 Prefix.class, pk).toInstance());
120
121                 removeEmptyNode(trans, nii);
122         }
123
124 }