bgp/parser-spi/src/main/java/org/opendaylight/protocol/bgp/parser/spi/BGPExtensionProviderContext.java

   1 /*
   2  * Copyright (c) 2013 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.parser.spi;
   9
  10 import org.opendaylight.protocol.bgp.parser.spi.extended.community.ExtendedCommunityParser;
  11 import org.opendaylight.protocol.bgp.parser.spi.extended.community.ExtendedCommunitySerializer;
  12 import org.opendaylight.protocol.util.ReferenceCache;
  13 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.open.message.BgpParameters;
  14 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;
  15 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.AddressFamily;
  16 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.SubsequentAddressFamily;
  17 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.extended.community.ExtendedCommunity;
  18 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.next.hop.CNextHop;
  19 import org.opendaylight.yangtools.yang.binding.DataObject;
  20 import org.opendaylight.yangtools.yang.binding.Notification;
  21
  22 /**
  23  * Context for registering providers of the various types of extension points BGP provides. These are then consumed by
  24  * extension consumers. It also provides access to the context-wide object cache, which extension providers can use to
  25  * increase the in-memory efficiency when the same objects are created over and over again.
  26  */
  27 public interface BGPExtensionProviderContext extends BGPExtensionConsumerContext {
  28     AutoCloseable registerAddressFamily(Class<? extends AddressFamily> clazz, int number);
  29
  30     AutoCloseable registerSubsequentAddressFamily(Class<? extends SubsequentAddressFamily> clazz, int number);
  31
  32     AutoCloseable registerAttributeParser(int attributeType, AttributeParser parser);
  33
  34     AutoCloseable registerAttributeSerializer(Class<? extends DataObject> attributeClass,
  35             AttributeSerializer serializer);
  36
  37     AutoCloseable registerCapabilityParser(int capabilityType, CapabilityParser parser);
  38
  39     AutoCloseable registerCapabilitySerializer(Class<? extends DataObject> capabilityClass,
  40             CapabilitySerializer serializer);
  41
  42     AutoCloseable registerMessageParser(int messageType, MessageParser parser);
  43
  44     AutoCloseable registerMessageSerializer(Class<? extends Notification> messageClass, MessageSerializer serializer);
  45
  46     AutoCloseable registerBgpPrefixSidTlvParser(int tlvType, BgpPrefixSidTlvParser parser);
  47
  48     AutoCloseable registerBgpPrefixSidTlvSerializer(Class<? extends BgpPrefixSidTlv> tlvClass,
  49             BgpPrefixSidTlvSerializer serializer);
  50
  51     AutoCloseable registerNlriParser(Class<? extends AddressFamily> afi, Class<? extends SubsequentAddressFamily> safi,
  52         NlriParser parser, NextHopParserSerializer nextHopHandler, Class<? extends CNextHop> cnextHopClass,
  53         Class<? extends CNextHop>... cnextHopClassList);
  54
  55     AutoCloseable registerNlriSerializer(Class<? extends DataObject> nlriClass, NlriSerializer serializer);
  56
  57     AutoCloseable registerParameterParser(int parameterType, ParameterParser parser);
  58
  59     AutoCloseable registerParameterSerializer(Class<? extends BgpParameters> paramClass,
  60             ParameterSerializer serializer);
  61
  62     AutoCloseable registerExtendedCommunitySerializer(Class<? extends ExtendedCommunity> extendedCommunityClass,
  63         ExtendedCommunitySerializer serializer);
  64
  65     AutoCloseable registerExtendedCommunityParser(int type, int subtype, ExtendedCommunityParser parser);
  66
  67     /**
  68      * Get the context-wide cache for a particular object type.
  69      *
  70      * @return An object cache instance.
  71      */
  72     ReferenceCache getReferenceCache();
  73 }