SecurityTokenProvider.GetTokenAsync(TimeSpan) 方法

定义

命名空间:

System.IdentityModel.Selectors

程序集:

System.ServiceModel.Primitives.dll

包:

System.ServiceModel.Primitives v6.2.0

Source:

SecurityTokenProvider.cs

获取安全令牌。

public:
 System::Threading::Tasks::Task<System::IdentityModel::Tokens::SecurityToken ^> ^ GetTokenAsync(TimeSpan timeout);

public System.Threading.Tasks.Task<System.IdentityModel.Tokens.SecurityToken> GetTokenAsync (TimeSpan timeout);

member this.GetTokenAsync : TimeSpan -> System.Threading.Tasks.Task<System.IdentityModel.Tokens.SecurityToken>

Public Function GetTokenAsync (timeout As TimeSpan) As Task(Of SecurityToken)

参数

timeout

TimeSpan

一个 TimeSpan，它为获取安全令牌的消息指定超时值。

返回

Task<SecurityToken>

表示 Task 异步读取操作并包装 SecurityToken 表示要获取的安全令牌的 。

注解

当客户端发送 SOAP 消息并且需要安全令牌时，GetTokenAsync 类会调用 ClientCredentials 方法。

GetTokenAsync 方法调用 GetTokenCoreAsync 方法。

在大多数情况下，timeout 的派生类（如 SecurityTokenProvider）不使用 UserNameSecurityTokenProvider 参数。 但有时检索安全令牌会涉及分布式消息。 联合服务中使用的 IssuedSecurityTokenProvider 就是一个例子。 在这类情况下，timeout 参数用于避免因网络故障、消息丢失或其他错误情况引起的异常。

此方法存储在任务中，它返回该方法的同步对应项可能引发的所有非使用异常。 如果异常存储在返回的任务中，则在等待任务时将引发该异常。 使用异常（如 ArgumentException）仍会同步引发。 有关存储的异常，请参阅 引发的 GetToken(TimeSpan)异常。