Created new classes for serializing/deserializing only. 95/22995/5
authorDana Kutenicsova <dkutenic@cisco.com>
Fri, 19 Jun 2015 11:03:42 +0000 (13:03 +0200)
committerGerrit Code Review <gerrit@opendaylight.org>
Tue, 28 Jul 2015 09:25:26 +0000 (09:25 +0000)
Codecs and RibSupportContext should be separate
concepts.

Change-Id: I953c36526775105bbee12d3530984a5ee1d9925c
Signed-off-by: Dana Kutenicsova <dkutenic@cisco.com>
bgp/rib-impl/src/main/java/org/opendaylight/protocol/bgp/rib/impl/Codecs.java [new file with mode: 0644]
bgp/rib-impl/src/main/java/org/opendaylight/protocol/bgp/rib/impl/CodecsRegistryImpl.java [new file with mode: 0644]
bgp/rib-impl/src/main/java/org/opendaylight/protocol/bgp/rib/impl/spi/CodecsRegistry.java [new file with mode: 0644]

diff --git a/bgp/rib-impl/src/main/java/org/opendaylight/protocol/bgp/rib/impl/Codecs.java b/bgp/rib-impl/src/main/java/org/opendaylight/protocol/bgp/rib/impl/Codecs.java
new file mode 100644 (file)
index 0000000..298e267
--- /dev/null
@@ -0,0 +1,137 @@
+/*
+ * Copyright (c) 2015 Cisco Systems, Inc. and others.  All rights reserved.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v1.0 which accompanies this distribution,
+ * and is available at http://www.eclipse.org/legal/epl-v10.html
+ */
+package org.opendaylight.protocol.bgp.rib.impl;
+
+import com.google.common.base.Preconditions;
+import com.google.common.collect.ImmutableSet;
+import com.google.common.collect.ImmutableSet.Builder;
+import java.util.Set;
+import org.opendaylight.protocol.bgp.rib.spi.RIBSupport;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.ClusterId;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.OriginatorId;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.Update;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.Attributes;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.AttributesBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.attributes.Aggregator;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.attributes.AsPath;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.attributes.Communities;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.attributes.ExtendedCommunities;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.attributes.LocalPref;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.attributes.MultiExitDisc;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.attributes.Origin;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.attributes.UnrecognizedAttributes;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.Attributes1;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.Attributes2;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.attributes.MpReachNlri;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.attributes.MpUnreachNlri;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.BgpRib;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.Route;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.bgp.rib.Rib;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.bgp.rib.rib.LocRib;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.Tables;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.tables.Routes;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.BgpAggregator;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.Community;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.ExtendedCommunity;
+import org.opendaylight.yangtools.binding.data.codec.api.BindingCodecTree;
+import org.opendaylight.yangtools.binding.data.codec.api.BindingCodecTreeNode;
+import org.opendaylight.yangtools.binding.data.codec.api.BindingNormalizedNodeCachingCodec;
+import org.opendaylight.yangtools.yang.binding.DataObject;
+import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
+import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
+import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
+
+public final class Codecs {
+
+    private static final Set<Class<? extends DataObject>> ATTRIBUTE_CACHEABLES;
+    private static final InstanceIdentifier<Tables> TABLE_BASE_II = InstanceIdentifier.builder(BgpRib.class)
+            .child(Rib.class)
+            .child(LocRib.class)
+            .child(Tables.class)
+            .build();
+    private static final InstanceIdentifier<MpReachNlri> MP_REACH_NLRI_II = InstanceIdentifier.create(Update.class)
+                .child(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.Attributes.class)
+                .augmentation(Attributes1.class)
+                .child(MpReachNlri.class);
+    private static final InstanceIdentifier<MpUnreachNlri> MP_UNREACH_NLRI_II = InstanceIdentifier.create(Update.class)
+            .child(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.Attributes.class)
+            .augmentation(Attributes2.class)
+            .child(MpUnreachNlri.class);
+
+    static {
+        final Builder<Class<? extends DataObject>> acb = ImmutableSet.builder();
+        acb.add(Aggregator.class);
+        acb.add(BgpAggregator.class);
+        acb.add(AsPath.class);
+        acb.add(ClusterId.class);
+        acb.add(Community.class);
+        acb.add(Communities.class);
+        acb.add(ExtendedCommunity.class);
+        acb.add(ExtendedCommunities.class);
+        acb.add(LocalPref.class);
+        acb.add(MultiExitDisc.class);
+        acb.add(Origin.class);
+        acb.add(OriginatorId.class);
+        acb.add(UnrecognizedAttributes.class);
+        ATTRIBUTE_CACHEABLES = acb.build();
+    }
+
+    private final ImmutableSet<Class<? extends DataObject>> cacheableAttributes;
+    private BindingNormalizedNodeCachingCodec<Attributes> attributesCodec;
+    private BindingNormalizedNodeCachingCodec<MpReachNlri> reachNlriCodec;
+    private BindingNormalizedNodeCachingCodec<MpUnreachNlri> unreachNlriCodec;
+
+    private final RIBSupport ribSupport;
+
+    public Codecs(final RIBSupport ribSupport) {
+        this.ribSupport = Preconditions.checkNotNull(ribSupport);
+        final Builder<Class<? extends DataObject>> acb = ImmutableSet.builder();
+        acb.addAll(ATTRIBUTE_CACHEABLES);
+        acb.addAll(this.ribSupport.cacheableAttributeObjects());
+        this.cacheableAttributes = acb.build();
+    }
+
+    @SuppressWarnings("unchecked")
+    void onCodecTreeUpdated(final BindingCodecTree tree) {
+
+        @SuppressWarnings("rawtypes")
+        final BindingCodecTreeNode tableCodecContext = tree.getSubtreeCodec(TABLE_BASE_II);
+        final BindingCodecTreeNode<? extends Route> routeListCodec = tableCodecContext
+            .streamChild(Routes.class)
+            .streamChild(this.ribSupport.routesCaseClass())
+            .streamChild(this.ribSupport.routesContainerClass())
+            .streamChild(this.ribSupport.routesListClass());
+
+        this.attributesCodec = routeListCodec.streamChild(Attributes.class).createCachingCodec(this.cacheableAttributes);
+        this.reachNlriCodec = tree.getSubtreeCodec(MP_REACH_NLRI_II).createCachingCodec(this.ribSupport.cacheableNlriObjects());
+        this.unreachNlriCodec = tree.getSubtreeCodec(MP_UNREACH_NLRI_II).createCachingCodec(this.ribSupport.cacheableNlriObjects());
+    }
+
+    ContainerNode serializeUnreachNlri(final MpUnreachNlri nlri) {
+        Preconditions.checkState(this.unreachNlriCodec != null, "MpReachNlri codec not available");
+        return (ContainerNode) this.unreachNlriCodec.serialize(nlri);
+    }
+
+    ContainerNode serializeReachNlri(final MpReachNlri nlri) {
+        Preconditions.checkState(this.reachNlriCodec != null, "MpReachNlri codec not available");
+        return (ContainerNode) this.reachNlriCodec.serialize(nlri);
+    }
+
+    Attributes deserializeAttributes(final NormalizedNode<?,?> attributes) {
+        Preconditions.checkState(this.attributesCodec != null, "Attributes codec not available");
+        return this.attributesCodec.deserialize(attributes);
+    }
+
+    ContainerNode serializeAttributes(final Attributes pathAttr) {
+        Preconditions.checkState(this.attributesCodec != null, "Attributes codec not available");
+        final AttributesBuilder a = new AttributesBuilder(pathAttr);
+        a.addAugmentation(Attributes1.class, null);
+        a.addAugmentation(Attributes2.class, null);
+        return (ContainerNode) this.attributesCodec.serialize(a.build());
+    }
+}
diff --git a/bgp/rib-impl/src/main/java/org/opendaylight/protocol/bgp/rib/impl/CodecsRegistryImpl.java b/bgp/rib-impl/src/main/java/org/opendaylight/protocol/bgp/rib/impl/CodecsRegistryImpl.java
new file mode 100644 (file)
index 0000000..189bf01
--- /dev/null
@@ -0,0 +1,75 @@
+/*
+ * Copyright (c) 2015 Cisco Systems, Inc. and others.  All rights reserved.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v1.0 which accompanies this distribution,
+ * and is available at http://www.eclipse.org/legal/epl-v10.html
+ */
+package org.opendaylight.protocol.bgp.rib.impl;
+
+import com.google.common.base.Preconditions;
+import com.google.common.cache.CacheBuilder;
+import com.google.common.cache.CacheLoader;
+import com.google.common.cache.LoadingCache;
+import org.opendaylight.protocol.bgp.rib.impl.spi.CodecsRegistry;
+import org.opendaylight.protocol.bgp.rib.spi.RIBSupport;
+import org.opendaylight.yangtools.binding.data.codec.api.BindingCodecTree;
+import org.opendaylight.yangtools.binding.data.codec.api.BindingCodecTreeFactory;
+import org.opendaylight.yangtools.sal.binding.generator.impl.GeneratedClassLoadingStrategy;
+import org.opendaylight.yangtools.sal.binding.generator.util.BindingRuntimeContext;
+import org.opendaylight.yangtools.yang.model.api.SchemaContext;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+final class CodecsRegistryImpl implements CodecsRegistry {
+
+    private static final Logger LOG = LoggerFactory.getLogger(CodecsRegistryImpl.class);
+
+    private final LoadingCache<RIBSupport, Codecs> contexts = CacheBuilder.newBuilder()
+        .build(new CacheLoader<RIBSupport, Codecs>(){
+
+            @Override
+            public Codecs load(final RIBSupport key) {
+                return createContext(key);
+            }
+        });
+    private final BindingCodecTreeFactory codecFactory;
+    private final GeneratedClassLoadingStrategy classContext;
+    private volatile BindingCodecTree latestCodecTree;
+
+    private CodecsRegistryImpl(final BindingCodecTreeFactory codecFactory, final GeneratedClassLoadingStrategy strategy) {
+        this.codecFactory = Preconditions.checkNotNull(codecFactory);
+        this.classContext = Preconditions.checkNotNull(strategy);
+    }
+
+    static CodecsRegistryImpl create(final BindingCodecTreeFactory codecFactory, final GeneratedClassLoadingStrategy classStrategy) {
+        return new CodecsRegistryImpl(codecFactory, classStrategy);
+    }
+
+    private Codecs createContext(final RIBSupport ribSupport) {
+        final Codecs codecs = new Codecs(ribSupport);
+        if (this.latestCodecTree != null) {
+            // FIXME: Do we need to recalculate latestCodecTree? E.g. new rib support was added
+            // after bgp was started.
+            codecs.onCodecTreeUpdated(this.latestCodecTree);
+        }
+        return codecs;
+    }
+
+    void onSchemaContextUpdated(final SchemaContext context) {
+        final BindingRuntimeContext runtimeContext = BindingRuntimeContext.create(this.classContext, context);
+        this.latestCodecTree  = this.codecFactory.create(runtimeContext);
+        for (final Codecs codecs : this.contexts.asMap().values()) {
+            try {
+                codecs.onCodecTreeUpdated(this.latestCodecTree);
+            } catch (final Exception e) {
+                LOG.error("Codec creation threw {}", e.getMessage(), e);
+            }
+        }
+    }
+
+    @Override
+    public Codecs getCodecs(final RIBSupport ribSupport) {
+        return this.contexts.getUnchecked(ribSupport);
+    }
+}
diff --git a/bgp/rib-impl/src/main/java/org/opendaylight/protocol/bgp/rib/impl/spi/CodecsRegistry.java b/bgp/rib-impl/src/main/java/org/opendaylight/protocol/bgp/rib/impl/spi/CodecsRegistry.java
new file mode 100644 (file)
index 0000000..e86379f
--- /dev/null
@@ -0,0 +1,26 @@
+/*
+ * Copyright (c) 2015 Cisco Systems, Inc. and others.  All rights reserved.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v1.0 which accompanies this distribution,
+ * and is available at http://www.eclipse.org/legal/epl-v10.html
+ */
+package org.opendaylight.protocol.bgp.rib.impl.spi;
+
+import org.opendaylight.protocol.bgp.rib.impl.Codecs;
+import org.opendaylight.protocol.bgp.rib.spi.RIBSupport;
+
+/**
+ * Registry for Codec classes
+ *
+ */
+public interface CodecsRegistry {
+
+    /**
+     * Return the Codecs class registered for given RIBSupport.
+     *
+     * @param ribSupport associated with Codecs class
+     * @return Codecs
+     */
+    Codecs getCodecs(final RIBSupport ribSupport);
+}