org.opendaylight.protocol.bgp.rib.spi

Interface RIBSupport

All Known Implementing Classes:

AbstractFlowspecL3vpnRIBSupport, AbstractFlowspecRIBSupport, AbstractRIBSupport, AbstractVpnRIBSupport, FlowspecIpv4RIBSupport, FlowspecIpv6RIBSupport, FlowspecL3vpnIpv4RIBSupport, FlowspecL3vpnIpv6RIBSupport, LabeledUnicastIpv4RIBSupport, LinkstateRIBSupport, MultiPathAbstractRIBSupport

public interface RIBSupport

Interface implemented for AFI/SAFI-specific RIB extensions. The extensions need to register an implementation of this class and the RIB core then calls into it to inquire about details specific to that particular model.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	RIBSupport.ApplyRoute

Method Summary

Modifier and Type	Method and Description
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.
com.google.common.collect.ImmutableCollection<Class<? extends org.opendaylight.yangtools.yang.binding.DataObject>>	cacheableAttributeObjects()
com.google.common.collect.ImmutableCollection<Class<? extends org.opendaylight.yangtools.yang.binding.DataObject>>	cacheableNlriObjects()
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()
boolean	isComplexRoute() Indicate whether this AFI/SAFI combination is a complex route.
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.
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.
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.
Class<? extends Route>	routesListClass() Return class object of the Routes List statement.

Method Detail

emptyRoutes

@Nonnull
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. This needs to include all the skeleton nodes under which the individual routes will be stored.

Returns:

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

routeAttributesIdentifier

@Nonnull
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.

Returns:

The attributes identifier, may not be null.

routesCaseClass

@Nonnull
Class<? extends Routes> routesCaseClass()

Return class object of the Routes Case statement.

Returns:

Class

routesContainerClass

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

Return class object of the Routes Container statement.

Returns:

Class

routesListClass

@Nonnull
Class<? extends Route> routesListClass()

Return class object of the Routes List statement.

Returns:

Class

cacheableAttributeObjects

@Nonnull
com.google.common.collect.ImmutableCollection<Class<? extends org.opendaylight.yangtools.yang.binding.DataObject>> cacheableAttributeObjects()

cacheableNlriObjects

@Nonnull
com.google.common.collect.ImmutableCollection<Class<? extends org.opendaylight.yangtools.yang.binding.DataObject>> cacheableNlriObjects()

deleteRoutes

void deleteRoutes(@Nonnull
                  org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction tx,
                  @Nonnull
                  org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier tablePath,
                  @Nonnull
                  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.

Parameters:

tx - DOMDataWriteTransaction

tablePath - YangInstanceIdentifier

nlri - ContainerNode DOM representation of NLRI in Update message

deleteRoutes

void deleteRoutes(@Nonnull
                  org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction tx,
                  @Nonnull
                  org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier tablePath,
                  @Nonnull
                  org.opendaylight.yangtools.yang.data.api.schema.ContainerNode nlri,
                  @Nonnull
                  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.

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 deleteRoutes(org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.ContainerNode)

Parameters:

tx - DOMDataWriteTransaction

tablePath - YangInstanceIdentifier

nlri - ContainerNode DOM representation of NLRI in Update message

routesNodeId - NodeIdentifier of "routes" data node

putRoutes

void putRoutes(@Nonnull
               org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction tx,
               @Nonnull
               org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier tablePath,
               @Nonnull
               org.opendaylight.yangtools.yang.data.api.schema.ContainerNode nlri,
               @Nonnull
               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.

Parameters:

tx - DOMDataWriteTransaction

tablePath - YangInstanceIdentifier

nlri - ContainerNode DOM representation of NLRI in Update message

attributes - ContainerNode

putRoutes

void putRoutes(@Nonnull
               org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction tx,
               @Nonnull
               org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier tablePath,
               @Nonnull
               org.opendaylight.yangtools.yang.data.api.schema.ContainerNode nlri,
               @Nonnull
               org.opendaylight.yangtools.yang.data.api.schema.ContainerNode attributes,
               @Nonnull
               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.

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 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)

Parameters:

tx - DOMDataWriteTransaction

tablePath - YangInstanceIdentifier

nlri - ContainerNode DOM representation of NLRI in Update message

attributes - ContainerNode

routesNodeId - NodeIdentifier of "routes" data node

changedRoutes

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

Returns routes that were modified within this RIB support instance.

Parameters:

routes - DataTreeCandidateNode

Returns:

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

routePath

@Nonnull
org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier routePath(@Nonnull
                                                                                   org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier routesPath,
                                                                                   @Nonnull
                                                                                   org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument routeId)

Constructs an instance identifier path to routeId.

Parameters:

routesPath - YangInstanceIdentifier base path

routeId - PathArgument leaf path

Returns:

YangInstanceIdentifier with routesPath + specific RIB support routes path + routeId

isComplexRoute

boolean isComplexRoute()

Indicate whether this AFI/SAFI combination is a complex route. Simple routes are those which only have their key and attributes, complex routes are those which include more structured data.

Returns:

True if this is a complex route, false otherwise.

buildUpdate

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

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.

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

getAfi

@Nonnull
Class<? extends AddressFamily> getAfi()

getSafi

@Nonnull
Class<? extends SubsequentAddressFamily> getSafi()

extractPathId

default 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
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

Parameters:

pathId - The path identifier

routeId - PathArgument leaf path

Returns:

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

createRouteKeyPathArgument

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

Parameters:

routeKeyPathArgument - routeKey Path Argument

Returns:

new route Key