org.odpi.openmetadata.repositoryservices.ffdc.exception

Class OMRSConfigErrorException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.odpi.openmetadata.repositoryservices.ffdc.exception.OMRSRuntimeException

org.odpi.openmetadata.repositoryservices.ffdc.exception.OMRSConfigErrorException

All Implemented Interfaces:

Serializable

public class OMRSConfigErrorException
extends OMRSRuntimeException

OMRSConfigErrorException is used for all runtime exceptions generated by the Open Metadata Repository Services (OMRS) components that indicate a configuration error. It is used in conjunction with the OMRSErrorCode to provide first failure data capture for these errors.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
OMRSConfigErrorException(int httpCode, String className, String actionDescription, String errorMessage, String systemAction, String userAction) This is the typical constructor used for creating an OMRSConfigErrorException.
OMRSConfigErrorException(int httpCode, String className, String actionDescription, String errorMessage, String systemAction, String userAction, Throwable caughtError) This is the constructor used for creating a OMRSConfigErrorException when an unexpected exception has been caught.
OMRSConfigErrorException(int httpCode, String className, String actionDescription, String errorMessage, String systemAction, String userAction, Throwable[] caughtErrors) This is the constructor used for creating a OMRSConfigErrorException when multiple unexpected errors have been caught.

Method Summary

Modifier and Type	Method and Description
String	getErrorMessage() A formatted short description of the cause of the condition that resulted in this exception.
Throwable[]	getReportedCaughtExceptions() 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 exception.
String	getReportingClassName() The class that created this exception.

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

OMRSConfigErrorException

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

This is the typical constructor used for creating an OMRSConfigErrorException.

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

OMRSConfigErrorException

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

This is the constructor used for creating a OMRSConfigErrorException when an unexpected exception 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

OMRSConfigErrorException

public OMRSConfigErrorException(int httpCode,
                                String className,
                                String actionDescription,
                                String errorMessage,
                                String systemAction,
                                String userAction,
                                Throwable[] caughtErrors)

This is the constructor used for creating a OMRSConfigErrorException when multiple unexpected errors have 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

caughtErrors - previous errors causing this exception

Method Detail

getReportedHTTPCode

public int getReportedHTTPCode()

Return the HTTP response code to use with this exception.

Overrides:

getReportedHTTPCode in class OMRSRuntimeException

Returns:

reportedHTTPCode

getReportingClassName

public String getReportingClassName()

The class that created this exception.

Overrides:

getReportingClassName in class OMRSRuntimeException

Returns:

reportingClassName

getReportingActionDescription

public String getReportingActionDescription()

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

Overrides:

getReportingActionDescription in class OMRSRuntimeException

Returns:

reportingActionDescription

getErrorMessage

public String getErrorMessage()

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

Overrides:

getErrorMessage in class OMRSRuntimeException

Returns:

reportedErrorMessage

getReportedSystemAction

public String getReportedSystemAction()

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

Overrides:

getReportedSystemAction in class OMRSRuntimeException

Returns:

reportedSystemAction

getReportedUserAction

public String getReportedUserAction()

A description of the action necessary to correct the error.

Overrides:

getReportedUserAction in class OMRSRuntimeException

Returns:

reportedUserAction

getReportedCaughtExceptions

public Throwable[] getReportedCaughtExceptions()

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.

Overrides:

getReportedCaughtExceptions in class OMRSRuntimeException

Returns:

reportedCaughtException