org.opendaylight.protocol.bgp.l3vpn

Class AbstractVpnRIBSupport

java.lang.Object

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

org.opendaylight.protocol.bgp.l3vpn.AbstractVpnRIBSupport

All Implemented Interfaces:

RIBSupport

public abstract class AbstractVpnRIBSupport
extends AbstractRIBSupport

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	AbstractVpnRIBSupport(Class<? extends Routes> cazeClass, Class<? extends org.opendaylight.yangtools.yang.binding.DataObject> containerClass, Class<? extends Route> listClass, Class<? extends AddressFamily> afiClass, org.opendaylight.yangtools.yang.common.QName vpnDstContainerClassQname) Default constructor.

Method Summary

Modifier and Type	Method and Description
protected DestinationType	buildDestination(Collection<org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode> routes)
protected DestinationType	buildWithdrawnDestination(Collection<org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode> routes)
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()
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.
default Long	extractPathId(org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?> normalizedNode) Extract PathId from route change received.
protected abstract org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix	extractPrefix(org.opendaylight.yangtools.yang.data.api.schema.DataContainerNode<? extends org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument> route, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier prefixTypeNid)
protected abstract DestinationType	getAdvertisedDestinationType(List<VpnDestination> dests)
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.
protected abstract DestinationType	getWithdrawnDestinationType(List<VpnDestination> dests)
boolean	isComplexRoute() Indicate whether this AFI/SAFI combination is a complex route.
protected 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 function)

Methods inherited from class org.opendaylight.protocol.bgp.rib.spi.AbstractRIBSupport

buildUpdate, changedRoutes, deleteRoutes, deleteRoutes, emptyRoutes, getAfi, getSafi, putRoutes, putRoutes, routeAttributesIdentifier, routeNid, routePath, routeQName, routesCaseClass, routesContainerClass, routesContainerIdentifier, routesListClass

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractVpnRIBSupport

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

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;

Method Detail

extractPrefix

protected abstract org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix extractPrefix(org.opendaylight.yangtools.yang.data.api.schema.DataContainerNode<? extends org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument> route,
                                                                                                                             org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier prefixTypeNid)

getAdvertisedDestinationType

protected abstract DestinationType getAdvertisedDestinationType(List<VpnDestination> dests)

getWithdrawnDestinationType

protected abstract DestinationType getWithdrawnDestinationType(List<VpnDestination> dests)

buildDestination

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

Specified by:

buildDestination in class AbstractRIBSupport

buildWithdrawnDestination

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

Specified by:

buildWithdrawnDestination in class AbstractRIBSupport

cacheableAttributeObjects

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

cacheableNlriObjects

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

isComplexRoute

public boolean isComplexRoute()

Description copied from interface: RIBSupport

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.

processDestination

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

Specified by:

processDestination in class AbstractRIBSupport

extractPathId

public Long extractPathId(@Nonnull
                          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,
                                                                                                                @Nonnull
                                                                                                                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

@Nonnull
public org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument createRouteKeyPathArgument(@Nonnull
                                                                                                                        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