c15333b7c4b89ecfb69f7c427ed14ff8dc2cb981
[bgpcep.git] / bgp / rib-impl / src / main / java / org / opendaylight / protocol / bgp / rib / impl / RIBSupportContextImpl.java
1 /*
2  * Copyright (c) 2015 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.rib.impl;
9
10 import com.google.common.base.Preconditions;
11 import com.google.common.base.Verify;
12 import com.google.common.collect.ImmutableSet;
13 import com.google.common.collect.ImmutableSet.Builder;
14 import java.util.Map.Entry;
15 import java.util.Set;
16 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
17 import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction;
18 import org.opendaylight.protocol.bgp.rib.impl.spi.RIBSupportContext;
19 import org.opendaylight.protocol.bgp.rib.spi.RIBSupport;
20 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.ClusterId;
21 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.OriginatorId;
22 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.Update;
23 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.Attributes;
24 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.AttributesBuilder;
25 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.attributes.Aggregator;
26 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.attributes.AsPath;
27 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.attributes.Communities;
28 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.attributes.ExtendedCommunities;
29 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.attributes.LocalPref;
30 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.attributes.MultiExitDisc;
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.attributes.Origin;
32 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.attributes.UnrecognizedAttributes;
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.Attributes1;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.Attributes2;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.attributes.MpReachNlri;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.attributes.MpUnreachNlri;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.BgpRib;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.Route;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.bgp.rib.Rib;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.bgp.rib.rib.LocRib;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.Tables;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.tables.Routes;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.BgpAggregator;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.Community;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.ExtendedCommunity;
46 import org.opendaylight.yangtools.binding.data.codec.api.BindingCodecTree;
47 import org.opendaylight.yangtools.binding.data.codec.api.BindingCodecTreeNode;
48 import org.opendaylight.yangtools.binding.data.codec.api.BindingNormalizedNodeCachingCodec;
49 import org.opendaylight.yangtools.yang.binding.DataObject;
50 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
51 import org.opendaylight.yangtools.yang.common.QName;
52 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
53 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
54 import org.opendaylight.yangtools.yang.data.api.schema.ChoiceNode;
55 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
56 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
57 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
58 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
59 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeBuilder;
60
61 class RIBSupportContextImpl extends RIBSupportContext {
62
63     private static final ContainerNode EMPTY_TABLE_ATTRIBUTES = ImmutableNodes.containerNode(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.tables.Attributes.QNAME);
64     private static final Set<Class<? extends DataObject>> ATTRIBUTE_CACHEABLES;
65
66     private static final InstanceIdentifier<Tables> TABLE_BASE_II = InstanceIdentifier.builder(BgpRib.class)
67             .child(Rib.class)
68             .child(LocRib.class)
69             .child(Tables.class)
70             .build();
71     private static final InstanceIdentifier<MpReachNlri> MP_REACH_NLRI_II = InstanceIdentifier.create(Update.class)
72                 .child(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.Attributes.class)
73                 .augmentation(Attributes1.class)
74                 .child(MpReachNlri.class);
75     private static final InstanceIdentifier<MpUnreachNlri> MP_UNREACH_NLRI_II = InstanceIdentifier.create(Update.class)
76             .child(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.Attributes.class)
77             .augmentation(Attributes2.class)
78             .child(MpUnreachNlri.class);
79
80
81     static {
82         final Builder<Class<? extends DataObject>> acb = ImmutableSet.builder();
83         acb.add(Aggregator.class);
84         acb.add(BgpAggregator.class);
85         acb.add(AsPath.class);
86         acb.add(ClusterId.class);
87         acb.add(Community.class);
88         acb.add(Communities.class);
89         acb.add(ExtendedCommunity.class);
90         acb.add(ExtendedCommunities.class);
91         acb.add(LocalPref.class);
92         acb.add(MultiExitDisc.class);
93         acb.add(Origin.class);
94         acb.add(OriginatorId.class);
95         acb.add(UnrecognizedAttributes.class);
96         ATTRIBUTE_CACHEABLES = acb.build();
97     }
98
99     private final RIBSupport tableSupport;
100     private final ImmutableSet<Class<? extends DataObject>> cacheableAttributes;
101     private BindingNormalizedNodeCachingCodec<Attributes> attributesCodec;
102     private BindingNormalizedNodeCachingCodec<MpReachNlri> reachNlriCodec;
103     private BindingNormalizedNodeCachingCodec<MpUnreachNlri> unreachNlriCodec;
104
105
106     public RIBSupportContextImpl(final RIBSupport ribSupport) {
107         this.tableSupport = Preconditions.checkNotNull(ribSupport);
108         final Builder<Class<? extends DataObject>> acb = ImmutableSet.builder();
109         acb.addAll(ATTRIBUTE_CACHEABLES);
110         acb.addAll(this.tableSupport.cacheableAttributeObjects());
111         this.cacheableAttributes = acb.build();
112
113     }
114
115     @SuppressWarnings("unchecked")
116     void onCodecTreeUpdated(final BindingCodecTree tree) {
117
118         @SuppressWarnings("rawtypes")
119         final BindingCodecTreeNode tableCodecContext = tree.getSubtreeCodec(TABLE_BASE_II);
120         final BindingCodecTreeNode<? extends Route> routeListCodec = tableCodecContext
121             .streamChild(Routes.class)
122             .streamChild(this.tableSupport.routesCaseClass())
123             .streamChild(this.tableSupport.routesContainerClass())
124             .streamChild(this.tableSupport.routesListClass());
125
126         this.attributesCodec = routeListCodec.streamChild(Attributes.class).createCachingCodec(this.cacheableAttributes);
127         this.reachNlriCodec = tree.getSubtreeCodec(MP_REACH_NLRI_II).createCachingCodec(this.tableSupport.cacheableNlriObjects());
128         this.unreachNlriCodec = tree.getSubtreeCodec(MP_UNREACH_NLRI_II).createCachingCodec(this.tableSupport.cacheableNlriObjects());
129     }
130
131     @Override
132     public void writeRoutes(final DOMDataWriteTransaction tx, final YangInstanceIdentifier tableId, final MpReachNlri nlri,
133             final Attributes attributes) {
134         final ContainerNode domNlri = serialiazeReachNlri(nlri);
135         final ContainerNode routeAttributes = serializeAttributes(attributes);
136         this.tableSupport.putRoutes(tx, tableId, domNlri, routeAttributes);
137     }
138
139     @Override
140     public void clearTable(final DOMDataWriteTransaction tx, final YangInstanceIdentifier tableId) {
141         final DataContainerNodeBuilder<NodeIdentifierWithPredicates, MapEntryNode> tb = ImmutableNodes.mapEntryBuilder();
142         tb.withNodeIdentifier((NodeIdentifierWithPredicates)tableId.getLastPathArgument());
143         tb.withChild(EMPTY_TABLE_ATTRIBUTES);
144
145         // tableId is keyed, but that fact is not directly visible from YangInstanceIdentifier, see BUG-2796
146         final NodeIdentifierWithPredicates tableKey = (NodeIdentifierWithPredicates) tableId.getLastPathArgument();
147         for (final Entry<QName, Object> e : tableKey.getKeyValues().entrySet()) {
148             tb.withChild(ImmutableNodes.leafNode(e.getKey(), e.getValue()));
149         }
150
151         final ChoiceNode routes = this.tableSupport.emptyRoutes();
152         Verify.verifyNotNull(routes, "Null empty routes in %s", this.tableSupport);
153         Verify.verify(Routes.QNAME.equals(routes.getNodeType()), "Empty routes have unexpected identifier %s, expected %s", routes.getNodeType(), Routes.QNAME);
154
155         tx.put(LogicalDatastoreType.OPERATIONAL, tableId, tb.withChild(routes).build());
156     }
157
158     @Override
159     public void deleteRoutes(final DOMDataWriteTransaction tx, final YangInstanceIdentifier tableId, final MpUnreachNlri nlri) {
160         this.tableSupport.deleteRoutes(tx, tableId, serialiazeUnreachNlri(nlri));
161     }
162
163     private ContainerNode serialiazeUnreachNlri(final MpUnreachNlri nlri) {
164         Preconditions.checkState(this.unreachNlriCodec != null, "MpReachNlri codec not available");
165         return (ContainerNode) this.unreachNlriCodec.serialize(nlri);
166     }
167
168     private ContainerNode serialiazeReachNlri(final MpReachNlri nlri) {
169         Preconditions.checkState(this.reachNlriCodec != null, "MpReachNlri codec not available");
170         return (ContainerNode) this.reachNlriCodec.serialize(nlri);
171     }
172
173     public Attributes deserializeAttributes(final NormalizedNode<?,?> attributes) {
174         Preconditions.checkState(this.attributesCodec != null, "Attributes codec not available");
175         return this.attributesCodec.deserialize(attributes);
176     }
177
178     private ContainerNode serializeAttributes(final Attributes pathAttr) {
179         Preconditions.checkState(this.attributesCodec != null, "Attributes codec not available");
180         final AttributesBuilder a = new AttributesBuilder(pathAttr);
181         a.addAugmentation(Attributes1.class, null);
182         a.addAugmentation(Attributes2.class, null);
183         return (ContainerNode) this.attributesCodec.serialize(a.build());
184     }
185
186     @Override
187     public RIBSupport getRibSupport() {
188         return this.tableSupport;
189     }
190 }