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.RIBSupport;
  12 import org.opendaylight.protocol.bgp.rib.spi.policy.BGPRibRoutingPolicy;
  13 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.Tables;
  14 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.TablesKey;
  15 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
  16
  17 /**
  18  * Container wrapper for all dependencies related to Route Entry, required for process and storage.
  19  */
  20 public interface RouteEntryDependenciesContainer {
  21     /**
  22      * Returns rib support.
  23      *
  24      * @return RIBSupport
  25      */
  26     @Nonnull
  27     RIBSupport getRibSupport();
  28
  29
  30     /**
  31      * Returns the table key(AFI/SAFI) corresponding to the Route Entry.
  32      *
  33      * @return TablesKey
  34      */
  35     @Nonnull
  36     TablesKey getLocalTablesKey();
  37
  38
  39     /**
  40      * Returns the loc-rib table to be updated and to which  corresponds this Route Entry.
  41      *
  42      * @return InstanceIdentifier containing the path to loc-rib table.
  43      */
  44     @Nonnull
  45     KeyedInstanceIdentifier<Tables, TablesKey> getLocRibTableTarget();
  46
  47     /**
  48      * Return routing policies defined per RIB.
  49      *
  50      * @return BGPRibRoutingPolicy
  51      */
  52     @Nonnull
  53     BGPRibRoutingPolicy getRoutingPolicies();
  54 }