SecurityTokenManager.GetTokenFromKeyInfo Method (KeyInfo, SoapContext)

Article
09/15/2006

Gets a security token from the specified key information when the security token type is unknown.

Namespace: Microsoft.Web.Services3.Security.Tokens
Assembly: Microsoft.Web.Services3 (in microsoft.web.services3.dll)

Usage

'Usage
Dim keyInfo As KeyInfo
Dim soapContext As SoapContext
Dim returnValue As SecurityToken
returnValue = SecurityTokenManager.GetTokenFromKeyInfo(keyInfo, soapContext)

Syntax

'Declaration
Overloads Public Shared Function GetTokenFromKeyInfo( _
    ByVal keyInfo As KeyInfo, _
    ByVal soapContext As SoapContext _
) As SecurityToken

public static SecurityToken GetTokenFromKeyInfo(
    KeyInfo keyInfo, 
    SoapContext soapContext
);

public:
static SecurityToken^ GetTokenFromKeyInfo(
    KeyInfo^ keyInfo,
    SoapContext^ soapContext
);

public static SecurityToken GetTokenFromKeyInfo(
    KeyInfo keyInfo, 
    SoapContext soapContext
);

public static function GetTokenFromKeyInfo(
     keyInfo : KeyInfo, 
     soapContext : SoapContext
) : SecurityToken;

Parameters

keyInfo
The KeyInfo to load into the security token.

soapContext
The SoapContext that is used to resolve any references to other security tokens within keyInfo .

Return Value

A SecurityToken that contains the key information.

Exceptions

Exception type	Condition
SecurityFault	soapContext is null, keyInfo contains a reference to a security token, and a SoapContext cannot be obtained.

Remarks

When the security token type that is referenced in a KeyInfo has not been determined, use the GetTokenFromKeyInfo method. The GetTokenFromKeyInfo method iterates over all configured and built-in security token managers until one is found that can load the KeyInfo clause. If a security token manager is not found that can load the KeyInfo clause, null is returned.

Instead of the KeyInfo clause just containing the security token, it can contain a reference to a security token. When that occurs, the reference is resolved by iterating through the security tokens in the soapContext parameter. When the soapContext parameter is null, an attempt is made to get the current SoapContext using the Current property. When that fails, an exception is thrown.

When the security token type referenced in the KeyInfo clause is known, call the LoadTokenFromKeyInfo method of the security tokens manager for the security 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

Development Platforms

Windows XP Home Edition, Windows XP Professional, Windows Server 2003, Windows 2000, Windows 2000 Server, Windows 2000 Advanced Server

Share via