This topic has not yet been rated - Rate this topic

TokenProvider Class

Represents a security token provider with built-in factory methods returning some well-known token providers.

System.Object
  Microsoft.ServiceBus.TokenProvider
    Microsoft.ServiceBus.OAuthTokenProvider
    Microsoft.ServiceBus.SamlTokenProvider
    Microsoft.ServiceBus.SharedAccessSignatureTokenProvider
    Microsoft.ServiceBus.SharedSecretTokenProvider
    Microsoft.ServiceBus.SimpleWebTokenProvider
    Microsoft.ServiceBus.WindowsTokenProvider

Namespace: Microsoft.ServiceBus
Assembly: Microsoft.ServiceBus (in Microsoft.ServiceBus.dll)

Syntax

C++

JScript

public abstract class TokenProvider

The TokenProvider type exposes the following members.

Constructors

	Name	Description
	TokenProvider(Boolean, Boolean)	Initializes a new instance of the TokenProvider class.
	TokenProvider(Boolean, Boolean, TokenScope)	Initializes a new instance of the TokenProvider class.
	TokenProvider(Boolean, Boolean, Int32, TokenScope)	Initializes a new instance of the TokenProvider class.

Top

Properties

	Name	Description
	CacheSize	Gets or sets the size of the cache.
	CacheTokens	Gets or sets a value that indicates whether new security tokens are being cached.
	IsWebTokenSupported	Gets or sets a value that indicates whether web token is supported by this provider.
	StripQueryParameters	Gets whether the token provider strips query parameters.
	TokenScope	Gets or sets the token scope associated with the provider.

Top

Methods

	Name	Description
	BeginGetToken	Begins an asynchronous operation to get a security token.
	BeginGetWebToken	Begins an asynchronous operation to get a web token.
	BuildKey	Generates a key for the token provider.
	Clear	Clears the token provider.
	CreateOAuthTokenProvider	Creates an OAuth (open standard for authorization) token provider.
	CreateSamlTokenProvider(String)	Creates a SAML token provider with the specified SAML token.
	CreateSamlTokenProvider(String, TokenScope)	Creates a SAML token provider with the specified SAML token and scope.
	CreateSamlTokenProvider(String, Uri)	Creates a SAML token provider with the specified SAML token and URI of the Security Token Service (STS).
	CreateSamlTokenProvider(String, Uri, TokenScope)	Creates a SAML token provider with the specified SAML token, URI of the Security Token Service (STS) and token scope.
	CreateSamlTokenProvider(String, Uri, Int32)	Creates a SAML token provider with the specified SAML token, URI of the Security Token Service (STS) and cache size.
	CreateSamlTokenProvider(String, Uri, Int32, TokenScope)	Creates a SAML token provider with the specified SAML token, URI of the Security Token Service (STS), cache size and token scope.
	CreateSharedAccessSignatureTokenProvider(String, String)	Creates a URL that grants access to token provider with specified key name and shared access key.
	CreateSharedAccessSignatureTokenProvider(String, String, TokenScope)	Creates a URL that grants access to token provider with specified key name, shared access key and token scope.
	CreateSharedAccessSignatureTokenProvider(String, String, TimeSpan)	Creates a URL that grants access to token provider with specified key name, shared access key and token time to live.
	CreateSharedAccessSignatureTokenProvider(String, String, TimeSpan, TokenScope)	Creates a URL that grants access to token provider.
	CreateSharedSecretTokenProvider(String, Byte[])	Creates a shared secret token provider.
	CreateSharedSecretTokenProvider(String, String)	Creates a shared secret token provider.
	CreateSharedSecretTokenProvider(String, Byte[], TokenScope)	Creates a shared secret token provider.
	CreateSharedSecretTokenProvider(String, Byte[], Uri)	Creates a shared secret token provider.
	CreateSharedSecretTokenProvider(String, String, TokenScope)	Creates a shared secret token provider.
	CreateSharedSecretTokenProvider(String, String, Uri)	Creates a shared secret token provider.
	CreateSharedSecretTokenProvider(String, Byte[], Uri, TokenScope)	Creates a shared secret token provider.
	CreateSharedSecretTokenProvider(String, String, Uri, TokenScope)	Creates a shared secret token provider.
	CreateSimpleWebTokenProvider(String)	Creates a simple web token provider.
	CreateSimpleWebTokenProvider(String, TokenScope)	Creates a simple web token provider.
	CreateSimpleWebTokenProvider(String, Uri)	Creates a simple web token provider.
	CreateSimpleWebTokenProvider(String, Uri, TokenScope)	Creates a simple web token provider.
	CreateUserNamePasswordTokenProvider	Created a user name and password for the token provider.
	CreateWindowsTokenProvider(IEnumerable<Uri>)	Creates a windows token provider.
	CreateWindowsTokenProvider(IEnumerable<Uri>, NetworkCredential)	Creates a windows token provider.
	EndGetToken	Completes an asynchronous operation to get a security token.
	EndGetWebToken	Completes an asynchronous operation to get a web token.
	Equals	(Inherited from Object.)
	Finalize	(Inherited from Object.)
	GetHashCode	(Inherited from Object.)
	GetTokenAsync	Asynchronously retrieves the token for the provider.
	GetType	(Inherited from Object.)
	GetWebTokenAsync	Asynchronously retrieves the web token for the provider.
	MemberwiseClone	(Inherited from Object.)
	NormalizeAppliesTo	Returns an object whose value is the same as the token provider.
	OnBeginGetToken	Executes upon calling the BeginGetToken method.
	OnBeginGetWebToken	Executes upon calling the BeginGetWebToken method.
	OnEndGetToken	Executes upon calling the EndGetToken method.
	OnEndGetWebToken	Executes upon calling the EndGetWebToken method.
	ToString	(Inherited from Object.)

Top

Remarks

The token provider is responsible for the acquisition of tokens and would, in the concrete case of a token provider for shared secrets in a specialization, also hold that secret.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Reference

Microsoft.ServiceBus Namespace

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)

Community Additions

ADD