org.onosproject.pcepio.protocol.ver1

Class PcepSrpObjectVer1

java.lang.Object

org.onosproject.pcepio.protocol.ver1.PcepSrpObjectVer1

All Implemented Interfaces:

PcepSrpObject

public class PcepSrpObjectVer1
extends Object
implements PcepSrpObject

Provides PCEP SRP obejct.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PcepSrpObjectVer1.Builder Builder class for PCEP srp Object.

Field Summary

Fields

Modifier and Type	Field and Description
static byte	BBIT_RESET
static byte	BBIT_SET
static boolean	FLAG_DEFAULT_VALUE
protected static org.slf4j.Logger	log
static int	MINIMUM_COMMON_HEADER_LENGTH
static byte	SRP_OBJ_CLASS
static short	SRP_OBJ_MINIMUM_LENGTH
static byte	SRP_OBJ_TYPE
static byte	SRP_OBJECT_VERSION

Constructor Summary

Constructors

Constructor and Description
PcepSrpObjectVer1(PcepObjectHeader srpObjHeader, boolean bRFlag, boolean bSFlag, int srpID, LinkedList<PcepValueType> llOptionalTlv) Constructor to initialize member variables.

Method Summary

Modifier and Type	Method and Description
LinkedList<PcepValueType>	getOptionalTlv() Returns list of optional tlvs.
boolean	getRFlag() Returns R flag of SRP Object.
boolean	getSFlag() Returns S flag of SRP Object.
int	getSrpID() Returns SRP ID of SRP Object.
PcepObjectHeader	getSrpObjHeader() Returns SRP object header.
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 Optional TLvs from the channel buffer.
static PcepSrpObject	read(org.jboss.netty.buffer.ChannelBuffer cb) Reads from channel buffer and returns instance of PCEP SRP object.
void	setOptionalTlv(LinkedList<PcepValueType> llOptionalTlv) sets the optional TLvs.
void	setRFlag(boolean bRFlag) Sets R flag with specified value.
void	setSFlag(boolean bSFlag) Sets S(sync) flag with specified value.
void	setSrpID(int srpID) Sets SRP ID with specified value.
void	setSrpObjHeader(PcepObjectHeader obj) sets the SRP object header.
String	toString()
int	write(org.jboss.netty.buffer.ChannelBuffer cb) Writes the SRP 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

SRP_OBJ_TYPE

public static final byte SRP_OBJ_TYPE

See Also:

Constant Field Values

SRP_OBJ_CLASS

public static final byte SRP_OBJ_CLASS

See Also:

Constant Field Values

SRP_OBJECT_VERSION

public static final byte SRP_OBJECT_VERSION

See Also:

Constant Field Values

SRP_OBJ_MINIMUM_LENGTH

public static final short SRP_OBJ_MINIMUM_LENGTH

See Also:

Constant Field Values

MINIMUM_COMMON_HEADER_LENGTH

public static final int MINIMUM_COMMON_HEADER_LENGTH

See Also:

Constant Field Values

FLAG_DEFAULT_VALUE

public static final boolean FLAG_DEFAULT_VALUE

See Also:

Constant Field Values

BBIT_SET

public static final byte BBIT_SET

See Also:

Constant Field Values

BBIT_RESET

public static final byte BBIT_RESET

See Also:

Constant Field Values

Constructor Detail

PcepSrpObjectVer1

public PcepSrpObjectVer1(PcepObjectHeader srpObjHeader,
                         boolean bRFlag,
                         boolean bSFlag,
                         int srpID,
                         LinkedList<PcepValueType> llOptionalTlv)

Constructor to initialize member variables.

Parameters:

srpObjHeader - srp object header

bRFlag - R flag

bSFlag - S (sync) flag

srpID - srp Id

llOptionalTlv - list of optional tlv

Method Detail

setSrpObjHeader

public void setSrpObjHeader(PcepObjectHeader obj)

sets the SRP object header.

Parameters:

obj - srp object header

setSrpID

public void setSrpID(int srpID)

Description copied from interface: PcepSrpObject

Sets SRP ID with specified value.

Specified by:

setSrpID in interface PcepSrpObject

Parameters:

srpID - SRP ID of SRP Object

setRFlag

public void setRFlag(boolean bRFlag)

Description copied from interface: PcepSrpObject

Sets R flag with specified value.

Specified by:

setRFlag in interface PcepSrpObject

Parameters:

bRFlag - R Flag of SRP Object

setSFlag

public void setSFlag(boolean bSFlag)

Description copied from interface: PcepSrpObject

Sets S(sync) flag with specified value.

Specified by:

setSFlag in interface PcepSrpObject

Parameters:

bSFlag - S Flag of SRP Object

getSrpObjHeader

public PcepObjectHeader getSrpObjHeader()

Returns SRP object header.

Returns:

srpObjHeader

getSrpID

public int getSrpID()

Description copied from interface: PcepSrpObject

Returns SRP ID of SRP Object.

Specified by:

getSrpID in interface PcepSrpObject

Returns:

SRP ID of SRP Object

getRFlag

public boolean getRFlag()

Description copied from interface: PcepSrpObject

Returns R flag of SRP Object.

Specified by:

getRFlag in interface PcepSrpObject

Returns:

R flag of SRP Object

getSFlag

public boolean getSFlag()

Description copied from interface: PcepSrpObject

Returns S flag of SRP Object.

Specified by:

getSFlag in interface PcepSrpObject

Returns:

S flag of SRP Object

setOptionalTlv

public void setOptionalTlv(LinkedList<PcepValueType> llOptionalTlv)

Description copied from interface: PcepSrpObject

sets the optional TLvs.

Specified by:

setOptionalTlv in interface PcepSrpObject

Parameters:

llOptionalTlv - list of optional tlvs

getOptionalTlv

public LinkedList<PcepValueType> getOptionalTlv()

Description copied from interface: PcepSrpObject

Returns list of optional tlvs.

Specified by:

getOptionalTlv in interface PcepSrpObject

Returns:

llOptionalTlv list of optional tlvs

read

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

Reads from channel buffer and returns instance of PCEP SRP object.

Parameters:

cb - of channel buffer.

Returns:

PCEP SRP object

Throws:

PcepParseException - when srp object is not received in channel buffer

write

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

Description copied from interface: PcepSrpObject

Writes the SRP Object into channel buffer.

Specified by:

write in interface PcepSrpObject

Parameters:

cb - channel buffer

Returns:

Returns the writerIndex of this buffer

Throws:

PcepParseException - when tlv is null

parseOptionalTlv

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

Parse Optional TLvs from the channel buffer.

Parameters:

cb - of type channel buffer

Returns:

list of optional tlvs

Throws:

PcepParseException - when unsupported tlv is received in srp object

packOptionalTlv

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

Writes optional tlvs to channel buffer.

Parameters:

cb - of type channel buffer

Returns:

true if writing optional tlv to channel buffer is success.

toString

public String toString()

Overrides:

toString in class Object