Table of Contents

Interface IMessageProblemDetails

Namespace
Excalibur.Dispatch
Assembly
Excalibur.Dispatch.Abstractions.dll

Interface for providing structured problem details for message processing errors.

public interface IMessageProblemDetails
Extension Methods

Remarks

Based on RFC 7807 Problem Details for HTTP APIs, but adapted for message processing scenarios. Provides a standard way to carry machine-readable details of errors in message processing.

Properties

Detail

Gets or sets a human-readable explanation specific to this occurrence of the problem.

string Detail { get; set; }

Property Value

string

The human-readable explanation.

ErrorCode

Gets or sets the application-specific error code.

int ErrorCode { get; set; }

Property Value

int

The application-specific error code.

Remarks

A problem type may define additional members and their semantics.

Extensions

Gets the additional problem-specific extension fields.

IDictionary<string, object?> Extensions { get; }

Property Value

IDictionary<string, object>

The problem-specific extensions.

Remarks

Problem type definitions are free to define additional members and their semantics.

Instance

Gets or sets a URI reference that identifies the specific occurrence of the problem.

string Instance { get; set; }

Property Value

string

The occurrence URI.

Remarks

It may or may not yield further information if dereferenced.

Status

Gets or sets the HTTP status code generated by the origin server for this occurrence of the problem.

int? Status { get; set; }

Property Value

int?

The HTTP status code when available; otherwise, null.

Remarks

This is only advisory; the actual HTTP status code is determined by the server. When used outside of HTTP contexts, this value indicates the closest equivalent HTTP status code for the problem.

Title

Gets or sets a short, human-readable summary of the problem type.

string Title { get; set; }

Property Value

string

The summary of the problem type.

Remarks

It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

Type

Gets or sets a URI reference that identifies the problem type.

string Type { get; set; }

Property Value

string

The problem type identifier.

Remarks

This specification encourages that, when dereferenced, it provide human-readable documentation for the problem type. When this member is not present, its value is assumed to be "about:blank".