org.opendaylight.protocol.bgp.flowspec

Class AbstractFlowspecNlriParser

java.lang.Object

org.opendaylight.protocol.bgp.flowspec.AbstractFlowspecNlriParser

All Implemented Interfaces:

NlriParser, NlriSerializer

Direct Known Subclasses:

AbstractFlowspecL3vpnNlriParser, SimpleFlowspecIpv4NlriParser, SimpleFlowspecIpv6NlriParser

public abstract class AbstractFlowspecNlriParser
extends Object
implements NlriParser, NlriSerializer

Field Summary

Fields

Modifier and Type	Field and Description
static org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier	DEST_PREFIX_NID
protected SimpleFlowspecTypeRegistry	flowspecTypeRegistry
protected static int	LENGTH_MAGIC Add this constant to length value to achieve all ones in the leftmost nibble.
protected static int	MAX_NLRI_LENGTH
protected static int	MAX_NLRI_LENGTH_ONE_BYTE
static org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier	OP_NID
static org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier	SOURCE_PREFIX_NID
static org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier	VALUE_NID

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractFlowspecNlriParser(SimpleFlowspecTypeRegistry flowspecTypeRegistry)

Method Summary

Modifier and Type	Method and Description
abstract DestinationType	createAdvertizedRoutesDestinationType(Object[] nlriFields, PathId pathId) Create advertized destination type
abstract DestinationType	createWithdrawnDestinationType(Object[] nlriFields, PathId pathId) Create withdrawn destination type
List<Flowspec>	extractFlowspec(org.opendaylight.yangtools.yang.data.api.schema.DataContainerNode<?> route)
abstract void	extractSpecificFlowspec(org.opendaylight.yangtools.yang.data.api.schema.ChoiceNode fsType, FlowspecBuilder fsBuilder)
protected Object[]	parseNlri(io.netty.buffer.ByteBuf nlri) Override this function to parse additional NLRI fields
void	parseNlri(io.netty.buffer.ByteBuf nlri, MpReachNlriBuilder builder) Parse MP REACH NLRI from buffer.
void	parseNlri(io.netty.buffer.ByteBuf nlri, MpReachNlriBuilder builder, PeerSpecificParserConstraint constraint) Invokes NlriParser.parseNlri(ByteBuf, MpReachNlriBuilder), so the constraint is omitted.
void	parseNlri(io.netty.buffer.ByteBuf nlri, MpUnreachNlriBuilder builder) Parse MP UN_REACH NLRI from buffer.
void	parseNlri(io.netty.buffer.ByteBuf nlri, MpUnreachNlriBuilder builder, PeerSpecificParserConstraint constraint) Invokes NlriParser.parseNlri(ByteBuf, MpUnreachNlriBuilder), so the constraint is omitted.
protected List<Flowspec>	parseNlriFlowspecList(io.netty.buffer.ByteBuf nlri) Parses Flowspec NLRI into list of Flowspec.
static int	readNlriLength(io.netty.buffer.ByteBuf nlri)
protected static PathId	readPathId(io.netty.buffer.ByteBuf nlri, Class<? extends AddressFamily> afi, Class<? extends SubsequentAddressFamily> safi, PeerSpecificParserConstraint constraint)
void	serializeAttribute(org.opendaylight.yangtools.yang.binding.DataObject attribute, io.netty.buffer.ByteBuf byteAggregator)
protected abstract void	serializeMpReachNlri(DestinationType dstType, io.netty.buffer.ByteBuf byteAggregator)
protected abstract void	serializeMpUnreachNlri(DestinationType dstType, io.netty.buffer.ByteBuf byteAggregator)
protected void	serializeNlri(List<Flowspec> flowspecList, io.netty.buffer.ByteBuf buffer)
protected void	serializeNlri(Object[] nlriFields, io.netty.buffer.ByteBuf buffer)
protected void	serializeNlri(Object[] nlriFields, PathId pathId, io.netty.buffer.ByteBuf buffer) Serializes Flowspec NLRI to ByteBuf.
String	stringNlri(org.opendaylight.yangtools.yang.data.api.schema.DataContainerNode<?> flowspec)
protected String	stringNlri(List<Flowspec> flows)
protected abstract void	stringSpecificFSNlriType(FlowspecType value, StringBuilder buffer)

Methods inherited from class java.lang.Object

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

Field Detail

DEST_PREFIX_NID

public static final org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier DEST_PREFIX_NID

SOURCE_PREFIX_NID

public static final org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier SOURCE_PREFIX_NID

OP_NID

public static final org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier OP_NID

VALUE_NID

public static final org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier VALUE_NID

flowspecTypeRegistry

protected SimpleFlowspecTypeRegistry flowspecTypeRegistry

LENGTH_MAGIC

protected static final int LENGTH_MAGIC

Add this constant to length value to achieve all ones in the leftmost nibble.

See Also:

Constant Field Values

MAX_NLRI_LENGTH

protected static final int MAX_NLRI_LENGTH

See Also:

Constant Field Values

MAX_NLRI_LENGTH_ONE_BYTE

protected static final int MAX_NLRI_LENGTH_ONE_BYTE

See Also:

Constant Field Values

Constructor Detail

AbstractFlowspecNlriParser

protected AbstractFlowspecNlriParser(SimpleFlowspecTypeRegistry flowspecTypeRegistry)

Method Detail

serializeMpReachNlri

protected abstract void serializeMpReachNlri(DestinationType dstType,
                                             io.netty.buffer.ByteBuf byteAggregator)

serializeMpUnreachNlri

protected abstract void serializeMpUnreachNlri(DestinationType dstType,
                                               io.netty.buffer.ByteBuf byteAggregator)

extractSpecificFlowspec

public abstract void extractSpecificFlowspec(org.opendaylight.yangtools.yang.data.api.schema.ChoiceNode fsType,
                                             FlowspecBuilder fsBuilder)

stringSpecificFSNlriType

protected abstract void stringSpecificFSNlriType(FlowspecType value,
                                                 StringBuilder buffer)

createWithdrawnDestinationType

public abstract DestinationType createWithdrawnDestinationType(@Nonnull
                                                               Object[] nlriFields,
                                                               @Nullable
                                                               PathId pathId)

Create withdrawn destination type

Parameters:

nlriFields - a list of NLRI fields to be included in the destination type

pathId - associated path id with given NLRI

Returns:

created destination type

createAdvertizedRoutesDestinationType

public abstract DestinationType createAdvertizedRoutesDestinationType(@Nonnull
                                                                      Object[] nlriFields,
                                                                      @Nullable
                                                                      PathId pathId)

Create advertized destination type

Parameters:

nlriFields - a list of NLRI fields to be included in the destination type

pathId - associated path id with given NLRI

Returns:

created destination type

serializeAttribute

public final void serializeAttribute(org.opendaylight.yangtools.yang.binding.DataObject attribute,
                                     io.netty.buffer.ByteBuf byteAggregator)

Specified by:

serializeAttribute in interface NlriSerializer

parseNlri

public final void parseNlri(io.netty.buffer.ByteBuf nlri,
                            MpUnreachNlriBuilder builder)
                     throws BGPParsingException

Description copied from interface: NlriParser

Parse MP UN_REACH NLRI from buffer.

Specified by:

parseNlri in interface NlriParser

Parameters:

nlri - Encoded unreachabel NLRI in ByteBuf.

builder - MP UNREACH NLRI builder.

Throws:

BGPParsingException

parseNlri

public final void parseNlri(io.netty.buffer.ByteBuf nlri,
                            MpReachNlriBuilder builder)
                     throws BGPParsingException

Description copied from interface: NlriParser

Parse MP REACH NLRI from buffer.

Specified by:

parseNlri in interface NlriParser

Parameters:

nlri - Encoded reachable NLRI in ByteBuf.

builder - MP REACH NLRI builder.

Throws:

BGPParsingException

serializeNlri

protected void serializeNlri(@Nonnull
                             Object[] nlriFields,
                             @Nonnull
                             io.netty.buffer.ByteBuf buffer)

serializeNlri

protected final void serializeNlri(List<Flowspec> flowspecList,
                                   @Nonnull
                                   io.netty.buffer.ByteBuf buffer)

serializeNlri

protected final void serializeNlri(@Nonnull
                                   Object[] nlriFields,
                                   @Nullable
                                   PathId pathId,
                                   @Nonnull
                                   io.netty.buffer.ByteBuf buffer)

Serializes Flowspec NLRI to ByteBuf.

Parameters:

nlriFields - NLRI fields to be serialized

pathId -

buffer - where flowspec NLRI will be serialized

stringNlri

public String stringNlri(org.opendaylight.yangtools.yang.data.api.schema.DataContainerNode<?> flowspec)

extractFlowspec

public final List<Flowspec> extractFlowspec(org.opendaylight.yangtools.yang.data.api.schema.DataContainerNode<?> route)

stringNlri

protected final String stringNlri(List<Flowspec> flows)

readNlriLength

public static final int readNlriLength(@Nonnull
                                       io.netty.buffer.ByteBuf nlri)

parseNlriFlowspecList

protected final List<Flowspec> parseNlriFlowspecList(@Nonnull
                                                     io.netty.buffer.ByteBuf nlri)
                                              throws BGPParsingException

Parses Flowspec NLRI into list of Flowspec.

Parameters:

nlri - byte representation of NLRI which will be parsed

Returns:

list of Flowspec

Throws:

BGPParsingException

parseNlri

@Nonnull
protected Object[] parseNlri(@Nonnull
                                      io.netty.buffer.ByteBuf nlri)
                               throws BGPParsingException

Override this function to parse additional NLRI fields

Parameters:

nlri - NLRI buffer

Returns:

Parsed additional fields

Throws:

BGPParsingException

parseNlri

public final void parseNlri(@Nonnull
                            io.netty.buffer.ByteBuf nlri,
                            @Nonnull
                            MpReachNlriBuilder builder,
                            @Nullable
                            PeerSpecificParserConstraint constraint)
                     throws BGPParsingException

Description copied from interface: NlriParser

Invokes NlriParser.parseNlri(ByteBuf, MpReachNlriBuilder), so the constraint is omitted. Override for specific parser behavior.

Specified by:

parseNlri in interface NlriParser

Parameters:

nlri - Encoded reachable NLRI in ByteBuf.

builder - MP REACH NLRI builder.

constraint - Peer specific constraints.

Throws:

BGPParsingException

readPathId

@Nullable
protected static final PathId readPathId(@Nonnull
                                                   io.netty.buffer.ByteBuf nlri,
                                                   Class<? extends AddressFamily> afi,
                                                   Class<? extends SubsequentAddressFamily> safi,
                                                   PeerSpecificParserConstraint constraint)

parseNlri

public final void parseNlri(@Nonnull
                            io.netty.buffer.ByteBuf nlri,
                            @Nonnull
                            MpUnreachNlriBuilder builder,
                            @Nullable
                            PeerSpecificParserConstraint constraint)
                     throws BGPParsingException

Description copied from interface: NlriParser

Invokes NlriParser.parseNlri(ByteBuf, MpUnreachNlriBuilder), so the constraint is omitted. Override for specific parser behavior.

Specified by:

parseNlri in interface NlriParser

Parameters:

nlri - Encoded unreachable NLRI in ByteBuf.

builder - MP UNREACH NLRI builder.

constraint - Peer specific constraints.

Throws:

BGPParsingException