docs/net.corda.core.context/InvocationContext

InvocationContext

data class InvocationContext(val origin: InvocationOrigin, val trace: Trace, val actor: Actor?, val externalTrace: Trace? = null, val impersonatedActor: Actor? = null, val arguments: List<Any?>? = emptyList(), val clientId: String? = null, val serializedTelemetry: SerializedTelemetry? = null)

Models the information needed to trace an invocation in Corda. Includes initiating actor, origin, trace information, and optional external trace information to correlate clients' IDs.

Constructors

Link copied to clipboard
constructor(origin: InvocationOrigin, trace: Trace, actor: Actor?, externalTrace: Trace? = null, impersonatedActor: Actor? = null)
constructor(origin: InvocationOrigin, trace: Trace, actor: Actor?, externalTrace: Trace? = null, impersonatedActor: Actor? = null, arguments: List<Any?>? = emptyList(), clientId: String? = null)
constructor(origin: InvocationOrigin, trace: Trace, actor: Actor?, externalTrace: Trace? = null, impersonatedActor: Actor? = null, arguments: List<Any?>? = emptyList(), clientId: String? = null, serializedTelemetry: SerializedTelemetry? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val actor: Actor?

Acting agent of the invocation, used to derive the security principal.

Link copied to clipboard
val arguments: List<Any?>?
Link copied to clipboard
val clientId: String? = null
Link copied to clipboard
val externalTrace: Trace? = null

Optional external invocation trace for cross-system logs correlation.

Link copied to clipboard
val impersonatedActor: Actor? = null

Optional impersonated actor, used for logging but not for authorisation.

Link copied to clipboard
val origin: InvocationOrigin

Origin of the invocation.

Link copied to clipboard
Link copied to clipboard
val trace: Trace

Corda invocation trace.

Functions

Link copied to clipboard
fun copy(origin: InvocationOrigin = this.origin, trace: Trace = this.trace, actor: Actor? = this.actor, externalTrace: Trace? = this.externalTrace, impersonatedActor: Actor? = this.impersonatedActor): InvocationContext
fun copy(origin: InvocationOrigin = this.origin, trace: Trace = this.trace, actor: Actor? = this.actor, externalTrace: Trace? = this.externalTrace, impersonatedActor: Actor? = this.impersonatedActor, arguments: List<Any?>? = this.arguments, clientId: String? = this.clientId): InvocationContext
Link copied to clipboard
fun principal(): Principal

Associated security principal.