org.opendaylight.protocol.bgp.rib.spi

Interface RIBSupport<C extends Routes & org.opendaylight.yangtools.yang.binding.DataObject & org.opendaylight.yangtools.yang.binding.ChoiceIn<Tables>,S extends org.opendaylight.yangtools.yang.binding.ChildOf<? super C>,R extends Route & org.opendaylight.yangtools.yang.binding.ChildOf<? super S> & org.opendaylight.yangtools.yang.binding.Identifiable<I>,I extends org.opendaylight.yangtools.yang.binding.Identifier<R>>

All Known Implementing Classes:

AbstractFlowspecL3vpnRIBSupport, AbstractFlowspecRIBSupport, AbstractRIBSupport, AbstractVpnRIBSupport, FlowspecIpv4RIBSupport, FlowspecIpv6RIBSupport, FlowspecL3vpnIpv4RIBSupport, FlowspecL3vpnIpv6RIBSupport, L3VpnMcastIpv4RIBSupport, L3VpnMcastIpv6RIBSupport, LabeledUnicastIpv4RIBSupport, LinkstateRIBSupport, RouteTargetConstrainRIBSupport, VpnIpv4RIBSupport, VpnIpv6RIBSupport

public interface RIBSupport<C extends Routes & org.opendaylight.yangtools.yang.binding.DataObject & org.opendaylight.yangtools.yang.binding.ChoiceIn<Tables>,S extends org.opendaylight.yangtools.yang.binding.ChildOf<? super C>,R extends Route & org.opendaylight.yangtools.yang.binding.ChildOf<? super S> & org.opendaylight.yangtools.yang.binding.Identifiable<I>,I extends org.opendaylight.yangtools.yang.binding.Identifier<R>>

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.
default com.google.common.collect.ImmutableCollection<Class<? extends org.opendaylight.yangtools.yang.binding.DataObject>>	cacheableAttributeObjects()
default 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.
R	createRoute(R route, String routeKey, long pathId, Attributes attributes) Creates a route with new path Id and attributes.
org.opendaylight.yangtools.yang.binding.InstanceIdentifier<R>	createRouteIdentifier(org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier<Tables,TablesKey> tableKey, I newRouteKey) Creates Route table Peer InstanceIdentifier.
I	createRouteListKey(long pathId, String routeKey) Construct a Route List Key using new path Id for Families.
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.
C	emptyRoutesCase() Return the table-type-specific empty routes container, as augmented into the bgp-peer model under /peer/effect-rib-in/tables/routes choice node.
S	emptyRoutesContainer() Return the table-type-specific empty routes container, as augmented into the bgp-peer model under /peer/effect-rib-in/tables/routes choice node/routes container.
org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode	emptyTable() Return the table-type-specific empty table with routes empty container, as augmented into the bgp-rib model under /rib/tables/routes choice node.
Class<? extends AddressFamily>	getAfi()
Class<? extends SubsequentAddressFamily>	getSafi()
TablesKey	getTablesKey() Returns TablesKey which we are providing support.
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<C>	routesCaseClass() Return class object of the Routes Case statement.
Class<S>	routesContainerClass() Return class object of the Routes Container statement.
Class<R>	routesListClass() Return class object of the Routes List statement.

Method Detail

emptyTable

@Nonnull
org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode emptyTable()

Return the table-type-specific empty table with routes empty 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<C> routesCaseClass()

Return class object of the Routes Case statement.

Returns:

Class

routesContainerClass

@Nonnull
Class<S> routesContainerClass()

Return class object of the Routes Container statement.

Returns:

Class

routesListClass

@Nonnull
Class<R> routesListClass()

Return class object of the Routes List statement.

Returns:

Class

cacheableAttributeObjects

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

cacheableNlriObjects

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

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

createRouteIdentifier

@Nonnull
org.opendaylight.yangtools.yang.binding.InstanceIdentifier<R> createRouteIdentifier(@Nonnull
                                                                                             org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier<Tables,TablesKey> tableKey,
                                                                                             @Nonnull
                                                                                             I newRouteKey)

Creates Route table Peer InstanceIdentifier.

Parameters:

tableKey - table InstanceIdentifier

newRouteKey - route key

Returns:

InstanceIdentifier

createRoute

@Nonnull
R createRoute(@Nullable
                       R route,
                       String routeKey,
                       @Nullable
                       long pathId,
                       @Nonnull
                       Attributes attributes)

Creates a route with new path Id and attributes.

Parameters:

route - route

routeKey - route key

pathId - new path Id

attributes - route attributes

Returns:

Route List key

getTablesKey

TablesKey getTablesKey()

Returns TablesKey which we are providing support.

Returns:

TablesKey

emptyRoutesCase

@Nonnull
C emptyRoutesCase()

Return the table-type-specific empty routes container, as augmented into the bgp-peer model under /peer/effect-rib-in/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.

emptyRoutesContainer

@Nonnull
S emptyRoutesContainer()

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

Returns:

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

createRouteListKey

@Nonnull
I createRouteListKey(@Nonnull
                              long pathId,
                              @Nonnull
                              String routeKey)

Construct a Route List Key using new path Id for Families.

Parameters:

pathId - The path identifier

routeKey - RouteKey

Returns:

route list Key (RouteKey + pathId)