Class AspNetCoreGovernanceOptions

Namespace

AsiBackbone.AspNetCore.DependencyInjection

Assembly

AsiBackbone.AspNetCore.dll

Provides configuration options for ASP.NET Core host integration.

public sealed class AspNetCoreGovernanceOptions

Inheritance

object

AspNetCoreGovernanceOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

CorrelationIdHeaderName

Gets or sets the primary HTTP header name preferred for correlation identifier propagation.

public string CorrelationIdHeaderName { get; set; }

Property Value

string

CorrelationIdHeaderNames

Gets or sets the HTTP header names checked for correlation identifier propagation.

public IList<string> CorrelationIdHeaderNames { get; set; }

Property Value

IList<string>

DefaultCorrelationIdHeaderNames

Gets the default header names checked for correlation identifier propagation.

public static IReadOnlyList<string> DefaultCorrelationIdHeaderNames { get; }

Property Value

IReadOnlyList<string>

IncludeEndpointDisplayName

Gets or sets a value indicating whether endpoint display names may be included as safe audit metadata.

public bool IncludeEndpointDisplayName { get; set; }

Property Value

bool

IncludeEndpointMetadata

Gets or sets a value indicating whether endpoint metadata may be inspected by request-context adapters.

public bool IncludeEndpointMetadata { get; set; }

Property Value

bool

IncludeRequestMethod

Gets or sets a value indicating whether the HTTP method may be included as safe audit metadata.

public bool IncludeRequestMethod { get; set; }

Property Value

bool

IncludeRequestPath

Gets or sets a value indicating whether the HTTP path may be included as safe audit metadata.

public bool IncludeRequestPath { get; set; }

Property Value

bool

IncludeRoutePattern

Gets or sets a value indicating whether endpoint route patterns may be included as safe audit metadata.

public bool IncludeRoutePattern { get; set; }

Property Value

bool

IncludeRouteValues

Gets or sets a value indicating whether HTTP route values may be included by request-context adapters.

public bool IncludeRouteValues { get; set; }

Property Value

bool

TrustInboundCorrelationIdHeaders

Gets or sets a value indicating whether correlation identifiers supplied through configured HTTP headers are trusted. The default is false.

public bool TrustInboundCorrelationIdHeaders { get; set; }

Property Value

bool

Remarks

Enable this only when a trusted ingress removes caller-supplied correlation headers and writes its own values. Enabling it for requests received directly from untrusted callers lets those callers choose audit correlation identifiers.

UseHttpContextTraceIdentifierAsCorrelationId

Gets or sets a value indicating whether the ASP.NET Core trace identifier is used as the correlation identifier when no configured correlation header is present.

public bool UseHttpContextTraceIdentifierAsCorrelationId { get; set; }

Property Value

bool

Methods

Validate()

Validates the options.

public void Validate()