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.mdsal.singleton.common.api.ClusterSingletonServiceProvider;
16 import org.opendaylight.mdsal.singleton.common.api.ServiceGroupIdentifier;
17 import org.opendaylight.protocol.bgp.rib.RibReference;
18 import org.opendaylight.protocol.bgp.rib.impl.stats.rib.impl.BGPRenderStats;
19 import org.opendaylight.protocol.bgp.rib.spi.ExportPolicyPeerTracker;
20 import org.opendaylight.protocol.bgp.rib.spi.RIBExtensionConsumerContext;
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.rev130919.BgpTableType;
23 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.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 RibReference, ClusterSingletonServiceProvider {
31 AsNumber getLocalAs();
33 BgpId getBgpIdentifier();
36 * Return the set of table identifiers which are accepted and advertised
37 * by this RIB instance.
39 * @return A set of identifiers.
41 @Nonnull Set<? extends BgpTableType> getLocalTables();
43 BGPDispatcher getDispatcher();
46 * Allocate a new transaction chain for use with a peer.
48 * @param listener {@link TransactionChainListener} handling recovery
49 * @return A new transaction chain.
51 DOMTransactionChain createPeerChain(TransactionChainListener listener);
54 * Return the RIB extensions available to the RIB instance.
56 * @return RIB extensions handle.
58 RIBExtensionConsumerContext getRibExtensions();
61 * Return the RIB extensions available to the RIB instance
62 * with additional RIB specific context such as
63 * translation between DOM and Binding.
65 * @return RIB extensions handle.
67 RIBSupportContextRegistry getRibSupportContext();
70 * Return YangInstanceIdentifier of BGP Rib with its RibId.
72 * @return YangInstanceIdentifier
74 YangInstanceIdentifier getYangRibId();
76 CodecsRegistry getCodecsRegistry();
79 * Return instance of DOMDataTreeChangeService, where consumer can register to
80 * listen on DOM data changes.
81 * @return DOMDataTreeChangeService
83 DOMDataTreeChangeService getService();
85 BGPRenderStats getRenderStats();
87 ImportPolicyPeerTracker getImportPolicyPeerTracker();
90 * Returns ExportPolicyPeerTracker for specific tableKey, where peer can register himself
91 * as supporting the table. Same export policy can be used to check which peers support respective
92 * table and announce then routes if required.
93 * @param tablesKey supported table
94 * @return ExportPolicyPeerTracker
96 ExportPolicyPeerTracker getExportPolicyPeerTracker(TablesKey tablesKey);
98 Set<TablesKey> getLocalTablesKeys();
101 * Return common ServiceGroupIdentifier to be used between same group cluster service
102 * @return ServiceGroupIdentifier
104 ServiceGroupIdentifier getRibIServiceGroupIdentifier();