Class CorrelationIdentifierOptions

Namespace

Cuemon.AspNetCore.Http.Headers

Assembly

Cuemon.AspNetCore.dll

Configuration options for CorrelationIdentifierMiddleware.

public class CorrelationIdentifierOptions : IValidatableParameterObject, IParameterObject

Inheritance

Object

CorrelationIdentifierOptions

Implements

IValidatableParameterObject

IParameterObject

Constructors

CorrelationIdentifierOptions()

Initializes a new instance of the CorrelationIdentifierOptions class.

public CorrelationIdentifierOptions()

Remarks

The following table shows the initial property values for an instance of CorrelationIdentifierOptions.

Property	Initial Value
HeaderName	XCorrelationId
Token	new CorrelationToken();

Properties

HeaderName

Gets or sets the name of the correlation identifier HTTP header.

public string HeaderName { get; set; }

Property Value

String

The name of the correlation identifier HTTP header.

Token

Gets or sets the ICorrelationToken that provides a Correlation ID implementation.

public ICorrelationToken Token { get; set; }

Property Value

ICorrelationToken

The ICorrelationToken that provides a Correlation ID implementation.

Methods

ValidateOptions()

Determines whether the public read-write properties of this instance are in a valid state.

public void ValidateOptions()

Remarks

This method is expected to throw exceptions when one or more conditions fails to be in a valid state.

Exceptions

System.InvalidOperationException

HeaderName cannot be null, empty or consist only of white-space characters - or - Token cannot be null.