SecurityContextTokenServiceClient.BeginIssueSecurityContextToken Method (SecurityToken, AsyncCallback, Object)

Begins an unsigned asynchronous request for a SecurityContextToken security token from a security token service. If the request is successful, an entropy value is returned in an <Entropy> element.

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

Usage

'Usage
Dim issuerToken As SecurityToken
Dim callback As AsyncCallback
Dim state As Object
Dim returnValue As IAsyncResult
Dim securityContextTokenServiceClient1 As SecurityContextTokenServiceClient
returnValue = securityContextTokenServiceClient1.BeginIssueSecurityContextToken(issuerToken, callback, state)

Syntax

'Declaration
Overloads Public Overridable Function BeginIssueSecurityContextToken( _
    ByVal issuerToken As SecurityToken, _
    ByVal callback As AsyncCallback, _
    ByVal state As Object _
) As IAsyncResult

public virtual IAsyncResult BeginIssueSecurityContextToken(
    SecurityToken issuerToken, 
    AsyncCallback callback, 
    object state
);

public: IAsyncResult^ BeginIssueSecurityContextToken(
    SecurityToken^ issuerToken, 
    AsyncCallback^ callback, 
    Object^ state
);

public IAsyncResult BeginIssueSecurityContextToken(
    SecurityToken issuerToken, 
    AsyncCallback callback, 
    System.Object state
);

public function BeginIssueSecurityContextToken(
     issuerToken : SecurityToken, 
     callback : AsyncCallback, 
     state : Object
) : IAsyncResult;

Parameters

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

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

Exceptions

Exception type	Condition
System.ArgumentNullException	issuerToken is null.
System.ArgumentException	issuerToken does not support the encryption of SOAP messages.
TrustFault	The security token service did not return a response. -or- The response from the security token service is not signed. -or- The response contains an <Entropy> element and the entropy value is less than 16 bytes. -or- The response contains an <Entropy> element that is not encrypted using the SOAP message sender's entropy value.

Remarks

Because this overload does not sign the security token request, a TrustFault exception is thrown if this request is sent to the SecurityContextTokenService security token service.

WSE generates the entropy value, encrypts it using the security token service's security token, and places it in an <Entropy> element within the security token request. If the request is successful, the security token service returns its entropy value. The SecurityContextTokenServiceClient class then generates the key for the SecurityContextToken using the entropy values of the SOAP message sender and 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

See Also

Reference

SecurityContextTokenServiceClient Class
Microsoft.Web.Services2.Security Namespace

Other Resources

SecurityContextTokenServiceClient Members