SecurityTokenCacheKey Constructor

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

Creates an instance of SecurityTokenCacheKey which is used an index while caching SecurityContextSecurityToken.

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

Usage

'Usage
Dim endpointId As String
Dim contextId As UniqueId
Dim keyGeneration As UniqueId
Dim isSessionMode As Boolean

Dim instance As New SecurityTokenCacheKey(endpointId, contextId, keyGeneration, isSessionMode)

Syntax

'Declaration
Public Sub New ( _
    endpointId As String, _
    contextId As UniqueId, _
    keyGeneration As UniqueId, _
    isSessionMode As Boolean _
)

public SecurityTokenCacheKey (
    string endpointId,
    UniqueId contextId,
    UniqueId keyGeneration,
    bool isSessionMode
)

public:
SecurityTokenCacheKey (
    String^ endpointId, 
    UniqueId^ contextId, 
    UniqueId^ keyGeneration, 
    bool isSessionMode
)

public SecurityTokenCacheKey (
    String endpointId, 
    UniqueId contextId, 
    UniqueId keyGeneration, 
    boolean isSessionMode
)

public function SecurityTokenCacheKey (
    endpointId : String, 
    contextId : UniqueId, 
    keyGeneration : UniqueId, 
    isSessionMode : boolean
)

Parameters

endpointId
The endpoint Id to which the SecurityToken is scoped.

contextId
UniqueId of the SecurityContextSecurityToken

keyGeneration
UniqueId which is available when the SCT is renewed. Will be null when caching a new SCT.

isSessionMode

Exceptions

Exception type	Condition
ArgumentNullException	The parameter 'contextId' is null.

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