org.onosproject.pcepio.types

Class PathKeySubObject

java.lang.Object

org.onosproject.pcepio.types.PathKeySubObject

All Implemented Interfaces:

PcepValueType

public class PathKeySubObject
extends Object
implements PcepValueType

Path Key SubObject: When a PCC needs to expand a path-key in order to expand a CPS, it issues a Path Computation Request (PCReq) to the PCE identified in the PKS in the RSVP-TE ERO that it is processing. The PCC supplies the PKS to be expanded in a PATH-KEY SubObject in the PCReq message.

Field Summary

Fields

Modifier and Type	Field and Description
static byte	LENGTH
protected static org.slf4j.Logger	log
static byte	TYPE

Constructor Summary

Constructors

Constructor and Description
PathKeySubObject(short pathKey, int pceID) Constructor for Path Key sub Object which initializes pathKey and pceId.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
short	getLength() Returns the Length of PCEP Message.
short	getPathKey() Returns Path Key.
int	getPceId() Returns pceID.
short	getType() Returns the Type of PCEP Message.
PcepVersion	getVersion() Returns the Version Of PCEP Message.
int	hashCode()
static PathKeySubObject	of(short pathKey, int pceID) Creates Path Key sub Object which initializes pathKey and pceId.
static PcepValueType	read(org.jboss.netty.buffer.ChannelBuffer c) Reads the channel buffer and returns new path key sub objects.
String	toString()
int	write(org.jboss.netty.buffer.ChannelBuffer c) Writes the byte Stream of PCEP Message to channel buffer.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

log

protected static final org.slf4j.Logger log

TYPE

public static final byte TYPE

See Also:

Constant Field Values

LENGTH

public static final byte LENGTH

See Also:

Constant Field Values

Constructor Detail

PathKeySubObject

public PathKeySubObject(short pathKey,
                        int pceID)

Constructor for Path Key sub Object which initializes pathKey and pceId.

Parameters:

pathKey - path key provided by PCC

pceID - ID for the PCE

Method Detail

of

public static PathKeySubObject of(short pathKey,
                                  int pceID)

Creates Path Key sub Object which initializes pathKey and pceId.

Parameters:

pathKey - path key provided by PCC

pceID - PCE id

Returns:

new object of type path key sub object

getPathKey

public short getPathKey()

Returns Path Key.

Returns:

pathKey

getPceId

public int getPceId()

Returns pceID.

Returns:

pceID

getVersion

public PcepVersion getVersion()

Description copied from interface: PcepValueType

Returns the Version Of PCEP Message.

Specified by:

getVersion in interface PcepValueType

Returns:

Version of PcepVersion Type.

getType

public short getType()

Description copied from interface: PcepValueType

Returns the Type of PCEP Message.

Specified by:

getType in interface PcepValueType

Returns:

value of type

getLength

public short getLength()

Description copied from interface: PcepValueType

Returns the Length of PCEP Message.

Specified by:

getLength in interface PcepValueType

Returns:

value of Length

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

write

public int write(org.jboss.netty.buffer.ChannelBuffer c)

Description copied from interface: PcepValueType

Writes the byte Stream of PCEP Message to channel buffer.

Specified by:

write in interface PcepValueType

Parameters:

c - of type channel buffer

Returns:

length of bytes written to channel buffer

read

public static PcepValueType read(org.jboss.netty.buffer.ChannelBuffer c)

Reads the channel buffer and returns new path key sub objects.

Parameters:

c - of type channel buffer

Returns:

object of type path key sub object

toString

public String toString()

Overrides:

toString in class Object