SecurityTokenProvider.RenewTokenCoreAsync(TimeSpan, SecurityToken) Method

Definition

Namespace:

System.IdentityModel.Selectors

Assembly:

System.ServiceModel.Primitives.dll

Package:

System.ServiceModel.Primitives v8.1.0

Source:

SecurityTokenProvider.cs

Renews a security token.

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

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

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

Protected Overridable Function RenewTokenCoreAsync (timeout As TimeSpan, tokenToBeRenewed As SecurityToken) As Task(Of SecurityToken)

Parameters

timeout

TimeSpan

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

tokenToBeRenewed

SecurityToken

The SecurityToken to renew.

Returns

Task<SecurityToken>

The Task that represents the asynchronous read operation and wraps the SecurityToken that represents the security token that is renewed.

Remarks

An issued security token that is renewable allows a client to renew it when the security token is about to or has expired.

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

The RenewTokenAsync method calls the RenewTokenCoreAsync 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 RenewTokenCore(TimeSpan, SecurityToken).