net.corda.node.services.api

Class FlowErrorAuditEvent

AuditEvent

net.corda.node.services.api.FlowErrorAuditEvent

All Implemented Interfaces:

FlowAuditInfo

public class FlowErrorAuditEvent
extends AuditEvent
implements FlowAuditInfo

Sealed data class to record any FlowExceptions, or other unexpected terminations of a Flow.

Constructor Summary

Constructors

Constructor and Description
FlowErrorAuditEvent(java.time.Instant timestamp, java.security.Principal principal, java.lang.String description, java.util.Map<java.lang.String,java.lang.String> contextData, java.lang.Class<? extends net.corda.core.flows.FlowLogic<?>> flowType, StateMachineRunId flowId, java.lang.Throwable error) Sealed data class to record any FlowExceptions, or other unexpected terminations of a Flow.

Method Summary

Modifier and Type	Method and Description
java.time.Instant	component1() The UTC time point at which the audit event happened.
java.security.Principal	component2() The responsible individual,
java.lang.String	component3() A human readable description of audit event including any permission check results.
java.util.Map<java.lang.String,java.lang.String>	component4() Further tagged details that should be recorded along with the common data of the audit event.
java.lang.Class<? extends net.corda.core.flows.FlowLogic<?>>	component5() The concrete type of FlowLogic being referenced.
StateMachineRunId	component6() The stable identifier of the flow as stored with Checkpoints.
java.lang.Throwable	component7()
FlowErrorAuditEvent	copy(java.time.Instant timestamp, java.security.Principal principal, java.lang.String description, java.util.Map<java.lang.String,java.lang.String> contextData, java.lang.Class<? extends net.corda.core.flows.FlowLogic<?>> flowType, StateMachineRunId flowId, java.lang.Throwable error) Sealed data class to record any FlowExceptions, or other unexpected terminations of a Flow.
boolean	equals(java.lang.Object p)
java.util.Map<java.lang.String,java.lang.String>	getContextData() Further tagged details that should be recorded along with the common data of the audit event.
java.lang.String	getDescription() A human readable description of audit event including any permission check results.
java.lang.Throwable	getError()
StateMachineRunId	getFlowId() The stable identifier of the flow as stored with Checkpoints.
java.lang.Class<? extends net.corda.core.flows.FlowLogic<?>>	getFlowType() The concrete type of FlowLogic being referenced.
java.security.Principal	getPrincipal() The responsible individual,
java.time.Instant	getTimestamp() The UTC time point at which the audit event happened.
int	hashCode()
java.lang.String	toString()

Methods inherited from class net.corda.node.services.api.AuditEvent

getContextData, getDescription, getPrincipal, getTimestamp

Methods inherited from interface net.corda.node.services.api.FlowAuditInfo

getFlowId, getFlowType

Constructor Detail

FlowErrorAuditEvent

public FlowErrorAuditEvent(java.time.Instant timestamp,
                           java.security.Principal principal,
                           java.lang.String description,
                           java.util.Map<java.lang.String,java.lang.String> contextData,
                           java.lang.Class<? extends net.corda.core.flows.FlowLogic<?>> flowType,
                           StateMachineRunId flowId,
                           java.lang.Throwable error)

Sealed data class to record any FlowExceptions, or other unexpected terminations of a Flow.

Parameters:

timestamp - The UTC time point at which the audit event happened.

principal - The responsible individual, node, or subsystem to which the audit event can be mapped.

description - A human readable description of audit event including any permission check results.

contextData - Further tagged details that should be recorded along with the common data of the audit event.Examples of this might be trade identifiers, system error codes, or source IP addresses, which could be usefulwhen searching the historic audit data for trails of evidence.

flowType - The concrete type of FlowLogic being referenced.TODO This should be replaced with the fully versioned name/signature of the flow.

flowId - The stable identifier of the flow as stored with Checkpoints.

Method Detail

getTimestamp

public java.time.Instant getTimestamp()

The UTC time point at which the audit event happened.

getPrincipal

public java.security.Principal getPrincipal()

The responsible individual,

node, or subsystem to which the audit event can be mapped.

getDescription

public java.lang.String getDescription()

A human readable description of audit event including any permission check results.

getContextData

public java.util.Map<java.lang.String,java.lang.String> getContextData()

Further tagged details that should be recorded along with the common data of the audit event.

Examples of this might be trade identifiers, system error codes, or source IP addresses, which could be usefulwhen searching the historic audit data for trails of evidence.

getFlowType

public java.lang.Class<? extends net.corda.core.flows.FlowLogic<?>> getFlowType()

The concrete type of FlowLogic being referenced.

TODO This should be replaced with the fully versioned name/signature of the flow.

getFlowId

public StateMachineRunId getFlowId()

The stable identifier of the flow as stored with Checkpoints.

getError

public java.lang.Throwable getError()

component1

public java.time.Instant component1()

The UTC time point at which the audit event happened.

component2

public java.security.Principal component2()

The responsible individual,

node, or subsystem to which the audit event can be mapped.

component3

public java.lang.String component3()

A human readable description of audit event including any permission check results.

component4

public java.util.Map<java.lang.String,java.lang.String> component4()

Further tagged details that should be recorded along with the common data of the audit event.

Examples of this might be trade identifiers, system error codes, or source IP addresses, which could be usefulwhen searching the historic audit data for trails of evidence.

component5

public java.lang.Class<? extends net.corda.core.flows.FlowLogic<?>> component5()

The concrete type of FlowLogic being referenced.

TODO This should be replaced with the fully versioned name/signature of the flow.

component6

public StateMachineRunId component6()

The stable identifier of the flow as stored with Checkpoints.

component7

public java.lang.Throwable component7()

copy

public FlowErrorAuditEvent copy(java.time.Instant timestamp,
                                java.security.Principal principal,
                                java.lang.String description,
                                java.util.Map<java.lang.String,java.lang.String> contextData,
                                java.lang.Class<? extends net.corda.core.flows.FlowLogic<?>> flowType,
                                StateMachineRunId flowId,
                                java.lang.Throwable error)

Sealed data class to record any FlowExceptions, or other unexpected terminations of a Flow.

toString

public java.lang.String toString()

hashCode

public int hashCode()

equals

public boolean equals(java.lang.Object p)