.. java:import:: com.idopte.scmiddleware Log

.. java:import:: org.json JSONObject

.. java:import:: java.math BigInteger

.. java:import:: java.security ProviderException

.. java:import:: java.security.spec ECParameterSpec

PrivateKeyEC
============

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

.. java:type:: @SuppressWarnings public class PrivateKeyEC extends PrivateKey implements java.security.interfaces.ECPrivateKey

   Class describes an EC private key object. Inherits from \ :java:ref:`PrivateKey`\  and implements \ :java:ref:`java.security.interfaces.ECPrivateKey`\ .

   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: PrivateKeyEC

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

   :return: ``"EC"``.

getEncoded
^^^^^^^^^^

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

   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: PrivateKeyEC

   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).

getParams
^^^^^^^^^

.. java:method:: @Override public ECParameterSpec getParams()
   :outertype: PrivateKeyEC

   Gets the elliptic curve parameters.

   :return: the elliptic curve parameters.

getS
^^^^

.. java:method:: @Override public BigInteger getS()
   :outertype: PrivateKeyEC

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

   :throws ProviderException: always.