SecurityTokenProvider.GetToken Method (TimeSpan)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Gets a security token.

Namespace:   System.IdentityModel.Selectors
Assembly:  System.IdentityModel (in System.IdentityModel.dll)

public SecurityToken GetToken(
	TimeSpan timeout
)

Parameters

timeout
Type: System.TimeSpan

A TimeSpan that specifies the timeout value for the message that gets the security token.

Return Value

Type: System.IdentityModel.Tokens.SecurityToken

The SecurityToken that represents the security token to get.

The GetToken method is called by the ClientCredentials class when a client sends a SOAP message and a security token is required.

The GetToken method calls the GetTokenCore method.

In most cases the timeout parameter is not used by derived classes of SecurityTokenProvider such as UserNameSecurityTokenProvider. However, sometimes retrieving a security token involves distributed messaging. An example is IssuedSecurityTokenProvider used in a federated service. In these cases the timeout parameter is used to avoid exceptions caused by network failures, message loss, and other error conditions.

.NET Framework
Available since 3.0
Return to top
Show: