UserNameSecurityTokenHandler Class

.NET Framework (current version)
 

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

Namespace:   System.IdentityModel.Tokens
Assembly:  System.IdentityModel (in System.IdentityModel.dll)


public ref class UserNameSecurityTokenHandler abstract : SecurityTokenHandler

NameDescription
System_CAPS_protmethodUserNameSecurityTokenHandler()

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

NameDescription
System_CAPS_pubpropertyCanValidateToken

Gets a value that indicates whether the handler supports validation of security tokens.(Inherited from SecurityTokenHandler.)

System_CAPS_pubpropertyCanWriteToken

Gets a value that indicates whether this handler can write tokens of type UserNameSecurityToken.(Overrides SecurityTokenHandler::CanWriteToken.)

System_CAPS_pubpropertyConfiguration

Gets or sets the SecurityTokenHandlerConfiguration object that provides configuration for the current instance.(Inherited from SecurityTokenHandler.)

System_CAPS_pubpropertyContainingCollection

Gets the token handler collection that contains the current instance.(Inherited from SecurityTokenHandler.)

System_CAPS_pubpropertyRetainPassword

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 method.

System_CAPS_pubpropertyTokenType

Gets the Type of the tokens that this handler processes.(Overrides SecurityTokenHandler::TokenType.)

NameDescription
System_CAPS_pubmethodCanReadKeyIdentifierClause(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.)

System_CAPS_pubmethodCanReadToken(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.)

System_CAPS_pubmethodCanReadToken(XmlReader^)

Indicates whether the current XML element can be read as a UserNameSecurityToken.(Overrides SecurityTokenHandler::CanReadToken(XmlReader^).)

System_CAPS_pubmethodCanWriteKeyIdentifierClause(SecurityKeyIdentifierClause^)

Returns a value that indicates whether the specified key identifier clause can be serialized by this instance.(Inherited from SecurityTokenHandler.)

System_CAPS_pubmethodCreateSecurityTokenReference(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.)

System_CAPS_pubmethodCreateToken(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.)

System_CAPS_protmethodDetectReplayedToken(SecurityToken^)

When overridden in a derived class, throws an exception if the specified token is detected as being replayed.(Inherited from SecurityTokenHandler.)

System_CAPS_pubmethodEquals(Object^)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetTokenTypeIdentifiers()

Returns the URIs used in requests to identify a token of the type that can be processed by this handler.(Overrides SecurityTokenHandler::GetTokenTypeIdentifiers().)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodLoadCustomConfiguration(XmlNodeList^)

When overridden in a derived class, loads custom configuration from XML.(Inherited from SecurityTokenHandler.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodReadKeyIdentifierClause(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.)

System_CAPS_pubmethodReadToken(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.)

System_CAPS_pubmethodReadToken(XmlReader^)

Reads a UserNameSecurityToken from the specified reader.(Overrides SecurityTokenHandler::ReadToken(XmlReader^).)

System_CAPS_pubmethodReadToken(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.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

System_CAPS_protmethodTraceTokenValidationFailure(SecurityToken^, String^)

Traces the failure event during the validation of security tokens when tracing is enabled.(Inherited from SecurityTokenHandler.)

System_CAPS_protmethodTraceTokenValidationSuccess(SecurityToken^)

Traces the successful validation of security tokens event when tracing is enabled.(Inherited from SecurityTokenHandler.)

System_CAPS_pubmethodValidateToken(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.)

System_CAPS_pubmethodWriteKeyIdentifierClause(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.)

System_CAPS_pubmethodWriteToken(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.)

System_CAPS_pubmethodWriteToken(XmlWriter^, SecurityToken^)

.NET Framework
Available since 4.5

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: