Saml2SecurityTokenHandler.GetCacheExpirationTime Method

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

Returns the time until which the token should be held in the token replay cache.

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


Dim token As Saml2SecurityToken
Dim returnValue As DateTime

returnValue = Me.GetCacheExpirationTime(token)


Protected Overridable Function GetCacheExpirationTime ( _
    token As Saml2SecurityToken _
) As DateTime
protected virtual DateTime GetCacheExpirationTime (
    Saml2SecurityToken token
virtual DateTime GetCacheExpirationTime (
    Saml2SecurityToken^ token
protected DateTime GetCacheExpirationTime (
    Saml2SecurityToken token
protected function GetCacheExpirationTime (
    token : Saml2SecurityToken
) : DateTime


  • token
    The token for which to return the expiration time.

Return Value

A DateTime that represents the expiration time.


Exception type Condition

token is null.


By default, this method returns the NotOnOrAfter of the SAML Condition if present.

If that value does not exist, it returns the NotOnOrAfter of the first SubjectConfirmationData.

This function will never return a value further from the current time (Now) than Configuration.TokenReplayCacheExpirationPeriod.

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.


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


Saml2SecurityTokenHandler Class
Saml2SecurityTokenHandler Members
Microsoft.IdentityModel.Tokens.Saml2 Namespace

Copyright © 2008 by Microsoft Corporation. All rights reserved.