org.opendaylight.protocol.bgp.rib.impl

Class BGPPeer

java.lang.Object

org.opendaylight.protocol.bgp.rib.DefaultRibReference

org.opendaylight.protocol.bgp.rib.impl.state.BGPPeerStateImpl

org.opendaylight.protocol.bgp.rib.impl.BGPPeer

All Implemented Interfaces:

EventListener, org.opendaylight.controller.md.sal.common.api.data.TransactionChainListener, BGPMessagesListener, PeerTransactionChain, RibReference, BGPSessionListener, Peer, PeerRPCs, PeerTrackerInformation, BGPRouteEntryImportParameters, RouteTargetMembershipConsumer, BGPAfiSafiState, BGPErrorHandlingState, BGPGracelfulRestartState, BGPPeerMessagesState, BGPPeerState, BGPPeerStateConsumer, InstanceReference<Rib>

public class BGPPeer
extends BGPPeerStateImpl
implements BGPSessionListener

Class representing a peer. We have a single instance for each peer, which provides translation from BGP events into RIB actions.

Constructor Summary

Constructors

Constructor and Description

BGPPeer(BGPTableTypeRegistryConsumer tableTypeRegistry, org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress neighborAddress, String peerGroupName, RIB rib, PeerRole role, ClusterIdentifier clusterId, org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber localAs, org.opendaylight.controller.sal.binding.api.RpcProviderRegistry rpcRegistry, Set<TablesKey> afiSafisAdvertized, Set<TablesKey> afiSafisGracefulAdvertized)

Method Summary

Modifier and Type	Method and Description
com.google.common.util.concurrent.FluentFuture<? extends org.opendaylight.mdsal.common.api.CommitInfo>	close() Close Peers and performs asynchronously DS clean up.
BGPAfiSafiState	getBGPAfiSafiState() Afi Safi Operational State.
BGPErrorHandlingState	getBGPErrorHandlingState() Error Handling State.
BGPSessionState	getBGPSessionState() BGP Session Operational State.
BGPTimersState	getBGPTimersState() BGP Operation Timers State.
BGPTransportState	getBGPTransportState() BGP Operational Transport State.
ClusterIdentifier	getClusterId() Returns Cluster Id.
org.opendaylight.controller.md.sal.dom.api.DOMTransactionChain	getDomChain() Returns Peer DOMTransactionChain.
ClusterIdentifier	getFromClusterId() Peer id of Peer route entry announcer.
PeerId	getFromPeerId() Peer id of Peer route entry announcer.
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber	getFromPeerLocalAs() Peer local AS of route entry announcer.
PeerRole	getFromPeerRole() Peer id of Peer route entry announcer.
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber	getLocalAs() Returns Local AS.
List<RouteTarget>	getMemberships() Returns list of Route target advertized per Peer.
String	getName() Return peer's symbolic name.
PeerId	getPeerId() Returns Peer id.
byte[]	getRawIdentifier() Return the peer's BGP identifier as raw byte array.
org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier<Tables,TablesKey>	getRibOutIId(TablesKey tablesKey) Creates Table Adj Rib Out Instance identifier.
PeerRole	getRole() Returns Peer Role.
SendReceive	getSupportedAddPathTables(TablesKey tableKey) Returns AddPath support configuration if supported, otherwise null.
<C extends Routes & org.opendaylight.yangtools.yang.binding.DataObject & org.opendaylight.yangtools.yang.binding.ChoiceIn<Tables>,S extends org.opendaylight.yangtools.yang.binding.ChildOf<? super C>,R extends Route & org.opendaylight.yangtools.yang.binding.ChildOf<? super S> & org.opendaylight.yangtools.yang.binding.Identifiable<I>,I extends org.opendaylight.yangtools.yang.binding.Identifier<R>> void	initializeRibOut(RouteEntryDependenciesContainer entryDep, List<ActualBestPathRoutes<C,S,R,I>> routesToStore) Stores under peers rib Out already present routes, before proceed to process any new route advertizement.
void	instantiateServiceInstance()
void	markUptodate(TablesKey tablesKey) Marks synchronization finished for given Table key.
void	onMessage(BGPSession session, org.opendaylight.yangtools.yang.binding.Notification msg) Fired when a normal protocol message is received.
void	onSessionDown(BGPSession session, Exception e) Fired when the session went down because of an IO error.
void	onSessionTerminated(BGPSession session, BGPTerminationReason cause) Fired when the session is terminated locally.
void	onSessionUp(BGPSession session) Fired when the session was established successfully.
void	onTransactionChainFailed(org.opendaylight.controller.md.sal.common.api.data.TransactionChain<?,?> chain, org.opendaylight.controller.md.sal.common.api.data.AsyncTransaction<?,?> transaction, Throwable cause)
void	onTransactionChainSuccessful(org.opendaylight.controller.md.sal.common.api.data.TransactionChain<?,?> chain)
<C extends Routes & org.opendaylight.yangtools.yang.binding.DataObject & org.opendaylight.yangtools.yang.binding.ChoiceIn<Tables>,S extends org.opendaylight.yangtools.yang.binding.ChildOf<? super C>,R extends Route & org.opendaylight.yangtools.yang.binding.ChildOf<? super S> & org.opendaylight.yangtools.yang.binding.Identifiable<I>,I extends org.opendaylight.yangtools.yang.binding.Identifier<R>> void	reEvaluateAdvertizement(RouteEntryDependenciesContainer entryDep, List<ActualBestPathRoutes<C,S,R,I>> routesToStore) Applies all policies through all present routes, and advertize/withdraws based on new results.
<C extends Routes & org.opendaylight.yangtools.yang.binding.DataObject & org.opendaylight.yangtools.yang.binding.ChoiceIn<Tables>,S extends org.opendaylight.yangtools.yang.binding.ChildOf<? super C>,R extends Route & org.opendaylight.yangtools.yang.binding.ChildOf<? super S> & org.opendaylight.yangtools.yang.binding.Identifiable<I>,I extends org.opendaylight.yangtools.yang.binding.Identifier<R>> void	refreshRibOut(RouteEntryDependenciesContainer entryDep, List<StaleBestPathRoute<C,S,R,I>> staleRoutes, List<AdvertizedRoute<C,S,R,I>> newRoutes) Update peers ribout after path selection processing.
com.google.common.util.concurrent.FluentFuture<? extends org.opendaylight.mdsal.common.api.CommitInfo>	releaseConnection() Release Peer session.
boolean	supportsTable(TablesKey tableKey) Returns true if peer supports table.
String	toString()

Methods inherited from class org.opendaylight.protocol.bgp.rib.impl.state.BGPPeerStateImpl

getAfiSafisAdvertized, getAfiSafisReceived, getBGPGracelfulRestart, getBGPPeerMessagesState, getErroneousUpdateReceivedCount, getGroupId, getNeighborAddress, getNotificationMessagesReceivedCount, getNotificationMessagesSentCount, getPeerRestartTime, getPeerState, getPrefixesInstalledCount, getPrefixesReceivedCount, getPrefixesSentCount, getTotalPrefixes, getUpdateMessagesReceivedCount, getUpdateMessagesSentCount, isActive, isAfiSafiSupported, isGracefulRestartAdvertized, isGracefulRestartReceived, isLocalRestarting, isPeerRestarting, messageReceived, messageSent, registerPrefixesCounters, registerPrefixesSentCounter, resetState, setActive, setAdvertizedGracefulRestartTableTypes, setAfiSafiGracefulRestartState

Methods inherited from class org.opendaylight.protocol.bgp.rib.DefaultRibReference

getInstanceIdentifier

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.opendaylight.protocol.bgp.rib.spi.PeerTrackerInformation

supportsAddPathSupported

Methods inherited from interface org.opendaylight.protocol.bgp.rib.spi.state.BGPPeerState

getTotalPathsCount

Methods inherited from interface org.opendaylight.protocol.bgp.rib.RibReference

getInstanceIdentifier

Constructor Detail

BGPPeer

public BGPPeer(BGPTableTypeRegistryConsumer tableTypeRegistry,
               org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress neighborAddress,
               String peerGroupName,
               RIB rib,
               PeerRole role,
               ClusterIdentifier clusterId,
               org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber localAs,
               org.opendaylight.controller.sal.binding.api.RpcProviderRegistry rpcRegistry,
               Set<TablesKey> afiSafisAdvertized,
               Set<TablesKey> afiSafisGracefulAdvertized)

Method Detail

instantiateServiceInstance

public void instantiateServiceInstance()

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

onMessage

public void onMessage(BGPSession session,
                      org.opendaylight.yangtools.yang.binding.Notification msg)
               throws BGPDocumentedException

Description copied from interface: BGPSessionListener

Fired when a normal protocol message is received.

Specified by:

onMessage in interface BGPSessionListener

msg - Protocol message

Throws:

BGPDocumentedException

onSessionUp

public void onSessionUp(BGPSession session)

Description copied from interface: BGPSessionListener

Fired when the session was established successfully.

Specified by:

onSessionUp in interface BGPSessionListener

Parameters:

session - Peer address families which we accepted

onSessionDown

public void onSessionDown(BGPSession session,
                          Exception e)

Description copied from interface: BGPSessionListener

Fired when the session went down because of an IO error. Implementation should take care of closing underlying session.

Specified by:

onSessionDown in interface BGPSessionListener

Parameters:

session - that went down

e - Exception that was thrown as the cause of session being down

onSessionTerminated

public void onSessionTerminated(BGPSession session,
                                BGPTerminationReason cause)

Description copied from interface: BGPSessionListener

Fired when the session is terminated locally. The session has already been closed and transitioned to IDLE state. Any outstanding queued messages were not sent. The user should not attempt to make any use of the session.

Specified by:

onSessionTerminated in interface BGPSessionListener

cause - the cause why the session went down

toString

public String toString()

Overrides:

toString in class Object

releaseConnection

public com.google.common.util.concurrent.FluentFuture<? extends org.opendaylight.mdsal.common.api.CommitInfo> releaseConnection()

Description copied from interface: PeerRPCs

Release Peer session.

Specified by:

releaseConnection in interface PeerRPCs

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 peer supports table.

Specified by:

supportsTable in interface PeerTrackerInformation

Parameters:

tableKey - table

Returns:

true if Additional Path is supported for defined table

getRibOutIId

public org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier<Tables,TablesKey> getRibOutIId(TablesKey tablesKey)

Description copied from interface: PeerTrackerInformation

Creates Table Adj Rib Out Instance identifier.

Specified by:

getRibOutIId in interface PeerTrackerInformation

Parameters:

tablesKey - table key

Returns:

instance identifier.

onTransactionChainFailed

public void onTransactionChainFailed(org.opendaylight.controller.md.sal.common.api.data.TransactionChain<?,?> chain,
                                     org.opendaylight.controller.md.sal.common.api.data.AsyncTransaction<?,?> transaction,
                                     Throwable cause)

Specified by:

onTransactionChainFailed in interface org.opendaylight.controller.md.sal.common.api.data.TransactionChainListener

markUptodate

public void markUptodate(TablesKey tablesKey)

Description copied from interface: BGPSessionListener

Marks synchronization finished for given Table key.

Specified by:

markUptodate in interface BGPSessionListener

Parameters:

tablesKey - of the table where synchronization finished

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

getMemberships

public List<RouteTarget> getMemberships()

Description copied from interface: RouteTargetMembershipConsumer

Returns list of Route target advertized per Peer.

Specified by:

getMemberships in interface RouteTargetMembershipConsumer

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

getRawIdentifier

public final byte[] getRawIdentifier()

Description copied from interface: Peer

Return the peer's BGP identifier as raw byte array.

Specified by:

getRawIdentifier in interface Peer

Returns:

byte[] raw identifier

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

onTransactionChainSuccessful

public final void onTransactionChainSuccessful(org.opendaylight.controller.md.sal.common.api.data.TransactionChain<?,?> chain)

Specified by:

onTransactionChainSuccessful in interface org.opendaylight.controller.md.sal.common.api.data.TransactionChainListener

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.controller.md.sal.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.yang.binding.DataObject & org.opendaylight.yangtools.yang.binding.ChoiceIn<Tables>,S extends org.opendaylight.yangtools.yang.binding.ChildOf<? super C>,R extends Route & org.opendaylight.yangtools.yang.binding.ChildOf<? super S> & org.opendaylight.yangtools.yang.binding.Identifiable<I>,I extends org.opendaylight.yangtools.yang.binding.Identifier<R>> void initializeRibOut(RouteEntryDependenciesContainer entryDep,
                                                                                                                                                                                                                                                                                                                                                                                                                                                  List<ActualBestPathRoutes<C,S,R,I>> 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.yang.binding.DataObject & org.opendaylight.yangtools.yang.binding.ChoiceIn<Tables>,S extends org.opendaylight.yangtools.yang.binding.ChildOf<? super C>,R extends Route & org.opendaylight.yangtools.yang.binding.ChildOf<? super S> & org.opendaylight.yangtools.yang.binding.Identifiable<I>,I extends org.opendaylight.yangtools.yang.binding.Identifier<R>> void refreshRibOut(RouteEntryDependenciesContainer entryDep,
                                                                                                                                                                                                                                                                                                                                                                                                                                               List<StaleBestPathRoute<C,S,R,I>> staleRoutes,
                                                                                                                                                                                                                                                                                                                                                                                                                                               List<AdvertizedRoute<C,S,R,I>> 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.yang.binding.DataObject & org.opendaylight.yangtools.yang.binding.ChoiceIn<Tables>,S extends org.opendaylight.yangtools.yang.binding.ChildOf<? super C>,R extends Route & org.opendaylight.yangtools.yang.binding.ChildOf<? super S> & org.opendaylight.yangtools.yang.binding.Identifiable<I>,I extends org.opendaylight.yangtools.yang.binding.Identifier<R>> void reEvaluateAdvertizement(RouteEntryDependenciesContainer entryDep,
                                                                                                                                                                                                                                                                                                                                                                                                                                                         List<ActualBestPathRoutes<C,S,R,I>> 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.