SecurityTokenProvider.GetTokenAsync(TimeSpan) Methode

Definition

Ruft ein Sicherheitstoken ab.

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)

Parameter

timeout
TimeSpan

Ein TimeSpan, der den Timeoutwert für die Meldung angibt, die das Sicherheitstoken abruft.

Gibt zurück

Der Task , der den asynchronen Lesevorgang darstellt und das umschließt, das SecurityToken das abzurufende Sicherheitstoken darstellt.

Hinweise

Die GetTokenAsync-Methode wird von der ClientCredentials-Klasse aufgerufen, wenn ein Client eine SOAP-Nachricht sendet und ein Sicherheitstoken erforderlich ist.

Die GetTokenAsync-Methode ruft die GetTokenCoreAsync-Methode auf.

In den meisten Fällen wird der timeout-Parameter nicht von abgeleiteten Klassen von SecurityTokenProvider wie z. B. UserNameSecurityTokenProvider verwendet. Manchmal beinhaltet jedoch das Abrufen eines Sicherheitstokens ein verteiltes Messaging. Ein Beispiel ist ein in einem Verbunddienst verwendeter IssuedSecurityTokenProvider. In diesen Fällen wird der timeout-Parameter zur Vermeidung von Ausnahmen verwendet, die durch Netzwerkfehler, Verlust von Nachrichten und andere Fehlerbedingungen verursacht wurden.

Diese Methode speichert in der Aufgabe, die sie alle Nichtverwendungsausnahmen zurückgibt, die die synchrone Entsprechung der Methode auslösen kann. Wenn eine Ausnahme in der zurückgegebenen Aufgabe gespeichert wird, wird diese Ausnahme ausgelöst, wenn die Aufgabe erwartet wird. Nutzungsausnahmen, z. B ArgumentException. , werden weiterhin synchron ausgelöst. Informationen zu den gespeicherten Ausnahmen finden Sie unter die von ausgelösten GetToken(TimeSpan)Ausnahmen.

Gilt für: