org.opennms.netmgt.telemetry.protocols.sflow.adapter

Class SFlow

java.lang.Object

org.opennms.netmgt.telemetry.protocols.sflow.adapter.SFlow

All Implemented Interfaces:

Flow

public class SFlow
extends Object
implements Flow

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SFlow.Header

Nested classes/interfaces inherited from interface org.opennms.netmgt.flows.api.Flow

Flow.Direction, Flow.NetflowVersion, Flow.SamplingAlgorithm

Field Summary

Fields inherited from interface org.opennms.netmgt.flows.api.Flow

IPV4_PROTOCOL_VERSION, IPV6_PROTOCOL_VERSION

Constructor Summary

Constructors

Constructor and Description
SFlow(SFlow.Header header, org.bson.BsonDocument document, java.time.Instant receivedAt)

Method Summary

Modifier and Type	Method and Description
Long	getBytes() Number of bytes transferred in the flow.
Long	getDeltaSwitched() Unix timestamp in ms at which the previous exported packet associated with this flow was switched.
Flow.Direction	getDirection() Direction of the flow (egress vs ingress)
String	getDstAddr() Destination address.
Optional<String>	getDstAddrHostname() Destination address hostname.
Long	getDstAs() Destination autonomous system (AS).
Integer	getDstMaskLen() The number of contiguous bits in the source address subnet mask.
Integer	getDstPort() Destination port.
Integer	getEngineId() Slot number of the flow-switching engine.
Integer	getEngineType() Type of flow-switching engine.
Long	getFirstSwitched() Unix timestamp in ms at which the first packet associated with this flow was switched.
int	getFlowRecords() Number of flow records in the associated packet.
long	getFlowSeqNum() Flow packet sequence number.
Integer	getInputSnmp() SNMP ifIndex
Integer	getIpProtocolVersion() IPv4 vs IPv6
Long	getLastSwitched() Unix timestamp in ms at which the last packet associated with this flow was switched.
Flow.NetflowVersion	getNetflowVersion() Netfow version
String	getNextHop() Next hop
Optional<String>	getNextHopHostname() Next hop hostname
String	getNodeIdentifier() Method to get node lookup identifier.
Integer	getOutputSnmp() SNMP ifIndex
Long	getPackets() Number of packets in the flow
Integer	getProtocol() IP protocol number i.e 6 for TCP, 17 for UDP
long	getReceivedAt() Time at which the flow was received by listener in milliseconds since epoch UTC.
Flow.SamplingAlgorithm	getSamplingAlgorithm() Sampling algorithm ID
Double	getSamplingInterval() Sampling interval
String	getSrcAddr() Source address.
Optional<String>	getSrcAddrHostname() Source address hostname.
Long	getSrcAs() Source autonomous system (AS).
Integer	getSrcMaskLen() The number of contiguous bits in the destination address subnet mask.
Integer	getSrcPort() Source port.
Integer	getTcpFlags() TCP Flags.
long	getTimestamp() Flow timestamp in milliseconds.
Integer	getTos() TOS.
Integer	getVlan() VLAN ID.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SFlow

public SFlow(SFlow.Header header,
             org.bson.BsonDocument document,
             java.time.Instant receivedAt)

Method Detail

getReceivedAt

public long getReceivedAt()

Description copied from interface: Flow

Time at which the flow was received by listener in milliseconds since epoch UTC.

Specified by:

getReceivedAt in interface Flow

getTimestamp

public long getTimestamp()

Description copied from interface: Flow

Flow timestamp in milliseconds.

Specified by:

getTimestamp in interface Flow

getBytes

public Long getBytes()

Description copied from interface: Flow

Number of bytes transferred in the flow.

Specified by:

getBytes in interface Flow

getDirection

public Flow.Direction getDirection()

Description copied from interface: Flow

Direction of the flow (egress vs ingress)

Specified by:

getDirection in interface Flow

getDstAddr

public String getDstAddr()

Description copied from interface: Flow

Destination address.

Specified by:

getDstAddr in interface Flow

getDstAddrHostname

public Optional<String> getDstAddrHostname()

Description copied from interface: Flow

Destination address hostname.

Specified by:

getDstAddrHostname in interface Flow

getDstAs

public Long getDstAs()

Description copied from interface: Flow

Destination autonomous system (AS).

Specified by:

getDstAs in interface Flow

getDstMaskLen

public Integer getDstMaskLen()

Description copied from interface: Flow

The number of contiguous bits in the source address subnet mask.

Specified by:

getDstMaskLen in interface Flow

getDstPort

public Integer getDstPort()

Description copied from interface: Flow

Destination port.

Specified by:

getDstPort in interface Flow

getEngineId

public Integer getEngineId()

Description copied from interface: Flow

Slot number of the flow-switching engine.

Specified by:

getEngineId in interface Flow

getEngineType

public Integer getEngineType()

Description copied from interface: Flow

Type of flow-switching engine.

Specified by:

getEngineType in interface Flow

getFirstSwitched

public Long getFirstSwitched()

Description copied from interface: Flow

Unix timestamp in ms at which the first packet associated with this flow was switched.

Specified by:

getFirstSwitched in interface Flow

getLastSwitched

public Long getLastSwitched()

Description copied from interface: Flow

Unix timestamp in ms at which the last packet associated with this flow was switched.

Specified by:

getLastSwitched in interface Flow

getFlowRecords

public int getFlowRecords()

Description copied from interface: Flow

Number of flow records in the associated packet.

Specified by:

getFlowRecords in interface Flow

getFlowSeqNum

public long getFlowSeqNum()

Description copied from interface: Flow

Flow packet sequence number.

Specified by:

getFlowSeqNum in interface Flow

getInputSnmp

public Integer getInputSnmp()

Description copied from interface: Flow

SNMP ifIndex

Specified by:

getInputSnmp in interface Flow

getOutputSnmp

public Integer getOutputSnmp()

Description copied from interface: Flow

SNMP ifIndex

Specified by:

getOutputSnmp in interface Flow

getIpProtocolVersion

public Integer getIpProtocolVersion()

Description copied from interface: Flow

IPv4 vs IPv6

Specified by:

getIpProtocolVersion in interface Flow

getNextHop

public String getNextHop()

Description copied from interface: Flow

Next hop

Specified by:

getNextHop in interface Flow

getNextHopHostname

public Optional<String> getNextHopHostname()

Description copied from interface: Flow

Next hop hostname

Specified by:

getNextHopHostname in interface Flow

getPackets

public Long getPackets()

Description copied from interface: Flow

Number of packets in the flow

Specified by:

getPackets in interface Flow

getProtocol

public Integer getProtocol()

Description copied from interface: Flow

IP protocol number i.e 6 for TCP, 17 for UDP

Specified by:

getProtocol in interface Flow

getSamplingAlgorithm

public Flow.SamplingAlgorithm getSamplingAlgorithm()

Description copied from interface: Flow

Sampling algorithm ID

Specified by:

getSamplingAlgorithm in interface Flow

getSamplingInterval

public Double getSamplingInterval()

Description copied from interface: Flow

Sampling interval

Specified by:

getSamplingInterval in interface Flow

getSrcAddr

public String getSrcAddr()

Description copied from interface: Flow

Source address.

Specified by:

getSrcAddr in interface Flow

getSrcAddrHostname

public Optional<String> getSrcAddrHostname()

Description copied from interface: Flow

Source address hostname.

Specified by:

getSrcAddrHostname in interface Flow

getSrcAs

public Long getSrcAs()

Description copied from interface: Flow

Source autonomous system (AS).

Specified by:

getSrcAs in interface Flow

getSrcMaskLen

public Integer getSrcMaskLen()

Description copied from interface: Flow

The number of contiguous bits in the destination address subnet mask.

Specified by:

getSrcMaskLen in interface Flow

getSrcPort

public Integer getSrcPort()

Description copied from interface: Flow

Source port.

Specified by:

getSrcPort in interface Flow

getTcpFlags

public Integer getTcpFlags()

Description copied from interface: Flow

TCP Flags.

Specified by:

getTcpFlags in interface Flow

getDeltaSwitched

public Long getDeltaSwitched()

Description copied from interface: Flow

Unix timestamp in ms at which the previous exported packet associated with this flow was switched.

Specified by:

getDeltaSwitched in interface Flow

getTos

public Integer getTos()

Description copied from interface: Flow

TOS.

Specified by:

getTos in interface Flow

getNetflowVersion

public Flow.NetflowVersion getNetflowVersion()

Description copied from interface: Flow

Netfow version

Specified by:

getNetflowVersion in interface Flow

getVlan

public Integer getVlan()

Description copied from interface: Flow

VLAN ID.

Specified by:

getVlan in interface Flow

getNodeIdentifier

public String getNodeIdentifier()

Description copied from interface: Flow

Method to get node lookup identifier. This field can be used as an alternate means to identify the exporter node when the source address of the packets are altered due to address translation. * @return the identifier

Specified by:

getNodeIdentifier in interface Flow