Table of Contents

Class MessageMetadataExtensions

Namespace
Excalibur.Dispatch.Metadata
Assembly
Excalibur.Dispatch.dll

Extension methods for working with unified message metadata.

public static class MessageMetadataExtensions
Inheritance
MessageMetadataExtensions
Inherited Members

Methods

ApplyToContext(IMessageMetadata, IMessageContext)

Updates an IMessageContext with values from unified metadata.

public static void ApplyToContext(this IMessageMetadata metadata, IMessageContext context)

Parameters

metadata IMessageMetadata
context IMessageContext

Remarks

This is an explicit adapter for callers that already hold metadata and a context. Call it to copy those values; this method is not registered as ingress middleware.

CreateDeadLetterMetadata(IMessageMetadata, string, string?, string?)

Creates metadata for a dead-lettered message.

public static IMessageMetadata CreateDeadLetterMetadata(this IMessageMetadata metadata, string reason, string? errorDescription = null, string? deadLetterQueue = null)

Parameters

metadata IMessageMetadata
reason string
errorDescription string
deadLetterQueue string

Returns

IMessageMetadata

CreateReplyMetadata(IMessageMetadata, string?)

Creates a reply metadata from the current metadata, setting up proper correlation.

public static IMessageMetadata CreateReplyMetadata(this IMessageMetadata metadata, string? replyMessageType = null)

Parameters

metadata IMessageMetadata
replyMessageType string

Returns

IMessageMetadata

ExtractMetadata(IMessageContext)

Creates unified metadata from an IMessageContext.

public static IMessageMetadata ExtractMetadata(this IMessageContext context)

Parameters

context IMessageContext

Returns

IMessageMetadata

GetClaimsPrincipal(IMessageMetadata)

Extracts user claims from metadata for authorization.

public static ClaimsPrincipal? GetClaimsPrincipal(this IMessageMetadata metadata)

Parameters

metadata IMessageMetadata

Returns

ClaimsPrincipal

IsExpired(IMessageMetadata, DateTimeOffset?)

Checks if the message has expired based on TTL or explicit expiration.

public static bool IsExpired(this IMessageMetadata metadata, DateTimeOffset? currentUtc = null)

Parameters

metadata IMessageMetadata
currentUtc DateTimeOffset?

Returns

bool

Merge(IMessageMetadata, IMessageMetadata)

Merges two metadata instances, with values from the second taking precedence.

public static IMessageMetadata Merge(this IMessageMetadata primary, IMessageMetadata secondary)

Parameters

primary IMessageMetadata
secondary IMessageMetadata

Returns

IMessageMetadata

ShouldDeadLetter(IMessageMetadata)

Checks if the message should be dead-lettered based on delivery count.

public static bool ShouldDeadLetter(this IMessageMetadata metadata)

Parameters

metadata IMessageMetadata

Returns

bool

ToDictionary(IMessageMetadata, bool)

Converts metadata to a dictionary for serialization or transport.

public static Dictionary<string, object?> ToDictionary(this IMessageMetadata metadata, bool includeNullValues = false)

Parameters

metadata IMessageMetadata
includeNullValues bool

Returns

Dictionary<string, object>

ToLegacy(IMessageMetadata)

Converts unified metadata back to legacy IMessageMetadata for backward compatibility.

public static IMessageMetadata ToLegacy(this IMessageMetadata unified)

Parameters

unified IMessageMetadata

Returns

IMessageMetadata

ToUnified(IMessageMetadata, IMessageContext?)

Converts legacy IMessageMetadata to unified metadata.

public static MessageMetadata ToUnified(this IMessageMetadata legacy, IMessageContext? context = null)

Parameters

legacy IMessageMetadata
context IMessageContext

Returns

MessageMetadata

WithCurrentTraceContext(IMessageMetadata)

Enriches metadata with OpenTelemetry trace context from the current activity.

public static IMessageMetadata WithCurrentTraceContext(this IMessageMetadata metadata)

Parameters

metadata IMessageMetadata

Returns

IMessageMetadata