EncryptedSecurityTokenHandler.ReadToken Method

Artigo
10/05/2012

[Starting with the .NET Framework 4.5, Windows Identity Foundation (WIF) has been fully integrated into the .NET Framework. The version of WIF addressed by this topic, WIF 3.5, is deprecated and should only be used when developing against the .NET Framework 3.5 SP1 or the .NET Framework 4. For more information about WIF in the .NET Framework 4.5, also known as WIF 4.5, see the Windows Identity Foundation documentation in the .NET Framework 4.5 Development Guide.]

Reads the encrypted security token.

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

Usage

'Usage
Dim instance As EncryptedSecurityTokenHandler
Dim reader As XmlReader
Dim returnValue As SecurityToken

returnValue = instance.ReadToken(reader)

Syntax

'Declaration
Public Overrides Function ReadToken ( _
    reader As XmlReader _
) As SecurityToken

public override SecurityToken ReadToken (
    XmlReader reader
)

public:
virtual SecurityToken^ ReadToken (
    XmlReader^ reader
) override

public SecurityToken ReadToken (
    XmlReader reader
)

public override function ReadToken (
    reader : XmlReader
) : SecurityToken

Parameters

reader
The reader from which to read the token.

Return Value

An instance of SecurityToken.

Exceptions

Exception type	Condition
ArgumentNullException	Input parameter 'reader' is null.
InvalidOperationException	One of the properties 'Configuration' or 'Configuration.ServiceTokenResolver' is null. This property is required for obtaining keys for decryption. -or- The ContainingCollection (SecurityTokenHandlerCollection) is unable to find a SecurityTokenHandler that is able to read the decrypted xml and return a SecurityToken.
SecurityTokenException	A SecurityKeyIdentifier is not found inside the xml pointed to by the reader. -or- The SecurityKeyIdentifier is not a SymmetricSecurityKey.
EncryptedTokenDecryptionFailedException	The SecurityKeyIdentifier found inside the xml cannot be resolved by Configuration.ServiceTokenResolver to a SecurityKey.

Thread Safety

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

Platforms

Target Platforms

Windows 7, Windows Server 2008 R2, Windows Vista SP2, Windows Server 2008 SP2, Windows Server 2003 SP2 (32-bit or 64-bit)

Compartilhar via