422adb061049f2af2bb746f8959154143685159a
[bgpcep.git] / 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.opendaylight.params.xml.ns.yang.bgp.rib.rev171207.PeerId;
13 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev171207.PeerRole;
14 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.ClusterIdentifier;
15
16 /**
17  * Contains Peer destiny information for import route entry.
18  */
19 public interface BGPRouteEntryImportParameters {
20     /**
21      * Peer id of Peer route entry announcer.
22      *
23      * @return peer Role of announcer Peer
24      */
25     @Nonnull
26     PeerRole getFromPeerRole();
27
28     /**
29      * Peer id of Peer route entry announcer.
30      *
31      * @return peer Id of announcer Peer
32      */
33     @Nonnull
34     PeerId getFromPeerId();
35
36     /**
37      * Peer id of Peer route entry announcer.
38      *
39      * @return peer Id of announcer Peer
40      */
41     @Nullable
42     ClusterIdentifier getFromClusterId();
43 }