-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
UserNameSecurityTokenHandler.xml
217 lines (215 loc) · 14.7 KB
/
UserNameSecurityTokenHandler.xml
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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
<Type Name="UserNameSecurityTokenHandler" FullName="System.IdentityModel.Tokens.UserNameSecurityTokenHandler">
<TypeSignature Language="C#" Value="public abstract class UserNameSecurityTokenHandler : System.IdentityModel.Tokens.SecurityTokenHandler" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit UserNameSecurityTokenHandler extends System.IdentityModel.Tokens.SecurityTokenHandler" />
<TypeSignature Language="DocId" Value="T:System.IdentityModel.Tokens.UserNameSecurityTokenHandler" />
<TypeSignature Language="VB.NET" Value="Public MustInherit Class UserNameSecurityTokenHandler
Inherits SecurityTokenHandler" />
<TypeSignature Language="F#" Value="type UserNameSecurityTokenHandler = class
 inherit SecurityTokenHandler" />
<TypeSignature Language="C++ CLI" Value="public ref class UserNameSecurityTokenHandler abstract : System::IdentityModel::Tokens::SecurityTokenHandler" />
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.IdentityModel.Tokens.SecurityTokenHandler</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>Defines an abstract base class for a <see cref="T:System.IdentityModel.Tokens.SecurityTokenHandler" /> that processes security tokens of type <see cref="T:System.IdentityModel.Tokens.UserNameSecurityToken" />.</summary>
<remarks>To be added.</remarks>
<altmember cref="T:System.IdentityModel.Tokens.WindowsUserNameSecurityTokenHandler" />
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected UserNameSecurityTokenHandler ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:System.IdentityModel.Tokens.UserNameSecurityTokenHandler.#ctor" />
<MemberSignature Language="VB.NET" Value="Protected Sub New ()" />
<MemberSignature Language="C++ CLI" Value="protected:
 UserNameSecurityTokenHandler();" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>Called from constructors in derived classes to initialize the <see cref="T:System.IdentityModel.Tokens.UserNameSecurityTokenHandler" /> class.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CanReadToken">
<MemberSignature Language="C#" Value="public override bool CanReadToken (System.Xml.XmlReader reader);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool CanReadToken(class System.Xml.XmlReader reader) cil managed" />
<MemberSignature Language="DocId" Value="M:System.IdentityModel.Tokens.UserNameSecurityTokenHandler.CanReadToken(System.Xml.XmlReader)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function CanReadToken (reader As XmlReader) As Boolean" />
<MemberSignature Language="F#" Value="override this.CanReadToken : System.Xml.XmlReader -> bool" Usage="userNameSecurityTokenHandler.CanReadToken reader" />
<MemberSignature Language="C++ CLI" Value="public:
 override bool CanReadToken(System::Xml::XmlReader ^ reader);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="reader" Type="System.Xml.XmlReader" />
</Parameters>
<Docs>
<param name="reader">An XML reader positioned at a start element. The reader should not be advanced.</param>
<summary>Indicates whether the current XML element can be read as a <see cref="T:System.IdentityModel.Tokens.UserNameSecurityToken" />.</summary>
<returns>
<see langword="true" /> if the reader is pointing to a <see cref="T:System.IdentityModel.Tokens.UserNameSecurityToken" />; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CanWriteToken">
<MemberSignature Language="C#" Value="public override bool CanWriteToken { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool CanWriteToken" />
<MemberSignature Language="DocId" Value="P:System.IdentityModel.Tokens.UserNameSecurityTokenHandler.CanWriteToken" />
<MemberSignature Language="VB.NET" Value="Public Overrides ReadOnly Property CanWriteToken As Boolean" />
<MemberSignature Language="F#" Value="member this.CanWriteToken : bool" Usage="System.IdentityModel.Tokens.UserNameSecurityTokenHandler.CanWriteToken" />
<MemberSignature Language="C++ CLI" Value="public:
 virtual property bool CanWriteToken { bool get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets a value that indicates whether this handler can write tokens of type <see cref="T:System.IdentityModel.Tokens.UserNameSecurityToken" />.</summary>
<value>
<see langword="true" /> if the handler can write tokens of type <see cref="T:System.IdentityModel.Tokens.UserNameSecurityToken" />; otherwise, <see langword="false" />. Always <see langword="true" />.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetTokenTypeIdentifiers">
<MemberSignature Language="C#" Value="public override string[] GetTokenTypeIdentifiers ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance string[] GetTokenTypeIdentifiers() cil managed" />
<MemberSignature Language="DocId" Value="M:System.IdentityModel.Tokens.UserNameSecurityTokenHandler.GetTokenTypeIdentifiers" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function GetTokenTypeIdentifiers () As String()" />
<MemberSignature Language="F#" Value="override this.GetTokenTypeIdentifiers : unit -> string[]" Usage="userNameSecurityTokenHandler.GetTokenTypeIdentifiers " />
<MemberSignature Language="C++ CLI" Value="public:
 override cli::array <System::String ^> ^ GetTokenTypeIdentifiers();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String[]</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Returns the URIs used in requests to identify a token of the type that can be processed by this handler.</summary>
<returns>The set of URIs that identify the token type that this handler supports.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ReadToken">
<MemberSignature Language="C#" Value="public override System.IdentityModel.Tokens.SecurityToken ReadToken (System.Xml.XmlReader reader);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance class System.IdentityModel.Tokens.SecurityToken ReadToken(class System.Xml.XmlReader reader) cil managed" />
<MemberSignature Language="DocId" Value="M:System.IdentityModel.Tokens.UserNameSecurityTokenHandler.ReadToken(System.Xml.XmlReader)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function ReadToken (reader As XmlReader) As SecurityToken" />
<MemberSignature Language="F#" Value="override this.ReadToken : System.Xml.XmlReader -> System.IdentityModel.Tokens.SecurityToken" Usage="userNameSecurityTokenHandler.ReadToken reader" />
<MemberSignature Language="C++ CLI" Value="public:
 override System::IdentityModel::Tokens::SecurityToken ^ ReadToken(System::Xml::XmlReader ^ reader);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.IdentityModel.Tokens.SecurityToken</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="reader" Type="System.Xml.XmlReader" />
</Parameters>
<Docs>
<param name="reader">An XML reader positioned at the start element of the token.</param>
<summary>Reads a <see cref="T:System.IdentityModel.Tokens.UserNameSecurityToken" /> from the specified reader.</summary>
<returns>The username security token that was deserialized from the XML.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="reader" /> is <see langword="null" />.</exception>
<exception cref="T:System.Xml.XmlException">The token cannot be read.</exception>
<exception cref="T:System.NotSupportedException">The password was not in plain text format.</exception>
<exception cref="T:System.InvalidOperationException">An unknown element was found in the security token or the username was not specified.</exception>
</Docs>
</Member>
<Member MemberName="RetainPassword">
<MemberSignature Language="C#" Value="public virtual bool RetainPassword { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool RetainPassword" />
<MemberSignature Language="DocId" Value="P:System.IdentityModel.Tokens.UserNameSecurityTokenHandler.RetainPassword" />
<MemberSignature Language="VB.NET" Value="Public Overridable Property RetainPassword As Boolean" />
<MemberSignature Language="F#" Value="member this.RetainPassword : bool with get, set" Usage="System.IdentityModel.Tokens.UserNameSecurityTokenHandler.RetainPassword" />
<MemberSignature Language="C++ CLI" Value="public:
 virtual property bool RetainPassword { bool get(); void set(bool value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets a value that specifies whether the password will be retained in the bootstrap token that is attached to the <see cref="T:System.Security.Claims.ClaimsIdentity" /> that is returned by the <see cref="M:System.IdentityModel.Tokens.SessionSecurityTokenHandler.ValidateToken(System.IdentityModel.Tokens.SecurityToken)" /> method.</summary>
<value>
<see langword="true" /> if the password should be retained in the bootstrap token; otherwise, <see langword="false" />. The default is <see langword="false" />.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="TokenType">
<MemberSignature Language="C#" Value="public override Type TokenType { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Type TokenType" />
<MemberSignature Language="DocId" Value="P:System.IdentityModel.Tokens.UserNameSecurityTokenHandler.TokenType" />
<MemberSignature Language="VB.NET" Value="Public Overrides ReadOnly Property TokenType As Type" />
<MemberSignature Language="F#" Value="member this.TokenType : Type" Usage="System.IdentityModel.Tokens.UserNameSecurityTokenHandler.TokenType" />
<MemberSignature Language="C++ CLI" Value="public:
 virtual property Type ^ TokenType { Type ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Type</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the <see cref="T:System.Type" /> of the tokens that this handler processes.</summary>
<value>The type of <see cref="T:System.IdentityModel.Tokens.UserNameSecurityToken" />.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="WriteToken">
<MemberSignature Language="C#" Value="public override void WriteToken (System.Xml.XmlWriter writer, System.IdentityModel.Tokens.SecurityToken token);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void WriteToken(class System.Xml.XmlWriter writer, class System.IdentityModel.Tokens.SecurityToken token) cil managed" />
<MemberSignature Language="DocId" Value="M:System.IdentityModel.Tokens.UserNameSecurityTokenHandler.WriteToken(System.Xml.XmlWriter,System.IdentityModel.Tokens.SecurityToken)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Sub WriteToken (writer As XmlWriter, token As SecurityToken)" />
<MemberSignature Language="F#" Value="override this.WriteToken : System.Xml.XmlWriter * System.IdentityModel.Tokens.SecurityToken -> unit" Usage="userNameSecurityTokenHandler.WriteToken (writer, token)" />
<MemberSignature Language="C++ CLI" Value="public:
 override void WriteToken(System::Xml::XmlWriter ^ writer, System::IdentityModel::Tokens::SecurityToken ^ token);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="writer" Type="System.Xml.XmlWriter" />
<Parameter Name="token" Type="System.IdentityModel.Tokens.SecurityToken" />
</Parameters>
<Docs>
<param name="writer">The XML writer to use to serialize the token.</param>
<param name="token">The token to serialize.</param>
<summary>Serializes the specified <see cref="T:System.IdentityModel.Tokens.UserNameSecurityToken" /> to XML.</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="writer" /> is <see langword="null" />.
-or-
<paramref name="token" /> is <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">
<paramref name="token" /> is not assignable from <see cref="T:System.IdentityModel.Tokens.UserNameSecurityToken" />.</exception>
</Docs>
</Member>
</Members>
</Type>