org.odpi.openmetadata.frameworks.connectors.ffdc

Class OCFRuntimeException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.odpi.openmetadata.frameworks.connectors.ffdc.OCFRuntimeException

All Implemented Interfaces:

Serializable

public class OCFRuntimeException
extends RuntimeException

OCFRuntimeException is used for all runtime exceptions generated by the OCF. The OCFErrorCode provides first failure data capture information for this exception, although this information can also be provided using custom values.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
OCFRuntimeException(ExceptionMessageDefinition messageDefinition, String className, String actionDescription) This is the typical constructor used for creating an OCFRuntimeException.
OCFRuntimeException(ExceptionMessageDefinition messageDefinition, String className, String actionDescription, Map<String,Object> relatedProperties) This is the typical constructor used for creating an OCFRuntimeException.
OCFRuntimeException(ExceptionMessageDefinition messageDefinition, String className, String actionDescription, Throwable caughtError) This is the constructor used for creating an OCFRuntimeException when an unexpected error has been caught.
OCFRuntimeException(ExceptionMessageDefinition messageDefinition, String className, String actionDescription, Throwable caughtError, Map<String,Object> relatedProperties) This is the constructor used for creating an OCFRuntimeException when an unexpected error has been caught.
OCFRuntimeException(int httpCode, String className, String actionDescription, String errorMessage, String systemAction, String userAction) Deprecated.
OCFRuntimeException(int httpCode, String className, String actionDescription, String errorMessage, String errorMessageId, String[] errorMessageParameters, String systemAction, String userAction, String caughtErrorClassName, Map<String,Object> relatedProperties) This is the constructor used when receiving an exception from a remote server.
OCFRuntimeException(int httpCode, String className, String actionDescription, String errorMessage, String systemAction, String userAction, Map<String,Object> relatedProperties) Deprecated.
OCFRuntimeException(int httpCode, String className, String actionDescription, String errorMessage, String systemAction, String userAction, Throwable caughtError) Deprecated.
OCFRuntimeException(int httpCode, String className, String actionDescription, String errorMessage, String systemAction, String userAction, Throwable caughtError, Map<String,Object> relatedProperties) Deprecated.
OCFRuntimeException(OCFRuntimeException template) This is the copy/clone constructor used for creating an OCFRuntimeException.
OCFRuntimeException(String errorMessage, OCFRuntimeException template) This is the copy/clone constructor used for creating an OCFRuntimeException.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object objectToCompare) Compare the values of the supplied object with those stored in the current object.
String	getErrorMessage() Deprecated.
Map<String,Object>	getRelatedProperties() Return any additional properties that were added to the exception to aid diagnosis.
Throwable	getReportedCaughtException() An exception that was caught and wrapped by this exception.
String	getReportedCaughtExceptionClassName() An exception that was caught and wrapped by this exception.
String	getReportedErrorMessage() A formatted short description of the cause of the condition that resulted in this exception.
String	getReportedErrorMessageId() Return the formal message identifier for the error message.
String[]	getReportedErrorMessageParameters() Return the parameters that were inserted in the error message.
int	getReportedHTTPCode() Return the HTTP response code to use with this exception.
String	getReportedSystemAction() A description of the action that the system took as a result of the error condition.
String	getReportedUserAction() A description of the action necessary to correct the error.
String	getReportingActionDescription() The type of request that the class was performing when the condition occurred that resulted in this exception.
String	getReportingClassName() The class that created this exception.
int	hashCode() Provide a common implementation of hashCode for all OCF Exception objects.
String	toString() Standard toString method.

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

OCFRuntimeException

public OCFRuntimeException(ExceptionMessageDefinition messageDefinition,
                           String className,
                           String actionDescription)

This is the typical constructor used for creating an OCFRuntimeException.

Parameters:

messageDefinition - content of the message

className - name of class reporting error

actionDescription - description of function it was performing when error detected

OCFRuntimeException

public OCFRuntimeException(ExceptionMessageDefinition messageDefinition,
                           String className,
                           String actionDescription,
                           Map<String,Object> relatedProperties)

This is the typical constructor used for creating an OCFRuntimeException. The properties allow additional information to be associated with the exception.

Parameters:

messageDefinition - content of the message

className - name of class reporting error

actionDescription - description of function it was performing when error detected

relatedProperties - arbitrary properties that may help with diagnosing the problem.

OCFRuntimeException

public OCFRuntimeException(ExceptionMessageDefinition messageDefinition,
                           String className,
                           String actionDescription,
                           Throwable caughtError)

This is the constructor used for creating an OCFRuntimeException when an unexpected error has been caught. The properties allow additional information to be associated with the exception.

Parameters:

messageDefinition - content of the message

className - name of class reporting error

actionDescription - description of function it was performing when error detected

caughtError - previous error causing this exception

OCFRuntimeException

public OCFRuntimeException(ExceptionMessageDefinition messageDefinition,
                           String className,
                           String actionDescription,
                           Throwable caughtError,
                           Map<String,Object> relatedProperties)

This is the constructor used for creating an OCFRuntimeException when an unexpected error has been caught. The properties allow additional information to be associated with the exception.

Parameters:

messageDefinition - content of the message

className - name of class reporting error

actionDescription - description of function it was performing when error detected

caughtError - previous error causing this exception

relatedProperties - arbitrary properties that may help with diagnosing the problem.

OCFRuntimeException

public OCFRuntimeException(int httpCode,
                           String className,
                           String actionDescription,
                           String errorMessage,
                           String errorMessageId,
                           String[] errorMessageParameters,
                           String systemAction,
                           String userAction,
                           String caughtErrorClassName,
                           Map<String,Object> relatedProperties)

This is the constructor used when receiving an exception from a remote server. The values are stored directly in the response object and are passed explicitly to the new exception. Notice that the technical aspects of the exception - such as class name creating the exception are local values so that the implementation of the server is not exposed.

Parameters:

httpCode - http response code to use if this exception flows over a REST call

className - name of class reporting error

actionDescription - description of function it was performing when error detected

errorMessage - description of error

errorMessageId - unique identifier for the message

errorMessageParameters - parameters that were inserted in the message

systemAction - actions of the system as a result of the error

userAction - instructions for correcting the error

caughtErrorClassName - previous error causing this exception

relatedProperties - arbitrary properties that may help with diagnosing the problem.

OCFRuntimeException

public OCFRuntimeException(String errorMessage,
                           OCFRuntimeException template)

This is the copy/clone constructor used for creating an OCFRuntimeException.

Parameters:

errorMessage - message for the exception - overrides the value from the caught exception

template - object to copy

OCFRuntimeException

public OCFRuntimeException(OCFRuntimeException template)

This is the copy/clone constructor used for creating an OCFRuntimeException.

Parameters:

template - object to copy

OCFRuntimeException

@Deprecated
public OCFRuntimeException(int httpCode,
                                       String className,
                                       String actionDescription,
                                       String errorMessage,
                                       String systemAction,
                                       String userAction)

Deprecated.

This is the typical constructor used for creating an OCFRuntimeException.

Parameters:

httpCode - http response code to use if this exception flows over a REST call

className - name of class reporting error

actionDescription - description of function it was performing when error detected

errorMessage - description of error

systemAction - actions of the system as a result of the error

userAction - instructions for correcting the error

OCFRuntimeException

@Deprecated
public OCFRuntimeException(int httpCode,
                                       String className,
                                       String actionDescription,
                                       String errorMessage,
                                       String systemAction,
                                       String userAction,
                                       Map<String,Object> relatedProperties)

Deprecated.

This is the typical constructor used for creating an OCFRuntimeException.

Parameters:

httpCode - http response code to use if this exception flows over a REST call

className - name of class reporting error

actionDescription - description of function it was performing when error detected

errorMessage - description of error

systemAction - actions of the system as a result of the error

userAction - instructions for correcting the error

relatedProperties - arbitrary properties that may help with diagnosing the problem.

OCFRuntimeException

@Deprecated
public OCFRuntimeException(int httpCode,
                                       String className,
                                       String actionDescription,
                                       String errorMessage,
                                       String systemAction,
                                       String userAction,
                                       Throwable caughtError)

Deprecated.

This is the constructor used for creating a OCFRuntimeException that results from a previous error/exception being thrown.

Parameters:

httpCode - http response code to use if this exception flows over a rest call

className - name of class reporting error

actionDescription - description of function it was performing when error detected

errorMessage - description of error

systemAction - actions of the system as a result of the error

userAction - instructions for correcting the error

caughtError - previous error causing this exception

OCFRuntimeException

@Deprecated
public OCFRuntimeException(int httpCode,
                                       String className,
                                       String actionDescription,
                                       String errorMessage,
                                       String systemAction,
                                       String userAction,
                                       Throwable caughtError,
                                       Map<String,Object> relatedProperties)

Deprecated.

This is the constructor used for creating a OCFRuntimeException that results from a previous error/exception being thrown.

Parameters:

httpCode - http response code to use if this exception flows over a rest call

className - name of class reporting error

actionDescription - description of function it was performing when error detected

errorMessage - description of error

systemAction - actions of the system as a result of the error

userAction - instructions for correcting the error

caughtError - previous error causing this exception

relatedProperties - arbitrary properties that may help with diagnosing the problem.

Method Detail

getReportedHTTPCode

public int getReportedHTTPCode()

Return the HTTP response code to use with this exception.

Returns:

reportedHTTPCode

getReportingClassName

public String getReportingClassName()

The class that created this exception.

Returns:

reportingClassName

getReportingActionDescription

public String getReportingActionDescription()

The type of request that the class was performing when the condition occurred that resulted in this exception.

Returns:

reportingActionDescription

getErrorMessage

@Deprecated
public String getErrorMessage()

Deprecated.

A formatted short description of the cause of the condition that resulted in this exception. It includes the message id and is formatted with the message parameters. The message is defined in En_US. The method is deprecated because it is inconsistent in its naming compared with other methods.

Returns:

string message

getReportedErrorMessage

public String getReportedErrorMessage()

A formatted short description of the cause of the condition that resulted in this exception. It includes the message id and is formatted with the message parameters. The message is defined in En_US.

Returns:

string message

getReportedErrorMessageId

public String getReportedErrorMessageId()

Return the formal message identifier for the error message. This is incorporated in the error message. This is provided both for automated processing and to enable the error message to be reformatted in a different language.

Returns:

string message id

getReportedErrorMessageParameters

public String[] getReportedErrorMessageParameters()

Return the parameters that were inserted in the error message. These are provided both for automated processing and to enable the error message to be reformatted in a different language.

Returns:

list of parameter values

getReportedSystemAction

public String getReportedSystemAction()

A description of the action that the system took as a result of the error condition.

Returns:

reportedSystemAction

getReportedUserAction

public String getReportedUserAction()

A description of the action necessary to correct the error.

Returns:

reportedUserAction

getReportedCaughtException

public Throwable getReportedCaughtException()

An exception that was caught and wrapped by this exception. If a null is returned, then this exception is either newly created and not the result of a previous exception or the exception occurred in a remote server. If the second situation is true then reportedCaughtExceptionClassName is set.

Returns:

reportedCaughtException Throwable object

getReportedCaughtExceptionClassName

public String getReportedCaughtExceptionClassName()

An exception that was caught and wrapped by this exception. If a null is returned, then this exception is the result of a newly detected error and not caused by another exception.

Returns:

full class name of the original exception

getRelatedProperties

public Map<String,Object> getRelatedProperties()

Return any additional properties that were added to the exception to aid diagnosis.

Returns:

property map

equals

public boolean equals(Object objectToCompare)

Compare the values of the supplied object with those stored in the current object.

Overrides:

equals in class Object

Parameters:

objectToCompare - supplied object

Returns:

boolean result of comparison

hashCode

public int hashCode()

Provide a common implementation of hashCode for all OCF Exception objects.

Overrides:

hashCode in class Object

Returns:

integer hash code based on the values in the attributes

toString

public String toString()

Standard toString method.

Overrides:

toString in class Throwable

Returns:

print out of variables in a JSON-style