SessionSecurityTokenCookieSerializer.ReadBootstrapToken Method

Article
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 a BoostrapToken from a XmlDictionaryReader.

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

Usage

'Usage
Dim dictionaryReader As XmlDictionaryReader
Dim dictionary As SessionDictionary
Dim identity As IClaimsIdentity
Dim returnValue As SecurityToken

returnValue = Me.ReadBootstrapToken(dictionaryReader, dictionary, identity)

Syntax

'Declaration
Protected Overridable Function ReadBootstrapToken ( _
    dictionaryReader As XmlDictionaryReader, _
    dictionary As SessionDictionary, _
    identity As IClaimsIdentity _
) As SecurityToken

protected virtual SecurityToken ReadBootstrapToken (
    XmlDictionaryReader dictionaryReader,
    SessionDictionary dictionary,
    IClaimsIdentity identity
)

protected:
virtual SecurityToken^ ReadBootstrapToken (
    XmlDictionaryReader^ dictionaryReader, 
    SessionDictionary^ dictionary, 
    IClaimsIdentity^ identity
)

protected SecurityToken ReadBootstrapToken (
    XmlDictionaryReader dictionaryReader, 
    SessionDictionary dictionary, 
    IClaimsIdentity identity
)

protected function ReadBootstrapToken (
    dictionaryReader : XmlDictionaryReader, 
    dictionary : SessionDictionary, 
    identity : IClaimsIdentity
) : SecurityToken

Parameters

dictionaryReader
XmlDictionaryReader positioned at dictionary.BootStrapTokens.

dictionary
SessionDictionary to provide dictionary strings.

identity
The identity that the token being read belongs to.

Return Value

A SecurityToken object representing the bootstrap token.

Exceptions

Exception type	Condition
ArgumentNullException	The input argument 'dictionaryReader' or 'dictionary' is null.

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)

Share via