org.onosproject.pcepio.protocol.ver1

Class PcepTEObjectVer1

java.lang.Object

org.onosproject.pcepio.protocol.ver1.PcepTEObjectVer1

All Implemented Interfaces:

PcepTEObject

public class PcepTEObjectVer1
extends Object
implements PcepTEObject

Provides PCEP TE Object.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PcepTEObjectVer1.Builder Builder class for PCEP te object.

Field Summary

Fields

Modifier and Type	Field and Description
static byte	DEFAULT_PROTOCOL_ID
static boolean	DEFAULT_R_FLAG
static boolean	DEFAULT_S_FLAG
static int	DEFAULT_TE_ID
static PcepObjectHeader	DEFAULT_TE_OBJECT_HEADER
static int	FLAG_SET_R_FLAG
static int	FLAG_SET_S_FLAG
protected static org.slf4j.Logger	log
static int	MINIMUM_COMMON_HEADER_LENGTH
static int	MINIMUM_TLV_HEADER_LENGTH
static int	OBJECT_HEADER_LENGTH
static int	RIGHT_FIRST_FLAG
static int	RIGHT_SHIFT_ONE
static byte	TE_OBJ_CLASS
static short	TE_OBJ_MINIMUM_LENGTH
static byte	TE_OBJ_TYPE_LINK_VALUE
static byte	TE_OBJ_TYPE_NODE_VALUE
static byte	TE_OBJECT_VERSION

Constructor Summary

Constructors

Constructor and Description
PcepTEObjectVer1(PcepObjectHeader teObjHeader, byte yProtocolId, boolean bRFlag, boolean bSFlag, int iTEId, LinkedList<PcepValueType> llOptionalTlv) Constructor to initialize variables.

Method Summary

Modifier and Type	Method and Description
LinkedList<PcepValueType>	getOptionalTlv() Returns list of Optional Tlvs in TE Object.
byte	getProtocolId() Returns ProtocolId in TE Object.
boolean	getRFlag() Returns R flag in TE Object.
boolean	getSFlag() Returns S flag in TE Object.
int	getTEId() Returns TE ID in TE Object.
PcepObjectHeader	getTEObjHeader() Returns TE object header.
protected int	packOptionalTlv(org.jboss.netty.buffer.ChannelBuffer cb) Returns the writer index.
protected static LinkedList<PcepValueType>	parseOptionalTlv(org.jboss.netty.buffer.ChannelBuffer cb) Returns Linked list of PCEP Value Type.
static PcepTEObject	read(org.jboss.netty.buffer.ChannelBuffer cb) Reads from the channel buffer and returns Object of PcepTEObject.
void	setOptionalTlv(LinkedList<PcepValueType> llOptionalTlv) Sets list of Optional Tlvs in TE Object.
void	setProtocolId(byte yProtId) Sets ProtocolId in TE Object.
void	setRFlag(boolean bRFlag) Sets R flag in TE Object.
void	setSFlag(boolean bSFlag) Sets S flag in TE Object.
void	setTEId(int iTEId) Sets TE ID in TE Object.
void	setTEObjHeader(PcepObjectHeader obj) Sets TE Object header.
String	toString()
int	write(org.jboss.netty.buffer.ChannelBuffer cb) Writes the TE Object into channel buffer.

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static final org.slf4j.Logger log

TE_OBJ_TYPE_NODE_VALUE

public static final byte TE_OBJ_TYPE_NODE_VALUE

See Also:

Constant Field Values

TE_OBJ_TYPE_LINK_VALUE

public static final byte TE_OBJ_TYPE_LINK_VALUE

See Also:

Constant Field Values

TE_OBJ_CLASS

public static final byte TE_OBJ_CLASS

See Also:

Constant Field Values

TE_OBJECT_VERSION

public static final byte TE_OBJECT_VERSION

See Also:

Constant Field Values

TE_OBJ_MINIMUM_LENGTH

public static final short TE_OBJ_MINIMUM_LENGTH

See Also:

Constant Field Values

DEFAULT_PROTOCOL_ID

public static final byte DEFAULT_PROTOCOL_ID

See Also:

Constant Field Values

DEFAULT_R_FLAG

public static final boolean DEFAULT_R_FLAG

See Also:

Constant Field Values

DEFAULT_S_FLAG

public static final boolean DEFAULT_S_FLAG

See Also:

Constant Field Values

DEFAULT_TE_ID

public static final int DEFAULT_TE_ID

See Also:

Constant Field Values

OBJECT_HEADER_LENGTH

public static final int OBJECT_HEADER_LENGTH

See Also:

Constant Field Values

RIGHT_SHIFT_ONE

public static final int RIGHT_SHIFT_ONE

See Also:

Constant Field Values

RIGHT_FIRST_FLAG

public static final int RIGHT_FIRST_FLAG

See Also:

Constant Field Values

FLAG_SET_R_FLAG

public static final int FLAG_SET_R_FLAG

See Also:

Constant Field Values

FLAG_SET_S_FLAG

public static final int FLAG_SET_S_FLAG

See Also:

Constant Field Values

MINIMUM_COMMON_HEADER_LENGTH

public static final int MINIMUM_COMMON_HEADER_LENGTH

See Also:

Constant Field Values

MINIMUM_TLV_HEADER_LENGTH

public static final int MINIMUM_TLV_HEADER_LENGTH

See Also:

Constant Field Values

DEFAULT_TE_OBJECT_HEADER

public static final PcepObjectHeader DEFAULT_TE_OBJECT_HEADER

Constructor Detail

PcepTEObjectVer1

public PcepTEObjectVer1(PcepObjectHeader teObjHeader,
                        byte yProtocolId,
                        boolean bRFlag,
                        boolean bSFlag,
                        int iTEId,
                        LinkedList<PcepValueType> llOptionalTlv)

Constructor to initialize variables.

Parameters:

teObjHeader - TE Object header

yProtocolId - Protocol-ID

bRFlag - R-flag

bSFlag - S-flag

iTEId - TE-ID

llOptionalTlv - linked list of Optional TLV

Method Detail

getTEObjHeader

public PcepObjectHeader getTEObjHeader()

Description copied from interface: PcepTEObject

Returns TE object header.

Specified by:

getTEObjHeader in interface PcepTEObject

Returns:

TE object header

setTEObjHeader

public void setTEObjHeader(PcepObjectHeader obj)

Description copied from interface: PcepTEObject

Sets TE Object header.

Specified by:

setTEObjHeader in interface PcepTEObject

Parameters:

obj - TE Object header

getProtocolId

public byte getProtocolId()

Description copied from interface: PcepTEObject

Returns ProtocolId in TE Object.

Specified by:

getProtocolId in interface PcepTEObject

Returns:

ProtocolId in TE Object

setProtocolId

public void setProtocolId(byte yProtId)

Description copied from interface: PcepTEObject

Sets ProtocolId in TE Object.

Specified by:

setProtocolId in interface PcepTEObject

Parameters:

yProtId - ProtocolId in TE Object

getRFlag

public boolean getRFlag()

Description copied from interface: PcepTEObject

Returns R flag in TE Object.

Specified by:

getRFlag in interface PcepTEObject

Returns:

R flag in TE Object

setRFlag

public void setRFlag(boolean bRFlag)

Description copied from interface: PcepTEObject

Sets R flag in TE Object.

Specified by:

setRFlag in interface PcepTEObject

Parameters:

bRFlag - R flag in TE Object

getSFlag

public boolean getSFlag()

Description copied from interface: PcepTEObject

Returns S flag in TE Object.

Specified by:

getSFlag in interface PcepTEObject

Returns:

S flag in TE Object

setSFlag

public void setSFlag(boolean bSFlag)

Description copied from interface: PcepTEObject

Sets S flag in TE Object.

Specified by:

setSFlag in interface PcepTEObject

Parameters:

bSFlag - S flag in TE Object

getTEId

public int getTEId()

Description copied from interface: PcepTEObject

Returns TE ID in TE Object.

Specified by:

getTEId in interface PcepTEObject

Returns:

TE ID in TE Object

setTEId

public void setTEId(int iTEId)

Description copied from interface: PcepTEObject

Sets TE ID in TE Object.

Specified by:

setTEId in interface PcepTEObject

Parameters:

iTEId - TE ID in TE Object

getOptionalTlv

public LinkedList<PcepValueType> getOptionalTlv()

Description copied from interface: PcepTEObject

Returns list of Optional Tlvs in TE Object.

Specified by:

getOptionalTlv in interface PcepTEObject

Returns:

list of Optional Tlvs

setOptionalTlv

public void setOptionalTlv(LinkedList<PcepValueType> llOptionalTlv)

Description copied from interface: PcepTEObject

Sets list of Optional Tlvs in TE Object.

Specified by:

setOptionalTlv in interface PcepTEObject

Parameters:

llOptionalTlv - list of Optional Tlvs

read

public static PcepTEObject read(org.jboss.netty.buffer.ChannelBuffer cb)
                         throws PcepParseException

Reads from the channel buffer and returns Object of PcepTEObject.

Parameters:

cb - of type channel buffer

Returns:

Object of PcepTEObject

Throws:

PcepParseException - if mandatory fields are missing

write

public int write(org.jboss.netty.buffer.ChannelBuffer cb)
          throws PcepParseException

Description copied from interface: PcepTEObject

Writes the TE Object into channel buffer.

Specified by:

write in interface PcepTEObject

Parameters:

cb - channel buffer

Returns:

Returns the writerIndex of this buffer

Throws:

PcepParseException - when obj header is not written to channel buffer

parseOptionalTlv

protected static LinkedList<PcepValueType> parseOptionalTlv(org.jboss.netty.buffer.ChannelBuffer cb)
                                                     throws PcepParseException

Returns Linked list of PCEP Value Type.

Parameters:

cb - of channel buffer

Returns:

Linked list of PCEP Value Type

Throws:

PcepParseException - if mandatory fields are missing

packOptionalTlv

protected int packOptionalTlv(org.jboss.netty.buffer.ChannelBuffer cb)

Returns the writer index.

Parameters:

cb - of type channel buffer

Returns:

the writer index.

toString

public String toString()

Overrides:

toString in class Object