org.onosproject.bgpio.types.attr

Class WideCommunity

java.lang.Object

org.onosproject.bgpio.types.attr.WideCommunity

All Implemented Interfaces:

BgpValueType

public class WideCommunity
extends Object
implements BgpValueType

Provides implementation of wide community path attribute.

Field Summary

Fields

Modifier and Type	Field and Description
static byte	FLAGS
static short	LENGTH
static byte	TYPE
static byte	TYPE_LENGTH_SIZE

Constructor Summary

Constructors

Constructor and Description
WideCommunity(WideCommunityAttrHeader wideCommunityHeader, int community, int localAsn, int contextAsn, WideCommunityTarget target, WideCommunityExcludeTarget excludeTarget, WideCommunityParameter parameter) Creates an instance of wide community.

Method Summary

Modifier and Type	Method and Description
int	community() Returns wide community value.
int	compareTo(Object o) Compares two objects.
int	contextAsn() Returns wide community context autonomous number.
static List<BgpValueType>	decodeWideCommunityTlv(org.jboss.netty.buffer.ChannelBuffer c) Decode wide community target(s).
static void	encodeWideCommunityTlv(org.jboss.netty.buffer.ChannelBuffer c, List<BgpValueType> targetTlv) Encode wide community target(s).
boolean	equals(Object obj)
WideCommunityExcludeTarget	excludeTarget() Returns wide community exclude target.
short	getType() Returns the Type of BGP Message.
int	hashCode()
int	localAsn() Returns wide community local autonomous number.
static WideCommunity	of(WideCommunityAttrHeader wideCommunityHeader, int community, int localAsn, int contextAsn, WideCommunityTarget target, WideCommunityExcludeTarget excludeTarget, WideCommunityParameter parameter) Returns object of this class with specified values.
WideCommunityParameter	parameter() Returns wide community parameter.
static WideCommunity	read(org.jboss.netty.buffer.ChannelBuffer c) Reads the wide community attribute.
void	setCommunity(int community) Sets wide community value.
void	setContextAsn(int contextAsn) Sets wide community context autonomous number.
void	setExcludeTarget(WideCommunityExcludeTarget excludeTarget) Sets wide community exclude target.
void	setLocalAsn(int localAsn) Sets wide community local autonomous number.
void	setParameter(WideCommunityParameter parameter) Sets wide community parameter.
void	setTarget(WideCommunityTarget target) Sets wide community target.
WideCommunityTarget	target() Returns wide community target.
String	toString()
int	write(org.jboss.netty.buffer.ChannelBuffer c) Writes the byte Stream of BGP Message to channel buffer.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

TYPE

public static final byte TYPE

See Also:

Constant Field Values

LENGTH

public static final short LENGTH

See Also:

Constant Field Values

TYPE_LENGTH_SIZE

public static final byte TYPE_LENGTH_SIZE

See Also:

Constant Field Values

FLAGS

public static final byte FLAGS

See Also:

Constant Field Values

Constructor Detail

WideCommunity

public WideCommunity(WideCommunityAttrHeader wideCommunityHeader,
                     int community,
                     int localAsn,
                     int contextAsn,
                     WideCommunityTarget target,
                     WideCommunityExcludeTarget excludeTarget,
                     WideCommunityParameter parameter)

Creates an instance of wide community.

Parameters:

wideCommunityHeader - wide community header

community - wide community

localAsn - local ASN number

contextAsn - context ASN number

target - wide community include target

excludeTarget - wide community exclude target

parameter - wide community parameter

Method Detail

of

public static WideCommunity of(WideCommunityAttrHeader wideCommunityHeader,
                               int community,
                               int localAsn,
                               int contextAsn,
                               WideCommunityTarget target,
                               WideCommunityExcludeTarget excludeTarget,
                               WideCommunityParameter parameter)

Returns object of this class with specified values.

Parameters:

wideCommunityHeader - community header

community - wide community

localAsn - local ASN number

contextAsn - context ASN number

target - wide community include target

excludeTarget - wide community exclude target

parameter - wide community parameter

Returns:

object of WideCommunityAttr

community

public int community()

Returns wide community value.

Returns:

wide community value

setCommunity

public void setCommunity(int community)

Sets wide community value.

Parameters:

community - wide community value

localAsn

public int localAsn()

Returns wide community local autonomous number.

Returns:

local autonomous number

setLocalAsn

public void setLocalAsn(int localAsn)

Sets wide community local autonomous number.

Parameters:

localAsn - local autonomous number

contextAsn

public int contextAsn()

Returns wide community context autonomous number.

Returns:

contest autonomous number

setContextAsn

public void setContextAsn(int contextAsn)

Sets wide community context autonomous number.

Parameters:

contextAsn - context autonomous number

target

public WideCommunityTarget target()

Returns wide community target.

Returns:

wide community target

setTarget

public void setTarget(WideCommunityTarget target)

Sets wide community target.

Parameters:

target - wide community target

excludeTarget

public WideCommunityExcludeTarget excludeTarget()

Returns wide community exclude target.

Returns:

wide community exclude target

setExcludeTarget

public void setExcludeTarget(WideCommunityExcludeTarget excludeTarget)

Sets wide community exclude target.

Parameters:

excludeTarget - wide community texclude arget

parameter

public WideCommunityParameter parameter()

Returns wide community parameter.

Returns:

wide community parameter

setParameter

public void setParameter(WideCommunityParameter parameter)

Sets wide community parameter.

Parameters:

parameter - wide community parameter

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

write

public int write(org.jboss.netty.buffer.ChannelBuffer c)

Description copied from interface: BgpValueType

Writes the byte Stream of BGP Message to channel buffer.

Specified by:

write in interface BgpValueType

Parameters:

c - channel buffer

Returns:

length written to channel buffer

read

public static WideCommunity read(org.jboss.netty.buffer.ChannelBuffer c)
                          throws BgpParseException

Reads the wide community attribute.

Parameters:

c - ChannelBuffer

Returns:

object of WideCommunityAttr

Throws:

BgpParseException - while parsing BgpPrefixAttrRouteTag

encodeWideCommunityTlv

public static void encodeWideCommunityTlv(org.jboss.netty.buffer.ChannelBuffer c,
                                          List<BgpValueType> targetTlv)

Encode wide community target(s).

Parameters:

c - channel buffer

targetTlv - wide community include/exclude target

decodeWideCommunityTlv

public static List<BgpValueType> decodeWideCommunityTlv(org.jboss.netty.buffer.ChannelBuffer c)
                                                 throws BgpParseException

Decode wide community target(s).

Parameters:

c - channel buffer

Returns:

target list

Throws:

BgpParseException - on decode error

getType

public short getType()

Description copied from interface: BgpValueType

Returns the Type of BGP Message.

Specified by:

getType in interface BgpValueType

Returns:

short value of type

compareTo

public int compareTo(Object o)

Description copied from interface: BgpValueType

Compares two objects.

Specified by:

compareTo in interface BgpValueType

Parameters:

o - object

Returns:

result after comparing two objects

toString

public String toString()

Overrides:

toString in class Object