Package security.whisper.javastix.coo.objects

Interface NetworkTrafficCoo

All Superinterfaces:

BundleableObject, CyberObservableObject, CyberObservableObjectCommonProperties, GenericValidation, SdoDefaultValidator, Serializable, Stix, StixCustomProperties

All Known Implementing Classes:

NetworkTraffic

@Immutable
@DefaultTypeValue(value="network-traffic",
                  groups=DefaultValuesProcessor.class)
public interface NetworkTrafficCoo
extends CyberObservableObject

network-traffic

The Network Traffic Object represents arbitrary network traffic that originates from a source and is addressed to a destination.

Field Summary

Fields inherited from interface security.whisper.javastix.validation.SdoDefaultValidator

VALIDATOR

Method Summary

Modifier and Type	Method	Description
Optional<Long>	getDstByteCount()
Optional<Long>	getDstPackets()
Optional<String>	getDstPayloadRef()
Optional<@Range(min=0L,max=65535L) Integer>	getDstPort()
Optional<String>	getDstRef()
Optional<String>	getEncapsulatedByRef()
default Set<String>	getEncapsulatesRefs()
Optional<StixInstant>	getEnd()
default String	getId()	Deterministically generates the ID for this network traffic based on source/destination references, ports, and protocols.
Map<String,Object>	getIpFix()
default @NotNull Set<String>	getProtocols()
Optional<Long>	getSrcByteCount()
Optional<Long>	getSrcPackets()
Optional<String>	getSrcPayloadRef()
Optional<@Range(min=0L,max=65535L) Integer>	getSrcPort()
Optional<String>	getSrcRef()
Optional<StixInstant>	getStart()
@NotNull Optional<Boolean>	isActive()

Methods inherited from interface security.whisper.javastix.bundle.BundleableObject

getGranularMarkings, getHydrated, getObjectMarkingRefs, getType, toJsonString

Methods inherited from interface security.whisper.javastix.coo.CyberObservableObjectCommonProperties

getDefanged, getExtensions, getObservableObjectKey, getType

Methods inherited from interface security.whisper.javastix.validation.GenericValidation

validateEntity

Methods inherited from interface security.whisper.javastix.validation.SdoDefaultValidator

validate, validateOnlyId

Methods inherited from interface security.whisper.javastix.common.StixCustomProperties

getCustomProperties

Method Details

getStart

@JsonPropertyDescription("Specifies the date/time the network traffic was initiated, if known.")
Optional<StixInstant> getStart()

getEnd

@JsonPropertyDescription("Specifies the date/time the network traffic ended, if known.")
Optional<StixInstant> getEnd()

isActive

@JsonPropertyDescription("Indicates whether the network traffic is still ongoing.")
@NotNull
@NotNull Optional<Boolean> isActive()

getSrcRef

@JsonPropertyDescription("Specifies the source of the network traffic, as a reference to one or more Observable Objects.")
Optional<String> getSrcRef()

getDstRef

@JsonPropertyDescription("Specifies the destination of the network traffic, as a reference to one or more Observable Objects.")
Optional<String> getDstRef()

getSrcPort

@JsonPropertyDescription("Specifies the source port used in the network traffic, as an integer. The port value MUST be in the range of 0 - 65535.")
Optional<@Range(min=0L,max=65535L) Integer> getSrcPort()

getDstPort

@JsonPropertyDescription("Specifies the destination port used in the network traffic, as an integer. The port value MUST be in the range of 0 - 65535.")
Optional<@Range(min=0L,max=65535L) Integer> getDstPort()

getProtocols

@JsonPropertyDescription("Specifies the protocols observed in the network traffic, along with their corresponding state.")
@NotNull
default @NotNull Set<String> getProtocols()

getSrcByteCount

@JsonPropertyDescription("Specifies the number of bytes sent from the source to the destination.")
Optional<Long> getSrcByteCount()

getDstByteCount

@JsonPropertyDescription("Specifies the number of bytes sent from the destination to the source.")
Optional<Long> getDstByteCount()

getSrcPackets

@JsonPropertyDescription("Specifies the number of packets sent from the source to the destination.")
Optional<Long> getSrcPackets()

getDstPackets

@JsonPropertyDescription("Specifies the number of packets sent destination to the source.")
Optional<Long> getDstPackets()

getIpFix

@JsonPropertyDescription("Specifies any IP Flow Information Export [IPFIX] data for the traffic, as a dictionary.")
Map<String,Object> getIpFix()

getSrcPayloadRef

@JsonPropertyDescription("Specifies the bytes sent from the source to the destination.")
Optional<String> getSrcPayloadRef()

getDstPayloadRef

@JsonPropertyDescription("Specifies the bytes sent from the source to the destination.")
Optional<String> getDstPayloadRef()

getEncapsulatesRefs

@JsonPropertyDescription("Links to other network-traffic objects encapsulated by a network-traffic.")
default Set<String> getEncapsulatesRefs()

getEncapsulatedByRef

@JsonPropertyDescription("Links to another network-traffic object which encapsulates this object.")
Optional<String> getEncapsulatedByRef()

getId

@Derived
default String getId()

Deterministically generates the ID for this network traffic based on source/destination references, ports, and protocols.

Specified by:

getId in interface BundleableObject

Specified by:

getId in interface CyberObservableObjectCommonProperties