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.util.ReferenceCache;
  11 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.open.BgpParameters;
  12 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.open.bgp.parameters.optional.capabilities.CParameters;
  13 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.AddressFamily;
  14 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.SubsequentAddressFamily;
  15 import org.opendaylight.yangtools.yang.binding.DataObject;
  16 import org.opendaylight.yangtools.yang.binding.Notification;
  17
  18 /**
  19  * Context for registering providers of the various types of extension points BGP provides. These are then consumed by
  20  * extension consumers. It also provides access to the context-wide object cache, which extension providers can use to
  21  * increase the in-memory efficiency when the same objects are created over and over again.
  22  */
  23 public interface BGPExtensionProviderContext extends BGPExtensionConsumerContext {
  24     AutoCloseable registerAddressFamily(Class<? extends AddressFamily> clazz, int number);
  25
  26     AutoCloseable registerSubsequentAddressFamily(Class<? extends SubsequentAddressFamily> clazz, int number);
  27
  28     AutoCloseable registerAttributeParser(int attributeType, AttributeParser parser);
  29
  30     AutoCloseable registerAttributeSerializer(Class<? extends DataObject> attributeClass, AttributeSerializer serializer);
  31
  32     AutoCloseable registerCapabilityParser(int capabilityType, CapabilityParser parser);
  33
  34     AutoCloseable registerCapabilitySerializer(Class<? extends CParameters> capabilityClass, CapabilitySerializer serializer);
  35
  36     AutoCloseable registerMessageParser(int messageType, MessageParser parser);
  37
  38     AutoCloseable registerMessageSerializer(Class<? extends Notification> messageClass, MessageSerializer serializer);
  39
  40     AutoCloseable registerNlriParser(Class<? extends AddressFamily> afi, Class<? extends SubsequentAddressFamily> safi, NlriParser parser);
  41
  42     AutoCloseable registerNlriSerializer(Class<? extends DataObject> nlriClass, NlriSerializer serializer);
  43
  44     AutoCloseable registerParameterParser(int parameterType, ParameterParser parser);
  45
  46     AutoCloseable registerParameterSerializer(Class<? extends BgpParameters> paramClass, ParameterSerializer serializer);
  47
  48     /**
  49      * Get the context-wide cache for a particular object type.
  50      *
  51      * @return An object cache instance.
  52      */
  53     ReferenceCache getReferenceCache();
  54 }