org.odpi.openmetadata.commonservices.ffdc.exceptions

Class OMAGRuntimeException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

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

org.odpi.openmetadata.commonservices.ffdc.exceptions.OMAGRuntimeException

All Implemented Interfaces:

Serializable

public class OMAGRuntimeException
extends OCFRuntimeException

OMAGRuntimeException is used for all runtime exceptions generated by one of the Open Metadata and Governance (OMAG) Services.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
OMAGRuntimeException(ExceptionMessageDefinition messageDefinition, String className, String actionDescription) This is the typical constructor used for creating an OMAGRuntimeException.
OMAGRuntimeException(ExceptionMessageDefinition messageDefinition, String className, String actionDescription, Map<String,Object> relatedProperties) This is the typical constructor used for creating an OMAGRuntimeException.
OMAGRuntimeException(ExceptionMessageDefinition messageDefinition, String className, String actionDescription, Throwable caughtError) This is the constructor used for creating an OMAGRuntimeException when an unexpected error has been caught.
OMAGRuntimeException(ExceptionMessageDefinition messageDefinition, String className, String actionDescription, Throwable caughtError, Map<String,Object> relatedProperties) This is the constructor used for creating an OMAGRuntimeException when an unexpected error has been caught.
OMAGRuntimeException(int httpCode, String className, String actionDescription, String errorMessage, String systemAction, String userAction, Map<String,Object> relatedProperties) Deprecated.
OMAGRuntimeException(int httpCode, String className, String actionDescription, String errorMessage, String systemAction, String userAction, Throwable caughtError, Map<String,Object> relatedProperties) Deprecated.

Method Summary

Modifier and Type	Method and Description
String	toString() JSON-style toString

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.ffdc.OCFRuntimeException

equals, getErrorMessage, getRelatedProperties, getReportedCaughtException, getReportedCaughtExceptionClassName, getReportedErrorMessage, getReportedErrorMessageId, getReportedErrorMessageParameters, getReportedHTTPCode, getReportedSystemAction, getReportedUserAction, getReportingActionDescription, getReportingClassName, hashCode

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

OMAGRuntimeException

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

This is the typical constructor used for creating an OMAGRuntimeException.

Parameters:

messageDefinition - content of the message

className - name of class reporting error

actionDescription - description of function it was performing when error detected

OMAGRuntimeException

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

This is the typical constructor used for creating an OMAGRuntimeException. 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.

OMAGRuntimeException

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

This is the constructor used for creating an OMAGRuntimeException 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

OMAGRuntimeException

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

This is the constructor used for creating an OMAGRuntimeException 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.

OMAGRuntimeException

@Deprecated
public OMAGRuntimeException(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 exception.

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.

OMAGRuntimeException

@Deprecated
public OMAGRuntimeException(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 an exception when an unexpected error has been caught.

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

toString

public String toString()

JSON-style toString

Overrides:

toString in class OCFRuntimeException

Returns:

string of property names and values for this enum