UserNameSecurityTokenHandler Class

Definition

Namespace:

System.IdentityModel.Tokens

Assembly:

System.IdentityModel.dll

Defines an abstract base class for a SecurityTokenHandler that processes security tokens of type UserNameSecurityToken.

public ref class UserNameSecurityTokenHandler abstract : System::IdentityModel::Tokens::SecurityTokenHandler

public abstract class UserNameSecurityTokenHandler : System.IdentityModel.Tokens.SecurityTokenHandler

type UserNameSecurityTokenHandler = class
    inherit SecurityTokenHandler

Public MustInherit Class UserNameSecurityTokenHandler
Inherits SecurityTokenHandler

Inheritance

Object

SecurityTokenHandler

UserNameSecurityTokenHandler

Derived

System.IdentityModel.Services.Tokens.MembershipUserNameSecurityTokenHandler

System.IdentityModel.Tokens.WindowsUserNameSecurityTokenHandler

Constructors

UserNameSecurityTokenHandler()

Called from constructors in derived classes to initialize the UserNameSecurityTokenHandler class.

Properties

CanValidateToken	Gets a value that indicates whether the handler supports validation of security tokens. (Inherited from SecurityTokenHandler)
CanWriteToken	Gets a value that indicates whether this handler can write tokens of type UserNameSecurityToken.
Configuration	Gets or sets the SecurityTokenHandlerConfiguration object that provides configuration for the current instance. (Inherited from SecurityTokenHandler)
ContainingCollection	Gets the token handler collection that contains the current instance. (Inherited from SecurityTokenHandler)
RetainPassword	Gets or sets a value that specifies whether the password will be retained in the bootstrap token that is attached to the ClaimsIdentity that is returned by the ValidateToken(SecurityToken) method.
TokenType	Gets the Type of the tokens that this handler processes.

Methods

CanReadKeyIdentifierClause(XmlReader)	Returns a value that indicates whether the XML element referred to by the specified XML reader is a key identifier clause that can be deserialized by this instance. (Inherited from SecurityTokenHandler)
CanReadToken(String)	Returns a value that indicates whether the specified string can be deserialized as a token of the type processed by this instance. (Inherited from SecurityTokenHandler)
CanReadToken(XmlReader)	Indicates whether the current XML element can be read as a UserNameSecurityToken.
CanWriteKeyIdentifierClause(SecurityKeyIdentifierClause)	Returns a value that indicates whether the specified key identifier clause can be serialized by this instance. (Inherited from SecurityTokenHandler)
CreateSecurityTokenReference(SecurityToken, Boolean)	When overridden in a derived class, creates the security token reference for tokens processed by that class. This method is typically called by a security token service (STS). (Inherited from SecurityTokenHandler)
CreateToken(SecurityTokenDescriptor)	When overridden in a derived class, creates a security token using the specified token descriptor. This method is called by a security token service (STS). (Inherited from SecurityTokenHandler)
DetectReplayedToken(SecurityToken)	When overridden in a derived class, throws an exception if the specified token is detected as being replayed. (Inherited from SecurityTokenHandler)
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetTokenTypeIdentifiers()	Returns the URIs used in requests to identify a token of the type that can be processed by this handler.
GetType()	Gets the Type of the current instance. (Inherited from Object)
LoadCustomConfiguration(XmlNodeList)	When overridden in a derived class, loads custom configuration from XML. (Inherited from SecurityTokenHandler)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ReadKeyIdentifierClause(XmlReader)	When overridden in a derived class, deserializes the XML referenced by the specified XML reader to a key identifier clause that references a token processed by the derived class. (Inherited from SecurityTokenHandler)
ReadToken(String)	When overridden in a derived class, deserializes the specified string to a token of the type processed by the derived class. (Inherited from SecurityTokenHandler)
ReadToken(XmlReader)	Reads a UserNameSecurityToken from the specified reader.
ReadToken(XmlReader, SecurityTokenResolver)	When overridden in a derived class, deserializes the XML referenced by the specified XML reader to a token of the type processed by the derived class by using the specified token resolver. (Inherited from SecurityTokenHandler)
ToString()	Returns a string that represents the current object. (Inherited from Object)
TraceTokenValidationFailure(SecurityToken, String)	Traces the failure event during the validation of security tokens when tracing is enabled. (Inherited from SecurityTokenHandler)
TraceTokenValidationSuccess(SecurityToken)	Traces the successful validation of security tokens event when tracing is enabled. (Inherited from SecurityTokenHandler)
ValidateToken(SecurityToken)	When overridden in a derived class, validates the specified security token. The token must be of the type processed by the derived class. (Inherited from SecurityTokenHandler)
WriteKeyIdentifierClause(XmlWriter, SecurityKeyIdentifierClause)	When overridden in a derived class, serializes the specified key identifier clause to XML. The key identifier clause must be of the type supported by the derived class. (Inherited from SecurityTokenHandler)
WriteToken(SecurityToken)	When overridden in a derived class, serializes the specified security token to a string. The token must be of the type processed by the derived class. (Inherited from SecurityTokenHandler)
WriteToken(XmlWriter, SecurityToken)	Serializes the specified UserNameSecurityToken to XML.

See also

• WindowsUserNameSecurityTokenHandler