modulecheck-reporting:sarif/modulecheck.reporting.sarif/ThreadFlowLocation

ThreadFlowLocation

@JsonClass(generateAdapter = true)

data class ThreadFlowLocation(@Json(name = "executionOrder") val executionOrder: Int? = null, @Json(name = "executionTimeUtc") val executionTimeUTC: String? = null, @Json(name = "importance") val importance: Importance? = null, @Json(name = "index") val index: Int? = null, @Json(name = "kinds") val kinds: List<String>? = null, @Json(name = "location") val location: Location? = null, @Json(name = "module") val module: String? = null, @Json(name = "nestingLevel") val nestingLevel: Int? = null, @Json(name = "properties") val properties: PropertyBag? = null, @Json(name = "stack") val stack: Stack? = null, @Json(name = "state") val state: Map<String, MultiformatMessageString>? = null, @Json(name = "taxa") val taxa: List<ReportingDescriptorReference>? = null, @Json(name = "webRequest") val webRequest: WebRequest? = null, @Json(name = "webResponse") val webResponse: WebResponse? = null)(source)

A location visited by an analysis tool while simulating or monitoring the execution of a program.

Since

0.12.0

Constructors

ThreadFlowLocation

constructor(@Json(name = "executionOrder") executionOrder: Int? = null, @Json(name = "executionTimeUtc") executionTimeUTC: String? = null, @Json(name = "importance") importance: Importance? = null, @Json(name = "index") index: Int? = null, @Json(name = "kinds") kinds: List<String>? = null, @Json(name = "location") location: Location? = null, @Json(name = "module") module: String? = null, @Json(name = "nestingLevel") nestingLevel: Int? = null, @Json(name = "properties") properties: PropertyBag? = null, @Json(name = "stack") stack: Stack? = null, @Json(name = "state") state: Map<String, MultiformatMessageString>? = null, @Json(name = "taxa") taxa: List<ReportingDescriptorReference>? = null, @Json(name = "webRequest") webRequest: WebRequest? = null, @Json(name = "webResponse") webResponse: WebResponse? = null)

Properties

executionOrder

val executionOrder: Int? = null

An integer representing the temporal order in which execution reached this location.

executionTimeUTC

val executionTimeUTC: String? = null

The Coordinated Universal Time (UTC) date and time at which this location was executed.

importance

val importance: Importance? = null

Specifies the importance of this location in understanding the code flow in which it occurs. The order from most to least important is "essential", "important", "unimportant". Default: "important".

index

val index: Int? = null

The index within the run threadFlowLocations array.

kinds

val kinds: List<String>? = null

A set of distinct strings that categorize the thread flow location. Well-known kinds include 'acquire', 'release', 'enter', 'exit', 'call', 'return', 'branch', 'implicit', 'false', 'true', 'caution', 'danger', 'unknown', 'unreachable', 'taint', 'function', 'handler', 'lock', 'memory', 'resource', 'scope' and 'value'.

location

val location: Location? = null

The code location.

module

val module: String? = null

The name of the module that contains the code that is executing.

nestingLevel

val nestingLevel: Int? = null

An integer representing a containment hierarchy within the thread flow.

properties

val properties: PropertyBag? = null

Key/value pairs that provide additional information about the threadflow location.

stack

val stack: Stack? = null

The call stack leading to this location.

state

val state: Map<String, MultiformatMessageString>? = null

A dictionary, each of whose keys specifies a variable or expression, the associated value of which represents the variable or expression value. For an annotation of kind 'continuation', for example, this dictionary might hold the current assumed values of a set of global variables.

taxa

val taxa: List<ReportingDescriptorReference>? = null

An array of references to rule or taxonomy reporting descriptors that are applicable to the thread flow location.

webRequest

val webRequest: WebRequest? = null

A web request associated with this thread flow location.

webResponse

val webResponse: WebResponse? = null

A web response associated with this thread flow location.