Saml2SecurityTokenHandler.DetectReplayedTokens 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.]

Throws an exception if the specified token already exists in the token replay cache; otherwise the token is added to the cache.

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

Usage

'Usage
Dim token As SecurityToken

Me.DetectReplayedTokens(token)

Syntax

'Declaration
Protected Overrides Sub DetectReplayedTokens ( _
    token As SecurityToken _
)

protected override void DetectReplayedTokens (
    SecurityToken token
)

protected:
virtual void DetectReplayedTokens (
    SecurityToken^ token
) override

protected void DetectReplayedTokens (
    SecurityToken token
)

protected override function DetectReplayedTokens (
    token : SecurityToken
)

Parameters

token
A SecurityToken that represents the SAML 2.0 security token (the token should be of type Saml2SecurityToken) to be checked.

Exceptions

Exception type	Condition
ArgumentNullException	token is null.
InvalidOperationException	The Configuration property is null. -or- The TokenReplayCache property of the handler configuration (accessed through the Configuration property) is null.
ArgumentException	token cannot be cast as an instance of Saml2SecurityToken.
SecurityTokenValidationException	The ID of the assertion associated with the token is null or empty. (The Assertion property of the token references a Saml2Assertion that has an Id property that references a Saml2Id with a Value property that is null or empty.)
SecurityTokenReplayDetectedException	The token already exists in the TokenReplayCache.

Remarks

The default behavior is to only check bearer tokens (tokens that do not have keys). The token replay cache is the TokenReplayCache object configured for this handler through the TokenReplayCache property of the SecurityTokenHandlerConfiguration object referenced through the Configuration property.

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)