SecurityContextTokenServiceClient.RetrieveSecurityContextToken Method

Article
09/15/2006

Extracts the SecurityContextToken from the response to a security token request.

Namespace: Microsoft.Web.Services2.Security
Assembly: Microsoft.Web.Services2 (in microsoft.web.services2.dll)

Usage

'Usage
Public Class securityContextTokenServiceClientImplementation
    Inherits SecurityContextTokenServiceClient
        Protected Overrides Function RetrieveSecurityContextToken(request As RequestSecurityToken, _
            response As RequestSecurityTokenResponse)
            MyBase.RetrieveSecurityContextToken(request, response)
        End Function
End Class

Syntax

'Declaration
Protected Overridable Function RetrieveSecurityContextToken( _
    ByVal request As RequestSecurityToken, _
    ByVal response As RequestSecurityTokenResponse _
) As SecurityContextToken

protected virtual SecurityContextToken RetrieveSecurityContextToken(
    RequestSecurityToken request, 
    RequestSecurityTokenResponse response
);

protected: SecurityContextToken^ RetrieveSecurityContextToken(
    RequestSecurityToken^ request, 
    RequestSecurityTokenResponse^ response
);

protected SecurityContextToken RetrieveSecurityContextToken(
    RequestSecurityToken request, 
    RequestSecurityTokenResponse response
);

protected function RetrieveSecurityContextToken(
     request : RequestSecurityToken, 
     response : RequestSecurityTokenResponse
) : SecurityContextToken;

Parameters

request
A RequestSecurityToken that represents the security token request.

response
A RequestSecurityTokenResponse that represents the response to the security token request.

Return Value

The SecurityContextToken returned from the security token service.

Remarks

The RetrieveSecurityContextToken method caches the SecurityContextToken security token.

The RequestSecurityContextToken method calls the RetrieveSecurityContextToken method to extract the SecurityContextToken from the response to the security token request. If an entropy value is returned from the security token service, the key for the SecurityContextToken is generated using that entropy value.

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 Longhorn, and Windows 2000

Target Platforms

Windows 2000, Windows 2000 Server, Windows 2000 Advanced Server, Windows XP Home Edition, Windows XP Professional, Windows Server 2003, Windows Longhorn, Pocket PC, Windows CE, Smart Phone

Share via