bgp/rib-spi/src/main/java/org/opendaylight/protocol/bgp/rib/spi/entry/RouteEntryDependenciesContainer.java

   1 /*
   2  * Copyright (c) 2018 AT&T Intellectual Property. 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.spi.entry;
   9
  10 import javax.annotation.Nonnull;
  11 import org.opendaylight.protocol.bgp.rib.spi.ExportPolicyPeerTracker;
  12 import org.opendaylight.protocol.bgp.rib.spi.RIBSupport;
  13 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev171207.rib.TablesKey;
  14 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  15
  16 /**
  17  * Container wrapper for all dependencies related to Route Entry, required for process and storage.
  18  */
  19 public interface RouteEntryDependenciesContainer {
  20     /**
  21      * Returns rib support.
  22      *
  23      * @return RIBSupport
  24      */
  25     @Nonnull
  26     RIBSupport getRibSupport();
  27
  28
  29     /**
  30      * Returns the table key(AFI/SAFI) corresponding to the Route Entry.
  31      *
  32      * @return TablesKey
  33      */
  34     @Nonnull
  35     TablesKey getLocalTablesKey();
  36
  37
  38     /**
  39      * Returns the loc-rib table to be updated and to which  corresponds this Route Entry.
  40      *
  41      * @return YangInstanceIdentifier containing the path to loc-rib table.
  42      */
  43     @Nonnull
  44     YangInstanceIdentifier getLocRibTableTarget();
  45
  46     /**
  47      * Return the ExportPolicyPeerTracker which tracks peers.
  48      *
  49      * @return ExportPolicyPeerTracker
  50      */
  51     @Nonnull
  52     ExportPolicyPeerTracker getExportPolicyPeerTracker();
  53 }