net.corda.core.context

Class InvocationContext

net.corda.core.context.InvocationContext

public class InvocationContext

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	InvocationContext.Companion

Field Summary

Fields

Modifier and Type	Field and Description
static InvocationContext.Companion	Companion

Constructor Summary

Constructors

Constructor and Description
InvocationContext(InvocationOrigin origin, Trace trace, Actor actor, Trace externalTrace, Actor impersonatedActor) 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.

Method Summary

Modifier and Type	Method and Description
InvocationOrigin	component1() Origin of the invocation.
Trace	component2() Corda invocation trace.
Actor	component3() Acting agent of the invocation,
Trace	component4() Optional external invocation trace for cross-system logs correlation.
Actor	component5() Optional impersonated actor,
InvocationContext	copy(InvocationOrigin origin, Trace trace, Actor actor, Trace externalTrace, Actor impersonatedActor) 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.
boolean	equals(java.lang.Object p)
Actor	getActor() Acting agent of the invocation,
Trace	getExternalTrace() Optional external invocation trace for cross-system logs correlation.
Actor	getImpersonatedActor() Optional impersonated actor,
InvocationOrigin	getOrigin() Origin of the invocation.
Trace	getTrace() Corda invocation trace.
int	hashCode()
static InvocationContext	newInstance(InvocationOrigin origin, Trace trace, Actor actor, Trace externalTrace, Actor impersonatedActor) Creates an class InvocationContext with a class Trace that defaults to a java.util.UUID as value and java.time.Instant.now timestamp.
static InvocationContext	peer(CordaX500Name party, Trace trace, Trace externalTrace, Actor impersonatedActor) Creates an class InvocationContext with class InvocationOrigin.Peer origin.
java.security.Principal	principal() Associated security principal.
static InvocationContext	rpc(Actor actor, Trace trace, Trace externalTrace, Actor impersonatedActor) Creates an class InvocationContext with class InvocationOrigin.RPC origin.
static InvocationContext	scheduled(ScheduledStateRef scheduledState, Trace trace, Trace externalTrace) Creates an class InvocationContext with class InvocationOrigin.Scheduled origin.
static InvocationContext	service(java.lang.String serviceClassName, CordaX500Name owningLegalIdentity, Trace trace, Trace externalTrace) Creates an class InvocationContext with class InvocationOrigin.Service origin.
static InvocationContext	shell(Trace trace, Trace externalTrace) Creates an class InvocationContext with class InvocationOrigin.Shell origin.
java.lang.String	toString()

Field Detail

Companion

public static InvocationContext.Companion Companion

Constructor Detail

InvocationContext

public InvocationContext(InvocationOrigin origin,
                         Trace trace,
                         Actor actor,
                         Trace externalTrace,
                         Actor impersonatedActor)

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.

Parameters:

origin - Origin of the invocation.

trace - Corda invocation trace.

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

externalTrace - Optional external invocation trace for cross-system logs correlation.

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

Method Detail

principal

public java.security.Principal principal()

Associated security principal.

getOrigin

public InvocationOrigin getOrigin()

Origin of the invocation.

getTrace

public Trace getTrace()

Corda invocation trace.

getActor

public Actor getActor()

Acting agent of the invocation,

used to derive the security principal.

getExternalTrace

public Trace getExternalTrace()

Optional external invocation trace for cross-system logs correlation.

getImpersonatedActor

public Actor getImpersonatedActor()

Optional impersonated actor,

used for logging but not for authorisation.

component1

public InvocationOrigin component1()

Origin of the invocation.

component2

public Trace component2()

Corda invocation trace.

component3

public Actor component3()

Acting agent of the invocation,

used to derive the security principal.

component4

public Trace component4()

Optional external invocation trace for cross-system logs correlation.

component5

public Actor component5()

Optional impersonated actor,

used for logging but not for authorisation.

copy

public InvocationContext copy(InvocationOrigin origin,
                              Trace trace,
                              Actor actor,
                              Trace externalTrace,
                              Actor impersonatedActor)

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.

toString

public java.lang.String toString()

hashCode

public int hashCode()

equals

public boolean equals(java.lang.Object p)

newInstance

public static InvocationContext newInstance(InvocationOrigin origin,
                                            Trace trace,
                                            Actor actor,
                                            Trace externalTrace,
                                            Actor impersonatedActor)

Creates an class InvocationContext with a class Trace that defaults to a java.util.UUID as value and java.time.Instant.now timestamp.

See Also:

class InvocationContext, class Trace, java.util.UUID, java.time.Instant.now

rpc

public static InvocationContext rpc(Actor actor,
                                    Trace trace,
                                    Trace externalTrace,
                                    Actor impersonatedActor)

Creates an class InvocationContext with class InvocationOrigin.RPC origin.

See Also:

class InvocationContext, class InvocationOrigin.RPC

peer

public static InvocationContext peer(CordaX500Name party,
                                     Trace trace,
                                     Trace externalTrace,
                                     Actor impersonatedActor)

Creates an class InvocationContext with class InvocationOrigin.Peer origin.

See Also:

class InvocationContext, class InvocationOrigin.Peer

service

public static InvocationContext service(java.lang.String serviceClassName,
                                        CordaX500Name owningLegalIdentity,
                                        Trace trace,
                                        Trace externalTrace)

Creates an class InvocationContext with class InvocationOrigin.Service origin.

See Also:

class InvocationContext, class InvocationOrigin.Service

scheduled

public static InvocationContext scheduled(ScheduledStateRef scheduledState,
                                          Trace trace,
                                          Trace externalTrace)

Creates an class InvocationContext with class InvocationOrigin.Scheduled origin.

See Also:

class InvocationContext, class InvocationOrigin.Scheduled

shell

public static InvocationContext shell(Trace trace,
                                      Trace externalTrace)

Creates an class InvocationContext with class InvocationOrigin.Shell origin.

See Also:

class InvocationContext, class InvocationOrigin.Shell