org.odpi.openmetadata.frameworks.governanceaction.ffdc

Class GAFRuntimeException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.odpi.openmetadata.frameworks.governanceaction.ffdc.GAFRuntimeException

All Implemented Interfaces:

Serializable

public class GAFRuntimeException
extends RuntimeException

The GAFRuntimeException is used for all runtime exceptions from GAF components. The GAFErrorCode is used to provide the first failure data capture for this exception. Typically runtime exceptions are the result of programming errors and so a developer is looking at their resolution.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GAFRuntimeException(int httpCode, String className, String actionDescription, String errorMessage, String systemAction, String userAction) This is the typical constructor used for creating a GAFRuntimeException.
GAFRuntimeException(int httpCode, String className, String actionDescription, String errorMessage, String systemAction, String userAction, Throwable caughtError) This is the constructor used for creating a GAFRuntimeException that results from a previous error.

Method Summary

Modifier and Type	Method and Description
String	getErrorMessage() A formatted short description of the cause of the condition that resulted in this GAFRuntimeException.
Throwable	getReportedCaughtException() An exception that was caught and wrapped by this exception.
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 GAFRuntimeException.
String	getReportingClassName() The class that created the GAFRuntimeException.

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

Constructor Detail

GAFRuntimeException

public GAFRuntimeException(int httpCode,
                           String className,
                           String actionDescription,
                           String errorMessage,
                           String systemAction,
                           String userAction)

This is the typical constructor used for creating a GAFRuntimeException.

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

GAFRuntimeException

public GAFRuntimeException(int httpCode,
                           String className,
                           String actionDescription,
                           String errorMessage,
                           String systemAction,
                           String userAction,
                           Throwable caughtError)

This is the constructor used for creating a GAFRuntimeException that results from a previous error.

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

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 the GAFRuntimeException.

Returns:

reportingClassName

getReportingActionDescription

public String getReportingActionDescription()

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

Returns:

reportingActionDescription

getErrorMessage

public String getErrorMessage()

A formatted short description of the cause of the condition that resulted in this GAFRuntimeException.

Returns:

reportedErrorMessage

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 newly created and not the result of a previous exception.

Returns:

reportedCaughtException