SecurityTokenProvider.GetTokenAsync(TimeSpan) Méthode

Définition

Espace de noms:

System.IdentityModel.Selectors

Assembly:

System.ServiceModel.Primitives.dll

Paquet:

System.ServiceModel.Primitives v10.0.652802

Source:

SecurityTokenProvider.cs

Obtient un jeton de sécurité.

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)

Paramètres

timeout

TimeSpan

Valeur TimeSpan de délai d’expiration du message qui obtient le jeton de sécurité.

Retours

Task<SecurityToken>

Qui Task représente l’opération de lecture asynchrone et encapsule celui SecurityToken qui représente le jeton de sécurité à obtenir.

Remarques

La GetTokenAsync méthode est appelée par la ClientCredentials classe lorsqu’un client envoie un message SOAP et qu’un jeton de sécurité est requis.

La GetTokenAsync méthode appelle la GetTokenCoreAsync méthode.

Dans la plupart des cas, le timeout paramètre n’est pas utilisé par les classes dérivées de SecurityTokenProvider telles que UserNameSecurityTokenProvider. Toutefois, la récupération d’un jeton de sécurité implique parfois la messagerie distribuée. Un exemple est IssuedSecurityTokenProvider utilisé dans un service fédéré. Dans ces cas, le timeout paramètre est utilisé pour éviter les exceptions provoquées par les défaillances réseau, la perte de messages et d’autres conditions d’erreur.

Cette méthode stocke dans la tâche toutes les exceptions non-utilisation que l’équivalent synchrone de la méthode peut lever. Si une exception est stockée dans la tâche retournée, cette exception est levée lorsque la tâche est attendue. Les exceptions d’utilisation, telles que ArgumentException, sont toujours levées de façon synchrone. Pour les exceptions stockées, consultez les exceptions levées par GetToken(TimeSpan).