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
  13 import org.opendaylight.protocol.util.ReferenceCache;
  14 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.open.message.BgpParameters;
  15 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.AddressFamily;
  16 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.SubsequentAddressFamily;
  17 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.extended.community.ExtendedCommunity;
  18 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.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, AttributeSerializer serializer);
  35
  36     AutoCloseable registerCapabilityParser(int capabilityType, CapabilityParser parser);
  37
  38     AutoCloseable registerCapabilitySerializer(Class<? extends DataObject> capabilityClass, CapabilitySerializer serializer);
  39
  40     AutoCloseable registerMessageParser(int messageType, MessageParser parser);
  41
  42     AutoCloseable registerMessageSerializer(Class<? extends Notification> messageClass, MessageSerializer serializer);
  43
  44     /**
  45      * Each extension requires a specific NextHop handler. Therefore this method has been deprecated  for
  46      * the method which enforce user to register it.
  47      */
  48     @Deprecated
  49     AutoCloseable registerNlriParser(Class<? extends AddressFamily> afi, Class<? extends SubsequentAddressFamily> safi, NlriParser parser);
  50
  51     AutoCloseable registerNlriParser(Class<? extends AddressFamily> afi, Class<? extends SubsequentAddressFamily>
  52         safi, NlriParser parser, final NextHopParserSerializer nextHopHandler, final Class<? extends CNextHop> cNextHopClass,
  53                                      final 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, ParameterSerializer serializer);
  60
  61     AutoCloseable registerExtendedCommunitySerializer(final Class<? extends ExtendedCommunity> extendedCommunityClass,
  62             final ExtendedCommunitySerializer serializer);
  63
  64     AutoCloseable registerExtendedCommunityParser(final int type, final int subtype, final ExtendedCommunityParser parser);
  65
  66     /**
  67      * Get the context-wide cache for a particular object type.
  68      *
  69      * @return An object cache instance.
  70      */
  71     ReferenceCache getReferenceCache();
  72 }