2 * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.protocol.bgp.rib.impl.spi;
11 import javax.annotation.Nonnull;
12 import org.opendaylight.controller.md.sal.common.api.data.TransactionChainListener;
13 import org.opendaylight.controller.md.sal.dom.api.DOMDataTreeChangeService;
14 import org.opendaylight.controller.md.sal.dom.api.DOMTransactionChain;
15 import org.opendaylight.protocol.bgp.rib.RibReference;
16 import org.opendaylight.protocol.bgp.rib.spi.BGPPeerTracker;
17 import org.opendaylight.protocol.bgp.rib.spi.ExportPolicyPeerTracker;
18 import org.opendaylight.protocol.bgp.rib.spi.RIBExtensionConsumerContext;
19 import org.opendaylight.protocol.bgp.rib.spi.entry.AttributeBindingCodecSerializer;
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.rev171207.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;
28 * Internal reference to a RIB instance.
30 public interface RIB extends AttributeBindingCodecSerializer, RibReference {
36 AsNumber getLocalAs();
38 BgpId getBgpIdentifier();
41 * Return the set of table identifiers which are accepted and advertised
42 * by this RIB instance.
44 * @return A set of identifiers.
47 Set<? extends BgpTableType> getLocalTables();
49 BGPDispatcher getDispatcher();
52 * Allocate a new transaction chain for use with a peer.
54 * @param listener {@link TransactionChainListener} handling recovery
55 * @return A new transaction chain.
57 DOMTransactionChain createPeerChain(TransactionChainListener listener);
60 * Return the RIB extensions available to the RIB instance.
62 * @return RIB extensions handle.
64 RIBExtensionConsumerContext getRibExtensions();
67 * Return the RIB extensions available to the RIB instance
68 * with additional RIB specific context such as
69 * translation between DOM and Binding.
71 * @return RIB extensions handle.
73 RIBSupportContextRegistry getRibSupportContext();
76 * Return YangInstanceIdentifier of BGP Rib with its RibId.
78 * @return YangInstanceIdentifier
80 YangInstanceIdentifier getYangRibId();
82 CodecsRegistry getCodecsRegistry();
85 * Return instance of DOMDataTreeChangeService, where consumer can register to
86 * listen on DOM data changes.
88 * @return DOMDataTreeChangeService
90 DOMDataTreeChangeService getService();
93 * Returns ExportPolicyPeerTracker for specific tableKey, where peer can register himself
94 * as supporting the table. Same export policy can be used to check which peers support respective
95 * table and announce then routes if required.
97 * @param tablesKey supported table
98 * @return ExportPolicyPeerTracker
100 ExportPolicyPeerTracker getExportPolicyPeerTracker(TablesKey tablesKey);
103 * Returns true if RIB supports table.
105 * @param tableKey table
106 * @return true if supported
108 boolean supportsTable(TablesKey tableKey);
110 Set<TablesKey> getLocalTablesKeys();
113 * Return Policies Container.
117 BGPRibRoutingPolicy getRibPolicies();
120 * Returns peer tracker for the rib.
122 * @return peer tracker
124 BGPPeerTracker getPeerTracker();