Package org.opennms.netmgt.flows.api
Interface Flow
-
- All Known Implementing Classes:
NetflowMessage
,SFlow
public interface Flow
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
Flow.Direction
static class
Flow.NetflowVersion
static class
Flow.SamplingAlgorithm
-
Field Summary
Fields Modifier and Type Field Description static int
IPV4_PROTOCOL_VERSION
static int
IPV6_PROTOCOL_VERSION
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method 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)default Integer
getDscp()
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.default Integer
getEcn()
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 ifIndexInteger
getIpProtocolVersion()
IPv4 vs IPv6Long
getLastSwitched()
Unix timestamp in ms at which the last packet associated with this flow was switched.Flow.NetflowVersion
getNetflowVersion()
Netfow versionString
getNextHop()
Next hopOptional<String>
getNextHopHostname()
Next hop hostnameString
getNodeIdentifier()
Method to get node lookup identifier.Integer
getOutputSnmp()
SNMP ifIndexLong
getPackets()
Number of packets in the flowInteger
getProtocol()
IP protocol number i.e 6 for TCP, 17 for UDPlong
getReceivedAt()
Time at which the flow was received by listener in milliseconds since epoch UTC.Flow.SamplingAlgorithm
getSamplingAlgorithm()
Sampling algorithm IDDouble
getSamplingInterval()
Sampling intervalString
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.
-
-
-
Field Detail
-
IPV4_PROTOCOL_VERSION
static final int IPV4_PROTOCOL_VERSION
- See Also:
- Constant Field Values
-
IPV6_PROTOCOL_VERSION
static final int IPV6_PROTOCOL_VERSION
- See Also:
- Constant Field Values
-
-
Method Detail
-
getReceivedAt
long getReceivedAt()
Time at which the flow was received by listener in milliseconds since epoch UTC.
-
getTimestamp
long getTimestamp()
Flow timestamp in milliseconds.
-
getBytes
Long getBytes()
Number of bytes transferred in the flow.
-
getDirection
Flow.Direction getDirection()
Direction of the flow (egress vs ingress)
-
getDstAddr
String getDstAddr()
Destination address.
-
getDstAs
Long getDstAs()
Destination autonomous system (AS).
-
getDstMaskLen
Integer getDstMaskLen()
The number of contiguous bits in the source address subnet mask.
-
getDstPort
Integer getDstPort()
Destination port.
-
getEngineId
Integer getEngineId()
Slot number of the flow-switching engine.
-
getEngineType
Integer getEngineType()
Type of flow-switching engine.
-
getDeltaSwitched
Long getDeltaSwitched()
Unix timestamp in ms at which the previous exported packet associated with this flow was switched.
-
getFirstSwitched
Long getFirstSwitched()
Unix timestamp in ms at which the first packet associated with this flow was switched.
-
getFlowRecords
int getFlowRecords()
Number of flow records in the associated packet.
-
getFlowSeqNum
long getFlowSeqNum()
Flow packet sequence number.
-
getInputSnmp
Integer getInputSnmp()
SNMP ifIndex
-
getIpProtocolVersion
Integer getIpProtocolVersion()
IPv4 vs IPv6
-
getLastSwitched
Long getLastSwitched()
Unix timestamp in ms at which the last packet associated with this flow was switched.
-
getNextHop
String getNextHop()
Next hop
-
getOutputSnmp
Integer getOutputSnmp()
SNMP ifIndex
-
getPackets
Long getPackets()
Number of packets in the flow
-
getProtocol
Integer getProtocol()
IP protocol number i.e 6 for TCP, 17 for UDP
-
getSamplingAlgorithm
Flow.SamplingAlgorithm getSamplingAlgorithm()
Sampling algorithm ID
-
getSamplingInterval
Double getSamplingInterval()
Sampling interval
-
getSrcAddr
String getSrcAddr()
Source address.
-
getSrcAs
Long getSrcAs()
Source autonomous system (AS).
-
getSrcMaskLen
Integer getSrcMaskLen()
The number of contiguous bits in the destination address subnet mask.
-
getSrcPort
Integer getSrcPort()
Source port.
-
getTcpFlags
Integer getTcpFlags()
TCP Flags.
-
getTos
Integer getTos()
TOS.
-
getDscp
default Integer getDscp()
-
getEcn
default Integer getEcn()
-
getNetflowVersion
Flow.NetflowVersion getNetflowVersion()
Netfow version
-
getVlan
Integer getVlan()
VLAN ID.
-
getNodeIdentifier
String getNodeIdentifier()
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
-
-