FederatedSecurityTokenManager.CreateSecurityTokenAuthenticator Method

2012-10-05

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

Overriden from the base class. Creates the requested Token Authenticator. Looks up the list of Token Handlers registered with the token Manager based on the TokenType Uri in the SecurityTokenRequirement. If none is found, then the call is delegated to the inner Token Manager.

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

Usage

'Usage
Dim instance As FederatedSecurityTokenManager
Dim tokenRequirement As SecurityTokenRequirement
Dim outOfBandTokenResolver As SecurityTokenResolver
Dim returnValue As SecurityTokenAuthenticator

returnValue = instance.CreateSecurityTokenAuthenticator(tokenRequirement, outOfBandTokenResolver)

Syntax

'Declaration
Public Overrides Function CreateSecurityTokenAuthenticator ( _
    tokenRequirement As SecurityTokenRequirement, _
    <OutAttribute> ByRef outOfBandTokenResolver As SecurityTokenResolver _
) As SecurityTokenAuthenticator

public override SecurityTokenAuthenticator CreateSecurityTokenAuthenticator (
    SecurityTokenRequirement tokenRequirement,
    out SecurityTokenResolver outOfBandTokenResolver
)

public:
virtual SecurityTokenAuthenticator^ CreateSecurityTokenAuthenticator (
    SecurityTokenRequirement^ tokenRequirement, 
    [OutAttribute] SecurityTokenResolver^% outOfBandTokenResolver
) override

public SecurityTokenAuthenticator CreateSecurityTokenAuthenticator (
    SecurityTokenRequirement tokenRequirement, 
    /** @attribute OutAttribute() */ /** @ref */ SecurityTokenResolver outOfBandTokenResolver
)

Parameters

tokenRequirement
Security Token Requirement for which the Authenticator should be created.

outOfBandTokenResolver
Token resolver that resolves any out-of-band tokens.

Return Value

Instance of Security Token Authenticator.

Exceptions

Exception type	Condition
ArgumentNullException	'tokenRequirement' parameter is null.
NotSupportedException	No Authenticator is registered for the given token type.

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