SecurityTokenProvider.GetTokenCoreAsync(TimeSpan) Method

Definition

Namespace:

System.IdentityModel.Selectors

Assembly:

System.ServiceModel.Primitives.dll

Package:

System.ServiceModel.Primitives v8.1.0

Source:

SecurityTokenProvider.cs

Gets a security token.

protected:
 virtual System::Threading::Tasks::Task<System::IdentityModel::Tokens::SecurityToken ^> ^ GetTokenCoreAsync(TimeSpan timeout);

protected virtual System.Threading.Tasks.Task<System.IdentityModel.Tokens.SecurityToken> GetTokenCoreAsync (TimeSpan timeout);

abstract member GetTokenCoreAsync : TimeSpan -> System.Threading.Tasks.Task<System.IdentityModel.Tokens.SecurityToken>
override this.GetTokenCoreAsync : TimeSpan -> System.Threading.Tasks.Task<System.IdentityModel.Tokens.SecurityToken>

Protected Overridable Function GetTokenCoreAsync (timeout As TimeSpan) As Task(Of SecurityToken)

Parameters

timeout

TimeSpan

A TimeSpan that specifies the timeout value for the message that gets the security token.

Returns

Task<SecurityToken>

The Task that represents the asynchronous read operation and wraps the SecurityToken that represents the security token to get.

Remarks

When the GetTokenCoreAsync method is overridden and the security token passed into the token parameter cannot be obtained, throw the SecurityTokenException exception.

The GetTokenAsync method is called by the ClientCredentials class when a client sends a SOAP message and a security token is required.

The GetTokenAsync method calls the GetTokenCoreAsync method.

This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as ArgumentException, are still thrown synchronously. For the stored exceptions, see the exceptions thrown by GetTokenCore(TimeSpan).