org.onosproject.pcepio.protocol.ver1

Class PcepErrorObjectVer1

java.lang.Object

org.onosproject.pcepio.protocol.ver1.PcepErrorObjectVer1

All Implemented Interfaces:

PcepErrorObject

public class PcepErrorObjectVer1
extends Object
implements PcepErrorObject

Provides PCEP Error Object.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PcepErrorObjectVer1.Builder Builder class for PCEP error object.

Field Summary

Fields

Modifier and Type	Field and Description
static PcepObjectHeader	DEFAULT_ERROR_OBJECT_HEADER
static byte	ERROR_OBJ_CLASS
static short	ERROR_OBJ_MINIMUM_LENGTH
static byte	ERROR_OBJ_TYPE
static byte	ERROR_OBJECT_VERSION
protected static org.slf4j.Logger	log
static int	OBJECT_HEADER_LENGTH

Constructor Summary

Constructors

Constructor and Description
PcepErrorObjectVer1(PcepObjectHeader errorObjHeader, byte errorType, byte errorValue, LinkedList<PcepValueType> optionalTlv) Constructor to initialize variables.

Method Summary

Modifier and Type	Method and Description
PcepObjectHeader	getErrorObjHeader() returns object header.
int	getErrorType() Returns Error Type in Error Object.
byte	getErrorValue() Returns Error Value in Error Object.
LinkedList<PcepValueType>	getOptionalTlv() Returns Optional Tlvs in Error Object.
protected int	packOptionalTlv(org.jboss.netty.buffer.ChannelBuffer cb) Pack the Optional tlvs.
protected static LinkedList<PcepValueType>	parseOptionalTlv(org.jboss.netty.buffer.ChannelBuffer cb) returns Linked list of optional tlvs.
static PcepErrorObject	read(org.jboss.netty.buffer.ChannelBuffer cb) Reads from channel buffer and returns object of PcepErrorObject.
void	setErrorType(byte errorType) Sets Error Type in Error Object.
void	setErrorValue(byte errorValue) Sets Error Value in Error Object.
void	setLspObjHeader(PcepObjectHeader obj) sets Object Header.
void	setOptionalTlv(LinkedList<PcepValueType> optionalTlv) Sets Optional Tlvs in Error Object.
String	toString()
int	write(org.jboss.netty.buffer.ChannelBuffer cb) Writes the Error 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

ERROR_OBJ_TYPE

public static final byte ERROR_OBJ_TYPE

See Also:

Constant Field Values

ERROR_OBJ_CLASS

public static final byte ERROR_OBJ_CLASS

See Also:

Constant Field Values

ERROR_OBJECT_VERSION

public static final byte ERROR_OBJECT_VERSION

See Also:

Constant Field Values

ERROR_OBJ_MINIMUM_LENGTH

public static final short ERROR_OBJ_MINIMUM_LENGTH

See Also:

Constant Field Values

OBJECT_HEADER_LENGTH

public static final int OBJECT_HEADER_LENGTH

See Also:

Constant Field Values

DEFAULT_ERROR_OBJECT_HEADER

public static final PcepObjectHeader DEFAULT_ERROR_OBJECT_HEADER

Constructor Detail

PcepErrorObjectVer1

public PcepErrorObjectVer1(PcepObjectHeader errorObjHeader,
                           byte errorType,
                           byte errorValue,
                           LinkedList<PcepValueType> optionalTlv)

Constructor to initialize variables.

Parameters:

errorObjHeader - ERROR Object header

errorType - Error Type

errorValue - Error Value

optionalTlv - list of optional TLV

Method Detail

setLspObjHeader

public void setLspObjHeader(PcepObjectHeader obj)

sets Object Header.

Parameters:

obj - Error-Object header

setErrorType

public void setErrorType(byte errorType)

Description copied from interface: PcepErrorObject

Sets Error Type in Error Object.

Specified by:

setErrorType in interface PcepErrorObject

Parameters:

errorType - Error Type

setErrorValue

public void setErrorValue(byte errorValue)

Description copied from interface: PcepErrorObject

Sets Error Value in Error Object.

Specified by:

setErrorValue in interface PcepErrorObject

Parameters:

errorValue - Error Value

getErrorObjHeader

public PcepObjectHeader getErrorObjHeader()

returns object header.

Returns:

errorObjHeader Error-Object header

getErrorType

public int getErrorType()

Description copied from interface: PcepErrorObject

Returns Error Type in Error Object.

Specified by:

getErrorType in interface PcepErrorObject

Returns:

Error Type in Error Object

getErrorValue

public byte getErrorValue()

Description copied from interface: PcepErrorObject

Returns Error Value in Error Object.

Specified by:

getErrorValue in interface PcepErrorObject

Returns:

Error Value

getOptionalTlv

public LinkedList<PcepValueType> getOptionalTlv()

Description copied from interface: PcepErrorObject

Returns Optional Tlvs in Error Object.

Specified by:

getOptionalTlv in interface PcepErrorObject

Returns:

list of Optional Tlvs in Error Object

setOptionalTlv

public void setOptionalTlv(LinkedList<PcepValueType> optionalTlv)

Description copied from interface: PcepErrorObject

Sets Optional Tlvs in Error Object.

Specified by:

setOptionalTlv in interface PcepErrorObject

Parameters:

optionalTlv - list of Optional Tlvs

read

public static PcepErrorObject read(org.jboss.netty.buffer.ChannelBuffer cb)

Reads from channel buffer and returns object of PcepErrorObject.

Parameters:

cb - of channel buffer.

Returns:

object of PCEP-ERROR-OBJECT

parseOptionalTlv

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

returns Linked list of optional tlvs.

Parameters:

cb - channel buffer.

Returns:

Linked list of optional tlvs

write

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

Description copied from interface: PcepErrorObject

Writes the Error Object into channel buffer.

Specified by:

write in interface PcepErrorObject

Parameters:

cb - channel buffer

Returns:

Returns the writerIndex of this buffer

Throws:

PcepParseException - while writing Error Object into ChannelBuffer

packOptionalTlv

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

Pack the Optional tlvs.

Parameters:

cb - channel buffer.

Returns:

writer index.

toString

public String toString()

Overrides:

toString in class Object