wow-core/me.ahoo.wow.messaging/DefaultHeader

DefaultHeader

class DefaultHeader(delegate: MutableMap<String, String> = mutableMapOf(), var isReadOnly: Boolean = false) : Header, MutableMap<String, String>

Default implementation of the Header interface.

This class provides a mutable header implementation that can be made read-only. It delegates map operations to an internal mutable map while enforcing read-only constraints.

Author

ahoo wang

Constructors

DefaultHeader

constructor(delegate: MutableMap<String, String> = mutableMapOf(), isReadOnly: Boolean = false)

Types

Companion

object Companion

Properties

compensationId

val Header.compensationId: String?

Gets the compensation ID from the header, if present.

entries

open override val entries: MutableSet<MutableMap.MutableEntry<String, String>>

isCompensation

val Header.isCompensation: Boolean

Checks if this header contains compensation information.

isReadOnly

@Volatile

open override var isReadOnly: Boolean

Whether this header is read-only (volatile for thread safety)

keys

open override val keys: MutableSet<String>

operator

val Header.operator: String?

Retrieves the operator from the command header.

remoteIp

val Header.remoteIp: String?

requiredOperator

val Header.requiredOperator: String

Retrieves the operator from the command header, throwing an exception if not present.

size

open override val size: Int

traceId

val Header.traceId: String?

Gets the trace ID from the header.

upstreamId

val Header.upstreamId: String?

upstreamName

val Header.upstreamName: String?

userAgent

val Header.userAgent: String?

values

open override val values: MutableCollection<String>

Functions

clear

open override fun clear()

Removes all mappings from this header.

containsKey

open override fun containsKey(key: String): Boolean

containsValue

open override fun containsValue(value: String): Boolean

copy

open override fun copy(): Header

Creates a copy of this header.

equals

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

extractCommandWaitEndpoint

fun Header.extractCommandWaitEndpoint(): String?

Extracts the command wait endpoint from the message header.

extractCommandWaitId

fun Header.extractCommandWaitId(): String?

Extracts the command wait ID from the message header.

extractSimpleWaitingChain

fun Header.extractSimpleWaitingChain(): WaitStrategy.FunctionMaterialized?

Extracts a simple waiting chain from the message header. Attempts to extract both simple chain and tail configurations.

extractWaitChain

fun Header.extractWaitChain(): String?

Extracts the wait chain type from the message header.

extractWaitFunction

fun Header.extractWaitFunction(): NamedFunctionInfoData

Extracts wait function information from the message header.

extractWaitingChainTail

fun Header.extractWaitingChainTail(): WaitingChainTail?

Extracts a waiting chain tail from the message header.

extractWaitingForStage

fun Header.extractWaitingForStage(): WaitingForStage.Materialized?

extractWaitingStage

fun Header.extractWaitingStage(): CommandStage?

Extracts the waiting stage from the message header.

extractWaitStrategy

fun Header.extractWaitStrategy(): ExtractedWaitStrategy?

Extracts a complete wait strategy from the message header. Attempts to extract both simple waiting chain and waiting for stage strategies.

get

open operator override fun get(key: String): String?

hashCode

open override fun hashCode(): Int

isEmpty

open override fun isEmpty(): Boolean

isLocalFirst

fun Header.isLocalFirst(): Boolean

Checks if the header has the local-first flag set.

match

fun Header.match(function: FunctionInfo): Boolean

Checks if this header's compensation information matches the given function.

propagate

fun Header.propagate(upstream: Message<*, *>): Header

Extension function to propagate context to this header from an upstream message.

propagateCommandWaitEndpoint

fun Header.propagateCommandWaitEndpoint(endpoint: String): Header

Adds the command wait endpoint to the message header for propagation.

propagateWaitChain

fun Header.propagateWaitChain(chain: String): Header

Adds the wait chain type to the message header.

propagateWaitCommandId

fun Header.propagateWaitCommandId(commandId: String): Header

Adds the wait command ID to the message header for propagation.

propagateWaitFunction

fun Header.propagateWaitFunction(function: NamedFunctionInfoData?): Header

Adds wait function information to the message header for propagation.

propagateWaitingStage

fun Header.propagateWaitingStage(stage: CommandStage): Header

Adds the waiting stage to the message header for propagation.

put

open override fun put(key: String, value: String): String?

Associates the specified value with the specified key in this header.

putAll

open override fun putAll(from: Map<out String, String>)

Copies all of the mappings from the specified map to this header.

remove

open override fun remove(key: String): String?

Removes the mapping for the specified key from this header if present.

open override fun remove(key: String, value: String): Boolean

Removes the entry for the specified key only if it is currently mapped to the specified value.

requireExtractCommandWaitEndpoint

fun Header.requireExtractCommandWaitEndpoint(): String

Extracts the command wait endpoint from the message header, throwing an exception if not present.

requireExtractWaitCommandId

fun Header.requireExtractWaitCommandId(): String

Extracts the command wait ID from the message header, throwing an exception if not present.

toHeader

fun Map<String, String>?.toHeader(): Header

Converts a nullable map of strings to a Header instance.

toString

open override fun toString(): String

with

open fun with(additional: Map<String, String>): Header

open fun with(key: String, value: String): Header

withCompensation

fun Header.withCompensation(target: CompensationTarget): Header

Adds compensation information to this header.

withLocalFirst

fun Header.withLocalFirst(localFirst: Boolean = true): Header

Adds the local-first flag to the header.

withOperator

fun Header.withOperator(operator: String): Header

Creates a new header with the specified operator added.

withReadOnly

open override fun withReadOnly(): Header

Makes this header read-only and returns it.

withRemoteIp

fun Header.withRemoteIp(remoteIp: String): Header

withTraceId

fun Header.withTraceId(traceId: String): Header

Adds a trace ID to the header.

withUpstreamId

fun Header.withUpstreamId(upstreamId: String): Header

withUpstreamName

fun Header.withUpstreamName(upstreamName: String): Header

withUserAgent

fun Header.withUserAgent(userAgent: String): Header