SecretKeyFactorySpi.xml

<Type Name="SecretKeyFactorySpi" FullName="Javax.Crypto.SecretKeyFactorySpi">
  <TypeSignature Language="C#" Value="public abstract class SecretKeyFactorySpi : Java.Lang.Object" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit SecretKeyFactorySpi extends Java.Lang.Object" />
  <TypeSignature Language="DocId" Value="T:Javax.Crypto.SecretKeyFactorySpi" />
  <TypeSignature Language="F#" Value="type SecretKeyFactorySpi = class&#xA;    inherit Object" />
  <AssemblyInfo>
    <AssemblyName>Mono.Android</AssemblyName>
    <AssemblyVersion>0.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>Java.Lang.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Attributes>
    <Attribute>
      <AttributeName Language="C#">[Android.Runtime.Register("javax/crypto/SecretKeyFactorySpi", DoNotGenerateAcw=true)]</AttributeName>
      <AttributeName Language="F#">[&lt;Android.Runtime.Register("javax/crypto/SecretKeyFactorySpi", DoNotGenerateAcw=true)&gt;]</AttributeName>
    </Attribute>
  </Attributes>
  <Docs since="1">
    <summary>This class defines the <i>Service Provider Interface</i> (&lt;b&gt;SPI&lt;/b&gt;)
            for the <c>SecretKeyFactory</c> class.</summary>
    <remarks>
      <para>This class defines the <i>Service Provider Interface</i> (&lt;b&gt;SPI&lt;/b&gt;)
            for the <c>SecretKeyFactory</c> class.
            All the abstract methods in this class must be implemented by each
            cryptographic service provider who wishes to supply the implementation
            of a secret-key factory for a particular algorithm.</para>
      <para>A provider should document all the key specifications supported by its
            secret key factory.
            For example, the DES secret-key factory supplied by the "SunJCE" provider
            supports <c>DESKeySpec</c> as a transparent representation of DES
            keys, and that provider's secret-key factory for Triple DES keys supports
            <c>DESedeKeySpec</c> as a transparent representation of Triple DES
            keys.</para>
      <para>Added in 1.4.</para>
      <para>
        <format type="text/html">
          <a href="https://developer.android.com/reference/javax/crypto/SecretKeyFactorySpi" title="Reference documentation">Java documentation for <code>javax.crypto.SecretKeyFactorySpi</code>.</a>
        </format>
      </para>
      <para>
                    Portions of this page are modifications based on work created and shared by the 
                    <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
                     and used according to terms described in the 
                    <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
    </remarks>
    <since version="Added in API level 1" />
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public SecretKeyFactorySpi ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
      <MemberSignature Language="DocId" Value="M:Javax.Crypto.SecretKeyFactorySpi.#ctor" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Mono.Android</AssemblyName>
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[Android.Runtime.Register(".ctor", "()V", "")]</AttributeName>
          <AttributeName Language="F#">[&lt;Android.Runtime.Register(".ctor", "()V", "")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <Parameters />
      <Docs>
        <summary>Creates a new <c>SecretKeyFactorySpi</c> instance.</summary>
        <remarks>
          <para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
        </remarks>
        <since version="Added in API level 1" />
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="protected SecretKeyFactorySpi (IntPtr javaReference, Android.Runtime.JniHandleOwnership transfer);" />
      <MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(native int javaReference, valuetype Android.Runtime.JniHandleOwnership transfer) cil managed" />
      <MemberSignature Language="DocId" Value="M:Javax.Crypto.SecretKeyFactorySpi.#ctor(System.IntPtr,Android.Runtime.JniHandleOwnership)" />
      <MemberSignature Language="F#" Value="new Javax.Crypto.SecretKeyFactorySpi : nativeint * Android.Runtime.JniHandleOwnership -&gt; Javax.Crypto.SecretKeyFactorySpi" Usage="new Javax.Crypto.SecretKeyFactorySpi (javaReference, transfer)" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Mono.Android</AssemblyName>
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="javaReference" Type="System.IntPtr" />
        <Parameter Name="transfer" Type="Android.Runtime.JniHandleOwnership" />
      </Parameters>
      <Docs>
        <param name="javaReference">A <see cref="T:System.IntPtr" />containing a Java Native Interface (JNI) object reference.</param>
        <param name="transfer">A <see cref="T:Android.Runtime.JniHandleOwnership" />indicating how to handle <paramref name="javaReference" /></param>
        <summary>A constructor used when creating managed representations of JNI objects; called by the runtime.</summary>
        <remarks>
          <para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="EngineGenerateSecret">
      <MemberSignature Language="C#" Value="protected abstract Javax.Crypto.ISecretKey? EngineGenerateSecret (Java.Security.Spec.IKeySpec? keySpec);" />
      <MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance class Javax.Crypto.ISecretKey EngineGenerateSecret(class Java.Security.Spec.IKeySpec keySpec) cil managed" />
      <MemberSignature Language="DocId" Value="M:Javax.Crypto.SecretKeyFactorySpi.EngineGenerateSecret(Java.Security.Spec.IKeySpec)" />
      <MemberSignature Language="F#" Value="abstract member EngineGenerateSecret : Java.Security.Spec.IKeySpec -&gt; Javax.Crypto.ISecretKey" Usage="secretKeyFactorySpi.EngineGenerateSecret keySpec" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Mono.Android</AssemblyName>
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[Android.Runtime.Register("engineGenerateSecret", "(Ljava/security/spec/KeySpec;)Ljavax/crypto/SecretKey;", "GetEngineGenerateSecret_Ljava_security_spec_KeySpec_Handler")]</AttributeName>
          <AttributeName Language="F#">[&lt;Android.Runtime.Register("engineGenerateSecret", "(Ljava/security/spec/KeySpec;)Ljavax/crypto/SecretKey;", "GetEngineGenerateSecret_Ljava_security_spec_KeySpec_Handler")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>Javax.Crypto.ISecretKey</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="keySpec" Type="Java.Security.Spec.IKeySpec" />
      </Parameters>
      <Docs>
        <param name="keySpec">the specification (key material) of the secret key</param>
        <summary>Generates a <c>SecretKey</c> object from the
            provided key specification (key material).</summary>
        <returns>the secret key</returns>
        <remarks>
          <para>Generates a <c>SecretKey</c> object from the
            provided key specification (key material).</para>
          <para>
            <format type="text/html">
              <a href="https://developer.android.com/reference/javax/crypto/SecretKeyFactorySpi#engineGenerateSecret(java.security.spec.KeySpec)" title="Reference documentation">Java documentation for <code>javax.crypto.SecretKeyFactorySpi.engineGenerateSecret(java.security.spec.KeySpec)</code>.</a>
            </format>
          </para>
          <para>
                    Portions of this page are modifications based on work created and shared by the 
                    <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
                     and used according to terms described in the 
                    <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
        </remarks>
        <since version="Added in API level 1" />
        <exception cref="T:Java.Security.Spec.InvalidKeySpecException">if the specified key specification cannot be used to generate
             a secret key.
</exception>
      </Docs>
    </Member>
    <Member MemberName="EngineGetKeySpec">
      <MemberSignature Language="C#" Value="protected abstract Java.Security.Spec.IKeySpec? EngineGetKeySpec (Javax.Crypto.ISecretKey? key, Java.Lang.Class? keySpec);" />
      <MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance class Java.Security.Spec.IKeySpec EngineGetKeySpec(class Javax.Crypto.ISecretKey key, class Java.Lang.Class keySpec) cil managed" />
      <MemberSignature Language="DocId" Value="M:Javax.Crypto.SecretKeyFactorySpi.EngineGetKeySpec(Javax.Crypto.ISecretKey,Java.Lang.Class)" />
      <MemberSignature Language="F#" Value="abstract member EngineGetKeySpec : Javax.Crypto.ISecretKey * Java.Lang.Class -&gt; Java.Security.Spec.IKeySpec" Usage="secretKeyFactorySpi.EngineGetKeySpec (key, keySpec)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Mono.Android</AssemblyName>
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[Android.Runtime.Register("engineGetKeySpec", "(Ljavax/crypto/SecretKey;Ljava/lang/Class;)Ljava/security/spec/KeySpec;", "GetEngineGetKeySpec_Ljavax_crypto_SecretKey_Ljava_lang_Class_Handler")]</AttributeName>
          <AttributeName Language="F#">[&lt;Android.Runtime.Register("engineGetKeySpec", "(Ljavax/crypto/SecretKey;Ljava/lang/Class;)Ljava/security/spec/KeySpec;", "GetEngineGetKeySpec_Ljavax_crypto_SecretKey_Ljava_lang_Class_Handler")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>Java.Security.Spec.IKeySpec</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="key" Type="Javax.Crypto.ISecretKey" />
        <Parameter Name="keySpec" Type="Java.Lang.Class" />
      </Parameters>
      <Docs>
        <param name="key">the key</param>
        <param name="keySpec">the requested format in which the key material shall be
            returned</param>
        <summary>Returns a specification (key material) of the given key
            object in the requested format.</summary>
        <returns>the underlying key specification (key material) in the
            requested format</returns>
        <remarks>
          <para>Returns a specification (key material) of the given key
            object in the requested format.</para>
          <para>
            <format type="text/html">
              <a href="https://developer.android.com/reference/javax/crypto/SecretKeyFactorySpi#engineGetKeySpec(javax.crypto.SecretKey,%20java.lang.Class%3C?%3E)" title="Reference documentation">Java documentation for <code>javax.crypto.SecretKeyFactorySpi.engineGetKeySpec(javax.crypto.SecretKey, java.lang.Class&lt;?&gt;)</code>.</a>
            </format>
          </para>
          <para>
                    Portions of this page are modifications based on work created and shared by the 
                    <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
                     and used according to terms described in the 
                    <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
        </remarks>
        <since version="Added in API level 1" />
        <exception cref="T:Java.Security.Spec.InvalidKeySpecException">if the specified secret key cannot be transformed into the
             requested key specification.
</exception>
      </Docs>
    </Member>
    <Member MemberName="EngineTranslateKey">
      <MemberSignature Language="C#" Value="protected abstract Javax.Crypto.ISecretKey? EngineTranslateKey (Javax.Crypto.ISecretKey? key);" />
      <MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance class Javax.Crypto.ISecretKey EngineTranslateKey(class Javax.Crypto.ISecretKey key) cil managed" />
      <MemberSignature Language="DocId" Value="M:Javax.Crypto.SecretKeyFactorySpi.EngineTranslateKey(Javax.Crypto.ISecretKey)" />
      <MemberSignature Language="F#" Value="abstract member EngineTranslateKey : Javax.Crypto.ISecretKey -&gt; Javax.Crypto.ISecretKey" Usage="secretKeyFactorySpi.EngineTranslateKey key" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Mono.Android</AssemblyName>
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[Android.Runtime.Register("engineTranslateKey", "(Ljavax/crypto/SecretKey;)Ljavax/crypto/SecretKey;", "GetEngineTranslateKey_Ljavax_crypto_SecretKey_Handler")]</AttributeName>
          <AttributeName Language="F#">[&lt;Android.Runtime.Register("engineTranslateKey", "(Ljavax/crypto/SecretKey;)Ljavax/crypto/SecretKey;", "GetEngineTranslateKey_Ljavax_crypto_SecretKey_Handler")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>Javax.Crypto.ISecretKey</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="key" Type="Javax.Crypto.ISecretKey" />
      </Parameters>
      <Docs>
        <param name="key">the key whose provider is unknown or untrusted</param>
        <summary>Translates a key object, whose provider may be unknown or
            potentially untrusted, into a corresponding key object of this
            secret-key factory.</summary>
        <returns>the translated key</returns>
        <remarks>
          <para>Translates a key object, whose provider may be unknown or
            potentially untrusted, into a corresponding key object of this
            secret-key factory.</para>
          <para>
            <format type="text/html">
              <a href="https://developer.android.com/reference/javax/crypto/SecretKeyFactorySpi#engineTranslateKey(javax.crypto.SecretKey)" title="Reference documentation">Java documentation for <code>javax.crypto.SecretKeyFactorySpi.engineTranslateKey(javax.crypto.SecretKey)</code>.</a>
            </format>
          </para>
          <para>
                    Portions of this page are modifications based on work created and shared by the 
                    <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
                     and used according to terms described in the 
                    <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
        </remarks>
        <since version="Added in API level 1" />
        <exception cref="T:Java.Security.InvalidKeyException">if the specified key cannot be translated using this key
             factory.
</exception>
      </Docs>
    </Member>
    <Member MemberName="JniPeerMembers">
      <MemberSignature Language="C#" Value="public override Java.Interop.JniPeerMembers JniPeerMembers { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class Java.Interop.JniPeerMembers JniPeerMembers" />
      <MemberSignature Language="DocId" Value="P:Javax.Crypto.SecretKeyFactorySpi.JniPeerMembers" />
      <MemberSignature Language="F#" Value="member this.JniPeerMembers : Java.Interop.JniPeerMembers" Usage="Javax.Crypto.SecretKeyFactorySpi.JniPeerMembers" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Mono.Android</AssemblyName>
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName>
          <AttributeName Language="F#">[&lt;System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)&gt;]</AttributeName>
        </Attribute>
        <Attribute>
          <AttributeName Language="C#">[System.Diagnostics.DebuggerBrowsable(System.Diagnostics.DebuggerBrowsableState.Never)]</AttributeName>
          <AttributeName Language="F#">[&lt;System.Diagnostics.DebuggerBrowsable(System.Diagnostics.DebuggerBrowsableState.Never)&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>Java.Interop.JniPeerMembers</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>To be added.</summary>
        <value>To be added.</value>
        <remarks>
          <para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="ThresholdClass">
      <MemberSignature Language="C#" Value="protected override IntPtr ThresholdClass { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance native int ThresholdClass" />
      <MemberSignature Language="DocId" Value="P:Javax.Crypto.SecretKeyFactorySpi.ThresholdClass" />
      <MemberSignature Language="F#" Value="member this.ThresholdClass : nativeint" Usage="Javax.Crypto.SecretKeyFactorySpi.ThresholdClass" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Mono.Android</AssemblyName>
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName>
          <AttributeName Language="F#">[&lt;System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)&gt;]</AttributeName>
        </Attribute>
        <Attribute>
          <AttributeName Language="C#">[System.Diagnostics.DebuggerBrowsable(System.Diagnostics.DebuggerBrowsableState.Never)]</AttributeName>
          <AttributeName Language="F#">[&lt;System.Diagnostics.DebuggerBrowsable(System.Diagnostics.DebuggerBrowsableState.Never)&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.IntPtr</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.</summary>
        <value>A <see cref="T:System.IntPtr" /> which contains the <c>java.lang.Class</c> JNI value corresponding to this type.</value>
        <remarks>
          <para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="ThresholdType">
      <MemberSignature Language="C#" Value="protected override Type ThresholdType { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class System.Type ThresholdType" />
      <MemberSignature Language="DocId" Value="P:Javax.Crypto.SecretKeyFactorySpi.ThresholdType" />
      <MemberSignature Language="F#" Value="member this.ThresholdType : Type" Usage="Javax.Crypto.SecretKeyFactorySpi.ThresholdType" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Mono.Android</AssemblyName>
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName>
          <AttributeName Language="F#">[&lt;System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)&gt;]</AttributeName>
        </Attribute>
        <Attribute>
          <AttributeName Language="C#">[System.Diagnostics.DebuggerBrowsable(System.Diagnostics.DebuggerBrowsableState.Never)]</AttributeName>
          <AttributeName Language="F#">[&lt;System.Diagnostics.DebuggerBrowsable(System.Diagnostics.DebuggerBrowsableState.Never)&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Type</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.</summary>
        <value>A <see cref="T:System.Type" /> which provides the declaring type.</value>
        <remarks>
          <para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
        </remarks>
      </Docs>
    </Member>
  </Members>
</Type>