SecurityTokenProvider Class

.NET Framework (current version)

Represents a security token provider that handles security tokens for a SOAP message sender.

Namespace: System.IdentityModel.Selectors
Assembly: System.IdentityModel (in System.IdentityModel.dll)

Inheritance Hierarchy

System::Object
System.IdentityModel.Selectors::SecurityTokenProvider
System.IdentityModel.Selectors::KerberosSecurityTokenProvider
System.IdentityModel.Selectors::UserNameSecurityTokenProvider
System.IdentityModel.Selectors::X509SecurityTokenProvider
System.ServiceModel.Security::SimpleSecurityTokenProvider
System.ServiceModel.Security::SspiSecurityTokenProvider
System.ServiceModel.Security.Tokens::IssuedSecurityTokenProvider

Syntax

C++

public ref class SecurityTokenProvider abstract

Constructors

	Name	Description
	SecurityTokenProvider()	Initializes a new instance of the SecurityTokenProvider class.

Properties

	Name	Description
	SupportsTokenCancellation	Gets a value that indicates whether the security token can be cancelled.
	SupportsTokenRenewal	Gets a value that indicates whether the security token is renewable.

Methods

	Name	Description
	BeginCancelToken(TimeSpan, SecurityToken^, AsyncCallback^, Object^)	Begins an asynchronous operation to cancel a security token.
	BeginCancelTokenCore(TimeSpan, SecurityToken^, AsyncCallback^, Object^)	Begins an asynchronous operation to cancel a security token.
	BeginGetToken(TimeSpan, AsyncCallback^, Object^)	Begins an asynchronous operation to get a security token.
	BeginGetTokenCore(TimeSpan, AsyncCallback^, Object^)	Begins an asynchronous operation to get a security token.
	BeginRenewToken(TimeSpan, SecurityToken^, AsyncCallback^, Object^)	Begins an asynchronous operation that renews a security token.
	BeginRenewTokenCore(TimeSpan, SecurityToken^, AsyncCallback^, Object^)	Begins an asynchronous operation that renews a security token.
	CancelToken(TimeSpan, SecurityToken^)	Cancels a security token.
	CancelTokenCore(TimeSpan, SecurityToken^)	Cancels a security token.
	EndCancelToken(IAsyncResult^)	Completes an asynchronous operation to cancel a security token.
	EndCancelTokenCore(IAsyncResult^)	Completes an asynchronous operation to cancel a security token.
	EndGetToken(IAsyncResult^)	Completes an asynchronous operation to get a security token.
	EndGetTokenCore(IAsyncResult^)	Completes an asynchronous operation to get a security token.
	EndRenewToken(IAsyncResult^)	Completes an asynchronous operation to renew a security token.
	EndRenewTokenCore(IAsyncResult^)	Completes an asynchronous operation to renew the security token.
	Equals(Object^)	Determines whether the specified object is equal to the current object.(Inherited from Object.)
	Finalize()	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)
	GetHashCode()	Serves as the default hash function. (Inherited from Object.)
	GetToken(TimeSpan)	Gets a security token.
	GetTokenCore(TimeSpan)	Gets a security token.
	GetType()	Gets the Type of the current instance.(Inherited from Object.)
	MemberwiseClone()	Creates a shallow copy of the current Object.(Inherited from Object.)
	RenewToken(TimeSpan, SecurityToken^)	Renews a security token.
	RenewTokenCore(TimeSpan, SecurityToken^)	Renews a security token.
	ToString()	Returns a string that represents the current object.(Inherited from Object.)

Use the SecurityTokenProvider class when custom security tokens are required. The role of a security token provider is to get a security token when a SOAP message is sent by a client and a security token is used to authenticate the client or to protect the SOAP message. Specifically, the GetToken method is called to get a security token. The security token provider can also be called to cancel and renew a security using the CancelToken and RenewToken methods.

Classes that derive from the SecurityTokenManager class implement the CreateSecurityTokenProvider method to determine which security token provider is required for a given security token.

The ClientCredentialsSecurityTokenManager and ServiceCredentialsSecurityTokenManager classes provide the default implementations for built-in security token types. For custom security token scenarios, you must derive a class from one of the SecurityTokenManager, ClientCredentialsSecurityTokenManager, or ServiceCredentialsSecurityTokenManager classes and provide the functionality to create the security token provider, security token authenticator, and security token serializer for the custom security token. For more information about creating a custom token, see How to: Create a Custom Token.