wow-core/me.ahoo.wow.command

Package-level declarations

Types

ClientCommandExchange

interface ClientCommandExchange<C : Any> : CommandExchange<ClientCommandExchange<C>, C>

Client-side command exchange interface for commands sent from clients.

CommandBus

interface CommandBus : MessageBus<CommandMessage<*>, ServerCommandExchange<*>> , TopicKindCapable

Command Bus interface for handling command messages in the CQRS architecture.

CommandExchange

interface CommandExchange<SOURCE : CommandExchange<SOURCE, C>, C : Any> : MessageExchange<SOURCE, CommandMessage<C>>

Base interface for command exchanges that facilitate message passing during command processing.

CommandGateway

interface CommandGateway : CommandBus

Command Gateway interface for sending commands and waiting for their results.

CommandOperator

object CommandOperator

Provides utility functions and extensions for managing command operators in message headers. This object allows setting and retrieving operator information from command message headers, which is useful for tracking who initiated a command.

CommandResult

data class CommandResult(val id: String, val waitCommandId: String, val stage: CommandStage, val contextName: String, val aggregateName: String, val tenantId: String, val aggregateId: String, val aggregateVersion: Int? = null, val requestId: String, val commandId: String, val function: FunctionInfoData, val errorCode: String = ErrorCodes.SUCCEEDED, val errorMsg: String = ErrorCodes.SUCCEEDED_MESSAGE, val bindingErrors: List<BindingError> = emptyList(), val result: Map<String, Any> = emptyMap(), val signalTime: Long = System.currentTimeMillis()) : Identifier, WaitCommandIdCapable, CommandStageCapable, NamedBoundedContext, AggregateNameCapable, TenantId, NullableAggregateVersionCapable, CommandId, RequestId, ErrorInfo, FunctionInfoCapable<FunctionInfoData> , CommandResultCapable, SignalTimeCapable, Materialized

Represents the result of a command execution, containing all relevant information about the command processing outcome.

CommandResultCapable

interface CommandResultCapable

Interface for objects that can provide command execution results. Implementations of this interface expose their results as a map of key-value pairs, allowing for flexible result representation and access.

CommandResultException

class CommandResultException(val commandResult: CommandResult, cause: Throwable? = null) : WowException, ErrorInfoCapable

Exception wrapping a command result that indicates failure.

CommandValidationException

class CommandValidationException(val command: Any, errorMsg: String = "Command validation failed.", bindingErrors: List<BindingError> = emptyList(), cause: Throwable? = null) : WowException, ErrorInfo

Exception thrown when command validation fails.

DefaultCommandGateway

class DefaultCommandGateway(commandWaitEndpoint: CommandWaitEndpoint, commandBus: CommandBus, validator: Validator, idempotencyCheckerProvider: AggregateIdempotencyCheckerProvider, waitStrategyRegistrar: WaitStrategyRegistrar, commandWaitNotifier: CommandWaitNotifier) : CommandGateway, CommandBus

Default implementation of the CommandGateway interface. This gateway provides comprehensive command handling including validation, idempotency checking, and various sending strategies with optional waiting.

DistributedCommandBus

interface DistributedCommandBus : CommandBus, DistributedMessageBus<CommandMessage<*>, ServerCommandExchange<*>>

Distributed Command Bus interface for handling commands across multiple instances or services.

DuplicateRequestIdException

class DuplicateRequestIdException(val aggregateId: AggregateId, val requestId: String, errorMsg: String = "Duplicate request ID[", cause: Throwable? = null) : WowException, NamedAggregate

Exception thrown when a duplicate request ID is detected.

InMemoryCommandBus

class InMemoryCommandBus(val sinkSupplier: (NamedAggregate) -> Sinks.Many<CommandMessage<*>> = { Sinks.many().unicast().onBackpressureBuffer() }) : InMemoryMessageBus<CommandMessage<*>, ServerCommandExchange<*>> , LocalCommandBus

In-memory implementation of CommandBus for local command processing. This bus uses unicast sinks to ensure each command has exactly one consumer, making it suitable for single-instance or testing scenarios.

LocalCommandBus

interface LocalCommandBus : CommandBus, LocalMessageBus<CommandMessage<*>, ServerCommandExchange<*>>

Local Command Bus interface for handling commands within the same JVM instance.

LocalFirstCommandBus

class LocalFirstCommandBus(val distributedBus: DistributedCommandBus, val localBus: LocalCommandBus = InMemoryCommandBus()) : CommandBus, LocalFirstMessageBus<CommandMessage<*>, ServerCommandExchange<*>>

Command bus that prioritizes local processing before falling back to distributed processing. Void commands are automatically configured to skip local-first behavior since they don't require waiting for results.

ServerCommandExchange

interface ServerCommandExchange<C : Any> : CommandExchange<ServerCommandExchange<C>, C>

Server-side command exchange interface for commands being processed by the server.

SimpleClientCommandExchange

class SimpleClientCommandExchange<C : Any>(val message: CommandMessage<C>, val waitStrategy: WaitStrategy, val attributes: MutableMap<String, Any> = ConcurrentHashMap()) : ClientCommandExchange<C>

Simple implementation of ClientCommandExchange.

SimpleCommandMessage

data class SimpleCommandMessage<C : Any>(val id: String = generateGlobalId(), val header: Header = DefaultHeader.empty(), val body: C, val aggregateId: AggregateId, val ownerId: String = OwnerId.DEFAULT_OWNER_ID, val requestId: String = id, val aggregateVersion: Int? = null, val name: String = body.javaClass.toName(), val isCreate: Boolean = false, val allowCreate: Boolean = false, val isVoid: Boolean = false, val createTime: Long = System.currentTimeMillis()) : CommandMessage<C> , NamedAggregate

Simple implementation of CommandMessage with default values for most properties. This class provides a convenient way to create command messages with sensible defaults.

SimpleServerCommandExchange

class SimpleServerCommandExchange<C : Any>(val message: CommandMessage<C>, val attributes: MutableMap<String, Any> = ConcurrentHashMap()) : ServerCommandExchange<C>

Simple implementation of ServerCommandExchange.

Properties

AGGREGATE_PROCESSOR_KEY

const val AGGREGATE_PROCESSOR_KEY: String

AGGREGATE_VERSION_KEY

const val AGGREGATE_VERSION_KEY: String

COMMAND_GATEWAY_FUNCTION

val COMMAND_GATEWAY_FUNCTION: FunctionInfoData

COMMAND_GATEWAY_PROCESSOR_NAME

const val COMMAND_GATEWAY_PROCESSOR_NAME: String

COMMAND_INVOKE_RESULT_KEY

const val COMMAND_INVOKE_RESULT_KEY: String

EVENT_STREAM_KEY

const val EVENT_STREAM_KEY: String

Functions

commandSentSignal

fun CommandMessage<*>.commandSentSignal(waitCommandId: String, error: Throwable? = null): WaitSignal

toCommandMessage

fun <C : Any> CommandBuilder.toCommandMessage(): CommandMessage<C>

Converts a CommandBuilder to a CommandMessage.

fun <C : Any> C.toCommandMessage(id: String = generateGlobalId(), requestId: String? = null, aggregateId: String? = null, tenantId: String? = null, ownerId: String? = null, aggregateVersion: Int? = null, namedAggregate: NamedAggregate? = null, header: Header = DefaultHeader.empty(), createTime: Long = System.currentTimeMillis(), upstream: DomainEvent<*>? = null, ownerIdSameAsAggregateId: Boolean = false): CommandMessage<C>

Converts any object to a CommandMessage using reflection and metadata.

toResult

fun WaitSignal.toResult(commandMessage: CommandMessage<*>): CommandResult

Converts a WaitSignal to a CommandResult.

fun Throwable.toResult(waitCommandId: String, commandMessage: CommandMessage<*>, function: FunctionInfoData = COMMAND_GATEWAY_FUNCTION, id: String = generateGlobalId(), stage: CommandStage = CommandStage.SENT, result: Map<String, Any> = emptyMap(), signalTime: Long = System.currentTimeMillis()): CommandResult

Converts a Throwable to a CommandResult representing a command failure.