wow-core/me.ahoo.wow.modeling.metadata/AggregateMetadata

AggregateMetadata

data class AggregateMetadata<C : Any, S : Any>(val namedAggregate: NamedAggregate, val staticTenantId: String?, val state: StateAggregateMetadata<S>, val command: CommandAggregateMetadata<C>) : NamedAggregateDecorator, Metadata

Represents the metadata for an aggregate, combining state and command aggregate metadata.

This data class encapsulates all the metadata required to work with an aggregate, including its named aggregate information, static tenant ID, state aggregate metadata, and command aggregate metadata. It provides utilities for extracting aggregate IDs and determining if the aggregate follows an aggregation pattern.

Type Parameters

The type of the command aggregate.

The type of the state aggregate.

Constructors

AggregateMetadata

constructor(namedAggregate: NamedAggregate, staticTenantId: String?, state: StateAggregateMetadata<S>, command: CommandAggregateMetadata<C>)

Creates a new AggregateMetadata with the specified named aggregate, tenant ID, and metadata.

Properties

command

val command: CommandAggregateMetadata<C>

The metadata for the command aggregate.

isAggregationPattern

val isAggregationPattern: Boolean

Determines if this aggregate follows an aggregation pattern where state and command aggregates are different types.

namedAggregate

open override val namedAggregate: NamedAggregate

The named aggregate that this metadata belongs to.

owner

val owner: OwnerPolicy

The aggregate's ownership policy (@AggregateOwner, or the deprecated @AggregateRoute(owner = …), else OwnerPolicy.NEVER), resolved once here. Since 9.3.0.

spaced

val spaced: Boolean

Whether the aggregate is spaced (@Spaced, or the deprecated @AggregateRoute(spaced = true)), as parsed into CommandAggregateMetadata.spaced: the one source every consumer reads. Commands to an aggregate that is not spaced carry the default space whatever their source (HTTP, saga, in-process), the aggregate neither checks nor records a command's space, and its queries are not scoped by a space taken from a request.

state

val state: StateAggregateMetadata<S>

The metadata for the state aggregate.

staticTenantId

val staticTenantId: String?

The static tenant ID configured for this aggregate, or null if not configured.

Functions

aggregateId

fun AggregateMetadata<*, *>.aggregateId(id: String = generateId(), tenantId: String = staticTenantId ?: TenantId.DEFAULT_TENANT_ID): DefaultAggregateId

Creates an AggregateId for this AggregateMetadata with the specified parameters.

equals

open operator override fun equals(other: Any?): Boolean

extractAggregateId

fun extractAggregateId(state: S, aggregateId: String, tenantId: String = TenantId.DEFAULT_TENANT_ID): AggregateId

hashCode

open override fun hashCode(): Int

toStateAggregate

@JvmStatic

fun <S : Any> AggregateMetadata<*, S>.toStateAggregate(state: S, version: Int, ownerId: String = OwnerId.DEFAULT_OWNER_ID, spaceId: SpaceId = SpaceIdCapable.DEFAULT_SPACE_ID, eventId: String = "", firstOperator: String = "", operator: String = "", firstEventTime: Long = 0, eventTime: Long = 0, tags: AbacTags = EMPTY_ABAC_TAGS, deleted: Boolean = false, aggregateId: String = "", tenantId: String = TenantId.DEFAULT_TENANT_ID): StateAggregate<S>

toString

open override fun toString(): String