SecurityTokenProvider.RenewTokenCore(TimeSpan, SecurityToken) Method

Reference

Definition

Namespace:: System.IdentityModel.Selectors

Assembly:: System.ServiceModel.Primitives.dll

Assembly:: System.IdentityModel.dll

Package:: System.ServiceModel.Primitives v6.0.0

Package:: System.ServiceModel.Primitives v6.2.0

Source:: SecurityTokenProvider.cs

Source:: SecurityTokenProvider.cs

Source:: SecurityTokenProvider.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Renews a security token.

protected:
 virtual System::IdentityModel::Tokens::SecurityToken ^ RenewTokenCore(TimeSpan timeout, System::IdentityModel::Tokens::SecurityToken ^ tokenToBeRenewed);

protected virtual System.IdentityModel.Tokens.SecurityToken RenewTokenCore (TimeSpan timeout, System.IdentityModel.Tokens.SecurityToken tokenToBeRenewed);

abstract member RenewTokenCore : TimeSpan * System.IdentityModel.Tokens.SecurityToken -> System.IdentityModel.Tokens.SecurityToken
override this.RenewTokenCore : TimeSpan * System.IdentityModel.Tokens.SecurityToken -> System.IdentityModel.Tokens.SecurityToken

Protected Overridable Function RenewTokenCore (timeout As TimeSpan, tokenToBeRenewed As SecurityToken) As 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

SecurityToken

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 RenewTokenCore method is overridden and the security token passed into the token parameter cannot be renewed, throw the SecurityTokenException exception.

The RenewToken method calls the RenewTokenCore method.

Applies to