bgp/rib-spi/src/main/java/org/opendaylight/protocol/bgp/rib/spi/entry/RouteEntryInfo.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.Peer;
  12
  13 /**
  14  * RouteEntryInfo wrapper contains all related information from new best path.
  15  */
  16 public interface RouteEntryInfo {
  17     /**
  18      * peer Id where best path will be advertized.
  19      *
  20      * @return PeerId
  21      */
  22     @Nonnull
  23     Peer getToPeer();
  24
  25     /**
  26      * Returns route containing prefix.
  27      *
  28      * @return Route key
  29      */
  30     @Nonnull
  31     String getRouteKey();
  32 }