bgp/rib-spi/src/main/java/org/opendaylight/protocol/bgp/rib/spi/policy/BGPRouteEntryImportParameters.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 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.ClusterIdentifier;
  16
  17 /**
  18  * Contains Peer destiny information for import route entry.
  19  */
  20 public interface BGPRouteEntryImportParameters {
  21     /**
  22      * Peer id of Peer route entry announcer.
  23      *
  24      * @return peer Role of announcer Peer
  25      */
  26     @Nonnull
  27     PeerRole getFromPeerRole();
  28
  29     /**
  30      * Peer id of Peer route entry announcer.
  31      *
  32      * @return peer Id of announcer Peer
  33      */
  34     @Nonnull
  35     PeerId getFromPeerId();
  36
  37     /**
  38      * Peer id of Peer route entry announcer.
  39      *
  40      * @return peer Id of announcer Peer
  41      */
  42     @Nullable
  43     ClusterIdentifier getFromClusterId();
  44
  45     /**
  46      * Peer local AS of route entry announcer.
  47      *
  48      * @return peer Local AS
  49      */
  50     @Nullable
  51     AsNumber getFromPeerLocalAs();
  52 }