org.onosproject.pcepio.protocol.ver1

Class PcepLSObjectVer1

java.lang.Object

org.onosproject.pcepio.protocol.ver1.PcepLSObjectVer1

All Implemented Interfaces:

PcepLSObject

public class PcepLSObjectVer1
extends Object
implements PcepLSObject

Provides PCEP LS (link-state) object.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PcepLSObjectVer1.Builder Builder class for PCEP LS (link-state) object.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_LS_ID
static PcepObjectHeader	DEFAULT_LS_OBJECT_HEADER
static byte	DEFAULT_PROTOCOL_ID
static boolean	DEFAULT_R_FLAG
static boolean	DEFAULT_S_FLAG
static int	FLAG_SET_R_FLAG
static int	FLAG_SET_S_FLAG
protected static org.slf4j.Logger	log
static byte	LS_OBJ_CLASS
static short	LS_OBJ_MINIMUM_LENGTH
static byte	LS_OBJ_TYPE_LINK_VALUE
static byte	LS_OBJ_TYPE_NODE_VALUE
static byte	LS_OBJECT_VERSION
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

Constructor Summary

Constructors

Constructor and Description
PcepLSObjectVer1(PcepObjectHeader lsObjHeader, byte protocolId, boolean removeFlag, boolean syncFlag, long lsId, List<PcepValueType> optionalTlvList) Constructor to initialize variables.

Method Summary

Modifier and Type	Method and Description
long	getLSId() Returns LS ID in LS Object.
PcepObjectHeader	getLSObjHeader() Returns LS object header.
List<PcepValueType>	getOptionalTlv() Returns list of Optional Tlvs in LS Object.
byte	getProtocolId() Returns ProtocolId in LS Object.
boolean	getRemoveFlag() Returns R flag in LS Object.
boolean	getSyncFlag() Returns sync flag in LS Object.
protected int	packOptionalTlv(org.jboss.netty.buffer.ChannelBuffer cb) Returns the writer index.
protected static List<PcepValueType>	parseOptionalTlv(org.jboss.netty.buffer.ChannelBuffer cb) Returns Linked list of PCEP Value Type.
static PcepLSObject	read(org.jboss.netty.buffer.ChannelBuffer cb) Reads from the channel buffer and returns Object of PcepLSObject.
void	setLSId(long lsId) Sets LS ID in LS Object.
void	setLSObjHeader(PcepObjectHeader obj) Sets LS Object header.
void	setOptionalTlv(List<PcepValueType> optionalTlvList) Sets list of Optional Tlvs in LS Object.
void	setProtocolId(byte protId) Sets ProtocolId in LS Object.
void	setRemoveFlag(boolean removeFlag) Sets R flag in LS Object.
void	setSyncFlag(boolean syncFlag) Sets sync flag in LS Object.
String	toString()
int	write(org.jboss.netty.buffer.ChannelBuffer cb) Writes the LS 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

LS_OBJ_TYPE_NODE_VALUE

public static final byte LS_OBJ_TYPE_NODE_VALUE

See Also:

Constant Field Values

LS_OBJ_TYPE_LINK_VALUE

public static final byte LS_OBJ_TYPE_LINK_VALUE

See Also:

Constant Field Values

LS_OBJ_CLASS

public static final byte LS_OBJ_CLASS

See Also:

Constant Field Values

LS_OBJECT_VERSION

public static final byte LS_OBJECT_VERSION

See Also:

Constant Field Values

LS_OBJ_MINIMUM_LENGTH

public static final short LS_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_LS_ID

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

public static final PcepObjectHeader DEFAULT_LS_OBJECT_HEADER

Constructor Detail

PcepLSObjectVer1

public PcepLSObjectVer1(PcepObjectHeader lsObjHeader,
                        byte protocolId,
                        boolean removeFlag,
                        boolean syncFlag,
                        long lsId,
                        List<PcepValueType> optionalTlvList)

Constructor to initialize variables.

Parameters:

lsObjHeader - LS Object header

protocolId - Protocol-ID

removeFlag - R-flag

syncFlag - S-flag

lsId - LS-ID

optionalTlvList - linked list of Optional TLV

Method Detail

getLSObjHeader

public PcepObjectHeader getLSObjHeader()

Description copied from interface: PcepLSObject

Returns LS object header.

Specified by:

getLSObjHeader in interface PcepLSObject

Returns:

LS object header

setLSObjHeader

public void setLSObjHeader(PcepObjectHeader obj)

Description copied from interface: PcepLSObject

Sets LS Object header.

Specified by:

setLSObjHeader in interface PcepLSObject

Parameters:

obj - LS Object header

getProtocolId

public byte getProtocolId()

Description copied from interface: PcepLSObject

Returns ProtocolId in LS Object.

Specified by:

getProtocolId in interface PcepLSObject

Returns:

ProtocolId in LS Object

setProtocolId

public void setProtocolId(byte protId)

Description copied from interface: PcepLSObject

Sets ProtocolId in LS Object.

Specified by:

setProtocolId in interface PcepLSObject

Parameters:

protId - ProtocolId in LS Object

getRemoveFlag

public boolean getRemoveFlag()

Description copied from interface: PcepLSObject

Returns R flag in LS Object.

Specified by:

getRemoveFlag in interface PcepLSObject

Returns:

R flag in LS Object

setRemoveFlag

public void setRemoveFlag(boolean removeFlag)

Description copied from interface: PcepLSObject

Sets R flag in LS Object.

Specified by:

setRemoveFlag in interface PcepLSObject

Parameters:

removeFlag - R flag in LS Object

getSyncFlag

public boolean getSyncFlag()

Description copied from interface: PcepLSObject

Returns sync flag in LS Object.

Specified by:

getSyncFlag in interface PcepLSObject

Returns:

sync flag in LS Object

setSyncFlag

public void setSyncFlag(boolean syncFlag)

Description copied from interface: PcepLSObject

Sets sync flag in LS Object.

Specified by:

setSyncFlag in interface PcepLSObject

Parameters:

syncFlag - sync flag in LS Object

getLSId

public long getLSId()

Description copied from interface: PcepLSObject

Returns LS ID in LS Object.

Specified by:

getLSId in interface PcepLSObject

Returns:

LS ID in LS Object

setLSId

public void setLSId(long lsId)

Description copied from interface: PcepLSObject

Sets LS ID in LS Object.

Specified by:

setLSId in interface PcepLSObject

Parameters:

lsId - LS ID in LS Object

getOptionalTlv

public List<PcepValueType> getOptionalTlv()

Description copied from interface: PcepLSObject

Returns list of Optional Tlvs in LS Object.

Specified by:

getOptionalTlv in interface PcepLSObject

Returns:

list of Optional Tlvs

setOptionalTlv

public void setOptionalTlv(List<PcepValueType> optionalTlvList)

Description copied from interface: PcepLSObject

Sets list of Optional Tlvs in LS Object.

Specified by:

setOptionalTlv in interface PcepLSObject

Parameters:

optionalTlvList - list of Optional Tlvs

read

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

Reads from the channel buffer and returns Object of PcepLSObject.

Parameters:

cb - of type channel buffer

Returns:

Object of PcepLSObject

Throws:

PcepParseException - if mandatory fields are missing

write

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

Description copied from interface: PcepLSObject

Writes the LS Object into channel buffer.

Specified by:

write in interface PcepLSObject

Parameters:

cb - channel buffer

Returns:

Returns the writerIndex of this buffer

Throws:

PcepParseException - when object header is not written to channel buffer

parseOptionalTlv

protected static List<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