SCMException
============

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

.. java:type:: @SuppressWarnings public class SCMException extends Exception

   Class describes an error resulting from a request to the SCWS service.

Methods
-------
getErrorCode
^^^^^^^^^^^^

.. java:method:: public long getErrorCode()
   :outertype: SCMException

   Error code, suitable for checking when specific actions need to be taken depending on the cause.

   Possible values are:

   ..

   * \ :java:ref:`SCMException.CKR_HOST_MEMORY`\ : Not enough memory on the host computer.
   * \ :java:ref:`SCMException.CKR_GENERAL_ERROR`\ : An unrecoverable error occurred. This may be due to an inconsistency in the smart card data.
   * \ :java:ref:`SCMException.CKR_FUNCTION_FAILED`\ : The operation failed for an unknown reason.
   * \ :java:ref:`SCMException.CKR_ATTRIBUTE_READ_ONLY`\ : The token object cannot be modified because it is read-only.
   * \ :java:ref:`SCMException.CKR_ATTRIBUTE_SENSITIVE`\ : The token object cannot be read because it is sensitive.
   * \ :java:ref:`SCMException.CKR_ATTRIBUTE_TYPE_INVALID`\ : The object attribute is invalid.
   * \ :java:ref:`SCMException.CKR_ATTRIBUTE_VALUE_INVALID`\ : The value of the object attribute is invalid.
   * \ :java:ref:`SCMException.CKR_DATA_INVALID`\ : The data is invalid.
   * \ :java:ref:`SCMException.CKR_DATA_LEN_RANGE`\ : The length of the data is inconsistent.
   * \ :java:ref:`SCMException.CKR_DEVICE_ERROR`\ : An error occurred during the communication with the card.
   * \ :java:ref:`SCMException.CKR_DEVICE_MEMORY`\ : There is not enough memory space available in the card.
   * \ :java:ref:`SCMException.CKR_DEVICE_REMOVED`\ : The card has been removed during the operation.
   * \ :java:ref:`SCMException.CKR_ENCRYPTED_DATA_INVALID`\ : The encrypted data is invalid.
   * \ :java:ref:`SCMException.CKR_ENCRYPTED_DATA_LEN_RANGE`\ : The length of the encrypted data is invalid.
   * \ :java:ref:`SCMException.CKR_FUNCTION_CANCELED`\ : The operation has been cancelled.
   * \ :java:ref:`SCMException.CXR_FUNCTION_TIMED_OUT`\ : The operation took too long.
   * \ :java:ref:`SCMException.CKR_FUNCTION_NOT_SUPPORTED`\ : The operation is not supported by the card.
   * \ :java:ref:`SCMException.CKR_KEY_SIZE_RANGE`\ : The key size is outside of the range supported for this operation.
   * \ :java:ref:`SCMException.CKR_KEY_TYPE_INCONSISTENT`\ : The key types are inconsistent for this operation.
   * \ :java:ref:`SCMException.CKR_KEY_FUNCTION_NOT_PERMITTED`\ : The key does not support this operation.
   * \ :java:ref:`SCMException.CKR_KEY_UNEXTRACTABLE`\ : The key cannot be extracted.
   * \ :java:ref:`SCMException.CKR_MECHANISM_INVALID`\ : The cryptographic algorithm is not supported.
   * \ :java:ref:`SCMException.CKR_MECHANISM_PARAM_INVALID`\ : The parameters for the cryptographic operation are incorrect.
   * \ :java:ref:`SCMException.CKR_PIN_INCORRECT`\ : The PIN value is incorrect.
   * \ :java:ref:`SCMException.CKR_PIN_INVALID`\ : The PIN does not have the proper format.
   * \ :java:ref:`SCMException.CKR_PIN_LEN_RANGE`\ : The length of the PIN is outside of the range.
   * \ :java:ref:`SCMException.CKR_PIN_EXPIRED`\ : The PIN has expired and needs to be changed.
   * \ :java:ref:`SCMException.CKR_PIN_LOCKED`\ : The PIN has been blocked.
   * \ :java:ref:`SCMException.CKR_PIN_TOO_WEAK`\ : The new PIN must be different from the current one and recent previous PINs.
   * \ :java:ref:`SCMException.CKR_SIGNATURE_INVALID`\ : The digital signature in invalid.
   * \ :java:ref:`SCMException.CKR_SIGNATURE_LEN_RANGE`\ : The length od the digital signature is incorrect.
   * \ :java:ref:`SCMException.CKR_TOKEN_NOT_PRESENT`\ : The token has been removed.
   * \ :java:ref:`SCMException.CKR_TOKEN_NOT_RECOGNIZED`\ : The token is not supported.
   * \ :java:ref:`SCMException.CKR_TOKEN_WRITE_PROTECTED`\ : The token is write-protected.
   * \ :java:ref:`SCMException.CKR_USER_ALREADY_LOGGED_IN`\ : The user is already logged in.
   * \ :java:ref:`SCMException.CKR_USER_NOT_LOGGED_IN`\ : The appropriate user is not logged in.
   * \ :java:ref:`SCMException.CKR_USER_PIN_NOT_INITIALIZED`\ : The user PIN on this token has never been initially set.
   * \ :java:ref:`SCMException.CKR_USER_TYPE_INVALID`\ : The required user type is not defined for this card.
   * \ :java:ref:`SCMException.CKR_USER_ANOTHER_ALREADY_LOGGED_IN`\ : Another user is currently logged in.
   * \ :java:ref:`SCMException.CKR_USER_TOO_MANY_TYPES`\ : Too many users are logged in the token.
   * \ :java:ref:`SCMException.CKR_INFORMATION_SENSITIVE`\ : The information is private and cannot be revealed.
   * \ :java:ref:`SCMException.CXR_NO_LICENSE_KEY`\ : The software license key is invalid.
   * \ :java:ref:`SCMException.CXR_BT_PERMISSIONS_NOT_GRANTED`\ : Bluetooth permissions are not granted.
   * \ :java:ref:`SCMException.CXR_BT_INITIALIZATION_FAILED`\ : The initialization of bluetooth service failed. Maybe it is not enabled on your device.
   * \ :java:ref:`SCMException.CXR_BT_NOT_SCANNING`\ : Bluetooth scan has not been started or has been stopped.
   * \ :java:ref:`SCMException.CXR_BT_DEVICE_NOT_SUPPORTED`\ : The bluetooth peripheral is not supported.
   * \ :java:ref:`SCMException.CXR_BT_DEVICE_NOT_DETECTED`\ : The bluetooth peripheral is not detected.
   * \ :java:ref:`SCMException.CXR_BT_ALREADY_PAIRED`\ : The current operation is not permitted because a bluetooth peripheral is already paired.

   :return: the error code.

getStringCode
^^^^^^^^^^^^^

.. java:method:: public String getStringCode()
   :outertype: SCMException

   Human-readable error message.

   :return: the error message.