Class OAuthTokenProvider

Namespace

Microsoft.ServiceBus

Assembly

Microsoft.ServiceBus.dll

Provides authentication token for the service bus.

public class OAuthTokenProvider : TokenProvider

Inheritance

object

TokenProvider

OAuthTokenProvider

Inherited Members

TokenProvider.Clear()

TokenProvider.CreateSamlTokenProvider(string)

TokenProvider.CreateSamlTokenProvider(string, Uri)

TokenProvider.CreateSamlTokenProvider(string, Uri, int)

TokenProvider.CreateSamlTokenProvider(string, TokenScope)

TokenProvider.CreateSamlTokenProvider(string, Uri, TokenScope)

TokenProvider.CreateSamlTokenProvider(string, Uri, int, TokenScope)

TokenProvider.CreateSharedAccessSignatureTokenProvider(string)

TokenProvider.CreateSharedAccessSignatureTokenProvider(string, string)

TokenProvider.CreateSharedAccessSignatureTokenProvider(string, string, TimeSpan)

TokenProvider.CreateSharedAccessSignatureTokenProvider(string, string, TokenScope)

TokenProvider.CreateSharedAccessSignatureTokenProvider(string, string, TimeSpan, TokenScope)

TokenProvider.CreateSharedSecretTokenProvider(string, string)

TokenProvider.CreateSharedSecretTokenProvider(string, string, Uri)

TokenProvider.CreateSharedSecretTokenProvider(string, byte[])

TokenProvider.CreateSharedSecretTokenProvider(string, byte[], Uri)

TokenProvider.CreateSharedSecretTokenProvider(string, string, TokenScope)

TokenProvider.CreateSharedSecretTokenProvider(string, string, Uri, TokenScope)

TokenProvider.CreateSharedSecretTokenProvider(string, byte[], TokenScope)

TokenProvider.CreateSharedSecretTokenProvider(string, byte[], Uri, TokenScope)

TokenProvider.CreateSimpleWebTokenProvider(string)

TokenProvider.CreateSimpleWebTokenProvider(string, Uri)

TokenProvider.CreateSimpleWebTokenProvider(string, TokenScope)

TokenProvider.CreateSimpleWebTokenProvider(string, Uri, TokenScope)

TokenProvider.CreateWindowsTokenProvider(IEnumerable<Uri>)

TokenProvider.CreateWindowsTokenProvider(IEnumerable<Uri>, NetworkCredential)

TokenProvider.CreateOAuthTokenProvider(IEnumerable<Uri>, NetworkCredential)

TokenProvider.BeginGetToken(string, string, bool, TimeSpan, AsyncCallback, object)

TokenProvider.BeginGetWebToken(string, string, bool, TimeSpan, AsyncCallback, object)

TokenProvider.EndGetToken(IAsyncResult)

TokenProvider.GetTokenAsync(string, string, bool, TimeSpan)

TokenProvider.GetWebTokenAsync(string, string, bool, TimeSpan)

TokenProvider.EndGetWebToken(IAsyncResult)

TokenProvider.TokenScope

TokenProvider.CacheTokens

TokenProvider.CacheSize

TokenProvider.IsWebTokenSupported

TokenProvider.StripQueryParameters

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Methods

BuildKey(string, string)

Builds a key for the provider.

protected override TokenProvider.Key BuildKey(string appliesTo, string action)

Parameters

appliesTo string

The provider in which the key will be applied.

action string

The action.

Returns

TokenProvider.Key

A Key.

NormalizeAppliesTo(string)

Applies normalization into the token provider.

protected override string NormalizeAppliesTo(string appliesTo)

Parameters

appliesTo string

The token provider where the normalization will be applied.

Returns

string

The normalized token provider.

OnBeginGetToken(string, string, TimeSpan, AsyncCallback, object)

Retrieves a token when the provider begins.

protected override IAsyncResult OnBeginGetToken(string appliesTo, string action, TimeSpan timeout, AsyncCallback callback, object state)

Parameters

appliesTo string

The provider in which the token will be applied.

action string

The action.

timeout TimeSpan

The duration.

callback AsyncCallback

The callback.

state object

The state of the operation.

Returns

IAsyncResult

The asynchronous result of the operation.

OnBeginGetWebToken(string, string, TimeSpan, AsyncCallback, object)

Retrieves a web token when the provider begins.

protected override IAsyncResult OnBeginGetWebToken(string appliesTo, string action, TimeSpan timeout, AsyncCallback callback, object state)

Parameters

appliesTo string

The provider in which the web token will be applied.

action string

The action.

timeout TimeSpan

The duration.

callback AsyncCallback

The callback.

state object

The state of the operation.

Returns

IAsyncResult

The asynchronous result of the operation.

OnEndGetToken(IAsyncResult, out DateTime)

Retrieves a token when the provider ends.

protected override SecurityToken OnEndGetToken(IAsyncResult result, out DateTime cacheUntil)

Parameters

result IAsyncResult

The result of the operation.

cacheUntil DateTime

The duration for the provider to store data.

Returns

SecurityToken

The retrieved token.

OnEndGetWebToken(IAsyncResult, out DateTime)

Retrieves a web token when the provider ends.

protected override string OnEndGetWebToken(IAsyncResult result, out DateTime cacheUntil)

Parameters

result IAsyncResult

The result of the operation.

cacheUntil DateTime

The duration for the provider to store data.

Returns

string

The retrieved token.