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