bgp/rib-impl/src/main/java/org/opendaylight/protocol/bgp/rib/impl/CodecsImpl.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 static java.util.Objects.requireNonNull;
  11
  12 import com.google.common.base.Preconditions;
  13 import com.google.common.collect.ImmutableSet;
  14 import com.google.common.collect.ImmutableSet.Builder;
  15 import java.util.Set;
  16 import org.opendaylight.mdsal.binding.dom.codec.api.BindingCodecTree;
  17 import org.opendaylight.mdsal.binding.dom.codec.api.BindingDataObjectCodecTreeNode;
  18 import org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeCachingCodec;
  19 import org.opendaylight.mdsal.binding.dom.codec.api.CommonDataObjectCodecTreeNode;
  20 import org.opendaylight.protocol.bgp.rib.impl.spi.Codecs;
  21 import org.opendaylight.protocol.bgp.rib.spi.RIBSupport;
  22 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.ClusterId;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.OriginatorId;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.Update;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.path.attributes.Attributes;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.path.attributes.AttributesBuilder;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.path.attributes.attributes.Aggregator;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.path.attributes.attributes.AsPath;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.path.attributes.attributes.Communities;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.path.attributes.attributes.ExtendedCommunities;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.path.attributes.attributes.LocalPref;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.path.attributes.attributes.MultiExitDisc;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.path.attributes.attributes.Origin;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.path.attributes.attributes.UnrecognizedAttributes;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.AttributesReach;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.AttributesUnreach;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.attributes.reach.MpReachNlri;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.attributes.unreach.MpUnreachNlri;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.BgpRib;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.Route;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.bgp.rib.Rib;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.bgp.rib.rib.LocRib;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.Tables;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.tables.Routes;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev200120.BgpAggregator;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev200120.Community;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev200120.ExtendedCommunity;
  48 import org.opendaylight.yangtools.yang.binding.BindingObject;
  49 import org.opendaylight.yangtools.yang.binding.DataObject;
  50 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  51 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  52 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  53
  54 public final class CodecsImpl implements Codecs {
  55
  56     private static final Set<Class<? extends DataObject>> ATTRIBUTE_CACHEABLES;
  57     private static final InstanceIdentifier<Tables> TABLE_BASE_II = InstanceIdentifier.builder(BgpRib.class)
  58             .child(Rib.class)
  59             .child(LocRib.class)
  60             .child(Tables.class)
  61             .build();
  62
  63     static {
  64         final Builder<Class<? extends DataObject>> acb = ImmutableSet.builder();
  65         acb.add(Aggregator.class);
  66         acb.add(BgpAggregator.class);
  67         acb.add(AsPath.class);
  68         acb.add(ClusterId.class);
  69         acb.add(Community.class);
  70         acb.add(Communities.class);
  71         acb.add(ExtendedCommunity.class);
  72         acb.add(ExtendedCommunities.class);
  73         acb.add(LocalPref.class);
  74         acb.add(MultiExitDisc.class);
  75         acb.add(Origin.class);
  76         acb.add(OriginatorId.class);
  77         acb.add(UnrecognizedAttributes.class);
  78         ATTRIBUTE_CACHEABLES = acb.build();
  79     }
  80
  81     private final ImmutableSet<Class<? extends BindingObject>> cacheableAttributes;
  82     private BindingNormalizedNodeCachingCodec<Attributes> attributesCodec;
  83     private BindingNormalizedNodeCachingCodec<MpReachNlri> reachNlriCodec;
  84     private BindingNormalizedNodeCachingCodec<MpUnreachNlri> unreachNlriCodec;
  85
  86     private final RIBSupport<?, ?> ribSupport;
  87
  88     public CodecsImpl(final RIBSupport<?, ?> ribSupport) {
  89         this.ribSupport = requireNonNull(ribSupport);
  90         final Builder<Class<? extends BindingObject>> acb = ImmutableSet.builder();
  91         acb.addAll(ATTRIBUTE_CACHEABLES);
  92         acb.addAll(this.ribSupport.cacheableAttributeObjects());
  93         cacheableAttributes = acb.build();
  94     }
  95
  96     @Override
  97     @SuppressWarnings("unchecked")
  98     public void onCodecTreeUpdated(final BindingCodecTree tree) {
  99
 100         final CommonDataObjectCodecTreeNode<Tables> codecContext = tree.getSubtreeCodec(TABLE_BASE_II);
 101         if (!(codecContext instanceof BindingDataObjectCodecTreeNode tableCodecContext)) {
 102             throw new IllegalStateException("Unexpected table codec " + codecContext);
 103         }
 104
 105         final BindingDataObjectCodecTreeNode<? extends Route> routeListCodec = tableCodecContext
 106             .getStreamChild(Routes.class)
 107             .getStreamChild(ribSupport.routesCaseClass())
 108             .getStreamChild(ribSupport.routesContainerClass())
 109             .getStreamDataObject(ribSupport.routesListClass());
 110
 111         attributesCodec = routeListCodec.getStreamDataObject(Attributes.class)
 112             .createCachingCodec(cacheableAttributes);
 113
 114         final var attrCodec = tree.getStreamChild(Update.class).getStreamChild(Attributes.class);
 115         reachNlriCodec = attrCodec.getStreamChild(AttributesReach.class)
 116             .getStreamDataObject(MpReachNlri.class)
 117             .createCachingCodec(ribSupport.cacheableNlriObjects());
 118         unreachNlriCodec = attrCodec.getStreamChild(AttributesUnreach.class)
 119             .getStreamDataObject(MpUnreachNlri.class)
 120             .createCachingCodec(ribSupport.cacheableNlriObjects());
 121     }
 122
 123     @Override
 124     public ContainerNode serializeUnreachNlri(final MpUnreachNlri nlri) {
 125         Preconditions.checkState(unreachNlriCodec != null, "MpReachNlri codec not available");
 126         return (ContainerNode) unreachNlriCodec.serialize(nlri);
 127     }
 128
 129     @Override
 130     public ContainerNode serializeReachNlri(final MpReachNlri nlri) {
 131         Preconditions.checkState(reachNlriCodec != null, "MpReachNlri codec not available");
 132         return (ContainerNode) reachNlriCodec.serialize(nlri);
 133     }
 134
 135     @Override
 136     public Attributes deserializeAttributes(final NormalizedNode attributes) {
 137         Preconditions.checkState(attributesCodec != null, "Attributes codec not available");
 138         return attributesCodec.deserialize(attributes);
 139     }
 140
 141     @Override
 142     public ContainerNode serializeAttributes(final Attributes pathAttr) {
 143         Preconditions.checkState(attributesCodec != null, "Attributes codec not available");
 144         final AttributesBuilder a = new AttributesBuilder(pathAttr);
 145         a.removeAugmentation(AttributesReach.class);
 146         a.removeAugmentation(AttributesUnreach.class);
 147         return (ContainerNode) attributesCodec.serialize(a.build());
 148     }
 149 }