Do not create empty route list container
[bgpcep.git] / bmp / bmp-impl / src / main / java / org / opendaylight / protocol / bmp / impl / app / TableContext.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
9 package org.opendaylight.protocol.bmp.impl.app;
10
11 import static java.util.Objects.requireNonNull;
12 import static org.opendaylight.protocol.bmp.impl.app.TablesUtil.BMP_ATTRIBUTES_QNAME;
13 import static org.opendaylight.protocol.bmp.impl.app.TablesUtil.BMP_ROUTES_QNAME;
14
15 import com.google.common.base.Preconditions;
16 import java.util.Map;
17 import javax.annotation.concurrent.NotThreadSafe;
18 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
19 import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction;
20 import org.opendaylight.mdsal.binding.dom.codec.api.BindingCodecTree;
21 import org.opendaylight.mdsal.binding.dom.codec.api.BindingCodecTreeNode;
22 import org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeCachingCodec;
23 import org.opendaylight.protocol.bgp.rib.spi.RIBSupport;
24 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.Update;
25 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.path.attributes.Attributes;
26 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.path.attributes.AttributesBuilder;
27 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.Attributes1;
28 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.Attributes2;
29 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.update.attributes.MpReachNlri;
30 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.update.attributes.MpUnreachNlri;
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.Route;
32 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.tables.Routes;
33 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
34 import org.opendaylight.yangtools.yang.common.QName;
35 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
36 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
37 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
38 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
39 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
40 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
41 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeBuilder;
42 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableChoiceNodeBuilder;
43
44 @NotThreadSafe
45 final class TableContext {
46
47     private static final ContainerNode EMPTY_TABLE_ATTRIBUTES = ImmutableNodes.containerNode(BMP_ATTRIBUTES_QNAME);
48
49     private static final InstanceIdentifier<MpReachNlri> MP_REACH_NLRI_II = InstanceIdentifier.create(Update.class)
50             .child(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.path
51                     .attributes.Attributes.class).augmentation(Attributes1.class).child(MpReachNlri.class);
52     private static final InstanceIdentifier<MpUnreachNlri> MP_UNREACH_NLRI_II = InstanceIdentifier.create(Update.class)
53             .child(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.path
54                     .attributes.Attributes.class).augmentation(Attributes2.class).child(MpUnreachNlri.class);
55     private static final NodeIdentifier BGP_ROUTES_NODE_ID = new NodeIdentifier(BMP_ROUTES_QNAME);
56
57     private final YangInstanceIdentifier tableId;
58     private final RIBSupport tableSupport;
59     private final BindingNormalizedNodeCachingCodec<Attributes> attributesCodec;
60     private final BindingNormalizedNodeCachingCodec<MpReachNlri> reachNlriCodec;
61     private final BindingNormalizedNodeCachingCodec<MpUnreachNlri> unreachNlriCodec;
62
63     @SuppressWarnings({ "unchecked", "rawtypes" })
64     TableContext(final RIBSupport tableSupport, final YangInstanceIdentifier tableId, final BindingCodecTree tree) {
65         this.tableSupport = requireNonNull(tableSupport);
66         this.tableId = requireNonNull(tableId);
67         final BindingCodecTreeNode tableCodecContext = tree.getSubtreeCodec(tableId);
68         final BindingCodecTreeNode<? extends Route> routeListCodec = tableCodecContext
69             .streamChild(Routes.class)
70             .streamChild(this.tableSupport.routesCaseClass())
71             .streamChild(this.tableSupport.routesContainerClass())
72             .streamChild(this.tableSupport.routesListClass());
73
74         this.attributesCodec = routeListCodec.streamChild(Attributes.class)
75                 .createCachingCodec(this.tableSupport.cacheableAttributeObjects());
76         this.reachNlriCodec = tree.getSubtreeCodec(MP_REACH_NLRI_II)
77                 .createCachingCodec(this.tableSupport.cacheableNlriObjects());
78         this.unreachNlriCodec = tree.getSubtreeCodec(MP_UNREACH_NLRI_II)
79                 .createCachingCodec(this.tableSupport.cacheableNlriObjects());
80     }
81
82     YangInstanceIdentifier getTableId() {
83         return this.tableId;
84     }
85
86     void createTable(final DOMDataWriteTransaction tx) {
87         final DataContainerNodeBuilder<NodeIdentifierWithPredicates, MapEntryNode> tb =
88                 ImmutableNodes.mapEntryBuilder();
89         tb.withNodeIdentifier((NodeIdentifierWithPredicates) this.tableId.getLastPathArgument());
90         tb.withChild(EMPTY_TABLE_ATTRIBUTES);
91
92         // tableId is keyed, but that fact is not directly visible from YangInstanceIdentifier, see BUG-2796
93         final NodeIdentifierWithPredicates tableKey =
94                 (NodeIdentifierWithPredicates) this.tableId.getLastPathArgument();
95         for (final Map.Entry<QName, Object> e : tableKey.getKeyValues().entrySet()) {
96             tb.withChild(ImmutableNodes.leafNode(e.getKey(), e.getValue()));
97         }
98
99         tx.put(LogicalDatastoreType.OPERATIONAL, this.tableId,
100                 tb.withChild(ImmutableChoiceNodeBuilder.create().withNodeIdentifier(
101                         new NodeIdentifier(TablesUtil.BMP_ROUTES_QNAME)).build()).build());
102     }
103
104     void writeRoutes(final DOMDataWriteTransaction tx, final MpReachNlri nlri, final Attributes attributes) {
105         final ContainerNode domNlri = serializeReachNlri(nlri);
106         final ContainerNode routeAttributes = serializeAttributes(attributes);
107         this.tableSupport.putRoutes(tx, this.tableId, domNlri, routeAttributes, BGP_ROUTES_NODE_ID);
108     }
109
110     void removeRoutes(final DOMDataWriteTransaction tx, final MpUnreachNlri nlri) {
111         this.tableSupport.deleteRoutes(tx, this.tableId, serializeUnreachNlri(nlri), BGP_ROUTES_NODE_ID);
112     }
113
114     private ContainerNode serializeUnreachNlri(final MpUnreachNlri nlri) {
115         Preconditions.checkState(this.unreachNlriCodec != null, "MpUnReachNlri codec not available");
116         return (ContainerNode) this.unreachNlriCodec.serialize(nlri);
117     }
118
119     private ContainerNode serializeReachNlri(final MpReachNlri nlri) {
120         Preconditions.checkState(this.reachNlriCodec != null, "MpReachNlri codec not available");
121         return (ContainerNode) this.reachNlriCodec.serialize(nlri);
122     }
123
124     private ContainerNode serializeAttributes(final Attributes pathAttr) {
125         Preconditions.checkState(this.attributesCodec != null, "Attributes codec not available");
126         final AttributesBuilder a = new AttributesBuilder(pathAttr);
127         a.addAugmentation(Attributes1.class, null);
128         a.addAugmentation(Attributes2.class, null);
129         return (ContainerNode) this.attributesCodec.serialize(a.build());
130     }
131 }