-
Notifications
You must be signed in to change notification settings - Fork 9.8k
/
HeaderPropagationEntryCollection.cs
108 lines (97 loc) · 4.42 KB
/
HeaderPropagationEntryCollection.cs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
// Copyright (c) .NET Foundation. All rights reserved.
// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
using System;
using System.Collections.ObjectModel;
using Microsoft.Extensions.Primitives;
namespace Microsoft.AspNetCore.HeaderPropagation
{
/// <summary>
/// A collection of <see cref="HeaderPropagationEntry"/> items.
/// </summary>
public sealed class HeaderPropagationEntryCollection : Collection<HeaderPropagationEntry>
{
/// <summary>
/// Adds an <see cref="HeaderPropagationEntry"/> that will use <paramref name="headerName"/> as
/// the value of <see cref="HeaderPropagationEntry.InboundHeaderName"/> and
/// <see cref="HeaderPropagationEntry.CapturedHeaderName"/>.
/// </summary>
/// <param name="headerName">The header name to be propagated.</param>
public void Add(string headerName)
{
if (headerName == null)
{
throw new ArgumentNullException(nameof(headerName));
}
Add(new HeaderPropagationEntry(headerName, headerName, valueFilter: null));
}
/// <summary>
/// Adds an <see cref="HeaderPropagationEntry"/> that will use <paramref name="headerName"/> as
/// the value of <see cref="HeaderPropagationEntry.InboundHeaderName"/> and
/// <see cref="HeaderPropagationEntry.CapturedHeaderName"/>.
/// </summary>
/// <param name="headerName">The header name to be propagated.</param>
/// <param name="valueFilter">
/// A filter delegate that can be used to transform the header value.
/// See <see cref="HeaderPropagationEntry.ValueFilter"/>.
/// </param>
public void Add(string headerName, Func<HeaderPropagationContext, StringValues> valueFilter)
{
if (headerName == null)
{
throw new ArgumentNullException(nameof(headerName));
}
Add(new HeaderPropagationEntry(headerName, headerName, valueFilter));
}
/// <summary>
/// Adds an <see cref="HeaderPropagationEntry"/> that will use the provided <paramref name="inboundHeaderName"/>
/// and <paramref name="outboundHeaderName"/>.
/// </summary>
/// <param name="inboundHeaderName">
/// The name of the header to be captured by <see cref="HeaderPropagationMiddleware"/>.
/// </param>
/// <param name="outboundHeaderName">
/// The name of the header to be added by <see cref="HeaderPropagationMessageHandler"/>.
/// </param>
public void Add(string inboundHeaderName, string outboundHeaderName)
{
if (inboundHeaderName == null)
{
throw new ArgumentNullException(nameof(inboundHeaderName));
}
if (outboundHeaderName == null)
{
throw new ArgumentNullException(nameof(outboundHeaderName));
}
Add(new HeaderPropagationEntry(inboundHeaderName, outboundHeaderName, valueFilter: null));
}
/// <summary>
/// Adds an <see cref="HeaderPropagationEntry"/> that will use the provided <paramref name="inboundHeaderName"/>,
/// <paramref name="outboundHeaderName"/>, and <paramref name="valueFilter"/>.
/// </summary>
/// <param name="inboundHeaderName">
/// The name of the header to be captured by <see cref="HeaderPropagationMiddleware"/>.
/// </param>
/// <param name="outboundHeaderName">
/// The name of the header to be added by <see cref="HeaderPropagationMessageHandler"/>.
/// </param>
/// <param name="valueFilter">
/// A filter delegate that can be used to transform the header value.
/// See <see cref="HeaderPropagationEntry.ValueFilter"/>.
/// </param>
public void Add(
string inboundHeaderName,
string outboundHeaderName,
Func<HeaderPropagationContext, StringValues> valueFilter)
{
if (inboundHeaderName == null)
{
throw new ArgumentNullException(nameof(inboundHeaderName));
}
if (outboundHeaderName == null)
{
throw new ArgumentNullException(nameof(outboundHeaderName));
}
Add(new HeaderPropagationEntry(inboundHeaderName, outboundHeaderName, valueFilter));
}
}
}