Package org.onlab.packet

Class ONOSLLDP

java.lang.Object

org.onlab.packet.BasePacket

org.onlab.packet.LLDP

org.onlab.packet.ONOSLLDP

All Implemented Interfaces:

IPacket

public class ONOSLLDP
extends LLDP

ONOS LLDP containing organizational TLV for ONOS device discovery.

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEFAULT_DEVICE
static String	DEFAULT_NAME
protected static byte	DEVICE_SUBTYPE
protected static byte	DOMAIN_SUBTYPE
protected static byte	NAME_SUBTYPE
protected static byte	SIG_SUBTYPE
protected static byte	TIMESTAMP_SUBTYPE

Fields inherited from class org.onlab.packet.LLDP

chassisId, ethType, optionalTLVList, PORT_TLV_COMPONENT_SUBTYPE, PORT_TLV_INTERFACE_NAME_SUBTYPE, PORT_TLV_SIZE, PORT_TLV_TYPE, portId, ttl, TTL_TLV_SIZE

Fields inherited from class org.onlab.packet.BasePacket

parent, payload

Constructor Summary

Constructors

Constructor	Description
ONOSLLDP(byte... subtype)

Method Summary

Modifier and Type	Method	Description
MacAddress	getChassisIdByMac()
String	getDeviceString()
LLDPOrganizationalTLV	getDeviceTLV()
String	getDomainString()
LLDPOrganizationalTLV	getDomainTLV()	Gets the TLV associated with remote probing.
String	getNameString()
LLDPOrganizationalTLV	getNameTLV()
Integer	getPort()
String	getPortDescString()
LLDPTLV	getPortDescTLV()
String	getPortNameString()
byte[]	getSig()
LLDPOrganizationalTLV	getSigTLV()
long	getTimestamp()
LLDPOrganizationalTLV	getTimestampTLV()
short	getTtlBySeconds()
static ONOSLLDP	onosLLDP(String deviceId, ChassisId chassisId, int portNum)	Deprecated. since 1.15.
static ONOSLLDP	onosLLDP(String deviceId, ChassisId chassisId, int portNum, String portDesc)	Deprecated. since 1.15.
static ONOSLLDP	onosSecureLLDP(String deviceId, ChassisId chassisId, int portNum, String secret)	Creates a link probe for link discovery/verification.
static ONOSLLDP	onosSecureLLDP(String deviceId, ChassisId chassisId, int portNum, String portDesc, String secret)	Creates a link probe for link discovery/verification.
static ONOSLLDP	parseLLDP(Ethernet eth)	Given an ethernet packet, returns the device the LLDP came from.
static ONOSLLDP	parseONOSLLDP(Ethernet eth)	Given an ethernet packet, determines if this is an LLDP from ONOS and returns the device the LLDP came from.
void	setChassisId(ChassisId chassisId)
void	setDevice(String device)
void	setDomainInfo(String domainId)
void	setName(String name)
void	setPortId(int portNumber)
void	setPortName(String portName)
void	setSig(byte[] sig)
void	setTimestamp(long timestamp)
static boolean	verify(ONOSLLDP probe, String secret, long maxDelay)

Methods inherited from class org.onlab.packet.LLDP

addOptionalTLV, deserializer, equals, getChassisId, getOptionalTLVList, getPortId, getTtl, hashCode, serialize, setChassisId, setOptionalTLVList, setPortId, setTtl, toString

Methods inherited from class org.onlab.packet.BasePacket

clone, getParent, getPayload, resetChecksum, setParent, setPayload

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_DEVICE

public static final String DEFAULT_DEVICE

See Also:

Constant Field Values

DEFAULT_NAME

public static final String DEFAULT_NAME

See Also:

Constant Field Values

NAME_SUBTYPE

protected static final byte NAME_SUBTYPE

See Also:

Constant Field Values

DEVICE_SUBTYPE

protected static final byte DEVICE_SUBTYPE

See Also:

Constant Field Values

DOMAIN_SUBTYPE

protected static final byte DOMAIN_SUBTYPE

See Also:

Constant Field Values

TIMESTAMP_SUBTYPE

protected static final byte TIMESTAMP_SUBTYPE

See Also:

Constant Field Values

SIG_SUBTYPE

protected static final byte SIG_SUBTYPE

See Also:

Constant Field Values

Constructor Detail

ONOSLLDP

public ONOSLLDP(byte... subtype)

Method Detail

setName

public void setName(String name)

setDevice

public void setDevice(String device)

setDomainInfo

public void setDomainInfo(String domainId)

setChassisId

public void setChassisId(ChassisId chassisId)

setPortId

public void setPortId(int portNumber)

setPortName

public void setPortName(String portName)

setTimestamp

public void setTimestamp(long timestamp)

setSig

public void setSig(byte[] sig)

getNameTLV

public LLDPOrganizationalTLV getNameTLV()

getDeviceTLV

public LLDPOrganizationalTLV getDeviceTLV()

getTimestampTLV

public LLDPOrganizationalTLV getTimestampTLV()

getSigTLV

public LLDPOrganizationalTLV getSigTLV()

getDomainTLV

public LLDPOrganizationalTLV getDomainTLV()

Gets the TLV associated with remote probing. This TLV will be null if remote probing is disabled.

Returns:

A TLV containing domain ID, or null.

getPortDescTLV

public LLDPTLV getPortDescTLV()

getNameString

public String getNameString()

getDeviceString

public String getDeviceString()

getDomainString

public String getDomainString()

getPortDescString

public String getPortDescString()

getPort

public Integer getPort()

getPortNameString

public String getPortNameString()

getChassisIdByMac

public MacAddress getChassisIdByMac()

getTtlBySeconds

public short getTtlBySeconds()

getTimestamp

public long getTimestamp()

getSig

public byte[] getSig()

parseONOSLLDP

public static ONOSLLDP parseONOSLLDP(Ethernet eth)

Given an ethernet packet, determines if this is an LLDP from ONOS and returns the device the LLDP came from.

Parameters:

eth - an ethernet packet

Returns:

a the lldp packet or null

parseLLDP

public static ONOSLLDP parseLLDP(Ethernet eth)

Given an ethernet packet, returns the device the LLDP came from.

Parameters:

eth - an ethernet packet

Returns:

a the lldp packet or null

onosLLDP

@Deprecated
public static ONOSLLDP onosLLDP(String deviceId,
                                ChassisId chassisId,
                                int portNum)

Deprecated.

since 1.15. Insecure, do not use.

Creates a link probe for link discovery/verification.

Parameters:

deviceId - The device ID as a String

chassisId - The chassis ID of the device

portNum - Port number of port to send probe out of

Returns:

ONOSLLDP probe message

onosSecureLLDP

public static ONOSLLDP onosSecureLLDP(String deviceId,
                                      ChassisId chassisId,
                                      int portNum,
                                      String secret)

Creates a link probe for link discovery/verification.

Parameters:

deviceId - The device ID as a String

chassisId - The chassis ID of the device

portNum - Port number of port to send probe out of

secret - LLDP secret

Returns:

ONOSLLDP probe message

onosLLDP

@Deprecated
public static ONOSLLDP onosLLDP(String deviceId,
                                ChassisId chassisId,
                                int portNum,
                                String portDesc)

Deprecated.

since 1.15. Insecure, do not use.

Creates a link probe for link discovery/verification.

Parameters:

deviceId - The device ID as a String

chassisId - The chassis ID of the device

portNum - Port number of port to send probe out of

portDesc - Port description of port to send probe out of

Returns:

ONOSLLDP probe message

onosSecureLLDP

public static ONOSLLDP onosSecureLLDP(String deviceId,
                                      ChassisId chassisId,
                                      int portNum,
                                      String portDesc,
                                      String secret)

Creates a link probe for link discovery/verification.

Parameters:

deviceId - The device ID as a String

chassisId - The chassis ID of the device

portNum - Port number of port to send probe out of

portDesc - Port description of port to send probe out of

secret - LLDP secret

Returns:

ONOSLLDP probe message

verify

public static boolean verify(ONOSLLDP probe,
                             String secret,
                             long maxDelay)