org.opendaylight.protocol.bgp.rib.impl.spi

Interface BGPPeerRegistry

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

StrictBGPPeerRegistry

public interface BGPPeerRegistry
extends AutoCloseable

Registry that contains configured bgp peers ready for when a bgp session is established with remote peer. IP address is uses as a key for configured peers. TODO Is IP sufficient ID for peers ?

Method Summary

Modifier and Type	Method and Description
void	addPeer(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress ip, BGPSessionListener peer, BGPSessionPreferences prefs) Add configured peer, its IP address and preferences.
BGPSessionListener	getPeer(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress ip, org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address sourceId, org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address remoteId, Open open) Get configured peer after BGP session was successfully established.
BGPSessionPreferences	getPeerPreferences(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress ip)
boolean	isPeerConfigured(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress ip) Check whether peer on provided IP address is present in this registry.
AutoCloseable	registerPeerRegisterListener(PeerRegistryListener listener) Register PeerRegistryListener, which listens to the changes in peer registry (add peer, remove peer).
AutoCloseable	registerPeerSessionListener(PeerRegistrySessionListener listener) Register PeerRegistrySessionListener, which listens to the changes in sessions of peers in peer registry (create session, remove session).
void	removePeer(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress ip) Remove configured peer from registry.
void	removePeerSession(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress ip) Remove peer session from registry.

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

addPeer

void addPeer(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress ip,
             BGPSessionListener peer,
             BGPSessionPreferences prefs)

Add configured peer, its IP address and preferences. To be used when a BGP session is established.

Parameters:

ip - address of remote peer

peer - configured peer as BGPSessionListener

prefs - session preferences for configured peer

removePeer

void removePeer(@Nonnull
                org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress ip)

Remove configured peer from registry.

Parameters:

ip - address of remote peer

removePeerSession

void removePeerSession(@Nonnull
                       org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress ip)

Remove peer session from registry.

Parameters:

ip - address of remote peer

isPeerConfigured

boolean isPeerConfigured(@Nonnull
                         org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress ip)

Check whether peer on provided IP address is present in this registry.

Parameters:

ip - address of remote peer

Returns:

true if peer is present false otherwise

getPeer

BGPSessionListener getPeer(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress ip,
                           org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address sourceId,
                           org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address remoteId,
                           Open open)
                    throws BGPDocumentedException

Get configured peer after BGP session was successfully established. Called by negotiators.

Parameters:

ip - address of remote peer

sourceId - BGP ID of peer that initiated the session (current device or remote peer)

remoteId - BGP ID of peer that accepted the session (current device or remote peer)

open - remote Open message

Returns:

BGPSessionListener configured Peer as BGP listener

Throws:

BGPDocumentedException - if session establishment cannot be finished successfully

IllegalStateException - if there is no peer configured for provided ip address

getPeerPreferences

BGPSessionPreferences getPeerPreferences(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress ip)

Parameters:

ip - address of remote peer

Returns:

BGP session preferences for configured peer

Throws:

IllegalStateException - if there is no peer configured for provided ip address

registerPeerRegisterListener

@Nonnull
AutoCloseable registerPeerRegisterListener(@Nonnull
                                                    PeerRegistryListener listener)

Register PeerRegistryListener, which listens to the changes in peer registry (add peer, remove peer). After registration, an initial drop is provided by calling onPeerAdded().

Parameters:

listener - The PeerRegistryListener to be registered.

Returns:

Registration ticked, used for closing of registration.

registerPeerSessionListener

@Nonnull
AutoCloseable registerPeerSessionListener(PeerRegistrySessionListener listener)

Register PeerRegistrySessionListener, which listens to the changes in sessions of peers in peer registry (create session, remove session). After registration, an initial drop is provided by calling onSessionCreated().

Parameters:

listener - The PeerRegistrySessionListener to be registered.

Returns:

Registration ticked, used for closing of registration.