SecurityTokenService.GetSecurityTokenHandler Method

  • Article

[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.]

Gets an appropriate security token handler for issuing a security token.

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

Usage

'Usage
Dim requestedTokenType As String
Dim returnValue As SecurityTokenHandler

returnValue = Me.GetSecurityTokenHandler(requestedTokenType)

Syntax

'Declaration
Protected Overridable Function GetSecurityTokenHandler ( _
    requestedTokenType As String _
) As SecurityTokenHandler

protected virtual SecurityTokenHandler GetSecurityTokenHandler (
    string requestedTokenType
)

protected:
virtual SecurityTokenHandler^ GetSecurityTokenHandler (
    String^ requestedTokenType
)

protected SecurityTokenHandler GetSecurityTokenHandler (
    String requestedTokenType
)

protected function GetSecurityTokenHandler (
    requestedTokenType : String
) : SecurityTokenHandler

Parameters

  • requestedTokenType
    A string that contains the requested token type URI.

Return Value

A SecurityTokenHandler that represents the token handler to be used for creating the issued security token. Returns null if the requested token type is not supported (configured).

Remarks

In the default implementation if requestedTokenType is null or an empty string, the default token type (DefaultTokenType) from configuration (accessed through the SecurityTokenServiceConfiguration property) is used.

This method is called from the default token issuance pipeline implemented in the Issue method. For more information about the token issuance pipeline, see the Claims Issuance Pipeline topic.

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)

See Also

Reference

SecurityTokenService Class
SecurityTokenService Members
Microsoft.IdentityModel.SecurityTokenService Namespace

Other Resources

Claims Issuance Pipeline

Copyright © 2008 by Microsoft Corporation. All rights reserved.