SecurityContextTokenServiceClient.BeginRequestSecurityContextToken Method

Article
09/15/2006

Begins an asynchronous request for 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 BeginRequestSecurityContextToken(baseToken As SecurityToken, _
            issuerToken As SecurityToken, _
            appliesTo As AppliesTo, _
            callback As AsyncCallback, _
            state As Object)
            MyBase.BeginRequestSecurityContextToken(baseToken, issuerToken, appliesTo, callback, state)
        End Function
End Class

Syntax

'Declaration
Protected Function BeginRequestSecurityContextToken( _
    ByVal baseToken As SecurityToken, _
    ByVal issuerToken As SecurityToken, _
    ByVal appliesTo As AppliesTo, _
    ByVal callback As AsyncCallback, _
    ByVal state As Object _
) As IAsyncResult

protected IAsyncResult BeginRequestSecurityContextToken(
    SecurityToken baseToken, 
    SecurityToken issuerToken, 
    AppliesTo appliesTo, 
    AsyncCallback callback, 
    object state
);

protected: IAsyncResult^ BeginRequestSecurityContextToken(
    SecurityToken^ baseToken, 
    SecurityToken^ issuerToken, 
    AppliesTo^ appliesTo, 
    AsyncCallback^ callback, 
    Object^ state
);

protected IAsyncResult BeginRequestSecurityContextToken(
    SecurityToken baseToken, 
    SecurityToken issuerToken, 
    AppliesTo appliesTo, 
    AsyncCallback callback, 
    System.Object state
);

protected function BeginRequestSecurityContextToken(
     baseToken : SecurityToken, 
     issuerToken : SecurityToken, 
     appliesTo : AppliesTo, 
     callback : AsyncCallback, 
     state : Object
) : IAsyncResult;

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.

callback
An System.AsyncCallback that is called when the asynchronous operation is completed. If callback is null, the delegate is not called.

state
An object that contains state information for this request.

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.

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