application/net.corda.v5.application.flows

Package-level declarations

Types

CordaInject

@Target(allowedTargets = [AnnotationTarget.FIELD])

annotation class CordaInject

The CordaInject annotation should be used within Flows to inject Corda's platform services.

Flow

@DoNotImplement

interface Flow

Marker interface from which all flow types inherit.

FlowContextProperties

interface FlowContextProperties

Context properties of a Flow are key value pairs of Strings. They are comprised of two sets of properties, those set by the platform when a Flow is started, and those which are added by the CorDapp developer during the execution of their flow. The latter set are referred to as user context properties. All context properties are immutable once set.

FlowEngine

@DoNotImplement

interface FlowEngine

FlowEngine provides core flow related functionality.

InitiatedBy

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class InitiatedBy(val protocol: String, val version: IntArray = [1])

InitiatedBy specifies the protocol name that triggers a ResponderFlow as a consequence of a counterparty requesting a new session.

InitiatingFlow

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class InitiatingFlow(val protocol: String, val version: IntArray = [1])

InitiatingFlow marks a flow as initiating, meaning that it starts a ResponderFlow when creating a session with another network entity.

ResponderFlow

interface ResponderFlow : Flow

ResponderFlow is a Flow that is started by receiving a message from a peer.

RPCRequestData

interface RPCRequestData

RPCRequestData wraps the requestData parameter of the HTTP call that triggered a RPCStartableFlow.

RPCStartableFlow

interface RPCStartableFlow : Flow

RPCStartableFlow is a Flow that is started via RPC.

SubFlow

interface SubFlow<out T> : Flow

A SubFlow can be used to:

Functions

getRequestBodyAs

inline fun <T> RPCRequestData.getRequestBodyAs(marshallingService: MarshallingService): T

Gets the request body and deserializes it into the given type, using a MarshallingService.

getRequestBodyAsList

inline fun <T> RPCRequestData.getRequestBodyAsList(marshallingService: MarshallingService): List<T>

Gets the request body and deserializes it into a list of the given type, using a MarshallingService.

set

operator fun FlowContextProperties.set(key: String, value: String)

Puts a user value into the context property store.