org.onosproject.bgp.controller

Interface BgpController

public interface BgpController

Abstraction of an BGP controller. Serves as a one stop shop for obtaining BGP devices and (un)register listeners on bgp events

Method Summary

Modifier and Type	Method and Description
void	activeSessionExceptionAdd(java.lang.String peerId, java.lang.String exception) Stores the exceptions occurred during an active session.
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	activeSessionMap() Return active session exceptions.
void	addLinkListener(BgpLinkListener listener) Register a listener for BGP message events.
void	addListener(BgpNodeListener listener) Register a listener for BGP message events.
void	addRouteListener(BgpRouteListener listener) Register a listener for BGP message events.
BgpLocalRib	bgpLocalRib() Return BGP local RIB instance.
BgpLocalRib	bgpLocalRibVpn() Return BGP local RIB instance with VPN.
void	closeConnectedPeers() Close all connected BGP peers.
void	closedSessionExceptionAdd(java.lang.String peerId, java.lang.String exception) Stores the exceptions occurred during an closed session.
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	closedSessionMap() Return closed session exceptions.
int	connectedPeerCount() Get the BGP connected peers to this controller.
java.util.Map<BgpId,BgpPeer>	connectedPeers() Return BGP connected peers.
BgpCfg	getConfig() Get the BGPConfig class to the caller.
BgpPeer	getPeer(BgpId bgpId) Returns the actual bgp peer for the given ip address.
java.lang.Iterable<BgpPeer>	getPeers() Returns list of bgp peers connected to this BGP controller.
java.util.Set<BgpLinkListener>	linkListener() Return BGP link listener.
java.util.Set<BgpNodeListener>	listener() Return BGP node listener.
BgpPeerManager	peerManager() Return BGP peer manager.
void	processBgpPacket(BgpId bgpId, BgpMessage msg) Process a message and notify the appropriate listeners.
void	removeLinkListener(BgpLinkListener listener) Unregister a listener.
void	removeListener(BgpNodeListener listener) Unregister a listener.
void	removeRouteListener(BgpRouteListener listener) Unregister a listener.
java.util.Set<BgpRouteListener>	routeListener() Return BGP route listener.
void	writeMsg(BgpId bgpId, BgpMessage msg) Send a message to a particular bgp peer.

Method Detail

getPeers

java.lang.Iterable<BgpPeer> getPeers()

Returns list of bgp peers connected to this BGP controller.

Returns:

Iterable of BGPPeer elements

getPeer

BgpPeer getPeer(BgpId bgpId)

Returns the actual bgp peer for the given ip address.

Parameters:

bgpId - the id of the bgp peer to fetch

Returns:

the interface to this bgp peer

addListener

void addListener(BgpNodeListener listener)

Register a listener for BGP message events.

Parameters:

listener - the listener to notify

removeListener

void removeListener(BgpNodeListener listener)

Unregister a listener.

Parameters:

listener - the listener to unregister

writeMsg

void writeMsg(BgpId bgpId,
              BgpMessage msg)

Send a message to a particular bgp peer.

Parameters:

bgpId - the id of the peer to send message.

msg - the message to send

processBgpPacket

void processBgpPacket(BgpId bgpId,
                      BgpMessage msg)
               throws BgpParseException

Process a message and notify the appropriate listeners.

Parameters:

bgpId - id of the peer the message arrived on

msg - the message to process.

Throws:

BgpParseException - on data processing error

closeConnectedPeers

void closeConnectedPeers()

Close all connected BGP peers.

getConfig

BgpCfg getConfig()

Get the BGPConfig class to the caller.

Returns:

configuration object

connectedPeerCount

int connectedPeerCount()

Get the BGP connected peers to this controller.

Returns:

the integer number

bgpLocalRibVpn

BgpLocalRib bgpLocalRibVpn()

Return BGP local RIB instance with VPN.

Returns:

BGPLocalRibImpl local RIB with VPN

bgpLocalRib

BgpLocalRib bgpLocalRib()

Return BGP local RIB instance.

Returns:

BGPLocalRibImpl local RIB

peerManager

BgpPeerManager peerManager()

Return BGP peer manager.

Returns:

BGPPeerManager peer manager instance

connectedPeers

java.util.Map<BgpId,BgpPeer> connectedPeers()

Return BGP connected peers.

Returns:

connectedPeers connected peers

listener

java.util.Set<BgpNodeListener> listener()

Return BGP node listener.

Returns:

node listener

addLinkListener

void addLinkListener(BgpLinkListener listener)

Register a listener for BGP message events.

Parameters:

listener - the listener to notify

removeLinkListener

void removeLinkListener(BgpLinkListener listener)

Unregister a listener.

Parameters:

listener - the listener to unregister

linkListener

java.util.Set<BgpLinkListener> linkListener()

Return BGP link listener.

Returns:

link listener

activeSessionExceptionAdd

void activeSessionExceptionAdd(java.lang.String peerId,
                               java.lang.String exception)

Stores the exceptions occurred during an active session.

Parameters:

peerId - BGP peer id

exception - exceptions based on the peer id.

closedSessionExceptionAdd

void closedSessionExceptionAdd(java.lang.String peerId,
                               java.lang.String exception)

Stores the exceptions occurred during an closed session.

Parameters:

peerId - BGP peer id

exception - exceptions based on the peer id

activeSessionMap

java.util.Map<java.lang.String,java.util.List<java.lang.String>> activeSessionMap()

Return active session exceptions.

Returns:

activeSessionMap

closedSessionMap

java.util.Map<java.lang.String,java.util.List<java.lang.String>> closedSessionMap()

Return closed session exceptions.

Returns:

closedSessionMap

addRouteListener

void addRouteListener(BgpRouteListener listener)

Register a listener for BGP message events.

Parameters:

listener - the listener to notify

removeRouteListener

void removeRouteListener(BgpRouteListener listener)

Unregister a listener.

Parameters:

listener - the listener to unregister

routeListener

java.util.Set<BgpRouteListener> routeListener()

Return BGP route listener.

Returns:

route listener