Package org.opendaylight.protocol.bgp.rib.impl

Class ApplicationPeer

java.lang.Object
org.opendaylight.protocol.bgp.rib.DefaultRibReference
org.opendaylight.protocol.bgp.rib.impl.state.BGPPeerStateImpl
org.opendaylight.protocol.bgp.rib.impl.ApplicationPeer
All Implemented Interfaces:
com.google.common.util.concurrent.FutureCallback<org.opendaylight.yangtools.yang.common.Empty>, org.opendaylight.mdsal.dom.api.DOMDataTreeChangeListener, BGPMessagesListener, PeerTransactionChain, RibReference, Peer, PeerTrackerInformation, BGPRouteEntryImportParameters, RouteTargetMembershipConsumer, BGPAfiSafiState, BGPErrorHandlingState, BGPGracelfulRestartState, BGPLlGracelfulRestartState, BGPPeerMessagesState, BGPPeerState, BGPPeerStateProvider, InstanceReference<Rib>
public class ApplicationPeer extends BGPPeerStateImpl implements org.opendaylight.mdsal.dom.api.DOMDataTreeChangeListener
Application Peer is a special case of BGP peer. It serves as an interface for user to advertise user routes to ODL and through ODL to other BGP peers.

This peer has it's own RIB, where it stores all user routes. This RIB is located in configurational datastore. Routes are added through RESTCONF.

They are then processed as routes from any other peer, through AdjRib, EffectiveRib, LocRib and if they are advertised further, through AdjRibOut.

For purposed of import policies such as Best Path Selection, application peer needs to have a BGP-ID that is configurable.

  • Constructor Details

    • ApplicationPeer

      public ApplicationPeer(BGPTableTypeRegistryConsumer tableTypeRegistry, ApplicationRibId applicationRibId, org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone ipAddress, RIB rib)

  • Method Details

    • instantiateServiceInstance

      public void instantiateServiceInstance(org.opendaylight.mdsal.dom.api.DOMDataBroker.DataTreeChangeExtension dataTreeChangeService, org.opendaylight.mdsal.dom.api.DOMDataTreeIdentifier appPeerDOMId)

    • getMemberships

      public List<RouteTarget> getMemberships()
      Description copied from interface: RouteTargetMembershipConsumer
      Returns list of Route target advertized per Peer.
      Specified by:
      getMemberships in interface RouteTargetMembershipConsumer

    • onInitialData

      public void onInitialData()
      Specified by:
      onInitialData in interface org.opendaylight.mdsal.dom.api.DOMDataTreeChangeListener

    • onDataTreeChanged

      public void onDataTreeChanged(List<org.opendaylight.yangtools.yang.data.tree.api.DataTreeCandidate> changes)
      Routes come from application RIB that is identified by (configurable) name. Each route is pushed into AdjRibsInWriter with it's whole context. In this method, it doesn't matter if the routes are removed or added, this will be determined in LocRib.
      Specified by:
      onDataTreeChanged in interface org.opendaylight.mdsal.dom.api.DOMDataTreeChangeListener

    • close

      public com.google.common.util.concurrent.FluentFuture<? extends org.opendaylight.mdsal.common.api.CommitInfo> close()
      Description copied from interface: Peer
      Close Peers and performs asynchronously DS clean up.
      Specified by:
      close in interface Peer
      Returns:
      future

    • supportsAddPathSupported

      public boolean supportsAddPathSupported(TablesKey tableKey)
      Description copied from interface: PeerTrackerInformation
      Returns if peer supports Additional Path for specific table.
      Specified by:
      supportsAddPathSupported in interface PeerTrackerInformation
      Parameters:
      tableKey - table
      Returns:
      true if Additional Path is supported for defined table

    • getSupportedAddPathTables

      public SendReceive getSupportedAddPathTables(TablesKey tableKey)
      Description copied from interface: PeerTrackerInformation
      Returns AddPath support configuration if supported, otherwise null.
      Specified by:
      getSupportedAddPathTables in interface PeerTrackerInformation
      Parameters:
      tableKey - table
      Returns:
      AddPath support configuration if supported, otherwise null

    • supportsTable

      public boolean supportsTable(TablesKey tableKey)
      Description copied from interface: PeerTrackerInformation
      Returns true if we have advertized support for a table, i.e. any prefix from this table should be subject to export towards the peer.
      Specified by:
      supportsTable in interface PeerTrackerInformation
      Parameters:
      tableKey - table
      Returns:
      true if the table is being advertized to the peer.

    • getRibOutIId

      public org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier getRibOutIId(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates tablekey)
      Description copied from interface: PeerTrackerInformation
      Creates Table Adj Rib Out Instance identifier.
      Specified by:
      getRibOutIId in interface PeerTrackerInformation
      Parameters:
      tablekey - table key
      Returns:
      instance identifier.

    • onFailure

      public void onFailure(Throwable cause)
      Specified by:
      onFailure in interface com.google.common.util.concurrent.FutureCallback<org.opendaylight.yangtools.yang.common.Empty>

    • getBGPSessionState

      public BGPSessionState getBGPSessionState()
      Description copied from interface: BGPPeerState
      BGP Session Operational State.
      Specified by:
      getBGPSessionState in interface BGPPeerState
      Returns:
      BGPSessionState

    • getBGPTimersState

      public BGPTimersState getBGPTimersState()
      Description copied from interface: BGPPeerState
      BGP Operation Timers State.
      Specified by:
      getBGPTimersState in interface BGPPeerState
      Returns:
      BGPTimersState

    • getBGPTransportState

      public BGPTransportState getBGPTransportState()
      Description copied from interface: BGPPeerState
      BGP Operational Transport State.
      Specified by:
      getBGPTransportState in interface BGPPeerState
      Returns:
      BGPTransportState

    • getPeerId

      public final PeerId getPeerId()
      Description copied from interface: PeerTrackerInformation
      Returns Peer id.
      Specified by:
      getPeerId in interface PeerTrackerInformation
      Returns:
      PeerID

    • getRole

      public final PeerRole getRole()
      Description copied from interface: PeerTrackerInformation
      Returns Peer Role.
      Specified by:
      getRole in interface PeerTrackerInformation
      Returns:
      PeerRole

    • getFromPeerRole

      public final PeerRole getFromPeerRole()
      Description copied from interface: BGPRouteEntryImportParameters
      Peer id of Peer route entry announcer.
      Specified by:
      getFromPeerRole in interface BGPRouteEntryImportParameters
      Returns:
      peer Role of announcer Peer

    • getFromPeerId

      public final PeerId getFromPeerId()
      Description copied from interface: BGPRouteEntryImportParameters
      Peer id of Peer route entry announcer.
      Specified by:
      getFromPeerId in interface BGPRouteEntryImportParameters
      Returns:
      peer Id of announcer Peer

    • getFromClusterId

      public final ClusterIdentifier getFromClusterId()
      Description copied from interface: BGPRouteEntryImportParameters
      Peer id of Peer route entry announcer.
      Specified by:
      getFromClusterId in interface BGPRouteEntryImportParameters
      Returns:
      peer Id of announcer Peer

    • onSuccess

      public final void onSuccess(org.opendaylight.yangtools.yang.common.Empty value)
      Specified by:
      onSuccess in interface com.google.common.util.concurrent.FutureCallback<org.opendaylight.yangtools.yang.common.Empty>

    • getBGPErrorHandlingState

      public final BGPErrorHandlingState getBGPErrorHandlingState()
      Description copied from interface: BGPPeerState
      Error Handling State.
      Specified by:
      getBGPErrorHandlingState in interface BGPPeerState
      Returns:
      ErrorHandlingState

    • getBGPAfiSafiState

      public final BGPAfiSafiState getBGPAfiSafiState()
      Description copied from interface: BGPPeerState
      Afi Safi Operational State.
      Specified by:
      getBGPAfiSafiState in interface BGPPeerState
      Returns:
      AfiSafiState

    • getFromPeerLocalAs

      public final org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber getFromPeerLocalAs()
      Description copied from interface: BGPRouteEntryImportParameters
      Peer local AS of route entry announcer.
      Specified by:
      getFromPeerLocalAs in interface BGPRouteEntryImportParameters
      Returns:
      peer Local AS

    • getName

      public final String getName()
      Description copied from interface: Peer
      Return peer's symbolic name.
      Specified by:
      getName in interface Peer
      Returns:
      symbolic name.

    • getClusterId

      public final ClusterIdentifier getClusterId()
      Description copied from interface: PeerTrackerInformation
      Returns Cluster Id.
      Specified by:
      getClusterId in interface PeerTrackerInformation
      Returns:
      Cluster Id

    • getLocalAs

      public final org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber getLocalAs()
      Description copied from interface: PeerTrackerInformation
      Returns Local AS.
      Specified by:
      getLocalAs in interface PeerTrackerInformation
      Returns:
      AS

    • getDomChain

      public org.opendaylight.mdsal.dom.api.DOMTransactionChain getDomChain()
      Description copied from interface: PeerTransactionChain
      Returns Peer DOMTransactionChain.
      Specified by:
      getDomChain in interface PeerTransactionChain
      Returns:
      DOMTransactionChain

    • initializeRibOut

      public final <C extends Routes & org.opendaylight.yangtools.binding.DataObject & org.opendaylight.yangtools.binding.ChoiceIn<Tables>, S extends org.opendaylight.yangtools.binding.ChildOf<? super C>> void initializeRibOut(RouteEntryDependenciesContainer entryDep, List<ActualBestPathRoutes<C,S>> routesToStore)
      Description copied from interface: Peer
      Stores under peers rib Out already present routes, before proceed to process any new route advertizement.
      Specified by:
      initializeRibOut in interface Peer
      Parameters:
      entryDep - RouteEntryDependenciesContainer
      routesToStore - routes to be advertized.

    • refreshRibOut

      public final <C extends Routes & org.opendaylight.yangtools.binding.DataObject & org.opendaylight.yangtools.binding.ChoiceIn<Tables>, S extends org.opendaylight.yangtools.binding.ChildOf<? super C>> void refreshRibOut(RouteEntryDependenciesContainer entryDep, List<StaleBestPathRoute> staleRoutes, List<AdvertizedRoute<C,S>> newRoutes)
      Description copied from interface: Peer
      Update peers ribout after path selection processing.
      Specified by:
      refreshRibOut in interface Peer
      Parameters:
      entryDep - RouteEntryDependenciesContainer
      staleRoutes - routes to be removed.
      newRoutes - routes to be advertized.

    • reEvaluateAdvertizement

      public final <C extends Routes & org.opendaylight.yangtools.binding.DataObject & org.opendaylight.yangtools.binding.ChoiceIn<Tables>, S extends org.opendaylight.yangtools.binding.ChildOf<? super C>> void reEvaluateAdvertizement(RouteEntryDependenciesContainer entryDep, List<ActualBestPathRoutes<C,S>> routesToStore)
      Description copied from interface: Peer
      Applies all policies through all present routes, and advertize/withdraws based on new results. Scenario would be for example a removal of RT membership. And reprocess VPN routes.
      Specified by:
      reEvaluateAdvertizement in interface Peer
      Parameters:
      entryDep - RouteEntryDependenciesContainer
      routesToStore - routes to be updated.