org.onosproject.pcepio.protocol.ver1

Class PcepLspaObjectVer1

java.lang.Object

org.onosproject.pcepio.protocol.ver1.PcepLspaObjectVer1

All Implemented Interfaces:

PcepLspaObject

public class PcepLspaObjectVer1
extends Object
implements PcepLspaObject

Provides PCEP label Object .

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PcepLspaObjectVer1.Builder Builder class for PCEP lspa object.

Field Summary

Fields

Modifier and Type	Field and Description
static int	BFLAG_SHIFT_VALUE
static int	HOLD_PRIORITY_SHIFT_VALUE
static int	LFLAG_RESET
static int	LFLAG_SET
protected static org.slf4j.Logger	log
static byte	LSPA_OBJ_CLASS
static short	LSPA_OBJ_MINIMUM_LENGTH
static byte	LSPA_OBJ_TYPE
static byte	LSPA_OBJECT_VERSION
static int	OBJECT_HEADER_LENGTH
static int	SETUP_PRIORITY_SHIFT_VALUE

Constructor Summary

Constructors

Constructor and Description
PcepLspaObjectVer1(PcepObjectHeader lspaObjHeader, boolean bLFlag, int iExcludeAny, int iIncludeAny, int iIncludeAll, byte cSetupPriority, byte cHoldPriority, LinkedList<PcepValueType> llOptionalTlv) Constructor to initialize member variables.

Method Summary

Modifier and Type	Method and Description
int	getExcludeAny() Returns Exclude Any field in LSPA Object.
byte	getHoldPriority() Returns Hold Priority field in LSPA Object.
int	getIncludeAll() Returns Include All field in LSPA Object.
int	getIncludeAny() Returns Include Any field in LSPA Object.
boolean	getLFlag() Returns L flag in LSPA Object.
PcepObjectHeader	getLspaObjHeader() Returns lspa Object Header.
LinkedList<PcepValueType>	getOptionalTlv() Returns list of Optional Tlvs in LSPA Object.
byte	getSetupPriority() Returns Setup Priority field in LSPA Object.
protected boolean	packOptionalTlv(org.jboss.netty.buffer.ChannelBuffer cb) Writes optional tlvs to channel buffer.
static LinkedList<PcepValueType>	parseOptionalTlv(org.jboss.netty.buffer.ChannelBuffer cb) Parse list of optional tlvs.
static PcepLspaObject	read(org.jboss.netty.buffer.ChannelBuffer cb) Reads channel buffer and returns object of PcepLspaObject.
void	setExcludeAny(int iExcludeAny) Sets Exclude Any field in LSPA Object.
void	setHoldPriority(byte cHoldPriority) Sets Hold Priority field in LSPA Object.
void	setIncludeAll(int value) Sets Include All field in LSPA Object.
void	setIncludeAny(int iIncludeAny) Sets Include Any field in LSPA Object.
void	setLFlag(boolean bLFlag) Sets L flag in LSPA Object.
void	setLspaObjHeader(PcepObjectHeader obj) Sets Object Header.
void	setOptionalTlv(LinkedList<PcepValueType> llOptionalTlv) Sets Optional Tlvs in LSPA Object.
void	setSetupPriority(byte cSetupPriority) Sets Setup Priority field in LSPA Object.
String	toString()
int	write(org.jboss.netty.buffer.ChannelBuffer cb) Writes the LSPA 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

LSPA_OBJ_TYPE

public static final byte LSPA_OBJ_TYPE

See Also:

Constant Field Values

LSPA_OBJ_CLASS

public static final byte LSPA_OBJ_CLASS

See Also:

Constant Field Values

LSPA_OBJECT_VERSION

public static final byte LSPA_OBJECT_VERSION

See Also:

Constant Field Values

LSPA_OBJ_MINIMUM_LENGTH

public static final short LSPA_OBJ_MINIMUM_LENGTH

See Also:

Constant Field Values

OBJECT_HEADER_LENGTH

public static final int OBJECT_HEADER_LENGTH

See Also:

Constant Field Values

SETUP_PRIORITY_SHIFT_VALUE

public static final int SETUP_PRIORITY_SHIFT_VALUE

See Also:

Constant Field Values

HOLD_PRIORITY_SHIFT_VALUE

public static final int HOLD_PRIORITY_SHIFT_VALUE

See Also:

Constant Field Values

BFLAG_SHIFT_VALUE

public static final int BFLAG_SHIFT_VALUE

See Also:

Constant Field Values

LFLAG_SET

public static final int LFLAG_SET

See Also:

Constant Field Values

LFLAG_RESET

public static final int LFLAG_RESET

See Also:

Constant Field Values

Constructor Detail

PcepLspaObjectVer1

public PcepLspaObjectVer1(PcepObjectHeader lspaObjHeader,
                          boolean bLFlag,
                          int iExcludeAny,
                          int iIncludeAny,
                          int iIncludeAll,
                          byte cSetupPriority,
                          byte cHoldPriority,
                          LinkedList<PcepValueType> llOptionalTlv)

Constructor to initialize member variables.

Parameters:

lspaObjHeader - lspa object header

bLFlag - b l flag

iExcludeAny - excludeAny value

iIncludeAny - includeAny value

iIncludeAll - includeAll value

cSetupPriority - setup priority value

cHoldPriority - hold priority value

llOptionalTlv - list of optional tlv

Method Detail

setLspaObjHeader

public void setLspaObjHeader(PcepObjectHeader obj)

Sets Object Header.

Parameters:

obj - lspa object header

setExcludeAny

public void setExcludeAny(int iExcludeAny)

Description copied from interface: PcepLspaObject

Sets Exclude Any field in LSPA Object.

Specified by:

setExcludeAny in interface PcepLspaObject

Parameters:

iExcludeAny - Exclude Any field

setIncludeAny

public void setIncludeAny(int iIncludeAny)

Description copied from interface: PcepLspaObject

Sets Include Any field in LSPA Object.

Specified by:

setIncludeAny in interface PcepLspaObject

Parameters:

iIncludeAny - Include Any field

setSetupPriority

public void setSetupPriority(byte cSetupPriority)

Description copied from interface: PcepLspaObject

Sets Setup Priority field in LSPA Object.

Specified by:

setSetupPriority in interface PcepLspaObject

Parameters:

cSetupPriority - Setup Priority field

setHoldPriority

public void setHoldPriority(byte cHoldPriority)

Description copied from interface: PcepLspaObject

Sets Hold Priority field in LSPA Object.

Specified by:

setHoldPriority in interface PcepLspaObject

Parameters:

cHoldPriority - Hold Priority field

setLFlag

public void setLFlag(boolean bLFlag)

Description copied from interface: PcepLspaObject

Sets L flag in LSPA Object.

Specified by:

setLFlag in interface PcepLspaObject

Parameters:

bLFlag - L flag

getLspaObjHeader

public PcepObjectHeader getLspaObjHeader()

Returns lspa Object Header.

Returns:

lspa Object Header

getExcludeAny

public int getExcludeAny()

Description copied from interface: PcepLspaObject

Returns Exclude Any field in LSPA Object.

Specified by:

getExcludeAny in interface PcepLspaObject

Returns:

Exclude Any field in LSPA Object

getIncludeAny

public int getIncludeAny()

Description copied from interface: PcepLspaObject

Returns Include Any field in LSPA Object.

Specified by:

getIncludeAny in interface PcepLspaObject

Returns:

Include Any field in LSPA Object

getIncludeAll

public int getIncludeAll()

Description copied from interface: PcepLspaObject

Returns Include All field in LSPA Object.

Specified by:

getIncludeAll in interface PcepLspaObject

Returns:

Include All field in LSPA Object

getSetupPriority

public byte getSetupPriority()

Description copied from interface: PcepLspaObject

Returns Setup Priority field in LSPA Object.

Specified by:

getSetupPriority in interface PcepLspaObject

Returns:

Setup Priority field in LSPA Object

getHoldPriority

public byte getHoldPriority()

Description copied from interface: PcepLspaObject

Returns Hold Priority field in LSPA Object.

Specified by:

getHoldPriority in interface PcepLspaObject

Returns:

Hold Priority field in LSPA Object

getLFlag

public boolean getLFlag()

Description copied from interface: PcepLspaObject

Returns L flag in LSPA Object.

Specified by:

getLFlag in interface PcepLspaObject

Returns:

L flag in LSPA Object

setIncludeAll

public void setIncludeAll(int value)

Description copied from interface: PcepLspaObject

Sets Include All field in LSPA Object.

Specified by:

setIncludeAll in interface PcepLspaObject

Parameters:

value - Include All field

getOptionalTlv

public LinkedList<PcepValueType> getOptionalTlv()

Description copied from interface: PcepLspaObject

Returns list of Optional Tlvs in LSPA Object.

Specified by:

getOptionalTlv in interface PcepLspaObject

Returns:

list of Optional Tlvs in LSPA Object

setOptionalTlv

public void setOptionalTlv(LinkedList<PcepValueType> llOptionalTlv)

Description copied from interface: PcepLspaObject

Sets Optional Tlvs in LSPA Object.

Specified by:

setOptionalTlv in interface PcepLspaObject

Parameters:

llOptionalTlv - Optional Tlvs in LSPA Object

read

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

Reads channel buffer and returns object of PcepLspaObject.

Parameters:

cb - of type channel buffer.

Returns:

object of PcepLspaObject

Throws:

PcepParseException - while parsing lspa object from channel buffer

write

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

Description copied from interface: PcepLspaObject

Writes the LSPA Object into channel buffer.

Specified by:

write in interface PcepLspaObject

Parameters:

cb - channel buffer

Returns:

Returns the writerIndex of this buffer

Throws:

PcepParseException - while writing LSPA object into Channel Buffer.

parseOptionalTlv

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

Parse list of optional tlvs.

Parameters:

cb - channel buffer

Returns:

list of optional tlvs.

Throws:

PcepParseException - when fails to parse optional tlv list.

packOptionalTlv

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

Writes optional tlvs to channel buffer.

Parameters:

cb - channel buffer

Returns:

true

toString

public String toString()

Overrides:

toString in class Object