Migrate AbstractRegistration/AutoCloseable

[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 bd186afb6d5fb9cc0e23899aa8b2a3dbf0ded9da..f6b57bc67a007700c0f5e766ddda7b6e4817688d 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,29 +7,68 @@
  */
 package org.opendaylight.protocol.bgp.parser.spi;
 
-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;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.SubsequentAddressFamily;
+import org.opendaylight.protocol.bgp.parser.spi.extended.community.ExtendedCommunityParser;
+import org.opendaylight.protocol.bgp.parser.spi.extended.community.ExtendedCommunitySerializer;
+import org.opendaylight.protocol.util.ReferenceCache;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.open.message.BgpParameters;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.path.attributes.attributes.bgp.prefix.sid.bgp.prefix.sid.tlvs.BgpPrefixSidTlv;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.AddressFamily;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.SubsequentAddressFamily;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.extended.community.ExtendedCommunity;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.next.hop.CNextHop;
+import org.opendaylight.yangtools.concepts.Registration;
 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 {
-       AutoCloseable registerAddressFamily(Class<? extends AddressFamily> clazz, int number);
-       AutoCloseable registerSubsequentAddressFamily(Class<? extends SubsequentAddressFamily> clazz, int number);
+    Registration registerAddressFamily(Class<? extends AddressFamily> clazz, int number);
+
+    Registration registerSubsequentAddressFamily(Class<? extends SubsequentAddressFamily> clazz, int number);
+
+    Registration registerAttributeParser(int attributeType, AttributeParser parser);
+
+    Registration registerAttributeSerializer(Class<? extends DataObject> attributeClass,
+            AttributeSerializer serializer);
+
+    Registration registerCapabilityParser(int capabilityType, CapabilityParser parser);
+
+    Registration registerCapabilitySerializer(Class<? extends DataObject> capabilityClass,
+            CapabilitySerializer serializer);
+
+    Registration registerMessageParser(int messageType, MessageParser parser);
+
+    Registration registerMessageSerializer(Class<? extends Notification> messageClass, MessageSerializer serializer);
+
+    Registration registerBgpPrefixSidTlvParser(int tlvType, BgpPrefixSidTlvParser parser);
+
+    Registration registerBgpPrefixSidTlvSerializer(Class<? extends BgpPrefixSidTlv> tlvClass,
+            BgpPrefixSidTlvSerializer serializer);
+
+    Registration registerNlriParser(Class<? extends AddressFamily> afi, Class<? extends SubsequentAddressFamily> safi,
+        NlriParser parser, NextHopParserSerializer nextHopHandler, Class<? extends CNextHop> cnextHopClass,
+        Class<? extends CNextHop>... cnextHopClassList);
+
+    Registration registerNlriSerializer(Class<? extends DataObject> nlriClass, NlriSerializer serializer);
 
-       AutoCloseable registerAttributeParser(int attributeType, AttributeParser parser);
-       AutoCloseable registerAttributeSerializer(Class<? extends DataObject> attributeClass, AttributeSerializer serializer);
+    Registration registerParameterParser(int parameterType, ParameterParser parser);
 
-       AutoCloseable registerCapabilityParser(int capabilityType, CapabilityParser parser);
-       AutoCloseable registerCapabilitySerializer(Class<? extends CParameters> capabilityClass, CapabilitySerializer serializer);
+    Registration registerParameterSerializer(Class<? extends BgpParameters> paramClass,
+            ParameterSerializer serializer);
 
-       AutoCloseable registerMessageParser(int messageType, MessageParser parser);
-       AutoCloseable registerMessageSerializer(Class<? extends Notification> messageClass, MessageSerializer serializer);
+    Registration registerExtendedCommunitySerializer(Class<? extends ExtendedCommunity> extendedCommunityClass,
+        ExtendedCommunitySerializer serializer);
 
-       AutoCloseable registerNlriParser(Class<? extends AddressFamily> afi, Class<? extends SubsequentAddressFamily> safi, NlriParser parser);
-       AutoCloseable registerNlriSerializer(Class<? extends DataObject> nlriClass, NlriSerializer serializer);
+    Registration registerExtendedCommunityParser(int type, int subtype, ExtendedCommunityParser parser);
 
-       AutoCloseable registerParameterParser(int parameterType, ParameterParser parser);
-       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();
 }