bgp/rib-impl/src/main/java/org/opendaylight/protocol/bgp/rib/impl/spi/RIB.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.rib.impl.spi;
   9
  10 import java.util.Set;
  11 import javax.annotation.Nonnull;
  12 import org.opendaylight.controller.md.sal.binding.api.BindingTransactionChain;
  13 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  14 import org.opendaylight.controller.md.sal.common.api.data.TransactionChainListener;
  15 import org.opendaylight.controller.md.sal.dom.api.DOMDataTreeChangeService;
  16 import org.opendaylight.controller.md.sal.dom.api.DOMTransactionChain;
  17 import org.opendaylight.protocol.bgp.rib.RibReference;
  18 import org.opendaylight.protocol.bgp.rib.spi.BGPPeerTracker;
  19 import org.opendaylight.protocol.bgp.rib.spi.RIBExtensionConsumerContext;
  20 import org.opendaylight.protocol.bgp.rib.spi.policy.BGPRibRoutingPolicy;
  21 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber;
  22 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev171207.BgpTableType;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.TablesKey;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.BgpId;
  25 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  26
  27 /**
  28  * Internal reference to a RIB instance.
  29  */
  30 public interface RIB extends RibReference {
  31     /**
  32      * RIB AS.
  33      *
  34      * @return AS
  35      */
  36     AsNumber getLocalAs();
  37
  38     BgpId getBgpIdentifier();
  39
  40     /**
  41      * Return the set of table identifiers which are accepted and advertised
  42      * by this RIB instance.
  43      *
  44      * @return A set of identifiers.
  45      */
  46     @Nonnull
  47     Set<? extends BgpTableType> getLocalTables();
  48
  49     BGPDispatcher getDispatcher();
  50
  51     /**
  52      * Allocate a new transaction chain for use with a peer.
  53      *
  54      * @param listener {@link TransactionChainListener} handling recovery
  55      * @return A new transaction chain.
  56      */
  57     DOMTransactionChain createPeerDOMChain(TransactionChainListener listener);
  58
  59     /**
  60      * Allocate a new transaction chain for use with a peer.
  61      *
  62      * @param listener {@link TransactionChainListener} handling recovery
  63      * @return A new transaction chain.
  64      */
  65     BindingTransactionChain createPeerChain(TransactionChainListener listener);
  66
  67     /**
  68      * Return the RIB extensions available to the RIB instance.
  69      *
  70      * @return RIB extensions handle.
  71      */
  72     RIBExtensionConsumerContext getRibExtensions();
  73
  74     /**
  75      * Return the RIB extensions available to the RIB instance
  76      * with additional RIB specific context such as
  77      * translation between DOM and Binding.
  78      *
  79      * @return RIB extensions handle.
  80      */
  81     RIBSupportContextRegistry getRibSupportContext();
  82
  83     /**
  84      * Return YangInstanceIdentifier of BGP Rib with its RibId.
  85      *
  86      * @return YangInstanceIdentifier
  87      */
  88     YangInstanceIdentifier getYangRibId();
  89
  90     CodecsRegistry getCodecsRegistry();
  91
  92     /**
  93      * Return instance of DOMDataTreeChangeService, where consumer can register to
  94      * listen on DOM data changes.
  95      *
  96      * @return DOMDataTreeChangeService
  97      */
  98     DOMDataTreeChangeService getService();
  99
 100     /**
 101      * Return DataBroker.
 102      *
 103      * @return DataBroker
 104      */
 105     DataBroker getDataBroker();
 106
 107     /**
 108      * Returns true if RIB supports table.
 109      *
 110      * @param tableKey table
 111      * @return true if supported
 112      */
 113     boolean supportsTable(TablesKey tableKey);
 114
 115     Set<TablesKey> getLocalTablesKeys();
 116
 117     /**
 118      * Return Policies Container.
 119      *
 120      * @return policies
 121      */
 122     BGPRibRoutingPolicy getRibPolicies();
 123
 124     /**
 125      * Returns peer tracker for the rib.
 126      *
 127      * @return peer tracker
 128      */
 129     BGPPeerTracker getPeerTracker();
 130 }