InMemoryCryptoProviderCache.xml

<Type Name="InMemoryCryptoProviderCache" FullName="Microsoft.IdentityModel.Tokens.InMemoryCryptoProviderCache">
  <TypeSignature Language="C#" Value="public class InMemoryCryptoProviderCache : Microsoft.IdentityModel.Tokens.CryptoProviderCache, IDisposable" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit InMemoryCryptoProviderCache extends Microsoft.IdentityModel.Tokens.CryptoProviderCache implements class System.IDisposable" />
  <TypeSignature Language="DocId" Value="T:Microsoft.IdentityModel.Tokens.InMemoryCryptoProviderCache" />
  <TypeSignature Language="VB.NET" Value="Public Class InMemoryCryptoProviderCache&#xA;Inherits CryptoProviderCache&#xA;Implements IDisposable" />
  <TypeSignature Language="F#" Value="type InMemoryCryptoProviderCache = class&#xA;    inherit CryptoProviderCache&#xA;    interface IDisposable" />
  <AssemblyInfo>
    <AssemblyName>Microsoft.IdentityModel.Tokens</AssemblyName>
    <AssemblyVersion>6.27.0.0</AssemblyVersion>
    <AssemblyVersion>6.28.1.0</AssemblyVersion>
    <AssemblyVersion>6.29.0.0</AssemblyVersion>
    <AssemblyVersion>6.30.0.0</AssemblyVersion>
    <AssemblyVersion>6.30.1.0</AssemblyVersion>
    <AssemblyVersion>6.31.0.0</AssemblyVersion>
    <AssemblyVersion>6.32.0.0</AssemblyVersion>
    <AssemblyVersion>6.32.1.0</AssemblyVersion>
    <AssemblyVersion>6.32.2.0</AssemblyVersion>
    <AssemblyVersion>6.32.3.0</AssemblyVersion>
    <AssemblyVersion>7.0.0.0</AssemblyVersion>
    <AssemblyVersion>7.0.2.0</AssemblyVersion>
    <AssemblyVersion>7.0.3.0</AssemblyVersion>
    <AssemblyVersion>7.2.0.0</AssemblyVersion>
    <AssemblyVersion>7.3.1.0</AssemblyVersion>
    <AssemblyVersion>7.4.0.0</AssemblyVersion>
    <AssemblyVersion>7.4.1.0</AssemblyVersion>
    <AssemblyVersion>7.5.0.0</AssemblyVersion>
    <AssemblyVersion>7.5.1.0</AssemblyVersion>
    <AssemblyVersion>7.5.2.0</AssemblyVersion>
    <AssemblyVersion>7.6.0.0</AssemblyVersion>
    <AssemblyVersion>7.6.2.0</AssemblyVersion>
    <AssemblyVersion>7.6.3.0</AssemblyVersion>
    <AssemblyVersion>8.0.0.0</AssemblyVersion>
    <AssemblyVersion>8.0.1.0</AssemblyVersion>
    <AssemblyVersion>8.0.2.0</AssemblyVersion>
    <AssemblyVersion>8.1.0.0</AssemblyVersion>
    <AssemblyVersion>8.1.1.0</AssemblyVersion>
    <AssemblyVersion>8.1.2.0</AssemblyVersion>
    <AssemblyVersion>8.2.0.0</AssemblyVersion>
    <AssemblyVersion>8.2.1.0</AssemblyVersion>
    <AssemblyVersion>8.3.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>Microsoft.IdentityModel.Tokens.CryptoProviderCache</BaseTypeName>
  </Base>
  <Interfaces>
    <Interface>
      <InterfaceName>System.IDisposable</InterfaceName>
    </Interface>
  </Interfaces>
  <Docs>
    <summary>
            Defines a cache for crypto providers.
            Current support is limited to <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider" /> only.
            </summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public InMemoryCryptoProviderCache ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.IdentityModel.Tokens.InMemoryCryptoProviderCache.#ctor" />
      <MemberSignature Language="VB.NET" Value="Public Sub New ()" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.IdentityModel.Tokens</AssemblyName>
        <AssemblyVersion>8.3.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters />
      <Docs>
        <summary>
            Creates a new instance of <see cref="T:Microsoft.IdentityModel.Tokens.InMemoryCryptoProviderCache" /> using the default <see cref="T:Microsoft.IdentityModel.Tokens.CryptoProviderCacheOptions" />.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public InMemoryCryptoProviderCache (Microsoft.IdentityModel.Tokens.CryptoProviderCacheOptions cryptoProviderCacheOptions);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Microsoft.IdentityModel.Tokens.CryptoProviderCacheOptions cryptoProviderCacheOptions) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.IdentityModel.Tokens.InMemoryCryptoProviderCache.#ctor(Microsoft.IdentityModel.Tokens.CryptoProviderCacheOptions)" />
      <MemberSignature Language="VB.NET" Value="Public Sub New (cryptoProviderCacheOptions As CryptoProviderCacheOptions)" />
      <MemberSignature Language="F#" Value="new Microsoft.IdentityModel.Tokens.InMemoryCryptoProviderCache : Microsoft.IdentityModel.Tokens.CryptoProviderCacheOptions -&gt; Microsoft.IdentityModel.Tokens.InMemoryCryptoProviderCache" Usage="new Microsoft.IdentityModel.Tokens.InMemoryCryptoProviderCache cryptoProviderCacheOptions" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.IdentityModel.Tokens</AssemblyName>
        <AssemblyVersion>8.3.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="cryptoProviderCacheOptions" Type="Microsoft.IdentityModel.Tokens.CryptoProviderCacheOptions" />
      </Parameters>
      <Docs>
        <param name="cryptoProviderCacheOptions">The options used to configure the <see cref="T:Microsoft.IdentityModel.Tokens.InMemoryCryptoProviderCache" />.</param>
        <summary>
            Creates a new instance of <see cref="T:Microsoft.IdentityModel.Tokens.InMemoryCryptoProviderCache" /> using the specified <paramref name="cryptoProviderCacheOptions" />.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Dispose">
      <MemberSignature Language="C#" Value="public void Dispose ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Dispose() cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.IdentityModel.Tokens.InMemoryCryptoProviderCache.Dispose" />
      <MemberSignature Language="VB.NET" Value="Public Sub Dispose ()" />
      <MemberSignature Language="F#" Value="abstract member Dispose : unit -&gt; unit&#xA;override this.Dispose : unit -&gt; unit" Usage="inMemoryCryptoProviderCache.Dispose " />
      <MemberType>Method</MemberType>
      <Implements>
        <InterfaceMember>M:System.IDisposable.Dispose</InterfaceMember>
      </Implements>
      <AssemblyInfo>
        <AssemblyName>Microsoft.IdentityModel.Tokens</AssemblyName>
        <AssemblyVersion>8.3.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>
            Calls <see cref="M:Microsoft.IdentityModel.Tokens.InMemoryCryptoProviderCache.Dispose(System.Boolean)" /> and <see cref="M:System.GC.SuppressFinalize(System.Object)" />
            Note: the EventBasedLRUCache is no longer being disposed of, but since this is a public class and can be used as base class of
            custom cache implementations, we need to keep it as some implementations may override Dispose().
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Dispose">
      <MemberSignature Language="C#" Value="protected virtual void Dispose (bool disposing);" />
      <MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void Dispose(bool disposing) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.IdentityModel.Tokens.InMemoryCryptoProviderCache.Dispose(System.Boolean)" />
      <MemberSignature Language="VB.NET" Value="Protected Overridable Sub Dispose (disposing As Boolean)" />
      <MemberSignature Language="F#" Value="abstract member Dispose : bool -&gt; unit&#xA;override this.Dispose : bool -&gt; unit" Usage="inMemoryCryptoProviderCache.Dispose disposing" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.IdentityModel.Tokens</AssemblyName>
        <AssemblyVersion>8.3.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="disposing" Type="System.Boolean" />
      </Parameters>
      <Docs>
        <param name="disposing">True if called from the <see cref="M:Microsoft.IdentityModel.Tokens.InMemoryCryptoProviderCache.Dispose" /> method, false otherwise.</param>
        <summary>
            If <paramref name="disposing" /> is true, this method disposes of <see cref="F:Microsoft.IdentityModel.Tokens.InMemoryCryptoProviderCache._signingSignatureProviders" /> and <see cref="F:Microsoft.IdentityModel.Tokens.InMemoryCryptoProviderCache._verifyingSignatureProviders" />.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="GetCacheKey">
      <MemberSignature Language="C#" Value="protected override string GetCacheKey (Microsoft.IdentityModel.Tokens.SignatureProvider signatureProvider);" />
      <MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance string GetCacheKey(class Microsoft.IdentityModel.Tokens.SignatureProvider signatureProvider) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.IdentityModel.Tokens.InMemoryCryptoProviderCache.GetCacheKey(Microsoft.IdentityModel.Tokens.SignatureProvider)" />
      <MemberSignature Language="VB.NET" Value="Protected Overrides Function GetCacheKey (signatureProvider As SignatureProvider) As String" />
      <MemberSignature Language="F#" Value="override this.GetCacheKey : Microsoft.IdentityModel.Tokens.SignatureProvider -&gt; string" Usage="inMemoryCryptoProviderCache.GetCacheKey signatureProvider" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.IdentityModel.Tokens</AssemblyName>
        <AssemblyVersion>8.3.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="signatureProvider" Type="Microsoft.IdentityModel.Tokens.SignatureProvider" />
      </Parameters>
      <Docs>
        <param name="signatureProvider">the <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider" /> to create the key for.</param>
        <summary>
            Returns the cache key to use when looking up an entry into the cache for a <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider" /></summary>
        <returns>the cache key to use for finding a <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider" />.</returns>
        <remarks>To be added.</remarks>
        <exception cref="T:System.ArgumentNullException">if signatureProvider is null.</exception>
      </Docs>
    </Member>
    <Member MemberName="GetCacheKey">
      <MemberSignature Language="C#" Value="protected override string GetCacheKey (Microsoft.IdentityModel.Tokens.SecurityKey securityKey, string algorithm, string typeofProvider);" />
      <MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance string GetCacheKey(class Microsoft.IdentityModel.Tokens.SecurityKey securityKey, string algorithm, string typeofProvider) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.IdentityModel.Tokens.InMemoryCryptoProviderCache.GetCacheKey(Microsoft.IdentityModel.Tokens.SecurityKey,System.String,System.String)" />
      <MemberSignature Language="VB.NET" Value="Protected Overrides Function GetCacheKey (securityKey As SecurityKey, algorithm As String, typeofProvider As String) As String" />
      <MemberSignature Language="F#" Value="override this.GetCacheKey : Microsoft.IdentityModel.Tokens.SecurityKey * string * string -&gt; string" Usage="inMemoryCryptoProviderCache.GetCacheKey (securityKey, algorithm, typeofProvider)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.IdentityModel.Tokens</AssemblyName>
        <AssemblyVersion>8.3.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="securityKey" Type="Microsoft.IdentityModel.Tokens.SecurityKey" />
        <Parameter Name="algorithm" Type="System.String" />
        <Parameter Name="typeofProvider" Type="System.String" />
      </Parameters>
      <Docs>
        <param name="securityKey">the key that is used to by the crypto provider.</param>
        <param name="algorithm">the algorithm that is used by the crypto provider.</param>
        <param name="typeofProvider">the typeof the crypto provider obtained by calling object.GetType().</param>
        <summary>
            Returns the 'key' that will be used to find a crypto provider in this cache.
            </summary>
        <returns>the cache key to use for finding a crypto provider.</returns>
        <remarks>To be added.</remarks>
        <exception cref="T:System.ArgumentNullException">if typeofProvider is null or empty string.</exception>
      </Docs>
    </Member>
    <Member MemberName="TryAdd">
      <MemberSignature Language="C#" Value="public override bool TryAdd (Microsoft.IdentityModel.Tokens.SignatureProvider signatureProvider);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool TryAdd(class Microsoft.IdentityModel.Tokens.SignatureProvider signatureProvider) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.IdentityModel.Tokens.InMemoryCryptoProviderCache.TryAdd(Microsoft.IdentityModel.Tokens.SignatureProvider)" />
      <MemberSignature Language="VB.NET" Value="Public Overrides Function TryAdd (signatureProvider As SignatureProvider) As Boolean" />
      <MemberSignature Language="F#" Value="override this.TryAdd : Microsoft.IdentityModel.Tokens.SignatureProvider -&gt; bool" Usage="inMemoryCryptoProviderCache.TryAdd signatureProvider" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.IdentityModel.Tokens</AssemblyName>
        <AssemblyVersion>8.3.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="signatureProvider" Type="Microsoft.IdentityModel.Tokens.SignatureProvider" />
      </Parameters>
      <Docs>
        <param name="signatureProvider">
          <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider" /> to cache.</param>
        <summary>
            Trys to adds a <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider" /> to this cache.
            </summary>
        <returns>
          <c>true</c> if the <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider" /> was added, <c>false</c> if the cache already contained the <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider" /> or if <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider" /> should not be cached.
            </returns>
        <remarks>if the <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider" /> is added <see cref="P:Microsoft.IdentityModel.Tokens.SignatureProvider.CryptoProviderCache" /> will be set to 'this'.</remarks>
        <exception cref="T:System.ArgumentNullException">if signatureProvider is null.</exception>
      </Docs>
    </Member>
    <Member MemberName="TryGetSignatureProvider">
      <MemberSignature Language="C#" Value="public override bool TryGetSignatureProvider (Microsoft.IdentityModel.Tokens.SecurityKey securityKey, string algorithm, string typeofProvider, bool willCreateSignatures, out Microsoft.IdentityModel.Tokens.SignatureProvider signatureProvider);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool TryGetSignatureProvider(class Microsoft.IdentityModel.Tokens.SecurityKey securityKey, string algorithm, string typeofProvider, bool willCreateSignatures, [out] class Microsoft.IdentityModel.Tokens.SignatureProvider&amp; signatureProvider) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.IdentityModel.Tokens.InMemoryCryptoProviderCache.TryGetSignatureProvider(Microsoft.IdentityModel.Tokens.SecurityKey,System.String,System.String,System.Boolean,Microsoft.IdentityModel.Tokens.SignatureProvider@)" />
      <MemberSignature Language="VB.NET" Value="Public Overrides Function TryGetSignatureProvider (securityKey As SecurityKey, algorithm As String, typeofProvider As String, willCreateSignatures As Boolean, ByRef signatureProvider As SignatureProvider) As Boolean" />
      <MemberSignature Language="F#" Value="override this.TryGetSignatureProvider : Microsoft.IdentityModel.Tokens.SecurityKey * string * string * bool * SignatureProvider -&gt; bool" Usage="inMemoryCryptoProviderCache.TryGetSignatureProvider (securityKey, algorithm, typeofProvider, willCreateSignatures, signatureProvider)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.IdentityModel.Tokens</AssemblyName>
        <AssemblyVersion>8.3.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="securityKey" Type="Microsoft.IdentityModel.Tokens.SecurityKey" />
        <Parameter Name="algorithm" Type="System.String" />
        <Parameter Name="typeofProvider" Type="System.String" />
        <Parameter Name="willCreateSignatures" Type="System.Boolean" />
        <Parameter Name="signatureProvider" Type="Microsoft.IdentityModel.Tokens.SignatureProvider" RefType="out" />
      </Parameters>
      <Docs>
        <param name="securityKey">the key that is used to by the crypto provider.</param>
        <param name="algorithm">the algorithm that is used by the crypto provider.</param>
        <param name="typeofProvider">the typeof the crypto provider obtained by calling object.GetType().</param>
        <param name="willCreateSignatures">If true, the provider will be used for creating signatures.</param>
        <param name="signatureProvider">the <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider" /> if found.</param>
        <summary>
            Trys to find a <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider" /> to this cache.
            </summary>
        <returns>true if a <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider" /> was found, false otherwise.</returns>
        <remarks>To be added.</remarks>
        <exception cref="T:System.ArgumentNullException">if typeofProvider is null or empty string.</exception>
      </Docs>
    </Member>
    <Member MemberName="TryRemove">
      <MemberSignature Language="C#" Value="public override bool TryRemove (Microsoft.IdentityModel.Tokens.SignatureProvider signatureProvider);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool TryRemove(class Microsoft.IdentityModel.Tokens.SignatureProvider signatureProvider) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.IdentityModel.Tokens.InMemoryCryptoProviderCache.TryRemove(Microsoft.IdentityModel.Tokens.SignatureProvider)" />
      <MemberSignature Language="VB.NET" Value="Public Overrides Function TryRemove (signatureProvider As SignatureProvider) As Boolean" />
      <MemberSignature Language="F#" Value="override this.TryRemove : Microsoft.IdentityModel.Tokens.SignatureProvider -&gt; bool" Usage="inMemoryCryptoProviderCache.TryRemove signatureProvider" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.IdentityModel.Tokens</AssemblyName>
        <AssemblyVersion>8.3.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="signatureProvider" Type="Microsoft.IdentityModel.Tokens.SignatureProvider" />
      </Parameters>
      <Docs>
        <param name="signatureProvider">
          <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider" /> to remove.</param>
        <summary>
            Trys to remove a <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider" /> from this cache.
            </summary>
        <returns>true if the <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider" /> was removed, false if the <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider" /> was not found.</returns>
        <remarks>if the <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider" /> is removed <see cref="P:Microsoft.IdentityModel.Tokens.SignatureProvider.CryptoProviderCache" /> will be set to null.</remarks>
        <exception cref="T:System.ArgumentNullException">if signatureProvider is null.</exception>
      </Docs>
    </Member>
  </Members>
</Type>