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.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.spi.ExportPolicyPeerTracker;
  19 import org.opendaylight.protocol.bgp.rib.spi.RIBExtensionConsumerContext;
  20 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber;
  21 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.BgpTableType;
  22 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.TablesKey;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.BgpId;
  24 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  25
  26 /**
  27  * Internal reference to a RIB instance.
  28  */
  29 public interface RIB extends RibReference, ClusterSingletonServiceProvider {
  30     AsNumber getLocalAs();
  31
  32     BgpId getBgpIdentifier();
  33
  34     /**
  35      * Return the set of table identifiers which are accepted and advertised
  36      * by this RIB instance.
  37      *
  38      * @return A set of identifiers.
  39      */
  40     @Nonnull
  41     Set<? extends BgpTableType> getLocalTables();
  42
  43     BGPDispatcher getDispatcher();
  44
  45     /**
  46      * Allocate a new transaction chain for use with a peer.
  47      *
  48      * @param listener {@link TransactionChainListener} handling recovery
  49      * @return A new transaction chain.
  50      */
  51     DOMTransactionChain createPeerChain(TransactionChainListener listener);
  52
  53     /**
  54      * Return the RIB extensions available to the RIB instance.
  55      *
  56      * @return RIB extensions handle.
  57      */
  58     RIBExtensionConsumerContext getRibExtensions();
  59
  60     /**
  61      * Return the RIB extensions available to the RIB instance
  62      * with additional RIB specific context such as
  63      * translation between DOM and Binding.
  64      *
  65      * @return RIB extensions handle.
  66      */
  67     RIBSupportContextRegistry getRibSupportContext();
  68
  69     /**
  70      * Return YangInstanceIdentifier of BGP Rib with its RibId.
  71      *
  72      * @return YangInstanceIdentifier
  73      */
  74     YangInstanceIdentifier getYangRibId();
  75
  76     CodecsRegistry getCodecsRegistry();
  77
  78     /**
  79      * Return instance of DOMDataTreeChangeService, where consumer can register to
  80      * listen on DOM data changes.
  81      *
  82      * @return DOMDataTreeChangeService
  83      */
  84     DOMDataTreeChangeService getService();
  85
  86     ImportPolicyPeerTracker getImportPolicyPeerTracker();
  87
  88     /**
  89      * Returns ExportPolicyPeerTracker for specific tableKey, where peer can register himself
  90      * as supporting the table. Same export policy can be used to check which peers support respective
  91      * table and announce then routes if required.
  92      *
  93      * @param tablesKey supported table
  94      * @return ExportPolicyPeerTracker
  95      */
  96     ExportPolicyPeerTracker getExportPolicyPeerTracker(TablesKey tablesKey);
  97
  98     Set<TablesKey> getLocalTablesKeys();
  99
 100     /**
 101      * Return common ServiceGroupIdentifier to be used between same group cluster service
 102      *
 103      * @return ServiceGroupIdentifier
 104      */
 105     ServiceGroupIdentifier getRibIServiceGroupIdentifier();
 106 }