Module ibm.crypto.hdwrcca

Package com.ibm.crypto.hdwrCCA.provider

Class JCECCARuntimeException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.ibm.crypto.hdwrCCA.provider.JCECCARuntimeException

All Implemented Interfaces:

Serializable

public class JCECCARuntimeException
extends RuntimeException

This class will extend RuntimeException such that an application can retrieve data returned from service calls made by the IBMJCECCA provider. The message passed to this class will be displayed by using RuntimeException.

Since:

1.6 (V6.0.1)

See Also:

• RuntimeException
• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ICSF_EXCEPTION	Exception Type (package scope)

Constructor Summary

Constructors

Constructor	Description
JCECCARuntimeException(int exception_type, String api_name, String exception_message, int return_code, int reason_code)	Creates an instance of JCECCARuntimeException.

Method Summary

Modifier and Type	Method	Description
String	getAPIName()	Gets the name of the API service call causing the exception.
String	getExceptionMessage()	Gets the exception message displayed.
int	getReasonCode()	Gets the reason code returned from the service call.
int	getReturnCode()	Gets the return code returned from the service call.

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

ICSF_EXCEPTION

public static final int ICSF_EXCEPTION

Exception Type (package scope)

See Also:

• Constant Field Values

Constructor Details

JCECCARuntimeException

public JCECCARuntimeException(int exception_type,
 String api_name,
 String exception_message,
 int return_code,
 int reason_code)

Creates an instance of JCECCARuntimeException. The constructor will display the input message and set it's member data.

Parameters:

exception_type - Identifies the service that is throwing the exception

api_name - Identifies the name of the API service call executing this handler

exception_message - Identifies the message string to be displayed

return_code - Identifies the return code returned from the service call

reason_code - Identifies the reason code returned from the service call

Method Details

getAPIName

public String getAPIName()

Gets the name of the API service call causing the exception.

Returns:

apiName the name of the API service call

getExceptionMessage

public String getExceptionMessage()

Gets the exception message displayed.

Returns:

message the exception message

getReturnCode

public int getReturnCode()

Gets the return code returned from the service call.

Returns:

returnCode the return code

getReasonCode

public int getReasonCode()

Gets the reason code returned from the service call.

Returns:

reasonCode the reason code