orchestrate/com.pingidentity.orchestrate

Package-level declarations

Types

Action

interface Action

Interface for actions.

Closeable

interface Closeable

Interface for closeable resources.

ContinueNode

abstract class ContinueNode(val context: FlowContext, val workflow: Workflow, val input: JsonObject, val actions: List<Action>) : Node, Closeable

Abstract class for a ContinueNode in the workflow.

ContinueNodeAware

interface ContinueNodeAware

An interface that should be implemented by classes that need to be aware of the ContinueNode. The continueNode will be injected to the classes that implement this interface.

EmptySession

data object EmptySession : Session

Object for an EmptySession. An EmptySession represents a session with no value.

ErrorNode

data class ErrorNode(val context: FlowContext, val input: JsonObject = buildJsonObject { }, val message: String) : Node

Represents a failure node in the workflow.

FailureNode

data class FailureNode(val cause: Throwable) : Node

Represents an error node in the workflow.

FlowContext

class FlowContext(val flowContext: SharedContext)

Class representing the context of a flow.

Module

interface Module<ModuleConfig : Any>

Interface for a Module. A Module represents a unit of functionality in the application.

ModuleRegistry

@VisibleForTesting(otherwise = 3)

class ModuleRegistry<Config : Any> : Comparable<ModuleRegistry<Config>>

Class for a ModuleRegistry. A ModuleRegistry represents a registry of modules in the application.

Node

sealed interface Node

Sealed interface for Node. Represents a node in the workflow.

OverrideMode

enum OverrideMode : Enum<OverrideMode>

Enum class representing the mode of module override.

RequestInterceptor

interface RequestInterceptor

An interface that should be implemented by classes that need to be transformed itself to a Request.

Session

interface Session

Interface for a Session. A Session represents a user's session in the application.

Setup

class Setup<ModuleConfig : Any>

Class for a Setup. A Setup represents the setup of a module in the application.

SharedContext

class SharedContext(val map: MutableMap<String, Any>) : MutableMap<String, Any>

Class for a SharedContext. A SharedContext represents a shared context in the application.

SuccessNode

data class SuccessNode(val input: JsonObject = buildJsonObject {}, val session: Session) : Node

Represents a success node in the workflow.

Workflow

class Workflow(val config: WorkflowConfig)

Class representing a workflow.

WorkflowConfig

open class WorkflowConfig

DSL class for configuring a Workflow.

Functions

catch

inline fun catch(block: () -> Node): Node

Tries to execute the given block and returns an Error node if an exception is thrown.

Workflow

fun Workflow(block: WorkflowConfig.() -> Unit = {}): Workflow

Creates a new Workflow instance with the provided configuration block.