51Degrees Pipeline for .NET

FiftyOne.Pipeline.Core.Constants Class Reference

Detailed Description

Class containing values for commonly used evidence keys.

Examples
ResultCaching/Program.cs.

Static Public Attributes

const string EVIDENCE_SEPERATOR = "."
 The string used to split evidence name parts.
const string EVIDENCE_HTTPHEADER_PREFIX = "header"
 Used to prefix evidence that is obtained from HTTP headers.
const string EVIDENCE_COOKIE_PREFIX = "cookie"
 Used to prefix evidence that is obtained from HTTP bookies.
const string EVIDENCE_QUERY_PREFIX = "query"
 Used to prefix evidence that is obtained from an HTTP request's query string or is passed into the pipeline for off-line processing.
const string EVIDENCE_SERVER_PREFIX = "server"
 Used to prefix evidence that is obtained from the server that the Pipeline is running on.
const string EVIDENCE_SESSION_PREFIX = "session"
 Used to prefix evidence that is obtained relating to the user's session.
const string EVIDENCE_USERAGENT = "user-agent"
 The suffix used when the User-Agent is passed as evidence.
const string EVIDENCE_CLIENTIP_KEY = EVIDENCE_SERVER_PREFIX + EVIDENCE_SEPERATOR + "client-ip"
 The complete key to be used when the client IP address is passed as evidence.
const string EVIDENCE_QUERY_USERAGENT_KEY = EVIDENCE_QUERY_PREFIX + EVIDENCE_SEPERATOR + EVIDENCE_USERAGENT
 The complete key to be used when the User-Agent is passed as evidence in the query string or is set from a data store for off-line processing.
const string EVIDENCE_HEADER_USERAGENT_KEY = EVIDENCE_HTTPHEADER_PREFIX + EVIDENCE_SEPERATOR + EVIDENCE_USERAGENT
 The complete key to be used when the User-Agent is passed as evidence in the HTTP headers.
const string EVIDENCE_SESSION_KEY = EVIDENCE_SESSION_PREFIX + EVIDENCE_SEPERATOR + "session"
 Used by the Pipeline to store the session object if one is available.
const string EVIDENCE_PROTOCOL = EVIDENCE_HTTPHEADER_PREFIX + EVIDENCE_SEPERATOR + "protocol"
 The complete key to be used when the 'Protocol' HTTP header is passed as evidence.
const string EVIDENCE_REQUEST_METHOD_KEY = EVIDENCE_SERVER_PREFIX + EVIDENCE_SEPERATOR + "request-method"
 The complete key to be used when the HTTP method of the request is passed as evidence.
const string EVIDENCE_REQUEST_PATH_KEY = EVIDENCE_SERVER_PREFIX + EVIDENCE_SEPERATOR + "request-path"
 The complete key to be used when the path of the request is passed as evidence, exactly as the request carried it.
const string EVIDENCE_REQUEST_QUERY_KEY = EVIDENCE_SERVER_PREFIX + EVIDENCE_SEPERATOR + "request-query"
 The complete key to be used when the whole query string of the request is passed as evidence, exactly as the request carried it and without the leading question mark.
const bool PIPELINE_BUILDER_DEFAULT_AUTO_DISPOSE_ELEMENTS = true
 The default value for the flag that controls whether the pipeline will automatically dispose of its elements when it is disposed.
const bool PIPELINE_BUILDER_DEFAULT_AUTO_SUPRESS_PROCESS_EXCEPTION = PIPELINE_BUILDER_DEFAULT_AUTO_SUPRESS_PROCESS_EXCEPTIONS
 The default value for the flag that controls whether the pipeline will allow exceptions from flow elements to bubble up to the caller, or be caught and logged.
const bool PIPELINE_BUILDER_DEFAULT_AUTO_SUPRESS_PROCESS_EXCEPTIONS = false
 The default value for the flag that controls whether the pipeline will allow exceptions from flow elements to bubble up to the caller, or be caught and logged.
const string TRACING_SOURCE_NAME = "FiftyOne.Pipeline"
 The name of the System.Diagnostics.ActivitySource that emits a tracing span for each flow element a pipeline processes.

Member Data Documentation

◆ EVIDENCE_REQUEST_METHOD_KEY

const string FiftyOne.Pipeline.Core.Constants.EVIDENCE_REQUEST_METHOD_KEY = EVIDENCE_SERVER_PREFIX + EVIDENCE_SEPERATOR + "request-method"
static

The complete key to be used when the HTTP method of the request is passed as evidence.

This key and the two below carry the request line. The values MUST be exactly what the request carried, byte for byte, with no decoding and no normalisation, because they are used to rebuild the text an HTTP message signature was made over and one changed byte makes a valid signature read as invalid. See the Specification

.

◆ EVIDENCE_REQUEST_QUERY_KEY

const string FiftyOne.Pipeline.Core.Constants.EVIDENCE_REQUEST_QUERY_KEY = EVIDENCE_SERVER_PREFIX + EVIDENCE_SEPERATOR + "request-query"
static

The complete key to be used when the whole query string of the request is passed as evidence, exactly as the request carried it and without the leading question mark.

The query string is carried whole here as well as split into 'query.' entries, because the split entries lose the ordering and the encoding of the original and so cannot rebuild it. An integration that supplies the request line supplies this key on every request, empty where the request carried no query string, so that a missing key always means the integration does not supply the request line rather than that the request had no query.

◆ TRACING_SOURCE_NAME

const string FiftyOne.Pipeline.Core.Constants.TRACING_SOURCE_NAME = "FiftyOne.Pipeline"
static

The name of the System.Diagnostics.ActivitySource that emits a tracing span for each flow element a pipeline processes.

Register this name with an OpenTelemetry tracer (AddSource) to collect the spans; nothing is emitted otherwise.

Have a data or code question? Get in touch and explore subscription options.