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 org.eclipse.jdt.annotation.NonNull;
  11 import org.opendaylight.protocol.bgp.rib.spi.BGPPeerTracker;
  12 import org.opendaylight.protocol.bgp.rib.spi.RIBSupport;
  13 import org.opendaylight.protocol.bgp.rib.spi.policy.BGPRibRoutingPolicy;
  14 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.types.rev151009.AfiSafiType;
  15 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.Route;
  16 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.Tables;
  17 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.TablesKey;
  18 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.tables.Routes;
  19 import org.opendaylight.yangtools.yang.binding.ChildOf;
  20 import org.opendaylight.yangtools.yang.binding.ChoiceIn;
  21 import org.opendaylight.yangtools.yang.binding.DataObject;
  22 import org.opendaylight.yangtools.yang.binding.Identifiable;
  23 import org.opendaylight.yangtools.yang.binding.Identifier;
  24 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
  25
  26 /**
  27  * Container wrapper for all dependencies related to Route Entry, required for process and storage.
  28  */
  29 public interface RouteEntryDependenciesContainer {
  30     /**
  31      * Returns rib support.
  32      *
  33      * @return RIBSupport
  34      */
  35     <C extends Routes & DataObject & ChoiceIn<Tables>, S extends ChildOf<? super C>,
  36             R extends Route & ChildOf<? super S> & Identifiable<I>,
  37             I extends Identifier<R>> @NonNull RIBSupport<C, S, R, I> getRIBSupport();
  38
  39     /**
  40      * Returns the table key(AFI/SAFI) corresponding to the Route Entry.
  41      *
  42      * @return TablesKey
  43      */
  44     @NonNull TablesKey getLocalTablesKey();
  45
  46     /**
  47      * Returns the AfiSafiType(AFI/SAFI) corresponding to the Route Entry.
  48      *
  49      * @return TablesKey
  50      */
  51     @NonNull Class<? extends AfiSafiType> getAfiSafType();
  52
  53     /**
  54      * Returns the loc-rib table to be updated and to which  corresponds this Route Entry.
  55      *
  56      * @return InstanceIdentifier containing the path to loc-rib table.
  57      */
  58     @NonNull KeyedInstanceIdentifier<Tables, TablesKey> getLocRibTableTarget();
  59
  60     /**
  61      * Return routing policies defined per RIB.
  62      *
  63      * @return BGPRibRoutingPolicy
  64      */
  65     @NonNull BGPRibRoutingPolicy getRoutingPolicies();
  66
  67     @NonNull BGPPeerTracker getPeerTracker();
  68 }