bgp/rib-spi/src/main/java/org/opendaylight/protocol/bgp/rib/spi/policy/BGPRouteEntryExportParameters.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.policy;
   9
  10 import javax.annotation.Nonnull;
  11 import javax.annotation.Nullable;
  12 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber;
  13 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.PeerId;
  14 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.PeerRole;
  15
  16 /**
  17  * Contains Peer destiny information for export route entry.
  18  */
  19 public interface BGPRouteEntryExportParameters extends RouteTargetMembershipConsumer,
  20         BGPRouteEntryImportParameters, RTCCache {
  21
  22     /**
  23      * Peer id of Peer route entry destiny.
  24      *
  25      * @return peer Id of announcer Peer
  26      */
  27     @Nonnull
  28     PeerId getToPeerId();
  29
  30     /**
  31      * Peer id of Peer route entry destiny.
  32      *
  33      * @return peer Role of announcer Peer
  34      */
  35     @Nonnull
  36     PeerRole getToPeerRole();
  37
  38     /**
  39      * Peer local AS of Peer route entry destiny.
  40      *
  41      * @return peer Local AS of destiny Peer
  42      */
  43     @Nullable
  44     AsNumber getToPeerLocalAs();
  45
  46     /**
  47      * Destination Route Key.
  48      *
  49      * @return routeKey
  50      */
  51     String getRouteKey();
  52 }