Package org.opennms.netmgt.flows.api

Interface Flow

    • 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

        java.lang.Long getBytes()
        Number of bytes transferred in the flow.

      • getDirection

        Flow.Direction getDirection()
        Direction of the flow (egress vs ingress)

      • getDstAddr

        java.lang.String getDstAddr()
        Destination address.

      • getDstAddrHostname

        java.util.Optional<java.lang.String> getDstAddrHostname()
        Destination address hostname.

      • getDstAs

        java.lang.Long getDstAs()
        Destination autonomous system (AS).

      • getDstMaskLen

        java.lang.Integer getDstMaskLen()
        The number of contiguous bits in the source address subnet mask.

      • getDstPort

        java.lang.Integer getDstPort()
        Destination port.

      • getEngineId

        java.lang.Integer getEngineId()
        Slot number of the flow-switching engine.

      • getEngineType

        java.lang.Integer getEngineType()
        Type of flow-switching engine.

      • getDeltaSwitched

        java.lang.Long getDeltaSwitched()
        Unix timestamp in ms at which the previous exported packet associated with this flow was switched.

      • getFirstSwitched

        java.lang.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

        java.lang.Integer getInputSnmp()
        SNMP ifIndex

      • getIpProtocolVersion

        java.lang.Integer getIpProtocolVersion()
        IPv4 vs IPv6

      • getLastSwitched

        java.lang.Long getLastSwitched()
        Unix timestamp in ms at which the last packet associated with this flow was switched.

      • getNextHop

        java.lang.String getNextHop()
        Next hop

      • getNextHopHostname

        java.util.Optional<java.lang.String> getNextHopHostname()
        Next hop hostname

      • getOutputSnmp

        java.lang.Integer getOutputSnmp()
        SNMP ifIndex

      • getPackets

        java.lang.Long getPackets()
        Number of packets in the flow

      • getProtocol

        java.lang.Integer getProtocol()
        IP protocol number i.e 6 for TCP, 17 for UDP

      • getSamplingInterval

        java.lang.Double getSamplingInterval()
        Sampling interval

      • getSrcAddr

        java.lang.String getSrcAddr()
        Source address.

      • getSrcAddrHostname

        java.util.Optional<java.lang.String> getSrcAddrHostname()
        Source address hostname.

      • getSrcAs

        java.lang.Long getSrcAs()
        Source autonomous system (AS).

      • getSrcMaskLen

        java.lang.Integer getSrcMaskLen()
        The number of contiguous bits in the destination address subnet mask.

      • getSrcPort

        java.lang.Integer getSrcPort()
        Source port.

      • getTcpFlags

        java.lang.Integer getTcpFlags()
        TCP Flags.

      • getTos

        java.lang.Integer getTos()
        TOS.

      • getDscp

        default java.lang.Integer getDscp()

      • getEcn

        default java.lang.Integer getEcn()

      • getVlan

        java.lang.Integer getVlan()
        VLAN ID.

      • getNodeIdentifier

        java.lang.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