org.opendaylight.controller.liblldp

Class LLDPTLV

java.lang.Object

org.opendaylight.controller.liblldp.Packet

org.opendaylight.controller.liblldp.LLDPTLV

public class LLDPTLV
extends Packet

Class that represents the LLDPTLV objects

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LLDPTLV.TLVType

Field Summary

Fields

Modifier and Type	Field and Description
static byte[]	chassisIDSubType
static byte[]	CUSTOM_TLV_SUB_TYPE_CUSTOM_SEC OpenFlow subtype: custom sec = hash code of verification of origin of LLDP
static byte[]	CUSTOM_TLV_SUB_TYPE_NODE_CONNECTOR_ID OpenFlow subtype: nodeConnectorId of source
static int	customTlvOffset
protected Map<String,byte[]>	fieldValues
static byte[]	OFOUI OpenFlow OUI
static byte[]	portIDSubType

Fields inherited from class org.opendaylight.controller.liblldp.Packet

corrupted, hdrFieldCoordMap, hdrFieldsMap, logger, parent, payload, payloadClass, rawPayload, writeAccess

Constructor Summary

Constructors

Constructor and Description
LLDPTLV() Default constructor that creates and sets the hash map values and sets the payload to null
LLDPTLV(LLDPTLV other) Constructor that writes the passed LLDPTLV values to the hdrFieldsMap

Method Summary

Methods

Modifier and Type	Method and Description
static byte[]	createChassisIDTLVValue(String nodeId) Creates the ChassisID TLV value including the subtype and ChassisID string
static byte[]	createCustomTLVValue(byte[] subtype, byte[] customByteArray) Creates the custom TLV value including OUI, subtype and custom string
static byte[]	createCustomTLVValue(String customString) Creates the custom TLV value including OUI, subtype and custom string
static byte[]	createPortIDTLVValue(String portId) Creates the PortID TLV value including the subtype and PortID string
static byte[]	createSystemNameTLVValue(String nodeId) Creates the SystemName TLV value
boolean	equals(Object obj)
static int	extractCustomOUI(LLDPTLV lldptlv)
static byte	extractCustomSubtype(LLDPTLV lldptlv)
static String	getCustomString(byte[] customTlvValue, int customTlvLen) Retrieves the custom string from the Custom TLV value which includes OUI, subtype and custom string
int	getfieldnumBits(String fieldName) This method fetches the number of bits for header field specified by 'fieldname'.
static String	getHexStringValue(byte[] tlvValue, int tlvLen) Retrieves the string from TLV value and returns it in HexString format
int	getLength()
static String	getStringValue(byte[] tlvValue, int tlvLen) Retrieves the string from TLV value
int	getTLVSize() Returns the size in bits of the whole TLV
byte	getType()
byte[]	getValue()
int	hashCode()
void	setHeaderField(String headerField, byte[] readValue)
LLDPTLV	setLength(short length)
LLDPTLV	setType(byte type)
LLDPTLV	setValue(byte[] value)

Methods inherited from class org.opendaylight.controller.liblldp.Packet

deserialize, getfieldOffset, getHeaderSize, getParent, getPayload, getRawPayload, isCorrupted, postDeserializeCustomOperation, postSerializeCustomOperation, serialize, setParent, setPayload, setRawPayload, toString

Methods inherited from class java.lang.Object

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

Field Detail

OFOUI

public static final byte[] OFOUI

OpenFlow OUI

CUSTOM_TLV_SUB_TYPE_NODE_CONNECTOR_ID

public static final byte[] CUSTOM_TLV_SUB_TYPE_NODE_CONNECTOR_ID

OpenFlow subtype: nodeConnectorId of source

CUSTOM_TLV_SUB_TYPE_CUSTOM_SEC

public static final byte[] CUSTOM_TLV_SUB_TYPE_CUSTOM_SEC

OpenFlow subtype: custom sec = hash code of verification of origin of LLDP

customTlvOffset

public static final int customTlvOffset

chassisIDSubType

public static final byte[] chassisIDSubType

portIDSubType

public static final byte[] portIDSubType

fieldValues

protected Map<String,byte[]> fieldValues

Constructor Detail

LLDPTLV

public LLDPTLV()

Default constructor that creates and sets the hash map values and sets the payload to null

LLDPTLV

public LLDPTLV(LLDPTLV other)

Constructor that writes the passed LLDPTLV values to the hdrFieldsMap

Method Detail

getLength

public int getLength()

Returns:

int - the length of TLV

getType

public byte getType()

Returns:

byte - the type of TLV

getValue

public byte[] getValue()

Returns:

byte[] - the value field of TLV

setType

public LLDPTLV setType(byte type)

Parameters:

byte - - the type to set

Returns:

LLDPTLV

setLength

public LLDPTLV setLength(short length)

Parameters:

short - - the length to set

Returns:

LLDPTLV

setValue

public LLDPTLV setValue(byte[] value)

Parameters:

byte[] - - the value to set

Returns:

LLDPTLV

setHeaderField

public void setHeaderField(String headerField,
                  byte[] readValue)

Overrides:

setHeaderField in class Packet

hashCode

public int hashCode()

Overrides:

hashCode in class Packet

equals

public boolean equals(Object obj)

Overrides:

equals in class Packet

getfieldnumBits

public int getfieldnumBits(String fieldName)

Description copied from class: Packet

This method fetches the number of bits for header field specified by 'fieldname'. The numBits are present in the hdrFieldCoordMap of the respective packet class

Overrides:

getfieldnumBits in class Packet

Returns:

Integer - number of bits of the requested field

getTLVSize

public int getTLVSize()

Returns the size in bits of the whole TLV

Returns:

int - size in bits of full TLV

createSystemNameTLVValue

public static byte[] createSystemNameTLVValue(String nodeId)

Creates the SystemName TLV value

Parameters:

nodeId - node identifier string

Returns:

the SystemName TLV value in byte array

createChassisIDTLVValue

public static byte[] createChassisIDTLVValue(String nodeId)

Creates the ChassisID TLV value including the subtype and ChassisID string

Parameters:

nodeId - node identifier string

Returns:

the ChassisID TLV value in byte array

createPortIDTLVValue

public static byte[] createPortIDTLVValue(String portId)

Creates the PortID TLV value including the subtype and PortID string

Parameters:

portId - port identifier string

Returns:

the PortID TLV value in byte array

createCustomTLVValue

public static byte[] createCustomTLVValue(String customString)

Creates the custom TLV value including OUI, subtype and custom string

Parameters:

portId - port identifier string

Returns:

the custom TLV value in byte array

See Also:

#createCustomTLVValue(byte,String)}

createCustomTLVValue

public static byte[] createCustomTLVValue(byte[] subtype,
                          byte[] customByteArray)

Creates the custom TLV value including OUI, subtype and custom string

Parameters:

subtype - openflow subtype

portId - port identifier string

Returns:

the custom TLV value in byte array

getHexStringValue

public static String getHexStringValue(byte[] tlvValue,
                       int tlvLen)

Retrieves the string from TLV value and returns it in HexString format

Parameters:

tlvValue - the TLV value

tlvLen - the TLV length

Returns:

the HexString

getStringValue

public static String getStringValue(byte[] tlvValue,
                    int tlvLen)

Retrieves the string from TLV value

Parameters:

tlvValue - the TLV value

tlvLen - the TLV length

Returns:

the string

getCustomString

public static String getCustomString(byte[] customTlvValue,
                     int customTlvLen)

Retrieves the custom string from the Custom TLV value which includes OUI, subtype and custom string

Parameters:

customTlvValue - the custom TLV value

customTlvLen - the custom TLV length

Returns:

the custom string

extractCustomOUI

public static int extractCustomOUI(LLDPTLV lldptlv)

extractCustomSubtype

public static byte extractCustomSubtype(LLDPTLV lldptlv)