SecurityContextTokenServiceClient.IssueSecurityContextToken Method (SecurityToken, AppliesTo)
Makes an unsigned request for a SecurityContextToken security token from a security token service for use with a specific Web 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 appliesTo As AppliesTo
Dim returnValue As SecurityContextToken
Dim securityContextTokenServiceClient1 As SecurityContextTokenServiceClient
returnValue = securityContextTokenServiceClient1.IssueSecurityContextToken(issuerToken, appliesTo)
Syntax
'Declaration
Overloads Public Overridable Function IssueSecurityContextToken( _
ByVal issuerToken As SecurityToken, _
ByVal appliesTo As AppliesTo _
) As SecurityContextToken
public virtual SecurityContextToken IssueSecurityContextToken(
SecurityToken issuerToken,
AppliesTo appliesTo
);
public: SecurityContextToken^ IssueSecurityContextToken(
SecurityToken^ issuerToken,
AppliesTo^ appliesTo
);
public SecurityContextToken IssueSecurityContextToken(
SecurityToken issuerToken,
AppliesTo appliesTo
);
public function IssueSecurityContextToken(
issuerToken : SecurityToken,
appliesTo : AppliesTo
) : SecurityContextToken;
Parameters
- issuerToken
The SecurityToken that encrypts the SOAP message sender's entropy value.
- appliesTo
An AppliesTo that specifies the Web service the requested security token will be used to communicate with.
Return Value
The SecurityContextToken issued by the security token service.
Exceptions
| Exception type | Condition |
|---|---|
| System.ArgumentNullException | issuerToken is null. -or- appliesTo 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
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
Because this overload does not sign the security token request, an 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