SecurityTokenProvider.GetTokenAsync(TimeSpan) Método

Definição

Namespace:

System.IdentityModel.Selectors

Assembly:

System.ServiceModel.Primitives.dll

Pacote:

System.ServiceModel.Primitives v6.2.0

Origem:

SecurityTokenProvider.cs

Obtém um token de segurança.

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)

Parâmetros

timeout

TimeSpan

Um TimeSpan que especifica o valor de tempo limite da mensagem que obtém o token de segurança.

Retornos

Task<SecurityToken>

O Task que representa a operação de leitura assíncrona e encapsula o SecurityToken que representa o token de segurança a ser obtido.

Comentários

O GetTokenAsync método é chamado pela ClientCredentials classe quando um cliente envia uma mensagem SOAP e um token de segurança é necessário.

O método GetTokenAsync chama o método GetTokenCoreAsync.

Na maioria dos casos, o timeout parâmetro não é usado por classes derivadas de SecurityTokenProvider como UserNameSecurityTokenProvider. No entanto, às vezes, a recuperação de um token de segurança envolve mensagens distribuídas. Um exemplo é IssuedSecurityTokenProvider usado em um serviço federado. Nesses casos, o timeout parâmetro é usado para evitar exceções causadas por falhas de rede, perda de mensagens e outras condições de erro.

Esse método armazena na tarefa que retorna todas as exceções de não uso que a contraparte síncrona do método pode gerar. Se uma exceção for armazenada na tarefa retornada, essa exceção será gerada quando a tarefa for aguardada. Exceções de uso, como ArgumentException, ainda são geradas de forma síncrona. Para as exceções armazenadas, consulte as exceções geradas por GetToken(TimeSpan).