.. java:import:: org.json JSONObject

.. java:import:: java.math BigInteger

.. java:import:: java.security ProviderException

PrivateKeyRSA
=============

.. java:package:: com.idopte.scmapi
   :noindex:

.. java:type:: @SuppressWarnings public class PrivateKeyRSA extends PrivateKey implements java.security.interfaces.RSAPrivateCrtKey

   Class describes a RSA private key object. Inherits from \ :java:ref:`PrivateKey`\  and implements \ :java:ref:`java.security.interfaces.RSAPrivateCrtKey`\ .

   Note that the constructor is not intended to be called by user code. Such objects are constructed internally by the API.

Methods
-------
getAlgorithm
^^^^^^^^^^^^

.. java:method:: @Override public String getAlgorithm()
   :outertype: PrivateKeyRSA

   Returns algorithm of key, which is ``"RSA"``.

   :return: ``"RSA"``.

getCrtCoefficient
^^^^^^^^^^^^^^^^^

.. java:method:: @Override public BigInteger getCrtCoefficient()
   :outertype: PrivateKeyRSA

   The private key is not extractable from the card, thus this method is not available.

   :throws ProviderException: always.

getEncoded
^^^^^^^^^^

.. java:method:: @Override public byte[] getEncoded()
   :outertype: PrivateKeyRSA

   The private key is not extractable from the card, thus this method is not available.

   :throws ProviderException: always.

getFormat
^^^^^^^^^

.. java:method:: @Override public String getFormat()
   :outertype: PrivateKeyRSA

   Returns the name of the primary encoding format of this key.

   :return: always ``null``, because the key does not support encoding (private key is not extractable).

getModulus
^^^^^^^^^^

.. java:method:: @Override public BigInteger getModulus()
   :outertype: PrivateKeyRSA

   Gets the modulus.

   :return: the modulus.

getPrimeExponentP
^^^^^^^^^^^^^^^^^

.. java:method:: @Override public BigInteger getPrimeExponentP()
   :outertype: PrivateKeyRSA

   The private key is not extractable from the card, thus this method is not available.

   :throws ProviderException: always.

getPrimeExponentQ
^^^^^^^^^^^^^^^^^

.. java:method:: @Override public BigInteger getPrimeExponentQ()
   :outertype: PrivateKeyRSA

   The private key is not extractable from the card, thus this method is not available.

   :throws ProviderException: always.

getPrimeP
^^^^^^^^^

.. java:method:: @Override public BigInteger getPrimeP()
   :outertype: PrivateKeyRSA

   The private key is not extractable from the card, thus this method is not available.

   :throws ProviderException: always.

getPrimeQ
^^^^^^^^^

.. java:method:: @Override public BigInteger getPrimeQ()
   :outertype: PrivateKeyRSA

   The private key is not extractable from the card, thus this method is not available.

   :throws ProviderException: always.

getPrivateExponent
^^^^^^^^^^^^^^^^^^

.. java:method:: @Override public BigInteger getPrivateExponent()
   :outertype: PrivateKeyRSA

   The private key is not extractable from the card, thus this method is not available.

   :throws ProviderException: always.

getPublicExponent
^^^^^^^^^^^^^^^^^

.. java:method:: @Override public BigInteger getPublicExponent()
   :outertype: PrivateKeyRSA

   Gets the public exponent.

   :return: the public exponent.