SecurityTokenProvider.GetTokenAsync(TimeSpan) メソッド

定義

名前空間:

System.IdentityModel.Selectors

アセンブリ:

System.ServiceModel.Primitives.dll

パッケージ:

System.ServiceModel.Primitives v6.2.0

ソース:

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)スローされる例外に関するページを参照してください。