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:

EventListener, org.opendaylight.controller.md.sal.common.api.data.TransactionChainListener, org.opendaylight.controller.md.sal.dom.api.ClusteredDOMDataTreeChangeListener, org.opendaylight.controller.md.sal.dom.api.DOMDataTreeChangeListener, BGPMessagesListener, RibReference, Peer, BGPAfiSafiState, BGPErrorHandlingState, BGPGracelfulRestartState, BGPPeerMessagesState, BGPPeerState, BGPPeerStateConsumer, InstanceReference<Rib>

public class ApplicationPeer
extends BGPPeerStateImpl
implements Peer, org.opendaylight.controller.md.sal.dom.api.ClusteredDOMDataTreeChangeListener, org.opendaylight.controller.md.sal.common.api.data.TransactionChainListener

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 Summary

Constructors

Constructor and Description
ApplicationPeer(ApplicationRibId applicationRibId, org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address ipAddress, RIB rib)

Method Summary

Modifier and Type	Method and Description
com.google.common.util.concurrent.ListenableFuture<Void>	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
String	getName() Return peer's symbolic name.
byte[]	getRawIdentifier() Return the peer's BGP identifier as raw bytearray
void	instantiateServiceInstance(org.opendaylight.controller.md.sal.dom.api.DOMDataTreeChangeService dataTreeChangeService, org.opendaylight.controller.md.sal.dom.api.DOMDataTreeIdentifier appPeerDOMId)
void	onDataTreeChanged(Collection<org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidate> changes) Routes come from application RIB that is identified by (configurable) name.
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)

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, isAfiSafiSupported, isGracefulRestartAdvertized, isGracefulRestartReceived, isLocalRestarting, isPeerRestarting, messageReceived, messageSent, registerPrefixesCounters, registerPrefixesSentCounter, resetState, 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, toString, wait, wait, wait

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

ApplicationPeer

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

Method Detail

instantiateServiceInstance

public void instantiateServiceInstance(org.opendaylight.controller.md.sal.dom.api.DOMDataTreeChangeService dataTreeChangeService,
                                       org.opendaylight.controller.md.sal.dom.api.DOMDataTreeIdentifier appPeerDOMId)

onDataTreeChanged

public void onDataTreeChanged(Collection<org.opendaylight.yangtools.yang.data.api.schema.tree.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.controller.md.sal.dom.api.DOMDataTreeChangeListener

getName

public String getName()

Description copied from interface: Peer

Return peer's symbolic name.

Specified by:

getName in interface Peer

Returns:

symbolic name.

close

public com.google.common.util.concurrent.ListenableFuture<Void> close()

Description copied from interface: Peer

Close Peers and performs asynchronously DS clean up

Specified by:

close in interface Peer

Returns:

future

getRawIdentifier

public byte[] getRawIdentifier()

Description copied from interface: Peer

Return the peer's BGP identifier as raw bytearray

Specified by:

getRawIdentifier in interface Peer

Returns:

byte[] raw 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

onTransactionChainSuccessful

public 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 BGPErrorHandlingState getBGPErrorHandlingState()

Description copied from interface: BGPPeerState

Error Handling State

Specified by:

getBGPErrorHandlingState in interface BGPPeerState

Returns:

ErrorHandlingState

getBGPAfiSafiState

public BGPAfiSafiState getBGPAfiSafiState()

Description copied from interface: BGPPeerState

Afi Safi Operational State

Specified by:

getBGPAfiSafiState in interface BGPPeerState

Returns:

AfiSafiState

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