Package uicc.toolkit

Class ToolkitException

java.lang.Object
java.lang.Throwable
java.lang.Exception
java.lang.RuntimeException
javacard.framework.CardRuntimeException
uicc.toolkit.ToolkitException
All Implemented Interfaces:
Serializable
public class ToolkitException extends javacard.framework.CardRuntimeException
This class extends the Throwable class and allows the classes of this package to throw specific exceptions in case of problems.
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final short
    ALLOWED_LENGTH_EXCEEDED
    This reason code (=10) is used to indicate that the provided menu entry string is bigger than the allocated space
    static final short
    BAD_INPUT_PARAMETER
    This reason code (=14) is used to indicate that an input parameter of the method is not valid
    static final short
    COMMAND_NOT_ALLOWED
    This reason code (=15) is used to indicate that the proactive command being sent is not allowed by the CAT Runtime Environment.
    static final short
    EVENT_ALREADY_REGISTERED
    This reason code (= 7) is used to indicate that the maximum number of registered applet for this event is already reached (e.g Call Control)
    static final short
    EVENT_NOT_ALLOWED
    This reason code (=13) is used to indicate that the registration to an indicated event can not be changed by the called method.
    static final short
    EVENT_NOT_SUPPORTED
    This reason code (= 6) is used to indicate that the event code is not supported by the CAT Runtime Environment
    static final short
    HANDLER_NOT_AVAILABLE
    This reason code (= 2) is used to indicate that the Handler is not available (e.g.
    static final short
    HANDLER_OVERFLOW
    This reason code (= 1) is used to indicate that data are to large than the storage space available in the handler.
    static final short
    INVALID_SERVICE_ID
    This reason code (=17) is used to indicate that the service identifier is not allocated to this applet.
    static final short
    INVALID_TIMER_ID
    This reason code (=12) is used to indicate that the indicated timer identifier is not allocated to this applet.
    static final short
    MENU_ENTRY_NOT_FOUND
    This reason code (= 4) is used to indicate that the requested menu entry is not defined for the corresponding applet.
    static final short
    NO_SERVICE_ID_AVAILABLE
    This reason code (=16) is used to indicate that all the available services identifiers or the maximum number of services identifiers have been allocated to the applet
    static final short
    NO_TIMER_AVAILABLE
    This reason code (=11) is used to indicate that all the available timers or the maximum number of timers have been allocated to the applet
    static final short
    OUT_OF_TLV_BOUNDARIES
    This reason code (= 8) is used to indicate that either the offset, the length or both are out of current TLV boundaries
    static final short
    REGISTRY_ERROR
    This reason code (= 5) is used to indicate an error in the applet registry
    static final short
    TAR_NOT_DEFINED
    This reason code (=18) is used to indicate that there is no TAR defined for the applet instance.
    static final short
    TERMINAL_PROFILE_NOT_AVAILABLE
    This reason code (= 9) is used to indicate that the Terminal Profile data are not available
    static final short
    UNAVAILABLE_ELEMENT
    This reason code (= 3) is used to indicate that the element is unavailable in the handler buffer.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ToolkitException(short reason)
    Construct a ToolkitException instance with the specified reason.

  • Method Summary

    Modifier and Type
    Method
    Description
    static void
    throwIt(short reason)
    Throws the JCRE instance of the ToolkitException class with the specified reason.

    Methods inherited from class javacard.framework.CardRuntimeException

    getReason, setReason

    Methods inherited from class java.lang.Throwable

    addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

  • Field Details

    • HANDLER_OVERFLOW

      public static final short HANDLER_OVERFLOW
      This reason code (= 1) is used to indicate that data are to large than the storage space available in the handler.
      See Also:

    • HANDLER_NOT_AVAILABLE

      public static final short HANDLER_NOT_AVAILABLE
      This reason code (= 2) is used to indicate that the Handler is not available (e.g. busy).
      See Also:

    • UNAVAILABLE_ELEMENT

      public static final short UNAVAILABLE_ELEMENT
      This reason code (= 3) is used to indicate that the element is unavailable in the handler buffer.
      See Also:

    • MENU_ENTRY_NOT_FOUND

      public static final short MENU_ENTRY_NOT_FOUND
      This reason code (= 4) is used to indicate that the requested menu entry is not defined for the corresponding applet.
      See Also:

    • REGISTRY_ERROR

      public static final short REGISTRY_ERROR
      This reason code (= 5) is used to indicate an error in the applet registry
      See Also:

    • EVENT_NOT_SUPPORTED

      public static final short EVENT_NOT_SUPPORTED
      This reason code (= 6) is used to indicate that the event code is not supported by the CAT Runtime Environment
      See Also:

    • EVENT_ALREADY_REGISTERED

      public static final short EVENT_ALREADY_REGISTERED
      This reason code (= 7) is used to indicate that the maximum number of registered applet for this event is already reached (e.g Call Control)
      See Also:

    • OUT_OF_TLV_BOUNDARIES

      public static final short OUT_OF_TLV_BOUNDARIES
      This reason code (= 8) is used to indicate that either the offset, the length or both are out of current TLV boundaries
      See Also:

    • TERMINAL_PROFILE_NOT_AVAILABLE

      public static final short TERMINAL_PROFILE_NOT_AVAILABLE
      This reason code (= 9) is used to indicate that the Terminal Profile data are not available
      See Also:

    • ALLOWED_LENGTH_EXCEEDED

      public static final short ALLOWED_LENGTH_EXCEEDED
      This reason code (=10) is used to indicate that the provided menu entry string is bigger than the allocated space
      See Also:

    • NO_TIMER_AVAILABLE

      public static final short NO_TIMER_AVAILABLE
      This reason code (=11) is used to indicate that all the available timers or the maximum number of timers have been allocated to the applet
      See Also:

    • INVALID_TIMER_ID

      public static final short INVALID_TIMER_ID
      This reason code (=12) is used to indicate that the indicated timer identifier is not allocated to this applet.
      See Also:

    • EVENT_NOT_ALLOWED

      public static final short EVENT_NOT_ALLOWED
      This reason code (=13) is used to indicate that the registration to an indicated event can not be changed by the called method.
      See Also:

    • BAD_INPUT_PARAMETER

      public static final short BAD_INPUT_PARAMETER
      This reason code (=14) is used to indicate that an input parameter of the method is not valid
      See Also:

    • COMMAND_NOT_ALLOWED

      public static final short COMMAND_NOT_ALLOWED
      This reason code (=15) is used to indicate that the proactive command being sent is not allowed by the CAT Runtime Environment.
      See Also:

    • NO_SERVICE_ID_AVAILABLE

      public static final short NO_SERVICE_ID_AVAILABLE
      This reason code (=16) is used to indicate that all the available services identifiers or the maximum number of services identifiers have been allocated to the applet
      See Also:

    • INVALID_SERVICE_ID

      public static final short INVALID_SERVICE_ID
      This reason code (=17) is used to indicate that the service identifier is not allocated to this applet.
      See Also:

    • TAR_NOT_DEFINED

      public static final short TAR_NOT_DEFINED
      This reason code (=18) is used to indicate that there is no TAR defined for the applet instance.
      See Also:

  • Constructor Details

    • ToolkitException

      public ToolkitException(short reason)
      Construct a ToolkitException instance with the specified reason. To conserve on resources use throwIt() method to re-use the JCRE instance of this class.
      Parameters:
      reason - the reason for the exception

  • Method Details

    • throwIt

      public static void throwIt(short reason) throws ToolkitException
      Throws the JCRE instance of the ToolkitException class with the specified reason.
      Parameters:
      reason - the reason for the exception.
      Throws:
      ToolkitException - always