CryptoProviderCache.xml

<Type Name="CryptoProviderCache" FullName="Microsoft.IdentityModel.Tokens.CryptoProviderCache">
  <TypeSignature Language="C#" Value="public abstract class CryptoProviderCache" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit CryptoProviderCache extends System.Object" />
  <TypeSignature Language="DocId" Value="T:Microsoft.IdentityModel.Tokens.CryptoProviderCache" />
  <TypeSignature Language="VB.NET" Value="Public MustInherit Class CryptoProviderCache" />
  <TypeSignature Language="F#" Value="type CryptoProviderCache = class" />
  <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>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>
            Definition of cache for crypto providers
            </summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="protected CryptoProviderCache ();" />
      <MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.IdentityModel.Tokens.CryptoProviderCache.#ctor" />
      <MemberSignature Language="VB.NET" Value="Protected Sub New ()" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.IdentityModel.Tokens</AssemblyName>
        <AssemblyVersion>7.6.2.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters />
      <Docs>
        <summary>To be added.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="GetCacheKey">
      <MemberSignature Language="C#" Value="protected abstract string GetCacheKey (Microsoft.IdentityModel.Tokens.SignatureProvider signatureProvider);" />
      <MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance string GetCacheKey(class Microsoft.IdentityModel.Tokens.SignatureProvider signatureProvider) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.IdentityModel.Tokens.CryptoProviderCache.GetCacheKey(Microsoft.IdentityModel.Tokens.SignatureProvider)" />
      <MemberSignature Language="VB.NET" Value="Protected MustOverride Function GetCacheKey (signatureProvider As SignatureProvider) As String" />
      <MemberSignature Language="F#" Value="abstract member GetCacheKey : Microsoft.IdentityModel.Tokens.SignatureProvider -&gt; string" Usage="cryptoProviderCache.GetCacheKey signatureProvider" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.IdentityModel.Tokens</AssemblyName>
        <AssemblyVersion>7.6.2.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>
      </Docs>
    </Member>
    <Member MemberName="GetCacheKey">
      <MemberSignature Language="C#" Value="protected abstract string GetCacheKey (Microsoft.IdentityModel.Tokens.SecurityKey securityKey, string algorithm, string typeofProvider);" />
      <MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance string GetCacheKey(class Microsoft.IdentityModel.Tokens.SecurityKey securityKey, string algorithm, string typeofProvider) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.IdentityModel.Tokens.CryptoProviderCache.GetCacheKey(Microsoft.IdentityModel.Tokens.SecurityKey,System.String,System.String)" />
      <MemberSignature Language="VB.NET" Value="Protected MustOverride Function GetCacheKey (securityKey As SecurityKey, algorithm As String, typeofProvider As String) As String" />
      <MemberSignature Language="F#" Value="abstract member GetCacheKey : Microsoft.IdentityModel.Tokens.SecurityKey * string * string -&gt; string" Usage="cryptoProviderCache.GetCacheKey (securityKey, algorithm, typeofProvider)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.IdentityModel.Tokens</AssemblyName>
        <AssemblyVersion>7.6.2.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>
      </Docs>
    </Member>
    <Member MemberName="TryAdd">
      <MemberSignature Language="C#" Value="public abstract bool TryAdd (Microsoft.IdentityModel.Tokens.SignatureProvider signatureProvider);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool TryAdd(class Microsoft.IdentityModel.Tokens.SignatureProvider signatureProvider) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.IdentityModel.Tokens.CryptoProviderCache.TryAdd(Microsoft.IdentityModel.Tokens.SignatureProvider)" />
      <MemberSignature Language="VB.NET" Value="Public MustOverride Function TryAdd (signatureProvider As SignatureProvider) As Boolean" />
      <MemberSignature Language="F#" Value="abstract member TryAdd : Microsoft.IdentityModel.Tokens.SignatureProvider -&gt; bool" Usage="cryptoProviderCache.TryAdd signatureProvider" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.IdentityModel.Tokens</AssemblyName>
        <AssemblyVersion>7.6.2.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>true if the <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider" /> was added, false if the cache already contained the <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider" /></returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="TryGetSignatureProvider">
      <MemberSignature Language="C#" Value="public abstract 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 newslot 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.CryptoProviderCache.TryGetSignatureProvider(Microsoft.IdentityModel.Tokens.SecurityKey,System.String,System.String,System.Boolean,Microsoft.IdentityModel.Tokens.SignatureProvider@)" />
      <MemberSignature Language="VB.NET" Value="Public MustOverride Function TryGetSignatureProvider (securityKey As SecurityKey, algorithm As String, typeofProvider As String, willCreateSignatures As Boolean, ByRef signatureProvider As SignatureProvider) As Boolean" />
      <MemberSignature Language="F#" Value="abstract member TryGetSignatureProvider : Microsoft.IdentityModel.Tokens.SecurityKey * string * string * bool * SignatureProvider -&gt; bool" Usage="cryptoProviderCache.TryGetSignatureProvider (securityKey, algorithm, typeofProvider, willCreateSignatures, signatureProvider)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.IdentityModel.Tokens</AssemblyName>
        <AssemblyVersion>7.6.2.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">a bool to indicate if the <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider" /> will be used to sign.</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" /> in this cache.
            </summary>
        <returns>true if a <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider" /> was found, false otherwise.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="TryRemove">
      <MemberSignature Language="C#" Value="public abstract bool TryRemove (Microsoft.IdentityModel.Tokens.SignatureProvider signatureProvider);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool TryRemove(class Microsoft.IdentityModel.Tokens.SignatureProvider signatureProvider) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.IdentityModel.Tokens.CryptoProviderCache.TryRemove(Microsoft.IdentityModel.Tokens.SignatureProvider)" />
      <MemberSignature Language="VB.NET" Value="Public MustOverride Function TryRemove (signatureProvider As SignatureProvider) As Boolean" />
      <MemberSignature Language="F#" Value="abstract member TryRemove : Microsoft.IdentityModel.Tokens.SignatureProvider -&gt; bool" Usage="cryptoProviderCache.TryRemove signatureProvider" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.IdentityModel.Tokens</AssemblyName>
        <AssemblyVersion>7.6.2.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>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>