org.onosproject.pcepio.protocol.ver1

Class PcepRPObjectVer1

java.lang.Object

org.onosproject.pcepio.protocol.ver1.PcepRPObjectVer1

All Implemented Interfaces:

PcepRPObject

public class PcepRPObjectVer1
extends Object
implements PcepRPObject

Provides PCEP RP object.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PcepRPObjectVer1.Builder Builder class for PCEP rp object.

Field Summary

Fields

Modifier and Type	Field and Description
static int	BFLAG_SHIFT_VALUE
static int	BFLAG_TEMP_SHIFT_VALUE
static int	BIT_RESET
static int	BIT_SET
static boolean	DEFAULT_BFLAG
static boolean	DEFAULT_OFLAG
static byte	DEFAULT_PRIFLAG
static int	DEFAULT_REQUEST_ID_NUM
static boolean	DEFAULT_RFLAG
static PcepObjectHeader	DEFAULT_RP_OBJECT_HEADER
protected static org.slf4j.Logger	log
static int	MINIMUM_COMMON_HEADER_LENGTH
static int	OBJECT_HEADER_LENGTH
static int	OFLAG_SHIFT_VALUE
static int	OFLAG_TEMP_SHIFT_VALUE
static int	PRIFLAG_TEMP_SHIFT_VALUE
static int	RFLAG_SHIFT_VALUE
static int	RFLAG_TEMP_SHIFT_VALUE
static byte	RP_OBJ_CLASS
static short	RP_OBJ_MINIMUM_LENGTH
static byte	RP_OBJ_TYPE
static byte	RP_OBJECT_VERSION

Constructor Summary

Constructors

Constructor and Description
PcepRPObjectVer1(PcepObjectHeader rpObjHeader, int iRequestIdNum, boolean bOFlag, boolean bBFlag, boolean bRFlag, byte yPriFlag, LinkedList<PcepValueType> llOptionalTlv) Constructor to initialize variables.

Method Summary

Modifier and Type	Method and Description
boolean	getBFlag() Returns B flag in RP Object.
boolean	getOFlag() Returns O flag in RP Object.
LinkedList<PcepValueType>	getOptionalTlv() Returns list of Optional Tlvs in RP Object.
byte	getPriFlag() Returns Priority Flag in RP Object.
int	getRequestIdNum() Returns RequestId Number in RP Object.
boolean	getRFlag() Returns R flag in RP Object.
PcepObjectHeader	getRPObjHeader() Returns RP Object header.
protected int	packOptionalTlv(org.jboss.netty.buffer.ChannelBuffer cb) Returns optional tlvs.
protected static LinkedList<PcepValueType>	parseOptionalTlv(org.jboss.netty.buffer.ChannelBuffer cb) Returns list of optional tlvs.
static PcepRPObject	read(org.jboss.netty.buffer.ChannelBuffer cb) Reads the channel buffer and returns the object of PcepRPObject.
void	setBFlag(boolean bBFlag) Sets B flag with specified value.
void	setOFlag(boolean bOFlag) Sets O flag with specified value.
void	setOptionalTlv(LinkedList<PcepValueType> llOptionalTlv) Sets list of Optional Tlvs in RP Object and returns its builder.
void	setPriFlag(byte yPriFlag) Sets Priority Flag with specified value.
void	setRequestIdNum(int iRequestIdNum) Sets RequestId Number with specified value.
void	setRFlag(boolean bRFlag) Sets R flag with specified value.
void	setRPObjHeader(PcepObjectHeader obj) Sets RP Object header.
String	toString()
int	write(org.jboss.netty.buffer.ChannelBuffer cb) Writes the RP 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

RP_OBJ_TYPE

public static final byte RP_OBJ_TYPE

See Also:

Constant Field Values

RP_OBJ_CLASS

public static final byte RP_OBJ_CLASS

See Also:

Constant Field Values

RP_OBJECT_VERSION

public static final byte RP_OBJECT_VERSION

See Also:

Constant Field Values

RP_OBJ_MINIMUM_LENGTH

public static final short RP_OBJ_MINIMUM_LENGTH

See Also:

Constant Field Values

DEFAULT_REQUEST_ID_NUM

public static final int DEFAULT_REQUEST_ID_NUM

See Also:

Constant Field Values

DEFAULT_OFLAG

public static final boolean DEFAULT_OFLAG

See Also:

Constant Field Values

DEFAULT_BFLAG

public static final boolean DEFAULT_BFLAG

See Also:

Constant Field Values

DEFAULT_RFLAG

public static final boolean DEFAULT_RFLAG

See Also:

Constant Field Values

DEFAULT_PRIFLAG

public static final byte DEFAULT_PRIFLAG

See Also:

Constant Field Values

OBJECT_HEADER_LENGTH

public static final int OBJECT_HEADER_LENGTH

See Also:

Constant Field Values

OFLAG_SHIFT_VALUE

public static final int OFLAG_SHIFT_VALUE

See Also:

Constant Field Values

BFLAG_SHIFT_VALUE

public static final int BFLAG_SHIFT_VALUE

See Also:

Constant Field Values

RFLAG_SHIFT_VALUE

public static final int RFLAG_SHIFT_VALUE

See Also:

Constant Field Values

OFLAG_TEMP_SHIFT_VALUE

public static final int OFLAG_TEMP_SHIFT_VALUE

See Also:

Constant Field Values

BFLAG_TEMP_SHIFT_VALUE

public static final int BFLAG_TEMP_SHIFT_VALUE

See Also:

Constant Field Values

RFLAG_TEMP_SHIFT_VALUE

public static final int RFLAG_TEMP_SHIFT_VALUE

See Also:

Constant Field Values

PRIFLAG_TEMP_SHIFT_VALUE

public static final int PRIFLAG_TEMP_SHIFT_VALUE

See Also:

Constant Field Values

BIT_SET

public static final int BIT_SET

See Also:

Constant Field Values

BIT_RESET

public static final int BIT_RESET

See Also:

Constant Field Values

MINIMUM_COMMON_HEADER_LENGTH

public static final int MINIMUM_COMMON_HEADER_LENGTH

See Also:

Constant Field Values

DEFAULT_RP_OBJECT_HEADER

public static final PcepObjectHeader DEFAULT_RP_OBJECT_HEADER

Constructor Detail

PcepRPObjectVer1

public PcepRPObjectVer1(PcepObjectHeader rpObjHeader,
                        int iRequestIdNum,
                        boolean bOFlag,
                        boolean bBFlag,
                        boolean bRFlag,
                        byte yPriFlag,
                        LinkedList<PcepValueType> llOptionalTlv)

Constructor to initialize variables.

Parameters:

rpObjHeader - RP-OBJECT header

iRequestIdNum - Request-ID-number

bOFlag - O-flag

bBFlag - B-flag

bRFlag - R-flag

yPriFlag - Pri-flag

llOptionalTlv - linked list of Optional TLV

Method Detail

setRPObjHeader

public void setRPObjHeader(PcepObjectHeader obj)

Sets RP Object header.

Parameters:

obj - RP Object header

setRequestIdNum

public void setRequestIdNum(int iRequestIdNum)

Description copied from interface: PcepRPObject

Sets RequestId Number with specified value.

Specified by:

setRequestIdNum in interface PcepRPObject

Parameters:

iRequestIdNum - RequestId Number

setOFlag

public void setOFlag(boolean bOFlag)

Description copied from interface: PcepRPObject

Sets O flag with specified value.

Specified by:

setOFlag in interface PcepRPObject

Parameters:

bOFlag - O flag

setBFlag

public void setBFlag(boolean bBFlag)

Description copied from interface: PcepRPObject

Sets B flag with specified value.

Specified by:

setBFlag in interface PcepRPObject

Parameters:

bBFlag - B flag

setRFlag

public void setRFlag(boolean bRFlag)

Description copied from interface: PcepRPObject

Sets R flag with specified value.

Specified by:

setRFlag in interface PcepRPObject

Parameters:

bRFlag - R flag

setPriFlag

public void setPriFlag(byte yPriFlag)

Description copied from interface: PcepRPObject

Sets Priority Flag with specified value.

Specified by:

setPriFlag in interface PcepRPObject

Parameters:

yPriFlag - Priority Flag

getRPObjHeader

public PcepObjectHeader getRPObjHeader()

Returns RP Object header.

Returns:

rpObjHeader

getRequestIdNum

public int getRequestIdNum()

Description copied from interface: PcepRPObject

Returns RequestId Number in RP Object.

Specified by:

getRequestIdNum in interface PcepRPObject

Returns:

RequestId Number in RP Object

getOFlag

public boolean getOFlag()

Description copied from interface: PcepRPObject

Returns O flag in RP Object.

Specified by:

getOFlag in interface PcepRPObject

Returns:

O flag in RP Object

getBFlag

public boolean getBFlag()

Description copied from interface: PcepRPObject

Returns B flag in RP Object.

Specified by:

getBFlag in interface PcepRPObject

Returns:

B flag in RP Object

getRFlag

public boolean getRFlag()

Description copied from interface: PcepRPObject

Returns R flag in RP Object.

Specified by:

getRFlag in interface PcepRPObject

Returns:

R flag in RP Object

getPriFlag

public byte getPriFlag()

Description copied from interface: PcepRPObject

Returns Priority Flag in RP Object.

Specified by:

getPriFlag in interface PcepRPObject

Returns:

Priority Flag in RP Object

read

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

Reads the channel buffer and returns the object of PcepRPObject.

Parameters:

cb - of type channel buffer

Returns:

the object of PcepRPObject

Throws:

PcepParseException - if mandatory fields are missing

write

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

Description copied from interface: PcepRPObject

Writes the RP Object into channel buffer.

Specified by:

write in interface PcepRPObject

Parameters:

cb - channel buffer

Returns:

Returns the writerIndex of this buffer

Throws:

PcepParseException - while writing RP object into Channel Buffer.

parseOptionalTlv

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

Returns list of optional tlvs.

Parameters:

cb - of type channel buffer.

Returns:

llOutOptionalTlv linked list of Optional TLV

Throws:

PcepParseException - if mandatory fields are missing

packOptionalTlv

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

Returns optional tlvs.

Parameters:

cb - of type channel buffer

Returns:

llOptionalTlv linked list of Optional TLV

getOptionalTlv

public LinkedList<PcepValueType> getOptionalTlv()

Description copied from interface: PcepRPObject

Returns list of Optional Tlvs in RP Object.

Specified by:

getOptionalTlv in interface PcepRPObject

Returns:

list of Optional Tlvs in RP Object

setOptionalTlv

public void setOptionalTlv(LinkedList<PcepValueType> llOptionalTlv)

Description copied from interface: PcepRPObject

Sets list of Optional Tlvs in RP Object and returns its builder.

Specified by:

setOptionalTlv in interface PcepRPObject

Parameters:

llOptionalTlv - list of Optional Tlvs

toString

public String toString()

Overrides:

toString in class Object