SecurityContextTokenServiceClient.RequestSecurityContextToken Method

Article
09/15/2006

Requests a SecurityContextToken security token from a security token service.

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

Usage

'Usage
Public Class securityContextTokenServiceClientImplementation
    Inherits SecurityContextTokenServiceClient
        Protected Overrides Function RequestSecurityContextToken(baseToken As SecurityToken, _
            issuerToken As SecurityToken, _
            appliesTo As AppliesTo)
            MyBase.RequestSecurityContextToken(baseToken, issuerToken, appliesTo)
        End Function
End Class

Syntax

'Declaration
Protected Function RequestSecurityContextToken( _
    ByVal baseToken As SecurityToken, _
    ByVal issuerToken As SecurityToken, _
    ByVal appliesTo As AppliesTo _
) As SecurityContextToken

protected SecurityContextToken RequestSecurityContextToken(
    SecurityToken baseToken, 
    SecurityToken issuerToken, 
    AppliesTo appliesTo
);

protected: SecurityContextToken^ RequestSecurityContextToken(
    SecurityToken^ baseToken, 
    SecurityToken^ issuerToken, 
    AppliesTo^ appliesTo
);

protected SecurityContextToken RequestSecurityContextToken(
    SecurityToken baseToken, 
    SecurityToken issuerToken, 
    AppliesTo appliesTo
);

protected function RequestSecurityContextToken(
     baseToken : SecurityToken, 
     issuerToken : SecurityToken, 
     appliesTo : AppliesTo
) : SecurityContextToken;

Parameters

baseToken
The SecurityToken that signs the security token request.

issuerToken
The SecurityToken that encrypts the SOAP message sender's entropy value.

appliesTo
An AppliesTo that specifies the Web service.

Return Value

The SecurityContextToken issued by the security token service.

Remarks

The SecurityContextToken issued by the security token service is used to exchange SOAP messages with the Web service that is specified by the appliesTo parameter

To request a SecurityContextToken security token, call one of the IssueSecurityContextTokenAuthenticated or IssueSecurityContextToken overloads.

When the issuerToken parameter is null, the RequestSecurityContextToken method expects the SecurityContextToken to be returned within a <ProofToken> element. The RequestSecurityContextToken method calls the RetrieveSecurityContextToken method to extract the SecurityContextToken from the response to the security token request. If the issuerToken parameter is null, then the key for the SecurityContextToken is generated using the entropy value returned by the security token service.

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