org.onosproject.pcepio.protocol.ver1

Class PcepLspObjectVer1

java.lang.Object

org.onosproject.pcepio.protocol.ver1.PcepLspObjectVer1

All Implemented Interfaces:

PcepLspObject

public class PcepLspObjectVer1
extends Object
implements PcepLspObject

Provides PCEP lsp object.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PcepLspObjectVer1.Builder Builder class for PCEP lsp Object.

Field Summary

Fields

Modifier and Type	Field and Description
static int	AFLAG_SHIFT_VALUE
static int	AFLAG_TEMP_SHIFT_VALUE
static int	BIT_RESET
static int	BIT_SET
static int	CFLAG_SHIFT_VALUE
static int	CFLAG_TEMP_SHIFT_VALUE
static boolean	DEFAULT_AFLAG
static boolean	DEFAULT_CFLAG
static boolean	DEFAULT_DFLAG
static byte	DEFAULT_OFLAG
static int	DEFAULT_PLSPID
static boolean	DEFAULT_RFLAG
static boolean	DEFAULT_SFLAG
static int	DFLAG_TEMP_SHIFT_VALUE
protected static org.slf4j.Logger	log
static byte	LSP_OBJ_CLASS
static short	LSP_OBJ_MINIMUM_LENGTH
static byte	LSP_OBJ_TYPE
static byte	LSP_OBJECT_VERSION
static int	MINIMUM_COMMON_HEADER_LENGTH
static int	OBJECT_HEADER_LENGTH
static int	OFLAG_SHIFT_VALUE
static int	OFLAG_TEMP_SHIFT_VALUE
static int	PLSPID_SHIFT_VALUE
static int	PLSPID_TEMP_SHIFT_VALUE
static int	RFLAG_SHIFT_VALUE
static int	RFLAG_TEMP_SHIFT_VALUE
static int	SFLAG_SHIFT_VALUE
static int	SFLAG_TEMP_SHIFT_VALUE

Constructor Summary

Constructors

Constructor and Description
PcepLspObjectVer1(PcepObjectHeader lspObjHeader, int iPlspId, byte yOFlag, boolean bAFlag, boolean bRFlag, boolean bSFlag, boolean bDFlag, boolean bCFlag, LinkedList<PcepValueType> llOptionalTlv) Constructor to initialize all the member variables.

Method Summary

Modifier and Type	Method and Description
boolean	getAFlag() Returns A flag in LSP Object.
boolean	getCFlag() Returns C flag in LSP Object.
boolean	getDFlag() Returns D flag in LSP Object.
PcepObjectHeader	getLspObjHeader() Returns lsp object header.
byte	getOFlag() Returns O flag in LSP Object.
LinkedList<PcepValueType>	getOptionalTlv() Returns list of Optional Tlvs in LSP Object.
int	getPlspId() Returns PlspId of LSP Object.
boolean	getRFlag() Returns R flag in LSP Object.
boolean	getSFlag() Returns S flag in LSP Object.
protected int	packOptionalTlv(org.jboss.netty.buffer.ChannelBuffer cb) returns writer index.
protected static LinkedList<PcepValueType>	parseOptionalTlv(org.jboss.netty.buffer.ChannelBuffer cb) Returns Linked list of optional tlvs.
static PcepLspObject	read(org.jboss.netty.buffer.ChannelBuffer cb) Parse channel buffer and returns object of PcepLspObject.
void	setAFlag(boolean bAFlag) Sets A flag with specified value.
void	setCFlag(boolean bCFlag) Sets C flag with specified value.
void	setDFlag(boolean bDFlag) Sets D flag with specified value.
void	setLspObjHeader(PcepObjectHeader obj) Sets lsp Object Header.
void	setOFlag(byte yOFlag) Sets O flag with specified value.
void	setOptionalTlv(LinkedList<PcepValueType> llOptionalTlv) Sets list of Optional Tlvs in LSP Object.
void	setPlspId(int iPlspId) Sets PlspId with specified value.
void	setRFlag(boolean bRFlag) Sets R flag with specified value.
void	setSFlag(boolean bSFlag) Sets S flag with specified value.
String	toString()
int	write(org.jboss.netty.buffer.ChannelBuffer cb) Writes the LSP 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

LSP_OBJ_TYPE

public static final byte LSP_OBJ_TYPE

See Also:

Constant Field Values

LSP_OBJ_CLASS

public static final byte LSP_OBJ_CLASS

See Also:

Constant Field Values

LSP_OBJECT_VERSION

public static final byte LSP_OBJECT_VERSION

See Also:

Constant Field Values

LSP_OBJ_MINIMUM_LENGTH

public static final short LSP_OBJ_MINIMUM_LENGTH

See Also:

Constant Field Values

DEFAULT_PLSPID

public static final int DEFAULT_PLSPID

See Also:

Constant Field Values

DEFAULT_OFLAG

public static final byte DEFAULT_OFLAG

See Also:

Constant Field Values

DEFAULT_AFLAG

public static final boolean DEFAULT_AFLAG

See Also:

Constant Field Values

DEFAULT_RFLAG

public static final boolean DEFAULT_RFLAG

See Also:

Constant Field Values

DEFAULT_SFLAG

public static final boolean DEFAULT_SFLAG

See Also:

Constant Field Values

DEFAULT_DFLAG

public static final boolean DEFAULT_DFLAG

See Also:

Constant Field Values

DEFAULT_CFLAG

public static final boolean DEFAULT_CFLAG

See Also:

Constant Field Values

OBJECT_HEADER_LENGTH

public static final int OBJECT_HEADER_LENGTH

See Also:

Constant Field Values

PLSPID_SHIFT_VALUE

public static final int PLSPID_SHIFT_VALUE

See Also:

Constant Field Values

CFLAG_SHIFT_VALUE

public static final int CFLAG_SHIFT_VALUE

See Also:

Constant Field Values

OFLAG_SHIFT_VALUE

public static final int OFLAG_SHIFT_VALUE

See Also:

Constant Field Values

AFLAG_SHIFT_VALUE

public static final int AFLAG_SHIFT_VALUE

See Also:

Constant Field Values

RFLAG_SHIFT_VALUE

public static final int RFLAG_SHIFT_VALUE

See Also:

Constant Field Values

SFLAG_SHIFT_VALUE

public static final int SFLAG_SHIFT_VALUE

See Also:

Constant Field Values

PLSPID_TEMP_SHIFT_VALUE

public static final int PLSPID_TEMP_SHIFT_VALUE

See Also:

Constant Field Values

CFLAG_TEMP_SHIFT_VALUE

public static final int CFLAG_TEMP_SHIFT_VALUE

See Also:

Constant Field Values

OFLAG_TEMP_SHIFT_VALUE

public static final int OFLAG_TEMP_SHIFT_VALUE

See Also:

Constant Field Values

AFLAG_TEMP_SHIFT_VALUE

public static final int AFLAG_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

SFLAG_TEMP_SHIFT_VALUE

public static final int SFLAG_TEMP_SHIFT_VALUE

See Also:

Constant Field Values

DFLAG_TEMP_SHIFT_VALUE

public static final int DFLAG_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

Constructor Detail

PcepLspObjectVer1

public PcepLspObjectVer1(PcepObjectHeader lspObjHeader,
                         int iPlspId,
                         byte yOFlag,
                         boolean bAFlag,
                         boolean bRFlag,
                         boolean bSFlag,
                         boolean bDFlag,
                         boolean bCFlag,
                         LinkedList<PcepValueType> llOptionalTlv)

Constructor to initialize all the member variables.

Parameters:

lspObjHeader - lsp object header

iPlspId - plsp id

yOFlag - O flag

bAFlag - A flag

bRFlag - R flag

bSFlag - S flag

bDFlag - D flag

bCFlag - C flag

llOptionalTlv - list of optional tlv

Method Detail

setLspObjHeader

public void setLspObjHeader(PcepObjectHeader obj)

Sets lsp Object Header.

Parameters:

obj - lsp object header

setPlspId

public void setPlspId(int iPlspId)

Description copied from interface: PcepLspObject

Sets PlspId with specified value.

Specified by:

setPlspId in interface PcepLspObject

Parameters:

iPlspId - PlspId

setCFlag

public void setCFlag(boolean bCFlag)

Description copied from interface: PcepLspObject

Sets C flag with specified value.

Specified by:

setCFlag in interface PcepLspObject

Parameters:

bCFlag - C flag

setOFlag

public void setOFlag(byte yOFlag)

Description copied from interface: PcepLspObject

Sets O flag with specified value.

Specified by:

setOFlag in interface PcepLspObject

Parameters:

yOFlag - O flag

setAFlag

public void setAFlag(boolean bAFlag)

Description copied from interface: PcepLspObject

Sets A flag with specified value.

Specified by:

setAFlag in interface PcepLspObject

Parameters:

bAFlag - A flag

setRFlag

public void setRFlag(boolean bRFlag)

Description copied from interface: PcepLspObject

Sets R flag with specified value.

Specified by:

setRFlag in interface PcepLspObject

Parameters:

bRFlag - R flag

setSFlag

public void setSFlag(boolean bSFlag)

Description copied from interface: PcepLspObject

Sets S flag with specified value.

Specified by:

setSFlag in interface PcepLspObject

Parameters:

bSFlag - S flag

setDFlag

public void setDFlag(boolean bDFlag)

Description copied from interface: PcepLspObject

Sets D flag with specified value.

Specified by:

setDFlag in interface PcepLspObject

Parameters:

bDFlag - D flag

getLspObjHeader

public PcepObjectHeader getLspObjHeader()

Returns lsp object header.

Returns:

lspObjHeader

getPlspId

public int getPlspId()

Description copied from interface: PcepLspObject

Returns PlspId of LSP Object.

Specified by:

getPlspId in interface PcepLspObject

Returns:

PlspId of LSP Object

getCFlag

public boolean getCFlag()

Description copied from interface: PcepLspObject

Returns C flag in LSP Object.

Specified by:

getCFlag in interface PcepLspObject

Returns:

C flag in LSP Object

getOFlag

public byte getOFlag()

Description copied from interface: PcepLspObject

Returns O flag in LSP Object.

Specified by:

getOFlag in interface PcepLspObject

Returns:

O flag in LSP Object

getAFlag

public boolean getAFlag()

Description copied from interface: PcepLspObject

Returns A flag in LSP Object.

Specified by:

getAFlag in interface PcepLspObject

Returns:

A flag in LSP Object

getRFlag

public boolean getRFlag()

Description copied from interface: PcepLspObject

Returns R flag in LSP Object.

Specified by:

getRFlag in interface PcepLspObject

Returns:

R flag in LSP Object

getSFlag

public boolean getSFlag()

Description copied from interface: PcepLspObject

Returns S flag in LSP Object.

Specified by:

getSFlag in interface PcepLspObject

Returns:

S flag in LSP Object

getDFlag

public boolean getDFlag()

Description copied from interface: PcepLspObject

Returns D flag in LSP Object.

Specified by:

getDFlag in interface PcepLspObject

Returns:

D flag in LSP Object

getOptionalTlv

public LinkedList<PcepValueType> getOptionalTlv()

Description copied from interface: PcepLspObject

Returns list of Optional Tlvs in LSP Object.

Specified by:

getOptionalTlv in interface PcepLspObject

Returns:

list of Optional Tlvs

setOptionalTlv

public void setOptionalTlv(LinkedList<PcepValueType> llOptionalTlv)

Description copied from interface: PcepLspObject

Sets list of Optional Tlvs in LSP Object.

Specified by:

setOptionalTlv in interface PcepLspObject

Parameters:

llOptionalTlv - list of Optional Tlvs

read

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

Parse channel buffer and returns object of PcepLspObject.

Parameters:

cb - of type channel buffer

Returns:

object of PcepLspObject

Throws:

PcepParseException - when lsp object is not present in channel buffer

write

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

Description copied from interface: PcepLspObject

Writes the LSP Object into channel buffer.

Specified by:

write in interface PcepLspObject

Parameters:

cb - channel buffer

Returns:

Returns the writerIndex of this buffer

Throws:

PcepParseException - while writing LSP object into Channel Buffer.

parseOptionalTlv

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

Returns Linked list of optional tlvs.

Parameters:

cb - of channel buffer.

Returns:

list of optional tlvs

Throws:

PcepParseException - when unsupported tlv is received

packOptionalTlv

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

returns writer index.

Parameters:

cb - of type channel buffer

Returns:

length of bytes written to channel buffer

toString

public String toString()

Overrides:

toString in class Object