org.opendaylight.protocol.bgp.rib.spi

Class AbstractRIBSupport

java.lang.Object

org.opendaylight.protocol.bgp.rib.spi.AbstractRIBSupport

All Implemented Interfaces:

RIBSupport

Direct Known Subclasses:

AbstractVpnRIBSupport, LinkstateRIBSupport, MultiPathAbstractRIBSupport

@Beta
public abstract class AbstractRIBSupport
extends Object
implements RIBSupport

Nested Class Summary

Nested classes/interfaces inherited from interface org.opendaylight.protocol.bgp.rib.spi.RIBSupport

RIBSupport.ApplyRoute

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractRIBSupport(Class<? extends Routes> cazeClass, Class<? extends org.opendaylight.yangtools.yang.binding.DataObject> containerClass, Class<? extends Route> listClass, Class<? extends AddressFamily> afiClass, Class<? extends SubsequentAddressFamily> safiClass, org.opendaylight.yangtools.yang.common.QName destinationQname) Default constructor.

Method Summary

Modifier and Type	Method and Description
protected abstract DestinationType	buildDestination(Collection<org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode> routes)
Update	buildUpdate(Collection<org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode> advertised, Collection<org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode> withdrawn, Attributes attr) To send routes out, we'd need to transform the DOM representation of route to binding-aware format.
protected abstract DestinationType	buildWithdrawnDestination(Collection<org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode> routes)
Collection<org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidateNode>	changedRoutes(org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidateNode routes) Returns routes that were modified within this RIB support instance.
default org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument	createRouteKeyPathArgument(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument routeKeyPathArgument) Create a new Path Argument for route Key removing remove Path Id from key For non extension which doesnt support Multiple Path this step is not required
void	deleteRoutes(org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction tx, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier tablePath, org.opendaylight.yangtools.yang.data.api.schema.ContainerNode nlri) Given the NLRI as ContainerNode, this method should extract withdrawn routes from the DOM model and delete them from RIBs.
void	deleteRoutes(org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction tx, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier tablePath, org.opendaylight.yangtools.yang.data.api.schema.ContainerNode nlri, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier routesNodeId) Given the NLRI as ContainerNode, this method should extract withdrawn routes from the DOM model and delete them from RIBs.
org.opendaylight.yangtools.yang.data.api.schema.ChoiceNode	emptyRoutes() Return the table-type-specific empty routes container, as augmented into the bgp-rib model under /rib/tables/routes choice node.
default Long	extractPathId(org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?> normalizedNode) Extract PathId from route change received
Class<? extends AddressFamily>	getAfi()
default org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument	getRouteIdAddPath(long pathId, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument routeId) Construct a PathArgument to an AddPathRoute
Class<? extends SubsequentAddressFamily>	getSafi()
protected abstract void	processDestination(org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction tx, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier routesPath, org.opendaylight.yangtools.yang.data.api.schema.ContainerNode destination, org.opendaylight.yangtools.yang.data.api.schema.ContainerNode attributes, RIBSupport.ApplyRoute applyFunction)
void	putRoutes(org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction tx, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier tablePath, org.opendaylight.yangtools.yang.data.api.schema.ContainerNode nlri, org.opendaylight.yangtools.yang.data.api.schema.ContainerNode attributes) Given the NLRI as ContainerNode, this method should extract advertised routes from the DOM model and put them into RIBs.
void	putRoutes(org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction tx, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier tablePath, org.opendaylight.yangtools.yang.data.api.schema.ContainerNode nlri, org.opendaylight.yangtools.yang.data.api.schema.ContainerNode attributes, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier routesNodeId) Given the NLRI as ContainerNode, this method should extract advertised routes from the DOM model and put them into RIBs.
org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier	routeAttributesIdentifier() Return the localized identifier of the attributes route member, as expanded from the route grouping in the specific augmentation of the base routes choice.
protected org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier	routeNid()
org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier	routePath(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier routesPath, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument routeId) Constructs an instance identifier path to routeId.
org.opendaylight.yangtools.yang.common.QName	routeQName()
Class<? extends Routes>	routesCaseClass() Return class object of the Routes Case statement.
Class<? extends org.opendaylight.yangtools.yang.binding.DataObject>	routesContainerClass() Return class object of the Routes Container statement.
protected org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier	routesContainerIdentifier() Return the YangInstanceIdentifier.NodeIdentifier of the AFI/SAFI-specific container under the RIB routes.
Class<? extends Route>	routesListClass() Return class object of the Routes List statement.

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.RIBSupport

cacheableAttributeObjects, cacheableNlriObjects, isComplexRoute

Constructor Detail

AbstractRIBSupport

protected AbstractRIBSupport(Class<? extends Routes> cazeClass,
                             Class<? extends org.opendaylight.yangtools.yang.binding.DataObject> containerClass,
                             Class<? extends Route> listClass,
                             Class<? extends AddressFamily> afiClass,
                             Class<? extends SubsequentAddressFamily> safiClass,
                             org.opendaylight.yangtools.yang.common.QName destinationQname)

Default constructor. Requires the QName of the container augmented under the routes choice node in instantiations of the rib grouping. It is assumed that this container is defined by the same model which populates it with route grouping instantiation, and by extension with the route attributes container.

Parameters:

cazeClass - Binding class of the AFI/SAFI-specific case statement, must not be null

containerClass - Binding class of the container in routes choice, must not be null.

listClass - Binding class of the route list, nust not be null;

afiClass - address Family Class

safiClass - SubsequentAddressFamily

destinationQname - destination Qname

Method Detail

routesCaseClass

@Nonnull
public final Class<? extends Routes> routesCaseClass()

Description copied from interface: RIBSupport

Return class object of the Routes Case statement.

Specified by:

routesCaseClass in interface RIBSupport

Returns:

Class

routesContainerClass

@Nonnull
public final Class<? extends org.opendaylight.yangtools.yang.binding.DataObject> routesContainerClass()

Description copied from interface: RIBSupport

Return class object of the Routes Container statement.

Specified by:

routesContainerClass in interface RIBSupport

Returns:

Class

routesListClass

@Nonnull
public final Class<? extends Route> routesListClass()

Description copied from interface: RIBSupport

Return class object of the Routes List statement.

Specified by:

routesListClass in interface RIBSupport

Returns:

Class

emptyRoutes

@Nonnull
public final org.opendaylight.yangtools.yang.data.api.schema.ChoiceNode emptyRoutes()

Description copied from interface: RIBSupport

Return the table-type-specific empty routes container, as augmented into the bgp-rib model under /rib/tables/routes choice node. This needs to include all the skeleton nodes under which the individual routes will be stored.

Specified by:

emptyRoutes in interface RIBSupport

Returns:

Protocol-specific case in the routes choice, may not be null.

routeQName

public final org.opendaylight.yangtools.yang.common.QName routeQName()

routeNid

protected final org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier routeNid()

getAfi

@Nonnull
public final Class<? extends AddressFamily> getAfi()

Specified by:

getAfi in interface RIBSupport

getSafi

@Nonnull
public final Class<? extends SubsequentAddressFamily> getSafi()

Specified by:

getSafi in interface RIBSupport

buildDestination

@Nonnull
protected abstract DestinationType buildDestination(@Nonnull
                                                             Collection<org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode> routes)

buildWithdrawnDestination

@Nonnull
protected abstract DestinationType buildWithdrawnDestination(@Nonnull
                                                                      Collection<org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode> routes)

routesContainerIdentifier

protected final org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier routesContainerIdentifier()

Return the YangInstanceIdentifier.NodeIdentifier of the AFI/SAFI-specific container under the RIB routes.

Returns:

Container identifier, may not be null.

processDestination

protected abstract void processDestination(org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction tx,
                                           org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier routesPath,
                                           org.opendaylight.yangtools.yang.data.api.schema.ContainerNode destination,
                                           org.opendaylight.yangtools.yang.data.api.schema.ContainerNode attributes,
                                           RIBSupport.ApplyRoute applyFunction)

routeAttributesIdentifier

public final org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier routeAttributesIdentifier()

Description copied from interface: RIBSupport

Return the localized identifier of the attributes route member, as expanded from the route grouping in the specific augmentation of the base routes choice.

Specified by:

routeAttributesIdentifier in interface RIBSupport

Returns:

The attributes identifier, may not be null.

changedRoutes

public final Collection<org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidateNode> changedRoutes(org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidateNode routes)

Description copied from interface: RIBSupport

Returns routes that were modified within this RIB support instance.

Specified by:

changedRoutes in interface RIBSupport

Parameters:

routes - DataTreeCandidateNode

Returns:

collection of modified nodes or empty collection if no node was modified

routePath

public final org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier routePath(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier routesPath,
                                                                                       org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument routeId)

Description copied from interface: RIBSupport

Constructs an instance identifier path to routeId.

Specified by:

routePath in interface RIBSupport

Parameters:

routesPath - YangInstanceIdentifier base path

routeId - PathArgument leaf path

Returns:

YangInstanceIdentifier with routesPath + specific RIB support routes path + routeId

deleteRoutes

public final void deleteRoutes(org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction tx,
                               org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier tablePath,
                               org.opendaylight.yangtools.yang.data.api.schema.ContainerNode nlri)

Description copied from interface: RIBSupport

Given the NLRI as ContainerNode, this method should extract withdrawn routes from the DOM model and delete them from RIBs.

Specified by:

deleteRoutes in interface RIBSupport

Parameters:

tx - DOMDataWriteTransaction

tablePath - YangInstanceIdentifier

nlri - ContainerNode DOM representation of NLRI in Update message

putRoutes

public final void putRoutes(org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction tx,
                            org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier tablePath,
                            org.opendaylight.yangtools.yang.data.api.schema.ContainerNode nlri,
                            org.opendaylight.yangtools.yang.data.api.schema.ContainerNode attributes)

Description copied from interface: RIBSupport

Given the NLRI as ContainerNode, this method should extract advertised routes from the DOM model and put them into RIBs.

Specified by:

putRoutes in interface RIBSupport

Parameters:

tx - DOMDataWriteTransaction

tablePath - YangInstanceIdentifier

nlri - ContainerNode DOM representation of NLRI in Update message

attributes - ContainerNode

buildUpdate

@Nonnull
public final Update buildUpdate(Collection<org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode> advertised,
                                         Collection<org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode> withdrawn,
                                         Attributes attr)

Description copied from interface: RIBSupport

To send routes out, we'd need to transform the DOM representation of route to binding-aware format. This needs to be done per each AFI/SAFI.

Specified by:

buildUpdate in interface RIBSupport

Parameters:

advertised - Collection of advertised routes in DOM format

withdrawn - Collection of withdrawn routes in DOM format

attr - Attributes MpReach is part of Attributes so we need to pass it as argument, create new AttributesBuilder with existing attributes and add MpReach

Returns:

Update message ready to be sent out

deleteRoutes

public final void deleteRoutes(org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction tx,
                               org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier tablePath,
                               org.opendaylight.yangtools.yang.data.api.schema.ContainerNode nlri,
                               org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier routesNodeId)

Description copied from interface: RIBSupport

Given the NLRI as ContainerNode, this method should extract withdrawn routes from the DOM model and delete them from RIBs.

Use this method when removing routes stored in RIBs out of the "bgp-rib" module. Provide YangInstanceIdentifier.NodeIdentifier with customized "routes" QName. For default "bgp-rib" RIBs use RIBSupport.deleteRoutes(org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.ContainerNode)

Specified by:

deleteRoutes in interface RIBSupport

Parameters:

tx - DOMDataWriteTransaction

tablePath - YangInstanceIdentifier

nlri - ContainerNode DOM representation of NLRI in Update message

routesNodeId - NodeIdentifier of "routes" data node

putRoutes

public final void putRoutes(org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction tx,
                            org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier tablePath,
                            org.opendaylight.yangtools.yang.data.api.schema.ContainerNode nlri,
                            org.opendaylight.yangtools.yang.data.api.schema.ContainerNode attributes,
                            org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier routesNodeId)

Description copied from interface: RIBSupport

Given the NLRI as ContainerNode, this method should extract advertised routes from the DOM model and put them into RIBs.

Use this method when putting routes stored in RIBs out of the "bgp-rib" module. Provide YangInstanceIdentifier.NodeIdentifier with customized "routes" QName. For default "bgp-rib" RIBs use RIBSupport.putRoutes(org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.ContainerNode, org.opendaylight.yangtools.yang.data.api.schema.ContainerNode)

Specified by:

putRoutes in interface RIBSupport

Parameters:

tx - DOMDataWriteTransaction

tablePath - YangInstanceIdentifier

nlri - ContainerNode DOM representation of NLRI in Update message

attributes - ContainerNode

routesNodeId - NodeIdentifier of "routes" data node

extractPathId

public Long extractPathId(org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?> normalizedNode)

Extract PathId from route change received

Parameters:

normalizedNode - Path Id Container

Returns:

pathId The path identifier value

getRouteIdAddPath

@Nullable
public org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument getRouteIdAddPath(long pathId,
                                                                                                                org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument routeId)

Construct a PathArgument to an AddPathRoute

Parameters:

pathId - The path identifier

routeId - PathArgument leaf path

Returns:

routeId PathArgument + pathId or Null in case Add-path is not supported

createRouteKeyPathArgument

public org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument createRouteKeyPathArgument(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument routeKeyPathArgument)

Create a new Path Argument for route Key removing remove Path Id from key For non extension which doesnt support Multiple Path this step is not required

Parameters:

routeKeyPathArgument - routeKey Path Argument

Returns:

new route Key