TokenProvider TokenProvider Class

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

Syntax

Declaration

public abstract class TokenProviderPublic MustInherit Class TokenProvider

Inheritance Hierarchy

Constructors summary

Initializes a new instance of the TokenProvider class.

Initializes a new instance of the TokenProvider class.

Initializes a new instance of the TokenProvider class.

Properties summary

Gets or sets the size of the cache.

Gets or sets a value that indicates whether new security tokens are being cached.

Gets or sets a value that indicates whether web token is supported by this provider.

Gets whether the token provider strips query parameters.

Gets or sets the token scope associated with the provider.

Methods summary

Begins an asynchronous operation to get a security token.

Begins an asynchronous operation to get a web token.

Generates a key for the token provider.

Clears the token provider.

Creates an OAuth (open standard for authorization) token provider.

Creates a SAML token provider with the specified SAML token.

Creates a SAML token provider with the specified SAML token and scope.

Creates a SAML token provider with the specified SAML token and URI of the Security Token Service (STS).

Creates a SAML token provider with the specified SAML token, URI of the Security Token Service (STS) and token scope.

Creates a SAML token provider with the specified SAML token, URI of the Security Token Service (STS) and cache size.

Creates a SAML token provider with the specified SAML token, URI of the Security Token Service (STS), cache size and token scope.

Creates a URL that grants access to the token provider with the specified shared access signature.

Creates a URL that grants access to the token provider with the specified key name and shared access key.

Creates a URL that grants access to the token provider with the specified key name, shared access key and token scope.

Creates a URL that grants access to the token provider with the specified key name, shared access key and token time to live.

Creates a URL that grants access to the token provider.

Creates a shared secret token provider.

Creates a shared secret token provider.

Creates a shared secret token provider.

Creates a shared secret token provider.

Creates a shared secret token provider.

Creates a shared secret token provider.

Creates a shared secret token provider.

Creates a shared secret token provider.

Creates a simple web token provider.

Creates a simple web token provider.

Creates a simple web token provider.

Creates a simple web token provider.

Creates a windows token provider.

Creates a windows token provider.

Completes an asynchronous operation to get a security token.

Completes an asynchronous operation to get a web token.

Asynchronously retrieves the token for the provider.

Asynchronously retrieves the web token for the provider.

Returns an object whose value is the same as the token provider.

Executes upon calling the BeginGetToken method.

Executes upon calling the BeginGetWebToken method.

Executes upon calling the EndGetToken method.

Executes upon calling the EndGetWebToken method.

Constructors

  • TokenProvider(Boolean, Boolean)
    TokenProvider(Boolean, Boolean)

    Initializes a new instance of the TokenProvider class.

    protected TokenProvider(bool cacheTokens, bool supportHttpAuthToken)Protected Sub New(cacheTokens As Boolean, supportHttpAuthToken As Boolean)

    Parameters

    • cacheTokens

      true if new security tokens are being cached; otherwise, false.

    • supportHttpAuthToken

      true if web token is supported by this provider; otherwise, false.

  • TokenProvider(Boolean, Boolean, TokenScope)
    TokenProvider(Boolean, Boolean, TokenScope)

    Initializes a new instance of the TokenProvider class.

    protected TokenProvider(bool cacheTokens, bool supportHttpAuthToken, TokenScope tokenScope)Protected Sub New(cacheTokens As Boolean, supportHttpAuthToken As Boolean, tokenScope As TokenScope)

    Parameters

    • cacheTokens

      true if new security tokens are being cached; otherwise, false.

    • supportHttpAuthToken

      true if web token is supported by this provider; otherwise, false.

    • tokenScope

      The token scope associated with the provider.

  • TokenProvider(Boolean, Boolean, Int32, TokenScope)
    TokenProvider(Boolean, Boolean, Int32, TokenScope)

    Initializes a new instance of the TokenProvider class.

    protected TokenProvider(bool cacheTokens, bool supportHttpAuthToken, int cacheSize, TokenScope tokenScope)Protected Sub New(cacheTokens As Boolean, supportHttpAuthToken As Boolean, cacheSize As Integer, tokenScope As TokenScope)

    Parameters

    • cacheTokens

      true if new security tokens are being cached; otherwise, false.

    • supportHttpAuthToken

      true if web token is supported by this provider; otherwise, false.

    • cacheSize

      The size of the cache.

    • tokenScope

      The token scope associated with the provider.

Properties

  • CacheSize
    CacheSize

    Gets or sets the size of the cache.

    public int CacheSize { get; set; }Public Property CacheSize As Integer

    Property Value

  • CacheTokens
    CacheTokens

    Gets or sets a value that indicates whether new security tokens are being cached.

    public bool CacheTokens { get; set; }Public Property CacheTokens As Boolean

    Property Value

    • true if new security tokens are being cached; otherwise, false.

  • IsWebTokenSupported
    IsWebTokenSupported

    Gets or sets a value that indicates whether web token is supported by this provider.

    public bool IsWebTokenSupported { get; }Public ReadOnly Property IsWebTokenSupported As Boolean

    Property Value

    • true if web token is supported by this provider; otherwise, false.

  • StripQueryParameters
    StripQueryParameters

    Gets whether the token provider strips query parameters.

    protected virtual bool StripQueryParameters { get; }Protected Overridable ReadOnly Property StripQueryParameters As Boolean

    Property Value

    • true if the token provider strips query parameters; otherwise, false.

  • TokenScope
    TokenScope

    Gets or sets the token scope associated with the provider.

    public TokenScope TokenScope { get; }Public ReadOnly Property TokenScope As TokenScope

    Property Value

Methods

  • BeginGetToken(String, String, Boolean, TimeSpan, AsyncCallback, Object)
    BeginGetToken(String, String, Boolean, TimeSpan, AsyncCallback, Object)

    Begins an asynchronous operation to get a security token.

    public IAsyncResult BeginGetToken(string appliesTo, string action, bool bypassCache, TimeSpan timeout, AsyncCallback callback, object state)Public Function BeginGetToken(appliesTo As String, action As String, bypassCache As Boolean, timeout As TimeSpan, callback As AsyncCallback, state As Object) As IAsyncResult

    Parameters

    • appliesTo

      The URI which the access token applies to.

    • action

      The request action.

    • bypassCache

      true to ignore existing token information in the cache; false to use the token information in the cache.

    • timeout

      The time span that specifies the timeout value for the message that gets the security token.

    • callback

      An AsyncCallback delegate that references the method to invoke when the operation is complete.

    • state

      A user-defined object that contains state information about the asynchronous operation.

    Returns

  • BeginGetWebToken(String, String, Boolean, TimeSpan, AsyncCallback, Object)
    BeginGetWebToken(String, String, Boolean, TimeSpan, AsyncCallback, Object)

    Begins an asynchronous operation to get a web token.

    public IAsyncResult BeginGetWebToken(string appliesTo, string action, bool bypassCache, TimeSpan timeout, AsyncCallback callback, object state)Public Function BeginGetWebToken(appliesTo As String, action As String, bypassCache As Boolean, timeout As TimeSpan, callback As AsyncCallback, state As Object) As IAsyncResult

    Parameters

    • appliesTo

      The URI which the token applies to.

    • action

      The request action.

    • bypassCache

      true to ignore existing token information in the cache; false to use the token information in the cache.

    • timeout

      The time span that specifies the timeout value for the message that gets the security token.

    • callback

      An AsyncCallback delegate that references the method to invoke when the operation is complete.

    • state

      A user-defined object that contains state information about the asynchronous operation.

    Returns

  • BuildKey(String, String)
    BuildKey(String, String)

    Generates a key for the token provider.

    protected virtual TokenProvider.Key BuildKey(string appliesTo, string action)Protected Overridable Function BuildKey(appliesTo As String, action As String) As TokenProvider.Key

    Parameters

    Returns

  • Clear()
    Clear()

    Clears the token provider.

    public void Clear()Public Sub Clear
  • CreateOAuthTokenProvider(IEnumerable<Uri>, NetworkCredential)
    CreateOAuthTokenProvider(IEnumerable(Of Uri), NetworkCredential)

    Creates an OAuth (open standard for authorization) token provider.

    public static TokenProvider CreateOAuthTokenProvider(IEnumerable<Uri> stsUris, NetworkCredential credential)Public Shared Function CreateOAuthTokenProvider(stsUris As IEnumerable(Of Uri), credential As NetworkCredential) As TokenProvider

    Parameters

    Returns

  • CreateSamlTokenProvider(String)
    CreateSamlTokenProvider(String)

    Creates a SAML token provider with the specified SAML token.

    public static TokenProvider CreateSamlTokenProvider(string samlToken)Public Shared Function CreateSamlTokenProvider(samlToken As String) As TokenProvider

    Parameters

    • samlToken

      The string that represents the SAML token.

    Returns

  • CreateSamlTokenProvider(String, TokenScope)
    CreateSamlTokenProvider(String, TokenScope)

    Creates a SAML token provider with the specified SAML token and scope.

    public static TokenProvider CreateSamlTokenProvider(string samlToken, TokenScope tokenScope)Public Shared Function CreateSamlTokenProvider(samlToken As String, tokenScope As TokenScope) As TokenProvider

    Parameters

    Returns

  • CreateSamlTokenProvider(String, Uri)
    CreateSamlTokenProvider(String, Uri)

    Creates a SAML token provider with the specified SAML token and URI of the Security Token Service (STS).

    public static TokenProvider CreateSamlTokenProvider(string samlToken, Uri stsUri)Public Shared Function CreateSamlTokenProvider(samlToken As String, stsUri As Uri) As TokenProvider

    Parameters

    • samlToken

      The string that represents the SAML token.

    • stsUri

      The URI of the Security Token Service (STS).

    Returns

  • CreateSamlTokenProvider(String, Uri, TokenScope)
    CreateSamlTokenProvider(String, Uri, TokenScope)

    Creates a SAML token provider with the specified SAML token, URI of the Security Token Service (STS) and token scope.

    public static TokenProvider CreateSamlTokenProvider(string samlToken, Uri stsUri, TokenScope tokenScope)Public Shared Function CreateSamlTokenProvider(samlToken As String, stsUri As Uri, tokenScope As TokenScope) As TokenProvider

    Parameters

    • samlToken

      The string that represents the SAML token.

    • stsUri

      The URI of the Security Token Service (STS).

    • tokenScope

      The token scope associated with the provider.

    Returns

  • CreateSamlTokenProvider(String, Uri, Int32)
    CreateSamlTokenProvider(String, Uri, Int32)

    Creates a SAML token provider with the specified SAML token, URI of the Security Token Service (STS) and cache size.

    public static TokenProvider CreateSamlTokenProvider(string samlToken, Uri stsUri, int cacheSize)Public Shared Function CreateSamlTokenProvider(samlToken As String, stsUri As Uri, cacheSize As Integer) As TokenProvider

    Parameters

    • samlToken

      The string that represents the SAML token.

    • stsUri

      The URI of the Security Token Service (STS).

    • cacheSize

      The size of the cache.

    Returns

  • CreateSamlTokenProvider(String, Uri, Int32, TokenScope)
    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.

    public static TokenProvider CreateSamlTokenProvider(string samlToken, Uri stsUri, int cacheSize, TokenScope tokenScope)Public Shared Function CreateSamlTokenProvider(samlToken As String, stsUri As Uri, cacheSize As Integer, tokenScope As TokenScope) As TokenProvider

    Parameters

    • samlToken

      The string that represents the SAML token.

    • stsUri

      The URI of the Security Token Service (STS).

    • cacheSize

      The size of the cache.

    • tokenScope

      The token scope associated with the provider.

    Returns

  • CreateSharedAccessSignatureTokenProvider(String)
    CreateSharedAccessSignatureTokenProvider(String)

    Creates a URL that grants access to the token provider with the specified shared access signature.

    public static TokenProvider CreateSharedAccessSignatureTokenProvider(string sharedAccessSignature)Public Shared Function CreateSharedAccessSignatureTokenProvider(sharedAccessSignature As String) As TokenProvider

    Parameters

    • sharedAccessSignature

      The shared access signature.

    Returns

  • CreateSharedAccessSignatureTokenProvider(String, String)
    CreateSharedAccessSignatureTokenProvider(String, String)

    Creates a URL that grants access to the token provider with the specified key name and shared access key.

    public static TokenProvider CreateSharedAccessSignatureTokenProvider(string keyName, string sharedAccessKey)Public Shared Function CreateSharedAccessSignatureTokenProvider(keyName As String, sharedAccessKey As String) As TokenProvider

    Parameters

    Returns

  • CreateSharedAccessSignatureTokenProvider(String, String, TokenScope)
    CreateSharedAccessSignatureTokenProvider(String, String, TokenScope)

    Creates a URL that grants access to the token provider with the specified key name, shared access key and token scope.

    public static TokenProvider CreateSharedAccessSignatureTokenProvider(string keyName, string sharedAccessKey, TokenScope tokenScope)Public Shared Function CreateSharedAccessSignatureTokenProvider(keyName As String, sharedAccessKey As String, tokenScope As TokenScope) As TokenProvider

    Parameters

    Returns

  • CreateSharedAccessSignatureTokenProvider(String, String, TimeSpan)
    CreateSharedAccessSignatureTokenProvider(String, String, TimeSpan)

    Creates a URL that grants access to the token provider with the specified key name, shared access key and token time to live.

    public static TokenProvider CreateSharedAccessSignatureTokenProvider(string keyName, string sharedAccessKey, TimeSpan tokenTimeToLive)Public Shared Function CreateSharedAccessSignatureTokenProvider(keyName As String, sharedAccessKey As String, tokenTimeToLive As TimeSpan) As TokenProvider

    Parameters

    Returns

  • CreateSharedAccessSignatureTokenProvider(String, String, TimeSpan, TokenScope)
    CreateSharedAccessSignatureTokenProvider(String, String, TimeSpan, TokenScope)

    Creates a URL that grants access to the token provider.

    public static TokenProvider CreateSharedAccessSignatureTokenProvider(string keyName, string sharedAccessKey, TimeSpan tokenTimeToLive, TokenScope tokenScope)Public Shared Function CreateSharedAccessSignatureTokenProvider(keyName As String, sharedAccessKey As String, tokenTimeToLive As TimeSpan, tokenScope As TokenScope) As TokenProvider

    Parameters

    Returns

  • CreateSharedSecretTokenProvider(String, Byte[])
    CreateSharedSecretTokenProvider(String, Byte())

    Creates a shared secret token provider.

    public static TokenProvider CreateSharedSecretTokenProvider(string issuerName, byte[] issuerSecret)Public Shared Function CreateSharedSecretTokenProvider(issuerName As String, issuerSecret As Byte()) As TokenProvider

    Parameters

    Returns

  • CreateSharedSecretTokenProvider(String, Byte[], TokenScope)
    CreateSharedSecretTokenProvider(String, Byte(), TokenScope)

    Creates a shared secret token provider.

    public static TokenProvider CreateSharedSecretTokenProvider(string issuerName, byte[] issuerSecret, TokenScope tokenScope)Public Shared Function CreateSharedSecretTokenProvider(issuerName As String, issuerSecret As Byte(), tokenScope As TokenScope) As TokenProvider

    Parameters

    Returns

  • CreateSharedSecretTokenProvider(String, Byte[], Uri)
    CreateSharedSecretTokenProvider(String, Byte(), Uri)

    Creates a shared secret token provider.

    public static TokenProvider CreateSharedSecretTokenProvider(string issuerName, byte[] issuerSecret, Uri stsUri)Public Shared Function CreateSharedSecretTokenProvider(issuerName As String, issuerSecret As Byte(), stsUri As Uri) As TokenProvider

    Parameters

    • issuerName

      The issuer name.

    • issuerSecret

      The set of issuer secret.

    • stsUri

      The URI of the Security Token Service (STS).

    Returns

  • CreateSharedSecretTokenProvider(String, Byte[], Uri, TokenScope)
    CreateSharedSecretTokenProvider(String, Byte(), Uri, TokenScope)

    Creates a shared secret token provider.

    public static TokenProvider CreateSharedSecretTokenProvider(string issuerName, byte[] issuerSecret, Uri stsUri, TokenScope tokenScope)Public Shared Function CreateSharedSecretTokenProvider(issuerName As String, issuerSecret As Byte(), stsUri As Uri, tokenScope As TokenScope) As TokenProvider

    Parameters

    • issuerName

      The issuer name.

    • issuerSecret

      The set of issuer secret.

    • stsUri

      The Security Token Service's endpoint Uri.

    • tokenScope

      The token scope associated with the provider.

    Returns

  • CreateSharedSecretTokenProvider(String, String)
    CreateSharedSecretTokenProvider(String, String)

    Creates a shared secret token provider.

    public static TokenProvider CreateSharedSecretTokenProvider(string issuerName, string issuerSecret)Public Shared Function CreateSharedSecretTokenProvider(issuerName As String, issuerSecret As String) As TokenProvider

    Parameters

    Returns

  • CreateSharedSecretTokenProvider(String, String, TokenScope)
    CreateSharedSecretTokenProvider(String, String, TokenScope)

    Creates a shared secret token provider.

    public static TokenProvider CreateSharedSecretTokenProvider(string issuerName, string issuerSecret, TokenScope tokenScope)Public Shared Function CreateSharedSecretTokenProvider(issuerName As String, issuerSecret As String, tokenScope As TokenScope) As TokenProvider

    Parameters

    Returns

  • CreateSharedSecretTokenProvider(String, String, Uri)
    CreateSharedSecretTokenProvider(String, String, Uri)

    Creates a shared secret token provider.

    public static TokenProvider CreateSharedSecretTokenProvider(string issuerName, string issuerSecret, Uri stsUri)Public Shared Function CreateSharedSecretTokenProvider(issuerName As String, issuerSecret As String, stsUri As Uri) As TokenProvider

    Parameters

    Returns

  • CreateSharedSecretTokenProvider(String, String, Uri, TokenScope)
    CreateSharedSecretTokenProvider(String, String, Uri, TokenScope)

    Creates a shared secret token provider.

    public static TokenProvider CreateSharedSecretTokenProvider(string issuerName, string issuerSecret, Uri stsUri, TokenScope tokenScope)Public Shared Function CreateSharedSecretTokenProvider(issuerName As String, issuerSecret As String, stsUri As Uri, tokenScope As TokenScope) As TokenProvider

    Parameters

    Returns

  • CreateSimpleWebTokenProvider(String)
    CreateSimpleWebTokenProvider(String)

    Creates a simple web token provider.

    public static TokenProvider CreateSimpleWebTokenProvider(string token)Public Shared Function CreateSimpleWebTokenProvider(token As String) As TokenProvider

    Parameters

    • token

      The string that represents the simple web token.

    Returns

  • CreateSimpleWebTokenProvider(String, TokenScope)
    CreateSimpleWebTokenProvider(String, TokenScope)

    Creates a simple web token provider.

    public static TokenProvider CreateSimpleWebTokenProvider(string token, TokenScope tokenScope)Public Shared Function CreateSimpleWebTokenProvider(token As String, tokenScope As TokenScope) As TokenProvider

    Parameters

    Returns

  • CreateSimpleWebTokenProvider(String, Uri)
    CreateSimpleWebTokenProvider(String, Uri)

    Creates a simple web token provider.

    public static TokenProvider CreateSimpleWebTokenProvider(string token, Uri stsUri)Public Shared Function CreateSimpleWebTokenProvider(token As String, stsUri As Uri) As TokenProvider

    Parameters

    • token

      The string that represents the simple web token.

    • stsUri

      The URI of the Security Token Service (STS).

    Returns

  • CreateSimpleWebTokenProvider(String, Uri, TokenScope)
    CreateSimpleWebTokenProvider(String, Uri, TokenScope)

    Creates a simple web token provider.

    public static TokenProvider CreateSimpleWebTokenProvider(string token, Uri stsUri, TokenScope tokenScope)Public Shared Function CreateSimpleWebTokenProvider(token As String, stsUri As Uri, tokenScope As TokenScope) As TokenProvider

    Parameters

    • token

      The string that represents the simple web token.

    • stsUri

      The URI of the Security Token Service (STS).

    • tokenScope

      The token scope associated with the provider.

    Returns

  • CreateWindowsTokenProvider(IEnumerable<Uri>)
    CreateWindowsTokenProvider(IEnumerable(Of Uri))

    Creates a windows token provider.

    public static TokenProvider CreateWindowsTokenProvider(IEnumerable<Uri> stsUris)Public Shared Function CreateWindowsTokenProvider(stsUris As IEnumerable(Of Uri)) As TokenProvider

    Parameters

    Returns

  • CreateWindowsTokenProvider(IEnumerable<Uri>, NetworkCredential)
    CreateWindowsTokenProvider(IEnumerable(Of Uri), NetworkCredential)

    Creates a windows token provider.

    public static TokenProvider CreateWindowsTokenProvider(IEnumerable<Uri> stsUris, NetworkCredential credential)Public Shared Function CreateWindowsTokenProvider(stsUris As IEnumerable(Of Uri), credential As NetworkCredential) As TokenProvider

    Parameters

    Returns

  • EndGetToken(IAsyncResult)
    EndGetToken(IAsyncResult)

    Completes an asynchronous operation to get a security token.

    public SecurityToken EndGetToken(IAsyncResult result)Public Function EndGetToken(result As IAsyncResult) As SecurityToken

    Parameters

    Returns

  • EndGetWebToken(IAsyncResult)
    EndGetWebToken(IAsyncResult)

    Completes an asynchronous operation to get a web token.

    public string EndGetWebToken(IAsyncResult result)Public Function EndGetWebToken(result As IAsyncResult) As String

    Parameters

    Returns

  • GetTokenAsync(String, String, Boolean, TimeSpan)
    GetTokenAsync(String, String, Boolean, TimeSpan)

    Asynchronously retrieves the token for the provider.

    public Task<SecurityToken> GetTokenAsync(string appliesTo, string action, bool bypassCache, TimeSpan timeout)Public Function GetTokenAsync(appliesTo As String, action As String, bypassCache As Boolean, timeout As TimeSpan) As Task(Of SecurityToken)

    Parameters

    • appliesTo

      The URI which the access token applies to.

    • action

      The request action.

    • bypassCache

      true to ignore existing token information in the cache; false to use the token information in the cache.

    • timeout

      The time span that specifies the timeout value for the message that gets the security token.

    Returns

  • GetWebTokenAsync(String, String, Boolean, TimeSpan)
    GetWebTokenAsync(String, String, Boolean, TimeSpan)

    Asynchronously retrieves the web token for the provider.

    public Task<string> GetWebTokenAsync(string appliesTo, string action, bool bypassCache, TimeSpan timeout)Public Function GetWebTokenAsync(appliesTo As String, action As String, bypassCache As Boolean, timeout As TimeSpan) As Task(Of String)

    Parameters

    • appliesTo

      The URI which the access token applies to.

    • action

      The request action.

    • bypassCache

      true to ignore existing token information in the cache; false to use the token information in the cache.

    • timeout

      The time span that specifies the timeout value for the message that gets the security token.

    Returns

  • NormalizeAppliesTo(String)
    NormalizeAppliesTo(String)

    Returns an object whose value is the same as the token provider.

    protected virtual string NormalizeAppliesTo(string appliesTo)Protected Overridable Function NormalizeAppliesTo(appliesTo As String) As String

    Parameters

    • appliesTo

      The URI which the access token applies to.

    Returns

  • OnBeginGetToken(String, String, TimeSpan, AsyncCallback, Object)
    OnBeginGetToken(String, String, TimeSpan, AsyncCallback, Object)

    Executes upon calling the BeginGetToken method.

    protected abstract IAsyncResult OnBeginGetToken(string appliesTo, string action, TimeSpan timeout, AsyncCallback callback, object state)Protected MustOverride Function OnBeginGetToken(appliesTo As String, action As String, timeout As TimeSpan, callback As AsyncCallback, state As Object) As IAsyncResult

    Parameters

    • appliesTo

      The URI which the access token applies to.

    • action

      The request action.

    • timeout

      The time span that specifies the timeout value for the message that gets the security token.

    • callback

      An AsyncCallback delegate that references the method to invoke when the operation is complete.

    • state

      A user-defined object that contains state information about the asynchronous operation.

    Returns

  • OnBeginGetWebToken(String, String, TimeSpan, AsyncCallback, Object)
    OnBeginGetWebToken(String, String, TimeSpan, AsyncCallback, Object)

    Executes upon calling the BeginGetWebToken method.

    protected abstract IAsyncResult OnBeginGetWebToken(string appliesTo, string action, TimeSpan timeout, AsyncCallback callback, object state)Protected MustOverride Function OnBeginGetWebToken(appliesTo As String, action As String, timeout As TimeSpan, callback As AsyncCallback, state As Object) As IAsyncResult

    Parameters

    • appliesTo

      The URI which the access token applies to.

    • action

      The request action.

    • timeout

      The time span that specifies the timeout value for the message that gets the security token.

    • callback

      An AsyncCallback delegate that references the method to invoke when the operation is complete.

    • state

      A user-defined object that contains state information about the asynchronous operation.

    Returns

  • OnEndGetToken(IAsyncResult, out DateTime)
    OnEndGetToken(IAsyncResult, ByRef DateTime)

    Executes upon calling the EndGetToken method.

    protected abstract SecurityToken OnEndGetToken(IAsyncResult result, out DateTime cacheUntil)Protected MustOverride Function OnEndGetToken(result As IAsyncResult, ByRef cacheUntil As Date) As SecurityToken

    Parameters

    Returns

  • OnEndGetWebToken(IAsyncResult, out DateTime)
    OnEndGetWebToken(IAsyncResult, ByRef DateTime)

    Executes upon calling the EndGetWebToken method.

    protected abstract string OnEndGetWebToken(IAsyncResult result, out DateTime cacheUntil)Protected MustOverride Function OnEndGetWebToken(result As IAsyncResult, ByRef cacheUntil As Date) As String

    Parameters

    Returns

Details

Assembly

Microsoft.ServiceBus.dll