bgp/openconfig-rp-spi/src/main/java/org/opendaylight/protocol/bgp/openconfig/routing/policy/spi/RouteEntryBaseAttributes.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.openconfig.routing.policy.spi;
   9
  10 import org.eclipse.jdt.annotation.NonNullByDefault;
  11 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone;
  12 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.ClusterIdentifier;
  13
  14 /**
  15  * Contains basic attributes of route entry (AS / originator id / cluster id).
  16  */
  17 @NonNullByDefault
  18 public interface RouteEntryBaseAttributes {
  19     /**
  20      * Returns AS.
  21      *
  22      * @return RIB AS
  23      */
  24     // FIXME: consider using Uint32 here
  25     long getLocalAs();
  26
  27     /**
  28      * Returns originator id.
  29      *
  30      * @return originator Id
  31      */
  32     Ipv4AddressNoZone getOriginatorId();
  33
  34     /**
  35      * Returns cluster identifier.
  36      *
  37      * @return Cluster Identifier
  38      */
  39     ClusterIdentifier getClusterId();
  40 }