Merge "Bug 611 - NlriReg supports serialization"

[bgpcep.git] / bgp / parser-spi / src / main / java / org / opendaylight / protocol / bgp / parser / spi / BGPExtensionProviderContext.java

diff --git a/bgp/parser-spi/src/main/java/org/opendaylight/protocol/bgp/parser/spi/BGPExtensionProviderContext.java b/bgp/parser-spi/src/main/java/org/opendaylight/protocol/bgp/parser/spi/BGPExtensionProviderContext.java
index 033232e6a4306cd80c4411104f0c0c3c6b702ae8..b132352991173c2c89322079367a7655c31ac9fb 100644 (file)
--- a/bgp/parser-spi/src/main/java/org/opendaylight/protocol/bgp/parser/spi/BGPExtensionProviderContext.java
+++ b/bgp/parser-spi/src/main/java/org/opendaylight/protocol/bgp/parser/spi/BGPExtensionProviderContext.java
@@ -7,6 +7,7 @@
  */
 package org.opendaylight.protocol.bgp.parser.spi;
 
+import org.opendaylight.protocol.util.ReferenceCache;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.open.BgpParameters;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.open.bgp.parameters.CParameters;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.AddressFamily;
@@ -14,22 +15,40 @@ import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.type
 import org.opendaylight.yangtools.yang.binding.DataObject;
 import org.opendaylight.yangtools.yang.binding.Notification;
 
+/**
+ * Context for registering providers of the various types of extension points BGP provides. These are then consumed by
+ * extension consumers. It also provides access to the context-wide object cache, which extension providers can use to
+ * increase the in-memory efficiency when the same objects are created over and over again.
+ */
 public interface BGPExtensionProviderContext extends BGPExtensionConsumerContext {
-       public AutoCloseable registerAddressFamily(Class<? extends AddressFamily> clazz, int number);
-       public AutoCloseable registerSubsequentAddressFamily(Class<? extends SubsequentAddressFamily> clazz, int number);
+    AutoCloseable registerAddressFamily(Class<? extends AddressFamily> clazz, int number);
+
+    AutoCloseable registerSubsequentAddressFamily(Class<? extends SubsequentAddressFamily> clazz, int number);
+
+    AutoCloseable registerAttributeParser(int attributeType, AttributeParser parser);
+
+    AutoCloseable registerAttributeSerializer(Class<? extends DataObject> attributeClass, AttributeSerializer serializer);
+
+    AutoCloseable registerCapabilityParser(int capabilityType, CapabilityParser parser);
+
+    AutoCloseable registerCapabilitySerializer(Class<? extends CParameters> capabilityClass, CapabilitySerializer serializer);
+
+    AutoCloseable registerMessageParser(int messageType, MessageParser parser);
+
+    AutoCloseable registerMessageSerializer(Class<? extends Notification> messageClass, MessageSerializer serializer);
 
-       public AutoCloseable registerAttributeParser(int attributeType, AttributeParser parser);
-       public AutoCloseable registerAttributeSerializer(Class<? extends DataObject> attributeClass, AttributeSerializer serializer);
+    AutoCloseable registerNlriParser(Class<? extends AddressFamily> afi, Class<? extends SubsequentAddressFamily> safi, NlriParser parser);
 
-       public AutoCloseable registerCapabilityParser(int capabilityType, CapabilityParser parser);
-       public AutoCloseable registerCapabilitySerializer(Class<? extends CParameters> capabilityClass, CapabilitySerializer serializer);
+    AutoCloseable registerNlriSerializer(Class<? extends DataObject> nlriClass, NlriSerializer serializer);
 
-       public AutoCloseable registerMessageParser(int messageType, MessageParser parser);
-       public AutoCloseable registerMessageSerializer(Class<? extends Notification> messageClass, MessageSerializer serializer);
+    AutoCloseable registerParameterParser(int parameterType, ParameterParser parser);
 
-       public AutoCloseable registerNlriParser(Class<? extends AddressFamily> afi, Class<? extends SubsequentAddressFamily> safi, NlriParser parser);
-       public AutoCloseable registerNlriSerializer(Class<? extends DataObject> nlriClass, NlriSerializer serializer);
+    AutoCloseable registerParameterSerializer(Class<? extends BgpParameters> paramClass, ParameterSerializer serializer);
 
-       public AutoCloseable registerParameterParser(int parameterType, ParameterParser parser);
-       public AutoCloseable registerParameterSerializer(Class<? extends BgpParameters> paramClass, ParameterSerializer serializer);
+    /**
+     * Get the context-wide cache for a particular object type.
+     *
+     * @return An object cache instance.
+     */
+    ReferenceCache getReferenceCache();
 }